pressure2  2.0.0.0
pressure2.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 PRESSURE2_H
36 #define PRESSURE2_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_spi_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
54 #define PRESSURE2_MAP_MIKROBUS( cfg, mikrobus ) \
55  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
56  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
57  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
58  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS )
59 
65 #define PRESSURE2_RETVAL uint8_t
66 #define PRESSURE2_OK 0x00
67 #define PRESSURE2_INIT_ERROR 0xFF
68 #define PRESSURE2_TRUE 1
69 #define PRESSURE2_FALSE 0
70 
76 #define PRESSURE2_CMD_RESET 0x1E // ADC reset command
77 #define PRESSURE2_CMD_ADC_READ 0x00 // ADC read command
78 #define PRESSURE2_CMD_ADC_CONV 0x40 // ADC conversion command
79 #define PRESSURE2_CMD_ADC_D1 0x00 // ADC D1 conversion
80 #define PRESSURE2_CMD_ADC_D2 0x10 // ADC D2 conversion
81 #define PRESSURE2_CMD_ADC_256 0x00 // ADC OSR=256
82 #define PRESSURE2_CMD_ADC_512 0x02 // ADC OSR=512
83 #define PRESSURE2_CMD_ADC_1024 0x04 // ADC OSR=1024
84 #define PRESSURE2_CMD_ADC_2048 0x06 // ADC OSR=2056
85 #define PRESSURE2_CMD_ADC_4096 0x08 // ADC OSR=4096
86 #define PRESSURE2_CMD_PROM_RD 0xA0 // Prom read command
87  // End group macro
89 
90 // --------------------------------------------------------------- PUBLIC TYPES
99 typedef struct
100 {
101  digital_out_t cs;
102 
103  // Modules
104 
105  spi_master_t spi;
106  pin_name_t chip_select;
107 
108  uint16_t sensor_coefficients[8];
109  uint32_t pressure;
110  uint32_t temperature;
111  uint32_t delta_temp;
113  float sensitivity;
114 
115 } pressure2_t;
116 
120 typedef struct
121 {
122  // Communication gpio pins
123 
124  pin_name_t miso;
125  pin_name_t mosi;
126  pin_name_t sck;
127  pin_name_t cs;
128 
129  // static variable
130 
131  uint32_t spi_speed;
132  uint8_t spi_mode;
133  spi_master_chip_select_polarity_t cs_polarity;
134 
136  // End types group
138 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
139 
144 #ifdef __cplusplus
145 extern "C"{
146 #endif
147 
157 
166 
175 
188 (
189  pressure2_t *ctx,
190  uint8_t *wr_buf,
191  uint16_t wr_len,
192  uint8_t *rd_buf,
193  uint16_t rd_len
194 );
195 
203 void pressure2_reset ( pressure2_t *ctx );
204 
215 void pressure2_read_data ( pressure2_t *ctx, uint8_t cmd, uint8_t *buffer, uint8_t n_bytes );
216 
225 void pressure2_write_bytes ( pressure2_t *ctx, uint8_t cmd );
226 
236 uint16_t pressure2_read_coefficient ( pressure2_t *ctx, uint8_t index );
237 
247 uint32_t pressure2_send_CmdADC ( pressure2_t *ctx, uint8_t cmd );
248 
258 void pressure2_read_sensor ( pressure2_t *ctx, float *P, float *T );
259 
260 
261 #ifdef __cplusplus
262 }
263 #endif
264 #endif // _PRESSURE2_H_
265  // End public_function group
268 
269 // ------------------------------------------------------------------------- END
pressure2_init
PRESSURE2_RETVAL pressure2_init(pressure2_t *ctx, pressure2_cfg_t *cfg)
Initialization function.
pressure2_read_sensor
void pressure2_read_sensor(pressure2_t *ctx, float *P, float *T)
Read sensor.
pressure2_read_coefficient
uint16_t pressure2_read_coefficient(pressure2_t *ctx, uint8_t index)
Read calibration coefficients and return coefficient.
pressure2_t::sensor_offset
float sensor_offset
Definition: pressure2.h:112
pressure2_cfg_setup
void pressure2_cfg_setup(pressure2_cfg_t *cfg)
Config Object Initialization function.
pressure2_t::pressure
uint32_t pressure
Definition: pressure2.h:109
pressure2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: pressure2.h:133
pressure2_cfg_t::spi_mode
uint8_t spi_mode
Definition: pressure2.h:132
pressure2_cfg_t::spi_speed
uint32_t spi_speed
Definition: pressure2.h:131
pressure2_t
Click ctx object definition.
Definition: pressure2.h:99
pressure2_cfg_t::cs
pin_name_t cs
Definition: pressure2.h:127
pressure2_t::delta_temp
uint32_t delta_temp
Definition: pressure2.h:111
pressure2_send_CmdADC
uint32_t pressure2_send_CmdADC(pressure2_t *ctx, uint8_t cmd)
ADC conversion and return 24bit result.
pressure2_t::sensitivity
float sensitivity
Definition: pressure2.h:113
PRESSURE2_RETVAL
#define PRESSURE2_RETVAL
Definition: pressure2.h:65
pressure2_t::cs
digital_out_t cs
Definition: pressure2.h:101
pressure2_t::spi
spi_master_t spi
Definition: pressure2.h:105
pressure2_write_bytes
void pressure2_write_bytes(pressure2_t *ctx, uint8_t cmd)
Sends command.
pressure2_cfg_t::miso
pin_name_t miso
Definition: pressure2.h:124
pressure2_reset
void pressure2_reset(pressure2_t *ctx)
Functions for reset chip.
pressure2_default_cfg
PRESSURE2_RETVAL pressure2_default_cfg(pressure2_t *ctx)
Click Default Configuration function.
pressure2_cfg_t::sck
pin_name_t sck
Definition: pressure2.h:126
pressure2_t::temperature
uint32_t temperature
Definition: pressure2.h:110
pressure2_cfg_t::mosi
pin_name_t mosi
Definition: pressure2.h:125
pressure2_cfg_t
Click configuration structure definition.
Definition: pressure2.h:120
pressure2_generic_transfer
void pressure2_generic_transfer(pressure2_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
pressure2_t::chip_select
pin_name_t chip_select
Definition: pressure2.h:106
pressure2_read_data
void pressure2_read_data(pressure2_t *ctx, uint8_t cmd, uint8_t *buffer, uint8_t n_bytes)
Generic transfer function.