templog5  2.0.0.0
templog5.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 TEMPLOG5_H
36 #define TEMPLOG5_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 // -------------------------------------------------------------- PUBLIC MACROS
66 #define TEMPLOG5_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define TEMPLOG5_RETVAL uint8_t
77 
78 #define TEMPLOG5_OK 0x00
79 #define TEMPLOG5_INIT_ERROR 0xFF
80 
86 #define TEMPLOG5_REG_CAPABILITY 0x00
87 #define TEMPLOG5_REG_CONFIGURATION 0x01
88 #define TEMPLOG5_REG_HIGH_LIMIT 0x02
89 #define TEMPLOG5_REG_LOW_LIMIT 0x03
90 #define TEMPLOG5_REG_CRITICAL_LIMIT 0x04
91 #define TEMPLOG5_REG_TEMPERATURE 0x05
92 #define TEMPLOG5_REG_MANUFACTURER_ID 0x06
93 #define TEMPLOG5_REG_DEVICE_ID 0x07
94 
100 #define TEMPLOG5_CFG_DISABLE_HYSTERESIS 0x0000
101 #define TEMPLOG5_CFG_HYSTERESIS_TO_1p5C 0x0200
102 #define TEMPLOG5_CFG_HYSTERESIS_TO_3C 0x0400
103 #define TEMPLOG5_CFG_HYSTERESIS_TO_6C 0x0600
104 #define TEMPLOG5_CFG_TEMP_SENSOR_ENABLE 0x0000
105 #define TEMPLOG5_CFG_TEMP_SENSOR_DISABLE 0x0100
106 #define TEMPLOG5_CFG_CRITICAL_TRIP_ENABLE 0x0000
107 #define TEMPLOG5_CFG_CRITICAL_TRIP_DISABLE 0x0080
108 #define TEMPLOG5_CFG_ALARM_TRIP_ENABLE 0x0000
109 #define TEMPLOG5_CFG_ALARM_TRIP_DISABLE 0x0040
110 #define TEMPLOG5_CFG_EVENT_INT_PIN_ENABLE 0x0010
111 #define TEMPLOG5_CFG_EVENT_INT_PIN_DISABLE 0x0000
112 #define TEMPLOG5_CFG_EVENT_OUT_ENABLE 0x0008
113 #define TEMPLOG5_CFG_EVENT_OUT_DISABLE 0x0000
114 #define TEMPLOG5_CFG_EVENT_OUT_ACTIVE_LOW 0x0000
115 #define TEMPLOG5_CFG_EVENT_OUT_ACTIVE_HIGH 0x0002
116 #define TEMPLOG5_CFG_EVENT_MODE_COMPARATOR 0x0000
117 #define TEMPLOG5_CFG_EVENT_MODE_INTERRUPT 0x0001
118 
124 #define TEMPLOG5_CAP_EVSD_FROZEN 0x0000
125 #define TEMPLOG5_CAP_EVSD_CLEARD 0x0080
126 #define TEMPLOG5_CAP_TMOUT_10ms_60ms 0x0000
127 #define TEMPLOG5_CAP_TMOUT_25ms_35ms 0x0040
128 #define TEMPLOG5_CAP_RSWP_NOT_EXPLICITLY_STATED 0x0000
129 #define TEMPLOG5_CAP_RSWP_EXPLICITLY_STATED 0x0020
130 #define TEMPLOG5_CAP_TEMP_RES_9bit 0x0000
131 #define TEMPLOG5_CAP_TEMP_RES_10bit 0x0008
132 #define TEMPLOG5_CAP_TEMP_RES_11bit 0x0010
133 #define TEMPLOG5_CAP_TEMP_RES_12bit 0x0018
134 #define TEMPLOG5_CAP_POS_TEMP_ONLY 0x0000
135 #define TEMPLOG5_CAP_POS_AND_NEG_TEMP 0x0004
136 #define TEMPLOG5_CAP_ACC_CLASS_C 0x0000
137 #define TEMPLOG5_CAP_ACC_CLASS_B 0x0002
138 #define TEMPLOG5_CAP_EV_CRITICAL_TEMP_ONLY 0x0000
139 #define TEMPLOG5_CAP_EV_ALARM_AND_CRITICAL_TEMP 0x0001
140 
146 #define TEMPLOG5_TS_SLAVE_ADDR_000 0x18
147 #define TEMPLOG5_TS_SLAVE_ADDR_001 0x19
148 #define TEMPLOG5_TS_SLAVE_ADDR_010 0x1A
149 #define TEMPLOG5_TS_SLAVE_ADDR_011 0x1B
150 #define TEMPLOG5_TS_SLAVE_ADDR_100 0x1C
151 #define TEMPLOG5_TS_SLAVE_ADDR_101 0x1D
152 #define TEMPLOG5_TS_SLAVE_ADDR_110 0x1E
153 #define TEMPLOG5_TS_SLAVE_ADDR_111 0x1F
154 
160 #define TEMPLOG5_EEPROM_SLAVE_ADDR_000 0x50
161 #define TEMPLOG5_EEPROM_SLAVE_ADDR_001 0x51
162 #define TEMPLOG5_EEPROM_SLAVE_ADDR_010 0x52
163 #define TEMPLOG5_EEPROM_SLAVE_ADDR_011 0x53
164 #define TEMPLOG5_EEPROM_SLAVE_ADDR_100 0x54
165 #define TEMPLOG5_EEPROM_SLAVE_ADDR_101 0x55
166 #define TEMPLOG5_EEPROM_SLAVE_ADDR_110 0x56
167 #define TEMPLOG5_EEPROM_SLAVE_ADDR_111 0x57
168 
174 #define TEMPLOG5_MANUFACTURER_ID 0x1B09
175 #define TEMPLOG5_DEVICE_ID_REV_B 0x0813
176 #define TEMPLOG5_DEVICE_ID_REV_C 0x0A00
177  // End group macro
180 // --------------------------------------------------------------- PUBLIC TYPES
189 typedef struct
190 {
191  // Input pins
192 
193  digital_in_t int_pin;
194 
195  // Modules
196 
197  i2c_master_t i2c;
198 
199  // ctx variable
200 
201  uint8_t ts_slave;
202  uint8_t eeprom_slave;
203  uint8_t temp_status;
204 
205 } templog5_t;
206 
210 typedef struct
211 {
212  // Communication gpio pins
213 
214  pin_name_t scl;
215  pin_name_t sda;
216 
217  // Additional gpio pins
218 
219  pin_name_t int_pin;
220 
221  // static variable
222 
223  uint32_t i2c_speed;
224  uint8_t ts_slave;
225  uint8_t eeprom_slave;
226 
227 
229  // End types group
231 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
232 
238 #ifdef __cplusplus
239 extern "C"{
240 #endif
241 
251 
261 
284 
294 void templog5_write_data ( templog5_t *ctx, uint8_t reg, uint16_t data_in );
295 
308 void templog5_write_eeprom ( templog5_t *ctx, uint8_t start_addr, uint8_t *data_in, uint8_t n_byte );
309 
320 uint16_t templog5_read_data ( templog5_t *ctx, uint8_t reg );
321 
332 void templog5_read_eeprom ( templog5_t *ctx, uint8_t start_addr, uint8_t *data_out, uint8_t n_byte );
333 
344 
355 
366 
367 #ifdef __cplusplus
368 }
369 #endif
370 #endif // _TEMPLOG5_H_
371  // End public_function group
374 
375 // ------------------------------------------------------------------------- END
templog5_get_interrupt_status
uint8_t templog5_get_interrupt_status(templog5_t *ctx)
EVENT Interrupt status.
templog5_cfg_t::sda
pin_name_t sda
Definition: templog5.h:215
templog5_init
TEMPLOG5_RETVAL templog5_init(templog5_t *ctx, templog5_cfg_t *cfg)
Initialization function.
templog5_cfg_t::ts_slave
uint8_t ts_slave
Definition: templog5.h:224
templog5_t::eeprom_slave
uint8_t eeprom_slave
Definition: templog5.h:202
templog5_t::i2c
i2c_master_t i2c
Definition: templog5.h:197
templog5_read_eeprom
void templog5_read_eeprom(templog5_t *ctx, uint8_t start_addr, uint8_t *data_out, uint8_t n_byte)
Reads data from EEPROM.
templog5_write_eeprom
void templog5_write_eeprom(templog5_t *ctx, uint8_t start_addr, uint8_t *data_in, uint8_t n_byte)
Writes data to the EEPROM address ( maximum 16 bytes per 1 page ).
templog5_cfg_t::scl
pin_name_t scl
Definition: templog5.h:214
templog5_cfg_t::eeprom_slave
uint8_t eeprom_slave
Definition: templog5.h:225
templog5_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: templog5.h:223
templog5_t::ts_slave
uint8_t ts_slave
Definition: templog5.h:201
templog5_default_cfg
void templog5_default_cfg(templog5_t *ctx)
Click Default Configuration function.
templog5_t::temp_status
uint8_t temp_status
Definition: templog5.h:203
TEMPLOG5_RETVAL
#define TEMPLOG5_RETVAL
Definition: templog5.h:76
templog5_t
Click ctx object definition.
Definition: templog5.h:190
templog5_write_data
void templog5_write_data(templog5_t *ctx, uint8_t reg, uint16_t data_in)
Functions for write data to the TS register.
templog5_get_temperature
float templog5_get_temperature(templog5_t *ctx)
Temperature Data.
templog5_cfg_t::int_pin
pin_name_t int_pin
Definition: templog5.h:219
templog5_cfg_setup
void templog5_cfg_setup(templog5_cfg_t *cfg)
Config Object Initialization function.
templog5_t::int_pin
digital_in_t int_pin
Definition: templog5.h:193
templog5_get_temperature_status
uint8_t templog5_get_temperature_status(templog5_t *ctx)
Teperature Status.
templog5_read_data
uint16_t templog5_read_data(templog5_t *ctx, uint8_t reg)
Functions for read data from registers.
templog5_cfg_t
Click configuration structure definition.
Definition: templog5.h:211