manometer  2.0.0.0
manometer.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 MANOMETER_H
36 #define MANOMETER_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 MANOMETER_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
56 
62 #define MANOMETER_RETVAL uint8_t
63 
64 #define MANOMETER_OK 0x00
65 #define MANOMETER_INIT_ERROR 0xFF
66 
72 #define MANOMETER_CMD_RESET 0x1E
73 
79 #define MANOMETER_CMD_ADC_READ 0x00
80 
86 #define MANOMETER_CMD_ADC_CONV 0x40
87 
93 #define MANOMETER_CMD_ADC_D1 0x00
94 
100 #define MANOMETER_CMD_ADC_D2 0x10
101 
107 #define MANOMETER_CMD_ADC_256 0x00
108 
114 #define MANOMETER_CMD_ADC_512 0x02
115 
121 #define MANOMETER_CMD_ADC_1024 0x04
122 
128 #define MANOMETER_CMD_ADC_2048 0x06
129 
135 #define MANOMETER_CMD_ADC_4096 0x08
136 
142 #define MANOMETER_CMD_PROM_RD 0xA0
143 
149 #define MANOMETER_OUTPUT_ADDRESS 0x38
150 
156 #define MANOMETER_I2C_ADDRESS 0x38
157  // End group macro
159 // --------------------------------------------------------------- PUBLIC TYPES
168 typedef struct
169 {
170 
171  // Modules
172 
173  i2c_master_t i2c;
174 
175  // ctx variable
176  uint8_t slave_address;
177 
178 } manometer_t;
179 
183 typedef struct
184 {
185  // Communication gpio pins
186 
187  pin_name_t scl;
188  pin_name_t sda;
189 
190  // static variable
191 
192  uint32_t i2c_speed;
193  uint8_t i2c_address;
194 
196  // End types group
198 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
199 
205 #ifdef __cplusplus
206 extern "C"{
207 #endif
208 
218 
227 
235 void manometer_default_cfg ( manometer_t *ctx );
236 
247 void manometer_generic_write ( manometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
248 
260 void manometer_generic_read ( manometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
261 
270 float manometer_get_pressure ( manometer_t *ctx );
271 
281 
282 #ifdef __cplusplus
283 }
284 #endif
285 #endif // _MANOMETER_H_
286  // End public_function group
289 
290 // ------------------------------------------------------------------------- END
Click configuration structure definition.
Definition: manometer.h:183
void manometer_default_cfg(manometer_t *ctx)
Click Default Configuration function.
void manometer_generic_read(manometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
pin_name_t scl
Definition: manometer.h:187
#define MANOMETER_RETVAL
Definition: manometer.h:62
float manometer_get_pressure(manometer_t *ctx)
Function read 16-bit data and convert to pressure in mbar.
uint8_t slave_address
Definition: manometer.h:176
i2c_master_t i2c
Definition: manometer.h:173
uint8_t i2c_address
Definition: manometer.h:193
void manometer_generic_write(manometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
MANOMETER_RETVAL manometer_init(manometer_t *ctx, manometer_cfg_t *cfg)
Initialization function.
uint32_t i2c_speed
Definition: manometer.h:192
void manometer_cfg_setup(manometer_cfg_t *cfg)
Config Object Initialization function.
Click ctx object definition.
Definition: manometer.h:168
float manometer_get_temperature(manometer_t *ctx)
Function read 11-bit data and convert to temperature in degrees Celsius [ �C ].
pin_name_t sda
Definition: manometer.h:188