thermo9  2.0.0.0
thermo9.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 THERMO9_H
36 #define THERMO9_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_i2c_master.h"
54 #include "drv_spi_master.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
67 #define THERMO9_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
69  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
70  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
71  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
72  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
73  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS )
74 
80 #define THERMO9_MASTER_I2C 0
81 #define THERMO9_MASTER_SPI 1
82 
88 #define THERMO9_RETVAL uint8_t
89 
90 #define THERMO9_OK 0x00
91 #define THERMO9_INIT_ERROR 0xFF
92 
97 #define THERMO9_ADDR_VCC 0x76
98 #define THERMO9_ADDR_GND 0x77
99 
105 #define THERMO9_DUMMY_BYTE 0x00
106 #define THERMO9_RESET_CMD 0x1E
107 #define THERMO9_START_ADC_TEMP_CONV 0x48
108 #define THERMO9_READ_ADC_TEMP_RES 0x00
109 #define THERMO9_PROM_READ_ADR_0 0xA0
110 #define THERMO9_PROM_READ_ADR_1_COEF_K4 0xA2
111 #define THERMO9_PROM_READ_ADR_2_COEF_K3 0xA4
112 #define THERMO9_PROM_READ_ADR_3_COEF_K2 0xA6
113 #define THERMO9_PROM_READ_ADR_4_COEF_K1 0xA8
114 #define THERMO9_PROM_READ_ADR_5_COEF_K0 0xAA
115 #define THERMO9_PROM_READ_ADR_6_SN23_8 0xAC
116 #define THERMO9_PROM_READ_ADR_7_SN7_0_CHECKSUM 0xAE
117 
123 #define THERMO9_COEF_CALC_4_2 -2
124 #define THERMO9_COEF_CALC_3 4
125 #define THERMO9_COEF_CALC_0 -1.5
126 #define THERMO9_CALC_COEF_4 1000000000000000000000.0
127 #define THERMO9_CALC_COEF_3 10000000000000000.0
128 #define THERMO9_CALC_COEF_2 100000000000.0
129 #define THERMO9_CALC_COEF_1 1000000.0
130 #define THERMO9_CALC_COEF_0 100.0
131 #define THERMO9_RES_MOD 256.0
132  // End group macro
135 // --------------------------------------------------------------- PUBLIC TYPES
144 typedef uint8_t thermo9_select_t;
145 
149 typedef void ( *thermo9_master_io_t )( struct thermo9_s*, uint8_t, uint8_t*, uint8_t );
150 
154 typedef struct
155 {
156  uint16_t coef0;
157  uint16_t coef1;
158  uint16_t coef2;
159  uint16_t coef3;
160  uint16_t coef4;
161 
163 
167 typedef struct thermo9_s
168 {
169  // Output pins
170 
171  digital_out_t cs;
172 
173  // Modules
174 
175  i2c_master_t i2c;
176  spi_master_t spi;
177 
178  // ctx variable
179 
180  uint8_t slave_address;
181  pin_name_t chip_select;
185 
186  // Temperature calibration coefficient
187 
189 
191 
195 typedef struct
196 {
197  // Communication gpio pins
198 
199  pin_name_t scl;
200  pin_name_t sda;
201  pin_name_t miso;
202  pin_name_t mosi;
203  pin_name_t sck;
204  pin_name_t cs;
205 
206  // static variable
207 
208  uint32_t i2c_speed;
209  uint8_t i2c_address;
210 
211  uint32_t spi_speed;
212  spi_master_mode_t spi_mode;
213  spi_master_chip_select_polarity_t cs_polarity;
214 
216 
217 } thermo9_cfg_t;
218  // End types group
220 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
226 #ifdef __cplusplus
227 extern "C"{
228 #endif
229 
239 
249 
260 void thermo9_generic_write ( thermo9_t *ctx, uint8_t reg, uint8_t *data_buf,
261  uint8_t len );
262 
273 void thermo9_generic_read ( thermo9_t *ctx, uint8_t reg, uint8_t *data_buf,
274  uint8_t len );
275 
284 void thermo9_send_cmd ( thermo9_t *ctx, uint8_t cmd_byte );
285 
295 
306 
307 #ifdef __cplusplus
308 }
309 #endif
310 #endif // _THERMO9_H_
311  // End public_function group
314 
315 // ------------------------------------------------------------------------- END
thermo9_s::chip_select
pin_name_t chip_select
Definition: thermo9.h:181
thermo9_cfg_t::scl
pin_name_t scl
Definition: thermo9.h:199
thermo9_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: thermo9.h:213
thermo9_temp_coef_t
Temperature calibration coefficient.
Definition: thermo9.h:155
thermo9_s::spi
spi_master_t spi
Definition: thermo9.h:176
thermo9_cfg_t::sda
pin_name_t sda
Definition: thermo9.h:200
thermo9_master_io_t
void(* thermo9_master_io_t)(struct thermo9_s *, uint8_t, uint8_t *, uint8_t)
Master Input/Output type.
Definition: thermo9.h:149
thermo9_s::read_f
thermo9_master_io_t read_f
Definition: thermo9.h:183
thermo9_temp_coef_t::coef1
uint16_t coef1
Definition: thermo9.h:157
thermo9_s
Click ctx object definition.
Definition: thermo9.h:168
thermo9_cfg_t::i2c_address
uint8_t i2c_address
Definition: thermo9.h:209
thermo9_read_temp
float thermo9_read_temp(thermo9_t *ctx)
Read temperature function.
thermo9_cfg_t
Click configuration structure definition.
Definition: thermo9.h:196
thermo9_cfg_t::sck
pin_name_t sck
Definition: thermo9.h:203
thermo9_cfg_setup
void thermo9_cfg_setup(thermo9_cfg_t *cfg)
Config Object Initialization function.
thermo9_cfg_t::miso
pin_name_t miso
Definition: thermo9.h:201
thermo9_calibation
void thermo9_calibation(thermo9_t *ctx)
Calibration function.
thermo9_s::cs
digital_out_t cs
Definition: thermo9.h:171
thermo9_temp_coef_t::coef0
uint16_t coef0
Definition: thermo9.h:156
thermo9_cfg_t::sel
thermo9_select_t sel
Definition: thermo9.h:215
thermo9_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: thermo9.h:208
thermo9_generic_read
void thermo9_generic_read(thermo9_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
thermo9_temp_coef_t::coef4
uint16_t coef4
Definition: thermo9.h:160
thermo9_send_cmd
void thermo9_send_cmd(thermo9_t *ctx, uint8_t cmd_byte)
Send command function.
thermo9_temp_coef_t::coef3
uint16_t coef3
Definition: thermo9.h:159
thermo9_s::write_f
thermo9_master_io_t write_f
Definition: thermo9.h:182
thermo9_cfg_t::cs
pin_name_t cs
Definition: thermo9.h:204
thermo9_s::slave_address
uint8_t slave_address
Definition: thermo9.h:180
thermo9_temp_coef_t::coef2
uint16_t coef2
Definition: thermo9.h:158
thermo9_generic_write
void thermo9_generic_write(thermo9_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
thermo9_s::temp_coef
thermo9_temp_coef_t temp_coef
Definition: thermo9.h:188
thermo9_s::i2c
i2c_master_t i2c
Definition: thermo9.h:175
thermo9_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: thermo9.h:212
thermo9_t
struct thermo9_s thermo9_t
Click ctx object definition.
thermo9_s::master_sel
thermo9_select_t master_sel
Definition: thermo9.h:184
thermo9_cfg_t::mosi
pin_name_t mosi
Definition: thermo9.h:202
thermo9_cfg_t::spi_speed
uint32_t spi_speed
Definition: thermo9.h:211
thermo9_select_t
uint8_t thermo9_select_t
Communication type.
Definition: thermo9.h:144
THERMO9_RETVAL
#define THERMO9_RETVAL
Definition: thermo9.h:88
thermo9_init
THERMO9_RETVAL thermo9_init(thermo9_t *ctx, thermo9_cfg_t *cfg)
Initialization function.