templog4  2.0.0.0
templog4.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 TEMPLOG4_H
36 #define TEMPLOG4_H
37 
38 #include "drv_digital_in.h"
39 #include "drv_i2c_master.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define TEMPLOG4_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
53  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
54  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
55 
61 #define TEMPLOG4_RETVAL uint8_t
62 
63 #define TEMPLOG4_OK 0x00
64 #define TEMPLOG4_INIT_ERROR 0xFF
65 
71 #define TEMPLOG4_SLAVE_ADDR_A0_H 0x19
72 #define TEMPLOG4_SLAVE_ADDR_A0_L 0x18
73 
79 #define TEMPLOG4_CAPABILITY_REG 0x00
80 #define TEMPLOG4_CONFIG_REG 0x01
81 #define TEMPLOG4_TEMP_UPPER_REG 0x02
82 #define TEMPLOG4_TEMP_LOWER_REG 0x03
83 #define TEMPLOG4_TEMP_CRITICAL_REG 0x04
84 #define TEMPLOG4_TEMP_AMBIENT_REG 0x05
85 #define TEMPLOG4_MANUFACT_ID_REG 0x06
86 #define TEMPLOG4_DEVICE_ID_REG 0x07
87 #define TEMPLOG4_SMBUS_REG 0x22
88 
94 #define TEMPLOG4_EVENT_SHDN_STATUS_MASK 0x80
95 #define TEMPLOG4_BUS_TIMEOUT_STATUS_MASK 0x40
96 #define TEMPLOG4_HIGH_VOLT_INPUT_STATUS_MASK 0x20
97 #define TEMPLOG4_RESOLUTION_STATUS_MASK 0x18
98 #define TEMPLOG4_MEAS_RANGE_STATUS_MASK 0x04
99 #define TEMPLOG4_ACCURACY_STATUS_MASK 0x02
100 #define TEMPLOG4_ALARM_STATUS_MASK 0x01
101 
107 #define TEMPLOG4_TLIMIT_HYST_0_DEG 0x0000
108 #define TEMPLOG4_TLIMIT_HYST_ONE_HALF_DEG 0x0200
109 #define TEMPLOG4_TLIMIT_HYST_3_DEG 0x0400
110 #define TEMPLOG4_TLIMIT_HYST_6_DEG 0x0600
111 #define TEMPLOG4_CONT_CONV_MODE 0x0000
112 #define TEMPLOG4_SHUTDOWN_MODE 0x0100
113 #define TEMPLOG4_TCRIT_LOCKED 0x0080
114 #define TEMPLOG4_TUPPER_TLOWER_LOCKED 0x0040
115 #define TEMPLOG4_INT_CLEAR 0x0020
116 #define TEMPLOG4_EVENT_OUTPUT_STATUS_MASK 0x0010
117 #define TEMPLOG4_EVENT_OUTPUT_EN 0x0008
118 #define TEMPLOG4_EVENT_ALL_TLIMIT 0x0000
119 #define TEMPLOG4_EVENT_TCRIT_ONLY 0x0004
120 #define TEMPLOG4_EVENT_POL_ACT_LOW 0x0000
121 #define TEMPLOG4_EVENT_POL_ACT_HIGH 0x0002
122 #define TEMPLOG4_EVENT_COMPARATOR_MODE 0x0000
123 #define TEMPLOG4_EVENT_INTERRUPT_MODE 0x0001
124 
130 #define TEMPLOG4_TCRIT_DETECT 0x80
131 #define TEMPLOG4_TUPPER_DETECT 0x40
132 #define TEMPLOG4_TLOWER_DETECT 0x20
133 #define TEMPLOG4_NBYTES_ERROR 0x04
134 #define TEMPLOG4_TEMP_RANGE_ERROR 0x03
135 #define TEMPLOG4_ADDR_ERROR 0x02
136 #define TEMPLOG4_ALARMING 0x01
137 #define TEMPLOG4_OK 0x00
138 
144 #define TEMPLOG4_SMBUS_TIMEOUT_DIS 0x80
145 #define TEMPLOG4_SMBUS_TIMEOUT_SHTDN_EN 0x20
146 #define TEMPLOG4_SMBUS_ARA_DIS 0x01
147 
153 #define TEMPLOG4_EEPROM_WRITE 0x00
154 #define TEMPLOG4_SW_WRITE_PROTECT 0x01
155 #define TEMPLOG4_CLEAR_WRITE_PROTECT 0x02
156 
162 #define _TEMPLOG4_EEPROM_SIZE 256
163 #define _TEMPLOG4_MANUFACT_ID 0x1131
164 #define _TEMPLOG4_DEVICE_ID 0xA203
165 #define TEMPLOG4_DUMMY_BYTE 0x00
166  // End group macro
169 // --------------------------------------------------------------- PUBLIC TYPES
178 typedef struct
179 {
180  // Input pins
181 
182  digital_in_t int_pin;
183 
184  // Modules
185 
186  i2c_master_t i2c;
187 
188  // ctx variable
189 
190  uint8_t slave_address;
191 
192 } templog4_t;
193 
197 typedef struct
198 {
199  // Communication gpio pins
200 
201  pin_name_t scl;
202  pin_name_t sda;
203 
204  // Additional gpio pins
205 
206  pin_name_t int_pin;
207 
208  // static variable
209 
210  uint32_t i2c_speed;
211  uint8_t i2c_address;
213 
215  // End types group
217 
218 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
219 
225 #ifdef __cplusplus
226 extern "C"{
227 #endif
228 
237 void templog4_cfg_setup ( templog4_cfg_t *cfg );
238 
248 
256 void templog4_default_cfg ( templog4_t *ctx );
257 
268 void templog4_generic_write ( templog4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
269 
280 void templog4_generic_read ( templog4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
281 
291 uint8_t templog4_write_reg ( templog4_t *ctx, uint8_t reg, uint16_t input_data );
292 
302 uint8_t templog4_read_reg ( templog4_t *ctx, uint8_t reg, uint16_t *out_var );
303 
312 void templog4_set_addr_ptr ( templog4_t *ctx, uint8_t addr );
313 
322 void templog4_repeated_read ( templog4_t *ctx, uint16_t *out_var );
323 
333 uint8_t templog4_get_temp ( templog4_t *ctx, uint8_t temp_sel, float *temp_out );
334 
344 void templog4_set_temp ( templog4_t *ctx, uint8_t temp_sel, float temp_in );
345 
346 #ifdef __cplusplus
347 }
348 #endif
349 #endif // _TEMPLOG4_H_
350  // End public_function group
353 
354 // ------------------------------------------------------------------------- END
templog4_cfg_t
Click configuration structure definition.
Definition: templog4.h:197
templog4_init
TEMPLOG4_RETVAL templog4_init(templog4_t *ctx, templog4_cfg_t *cfg)
Initialization function.
templog4_cfg_t::i2c_address
uint8_t i2c_address
Definition: templog4.h:211
templog4_set_temp
void templog4_set_temp(templog4_t *ctx, uint8_t temp_sel, float temp_in)
Set Temperature function.
templog4_default_cfg
void templog4_default_cfg(templog4_t *ctx)
Click Default Configuration function.
templog4_cfg_t::scl
pin_name_t scl
Definition: templog4.h:201
templog4_t::int_pin
digital_in_t int_pin
Definition: templog4.h:182
templog4_generic_write
void templog4_generic_write(templog4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
templog4_read_reg
uint8_t templog4_read_reg(templog4_t *ctx, uint8_t reg, uint16_t *out_var)
Generic Read function.
templog4_cfg_setup
void templog4_cfg_setup(templog4_cfg_t *cfg)
Config Object Initialization function.
templog4_cfg_t::sda
pin_name_t sda
Definition: templog4.h:202
templog4_repeated_read
void templog4_repeated_read(templog4_t *ctx, uint16_t *out_var)
Repeated Read function.
templog4_generic_read
void templog4_generic_read(templog4_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
templog4_set_addr_ptr
void templog4_set_addr_ptr(templog4_t *ctx, uint8_t addr)
Set Address Pointer function.
TEMPLOG4_RETVAL
#define TEMPLOG4_RETVAL
Definition: templog4.h:61
templog4_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: templog4.h:210
templog4_t::slave_address
uint8_t slave_address
Definition: templog4.h:190
templog4_get_temp
uint8_t templog4_get_temp(templog4_t *ctx, uint8_t temp_sel, float *temp_out)
Get Temperature function.
templog4_t
Click ctx object definition.
Definition: templog4.h:178
templog4_write_reg
uint8_t templog4_write_reg(templog4_t *ctx, uint8_t reg, uint16_t input_data)
Generic Write function.
templog4_t::i2c
i2c_master_t i2c
Definition: templog4.h:186
templog4_cfg_t::int_pin
pin_name_t int_pin
Definition: templog4.h:206
templog4_cfg_t::i2c_eeprom_address
uint8_t i2c_eeprom_address
Definition: templog4.h:212