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 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define MANOMETER_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
69  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
70 
76 #define MANOMETER_RETVAL uint8_t
77 
78 #define MANOMETER_OK 0x00
79 #define MANOMETER_INIT_ERROR 0xFF
80 
86 #define MANOMETER_CMD_RESET 0x1E
87 
93 #define MANOMETER_CMD_ADC_READ 0x00
94 
100 #define MANOMETER_CMD_ADC_CONV 0x40
101 
107 #define MANOMETER_CMD_ADC_D1 0x00
108 
114 #define MANOMETER_CMD_ADC_D2 0x10
115 
121 #define MANOMETER_CMD_ADC_256 0x00
122 
128 #define MANOMETER_CMD_ADC_512 0x02
129 
135 #define MANOMETER_CMD_ADC_1024 0x04
136 
142 #define MANOMETER_CMD_ADC_2048 0x06
143 
149 #define MANOMETER_CMD_ADC_4096 0x08
150 
156 #define MANOMETER_CMD_PROM_RD 0xA0
157 
163 #define MANOMETER_OUTPUT_ADDRESS 0x38
164 
170 #define MANOMETER_I2C_ADDRESS 0x38
171  // End group macro
173 // --------------------------------------------------------------- PUBLIC TYPES
182 typedef struct
183 {
184 
185  // Modules
186 
187  i2c_master_t i2c;
188 
189  // ctx variable
190  uint8_t slave_address;
191 
192 } manometer_t;
193 
197 typedef struct
198 {
199  // Communication gpio pins
200 
201  pin_name_t scl;
202  pin_name_t sda;
203 
204  // static variable
205 
206  uint32_t i2c_speed;
207  uint8_t i2c_address;
208 
210  // End types group
212 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
213 
219 #ifdef __cplusplus
220 extern "C"{
221 #endif
222 
232 
241 
250 
261 void manometer_generic_write ( manometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
262 
274 void manometer_generic_read ( manometer_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
275 
285 
295 
296 #ifdef __cplusplus
297 }
298 #endif
299 #endif // _MANOMETER_H_
300  // End public_function group
303 
304 // ------------------------------------------------------------------------- END
manometer_t::slave_address
uint8_t slave_address
Definition: manometer.h:190
manometer_cfg_t::i2c_address
uint8_t i2c_address
Definition: manometer.h:207
manometer_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: manometer.h:206
manometer_cfg_t::sda
pin_name_t sda
Definition: manometer.h:202
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:198
manometer_default_cfg
void manometer_default_cfg(manometer_t *ctx)
Click Default Configuration function.
manometer_t
Click ctx object definition.
Definition: manometer.h:183
MANOMETER_RETVAL
#define MANOMETER_RETVAL
Definition: manometer.h:76
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:187
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:201