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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
63 #define MANOMETER_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
65  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
66 
72 #define MANOMETER_RETVAL uint8_t
73 
74 #define MANOMETER_OK 0x00
75 #define MANOMETER_INIT_ERROR 0xFF
76 
82 #define MANOMETER_CMD_RESET 0x1E
83 
89 #define MANOMETER_CMD_ADC_READ 0x00
90 
96 #define MANOMETER_CMD_ADC_CONV 0x40
97 
103 #define MANOMETER_CMD_ADC_D1 0x00
104 
110 #define MANOMETER_CMD_ADC_D2 0x10
111 
117 #define MANOMETER_CMD_ADC_256 0x00
118 
124 #define MANOMETER_CMD_ADC_512 0x02
125 
131 #define MANOMETER_CMD_ADC_1024 0x04
132 
138 #define MANOMETER_CMD_ADC_2048 0x06
139 
145 #define MANOMETER_CMD_ADC_4096 0x08
146 
152 #define MANOMETER_CMD_PROM_RD 0xA0
153 
159 #define MANOMETER_OUTPUT_ADDRESS 0x38
160 
166 #define MANOMETER_I2C_ADDRESS 0x38
167  // End group macro
169 // --------------------------------------------------------------- PUBLIC TYPES
178 typedef struct
179 {
180 
181  // Modules
182 
183  i2c_master_t i2c;
184 
185  // ctx variable
186  uint8_t slave_address;
187 
188 } manometer_t;
189 
193 typedef struct
194 {
195  // Communication gpio pins
196 
197  pin_name_t scl;
198  pin_name_t sda;
199 
200  // static variable
201 
202  uint32_t i2c_speed;
203  uint8_t i2c_address;
204 
206  // End types group
208 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
209 
215 #ifdef __cplusplus
216 extern "C"{
217 #endif
218 
228 
237 
246 
257 void manometer_generic_write ( manometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
258 
270 void manometer_generic_read ( manometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
271 
281 
291 
292 #ifdef __cplusplus
293 }
294 #endif
295 #endif // _MANOMETER_H_
296  // End public_function group
299 
300 // ------------------------------------------------------------------------- END
manometer_t::slave_address
uint8_t slave_address
Definition: manometer.h:186
manometer_cfg_t::i2c_address
uint8_t i2c_address
Definition: manometer.h:203
manometer_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: manometer.h:202
manometer_cfg_t::sda
pin_name_t sda
Definition: manometer.h:198
manometer_generic_write
void manometer_generic_write(manometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
manometer_init
MANOMETER_RETVAL manometer_init(manometer_t *ctx, manometer_cfg_t *cfg)
Initialization function.
manometer_cfg_t
Click configuration structure definition.
Definition: manometer.h:194
manometer_default_cfg
void manometer_default_cfg(manometer_t *ctx)
Click Default Configuration function.
manometer_t
Click ctx object definition.
Definition: manometer.h:179
MANOMETER_RETVAL
#define MANOMETER_RETVAL
Definition: manometer.h:72
manometer_generic_read
void manometer_generic_read(manometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
manometer_t::i2c
i2c_master_t i2c
Definition: manometer.h:183
manometer_get_pressure
float manometer_get_pressure(manometer_t *ctx)
Function read 16-bit data and convert to pressure in mbar.
manometer_cfg_setup
void manometer_cfg_setup(manometer_cfg_t *cfg)
Config Object Initialization function.
manometer_get_temperature
float manometer_get_temperature(manometer_t *ctx)
Function read 11-bit data and convert to temperature in degrees Celsius [ �C ].
manometer_cfg_t::scl
pin_name_t scl
Definition: manometer.h:197