templog3  2.0.0.0
templog3.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 TEMPLOG3_H
36 #define TEMPLOG3_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define TEMPLOG3_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
66 
72 #define TEMPLOG3_RETVAL uint8_t
73 
74 #define TEMPLOG3_OK 0x00
75 #define TEMPLOG3_INIT_ERROR 0xFF
76 
82 #define TEMPLOG3_SLAVE_ADDR_A0_H 0x19
83 #define TEMPLOG3_SLAVE_ADDR_A0_L 0x18
84 
90 #define TEMPLOG3_CAPABILITY_REG 0x00
91 #define TEMPLOG3_CONFIG_REG 0x01
92 #define TEMPLOG3_TEMP_UPPER_REG 0x02
93 #define TEMPLOG3_TEMP_LOWER_REG 0x03
94 #define TEMPLOG3_TEMP_CRITICAL_REG 0x04
95 #define TEMPLOG3_TEMP_AMBIENT_REG 0x05
96 #define TEMPLOG3_MANUFACT_ID_REG 0x06
97 #define TEMPLOG3_DEVICE_ID_REG 0x07
98 #define TEMPLOG3_RESOLUTION_REG 0x08
99 
105 #define TEMPLOG3_EVENT_SHDN_STATUS_MASK 0x80
106 #define TEMPLOG3_I2C_TIMEOUT_STATUS_MASK 0x40
107 #define TEMPLOG3_HIGH_VOLT_INPUT_STATUS_MASK 0x20
108 #define TEMPLOG3_RESOLUTION_STATUS_MASK 0x18
109 #define TEMPLOG3_MEAS_RANGE_STATUS_MASK 0x04
110 #define TEMPLOG3_ACCURACY_STATUS_MASK 0x02
111 #define TEMPLOG3_ALARM_STATUS_MASK 0x01
112 
118 #define TEMPLOG3_TLIMIT_HYST_0_DEG 0x0000
119 #define TEMPLOG3_TLIMIT_HYST_ONE_HALF_DEG 0x0200
120 #define TEMPLOG3_TLIMIT_HYST_3_DEG 0x0400
121 #define TEMPLOG3_TLIMIT_HYST_6_DEG 0x0600
122 #define TEMPLOG3_CONT_CONV_MODE 0x0000
123 #define TEMPLOG3_SHUTDOWN_MODE 0x0100
124 #define TEMPLOG3_TCRIT_LOCKED 0x0080
125 #define TEMPLOG3_TUPPER_TLOWER_LOCKED 0x0040
126 #define TEMPLOG3_INT_CLEAR 0x0020
127 #define TEMPLOG3_EVENT_OUTPUT_STATUS_MASK 0x0010
128 #define TEMPLOG3_EVENT_OUTPUT_EN 0x0008
129 #define TEMPLOG3_EVENT_ALL_TLIMIT 0x0000
130 #define TEMPLOG3_EVENT_TCRIT_ONLY 0x0004
131 #define TEMPLOG3_EVENT_POL_ACT_LOW 0x0000
132 #define TEMPLOG3_EVENT_POL_ACT_HIGH 0x0002
133 #define TEMPLOG3_EVENT_COMPARATOR_MODE 0x0000
134 #define TEMPLOG3_EVENT_INTERRUPT_MODE 0x0001
135 
141 #define TEMPLOG3_TCRIT_DETECT 0x80
142 #define TEMPLOG3_TUPPER_DETECT 0x40
143 #define TEMPLOG3_TLOWER_DETECT 0x20
144 #define TEMPLOG3_NBYTES_ERROR 0x04
145 #define TEMPLOG3_TEMP_RANGE_ERROR 0x03
146 #define TEMPLOG3_ADDR_ERROR 0x02
147 #define TEMPLOG3_ALARMING 0x01
148 #define TEMPLOG3_OK 0x00
149 
155 #define TEMPLOG3_12BIT_RESOLUTION 0x03
156 #define TEMPLOG3_11BIT_RESOLUTION 0x02
157 #define TEMPLOG3_10BIT_RESOLUTION 0x01
158 #define TEMPLOG3_9BIT_RESOLUTION 0x00
159 
165 #define TEMPLOG3_EEPROM_WRITE 0x00
166 #define TEMPLOG3_SW_WRITE_PROTECT 0x01
167 #define TEMPLOG3_CLEAR_WRITE_PROTECT 0x02
168 
174 #define TEMPLOG3_EEPROM_SIZE 256
175  // End group macro
178 // --------------------------------------------------------------- PUBLIC TYPES
187 typedef struct
188 {
189  // Input pins
190 
191  digital_in_t int_pin;
192 
193  // Modules
194 
195  i2c_master_t i2c;
196 
197  // ctx variable
198 
199  uint8_t slave_address;
200  uint8_t slave_eeprom;
201 
202  uint8_t resolution;
203  uint8_t n_bytes;
204 
205 } templog3_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 i2c_address;
225  uint8_t i2c_eeprom;
226 
227  uint8_t dev_resolution;
228  uint8_t dev_n_bytes;
229 
231  // End types group
233 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
234 
240 #ifdef __cplusplus
241 extern "C"{
242 #endif
243 
253 
263 
291 
303 uint8_t templog3_write_reg ( templog3_t *ctx, uint8_t reg_addr, uint16_t data_in );
304 
316 uint8_t templog3_read_reg ( templog3_t *ctx, uint8_t reg_addr, uint16_t *data_out );
317 
328 uint8_t templog3_set_addr_ptr ( templog3_t *ctx, uint8_t reg_addr );
329 
338 void templog3_repeated_read ( templog3_t *ctx, uint16_t *data_out );
339 
351 uint8_t templog3_get_temp ( templog3_t *ctx, uint8_t temp_sel, float *temp_out );
352 
364 uint8_t templog3_set_temp ( templog3_t *ctx, uint8_t temp_sel, float temp_in );
365 
376 
385 
396 void templog3_eeprom_byte_write ( templog3_t *ctx, uint8_t reg_addr, uint8_t data_in, uint8_t eeprom_mode );
397 
407 void templog3_eeprom_page_write ( templog3_t *ctx, uint8_t reg_addr, uint8_t *data_in );
408 
417 void templog3_eeprom_curr_addr_read ( templog3_t *ctx, uint8_t *current_address );
418 
428 void templog3_eeprom_byte_read ( templog3_t *ctx, uint8_t reg_addr, uint8_t *data_out );
429 
443 uint8_t templog3_eeprom_sequential_read ( templog3_t *ctx, uint8_t reg_addr, uint8_t *data_out, uint16_t num_bytes );
444 
445 
446 #ifdef __cplusplus
447 }
448 #endif
449 #endif // _TEMPLOG3_H_
450  // End public_function group
453 
454 // ------------------------------------------------------------------------- END
templog3_cfg_t
Click configuration structure definition.
Definition: templog3.h:211
templog3_read_reg
uint8_t templog3_read_reg(templog3_t *ctx, uint8_t reg_addr, uint16_t *data_out)
Generic Read function.
templog3_eeprom_sequential_read
uint8_t templog3_eeprom_sequential_read(templog3_t *ctx, uint8_t reg_addr, uint8_t *data_out, uint16_t num_bytes)
EEPROM Sequential Read function.
templog3_t::resolution
uint8_t resolution
Definition: templog3.h:202
templog3_eeprom_byte_read
void templog3_eeprom_byte_read(templog3_t *ctx, uint8_t reg_addr, uint8_t *data_out)
EEPROM Single Read function.
templog3_t::i2c
i2c_master_t i2c
Definition: templog3.h:195
templog3_cfg_t::int_pin
pin_name_t int_pin
Definition: templog3.h:219
templog3_t::slave_address
uint8_t slave_address
Definition: templog3.h:199
templog3_write_reg
uint8_t templog3_write_reg(templog3_t *ctx, uint8_t reg_addr, uint16_t data_in)
Generic Write function.
templog3_eeprom_byte_write
void templog3_eeprom_byte_write(templog3_t *ctx, uint8_t reg_addr, uint8_t data_in, uint8_t eeprom_mode)
EEPROM Single Write function.
templog3_default_cfg
void templog3_default_cfg(templog3_t *ctx)
Click Default Configuration function.
templog3_t::n_bytes
uint8_t n_bytes
Definition: templog3.h:203
templog3_t::slave_eeprom
uint8_t slave_eeprom
Definition: templog3.h:200
templog3_repeated_read
void templog3_repeated_read(templog3_t *ctx, uint16_t *data_out)
Repeated Read function.
TEMPLOG3_RETVAL
#define TEMPLOG3_RETVAL
Definition: templog3.h:72
templog3_cfg_t::i2c_eeprom
uint8_t i2c_eeprom
Definition: templog3.h:225
templog3_t::int_pin
digital_in_t int_pin
Definition: templog3.h:191
templog3_t
Click ctx object definition.
Definition: templog3.h:188
templog3_get_temp
uint8_t templog3_get_temp(templog3_t *ctx, uint8_t temp_sel, float *temp_out)
Get Temperature function.
templog3_set_temp
uint8_t templog3_set_temp(templog3_t *ctx, uint8_t temp_sel, float temp_in)
Set Temperature function.
templog3_set_addr_ptr
uint8_t templog3_set_addr_ptr(templog3_t *ctx, uint8_t reg_addr)
Set Address Pointer function.
templog3_eeprom_page_write
void templog3_eeprom_page_write(templog3_t *ctx, uint8_t reg_addr, uint8_t *data_in)
EEPROM Page Write function.
templog3_cfg_setup
void templog3_cfg_setup(templog3_cfg_t *cfg)
Config Object Initialization function.
templog3_cfg_t::sda
pin_name_t sda
Definition: templog3.h:215
templog3_wait_conv_done
void templog3_wait_conv_done(templog3_t *ctx)
Conversion Time function.
templog3_check_alarm
uint8_t templog3_check_alarm(templog3_t *ctx)
Alarm-Event Check function.
templog3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: templog3.h:223
templog3_cfg_t::dev_n_bytes
uint8_t dev_n_bytes
Definition: templog3.h:228
templog3_init
TEMPLOG3_RETVAL templog3_init(templog3_t *ctx, templog3_cfg_t *cfg)
Initialization function.
templog3_cfg_t::i2c_address
uint8_t i2c_address
Definition: templog3.h:224
templog3_cfg_t::scl
pin_name_t scl
Definition: templog3.h:214
templog3_eeprom_curr_addr_read
void templog3_eeprom_curr_addr_read(templog3_t *ctx, uint8_t *current_address)
EEPROM Current Address Read function.
templog3_cfg_t::dev_resolution
uint8_t dev_resolution
Definition: templog3.h:227