pressure8  2.0.0.0
pressure8.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef PRESSURE8_H
36 #define PRESSURE8_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define PRESSURE8_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
57  cfg.eoc = MIKROBUS( mikrobus, MIKROBUS_INT )
58 
64 #define PRESSURE8_RETVAL uint8_t
65 
66 #define PRESSURE8_OK 0x00
67 #define PRESSURE8_INIT_ERROR 0xFF
68 
74 #define PRESSURE8_DATA_IN_mBar 1
75 #define PRESSURE8_DATA_IN_hPa 2
76 #define PRESSURE8_DATA_IN_kPa 3
77 #define PRESSURE8_DATA_IN_Torr 4
78 #define PRESSURE8_DATA_IN_mmHg 5
79  // End group macro
82 // --------------------------------------------------------------- PUBLIC TYPES
91 typedef struct
92 {
93  // Output pins
94 
95  digital_out_t rst;
96 
97  // Input pins
98 
99  digital_in_t eoc;
100 
101  // Modules
102 
103  i2c_master_t i2c;
104 
105  // ctx variable
106 
107  uint8_t slave_address;
108  uint8_t device_status;
109 
110  float P_MAX;
111  float P_MIN;
112 
113 } pressure8_t;
114 
118 typedef struct
119 {
120  // Communication gpio pins
121 
122  pin_name_t scl;
123  pin_name_t sda;
124 
125  // Additional gpio pins
126 
127  pin_name_t rst;
128  pin_name_t eoc;
129 
130  // static variable
131 
132  uint32_t i2c_speed;
133  uint8_t i2c_address;
134 
136  // End types group
138 
139 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
140 
146 #ifdef __cplusplus
147 extern "C"{
148 #endif
149 
159 
169 
179 void pressure8_generic_read ( pressure8_t *ctx, uint8_t *data_buf, uint8_t len );
180 
191 float pressure8_get_pressure ( pressure8_t *ctx, uint8_t press_format );
192 
200 void pressure8_device_reset ( pressure8_t *ctx );
201 
212 
223 
239 void pressure8_set_psi_range ( pressure8_t *ctx, float psi_min, float psi_max );
240 
241 #ifdef __cplusplus
242 }
243 #endif
244 #endif // PRESSURE8_H
245  // End public_function group
248 
249 // ------------------------------------------------------------------------ END
pressure8_init
PRESSURE8_RETVAL pressure8_init(pressure8_t *ctx, pressure8_cfg_t *cfg)
Initialization function.
pressure8_cfg_t::i2c_address
uint8_t i2c_address
Definition: pressure8.h:133
pressure8_t::i2c
i2c_master_t i2c
Definition: pressure8.h:103
pressure8_cfg_t::sda
pin_name_t sda
Definition: pressure8.h:123
pressure8_t
Click ctx object definition.
Definition: pressure8.h:91
pressure8_cfg_t::eoc
pin_name_t eoc
Definition: pressure8.h:128
pressure8_cfg_setup
void pressure8_cfg_setup(pressure8_cfg_t *cfg)
Config Object Initialization function.
pressure8_t::device_status
uint8_t device_status
Definition: pressure8.h:108
pressure8_get_interrupt_state
uint8_t pressure8_get_interrupt_state(pressure8_t *ctx)
Functions for get interrupt pin state.
pressure8_t::slave_address
uint8_t slave_address
Definition: pressure8.h:107
PRESSURE8_RETVAL
#define PRESSURE8_RETVAL
Definition: pressure8.h:64
pressure8_t::P_MIN
float P_MIN
Definition: pressure8.h:111
pressure8_t::eoc
digital_in_t eoc
Definition: pressure8.h:99
pressure8_cfg_t::rst
pin_name_t rst
Definition: pressure8.h:127
pressure8_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: pressure8.h:132
pressure8_t::P_MAX
float P_MAX
Definition: pressure8.h:110
pressure8_get_pressure
float pressure8_get_pressure(pressure8_t *ctx, uint8_t press_format)
Functions for get Pressure data.
pressure8_generic_read
void pressure8_generic_read(pressure8_t *ctx, uint8_t *data_buf, uint8_t len)
Generic read function.
pressure8_cfg_t
Click configuration structure definition.
Definition: pressure8.h:118
pressure8_t::rst
digital_out_t rst
Definition: pressure8.h:95
pressure8_cfg_t::scl
pin_name_t scl
Definition: pressure8.h:122
pressure8_device_reset
void pressure8_device_reset(pressure8_t *ctx)
Functions for hardware device reset.
pressure8_get_device_status
uint8_t pressure8_get_device_status(pressure8_t *ctx)
Functions for get device status.
pressure8_set_psi_range
void pressure8_set_psi_range(pressure8_t *ctx, float psi_min, float psi_max)
Functions for set PSI range.