templog3  2.0.0.0
templog3.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef TEMPLOG3_H
36 #define TEMPLOG3_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define TEMPLOG3_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
57 
63 #define TEMPLOG3_RETVAL uint8_t
64 
65 #define TEMPLOG3_OK 0x00
66 #define TEMPLOG3_INIT_ERROR 0xFF
67 
73 #define TEMPLOG3_SLAVE_ADDR_A0_H 0x19
74 #define TEMPLOG3_SLAVE_ADDR_A0_L 0x18
75 
81 #define TEMPLOG3_CAPABILITY_REG 0x00
82 #define TEMPLOG3_CONFIG_REG 0x01
83 #define TEMPLOG3_TEMP_UPPER_REG 0x02
84 #define TEMPLOG3_TEMP_LOWER_REG 0x03
85 #define TEMPLOG3_TEMP_CRITICAL_REG 0x04
86 #define TEMPLOG3_TEMP_AMBIENT_REG 0x05
87 #define TEMPLOG3_MANUFACT_ID_REG 0x06
88 #define TEMPLOG3_DEVICE_ID_REG 0x07
89 #define TEMPLOG3_RESOLUTION_REG 0x08
90 
96 #define TEMPLOG3_EVENT_SHDN_STATUS_MASK 0x80
97 #define TEMPLOG3_I2C_TIMEOUT_STATUS_MASK 0x40
98 #define TEMPLOG3_HIGH_VOLT_INPUT_STATUS_MASK 0x20
99 #define TEMPLOG3_RESOLUTION_STATUS_MASK 0x18
100 #define TEMPLOG3_MEAS_RANGE_STATUS_MASK 0x04
101 #define TEMPLOG3_ACCURACY_STATUS_MASK 0x02
102 #define TEMPLOG3_ALARM_STATUS_MASK 0x01
103 
109 #define TEMPLOG3_TLIMIT_HYST_0_DEG 0x0000
110 #define TEMPLOG3_TLIMIT_HYST_ONE_HALF_DEG 0x0200
111 #define TEMPLOG3_TLIMIT_HYST_3_DEG 0x0400
112 #define TEMPLOG3_TLIMIT_HYST_6_DEG 0x0600
113 #define TEMPLOG3_CONT_CONV_MODE 0x0000
114 #define TEMPLOG3_SHUTDOWN_MODE 0x0100
115 #define TEMPLOG3_TCRIT_LOCKED 0x0080
116 #define TEMPLOG3_TUPPER_TLOWER_LOCKED 0x0040
117 #define TEMPLOG3_INT_CLEAR 0x0020
118 #define TEMPLOG3_EVENT_OUTPUT_STATUS_MASK 0x0010
119 #define TEMPLOG3_EVENT_OUTPUT_EN 0x0008
120 #define TEMPLOG3_EVENT_ALL_TLIMIT 0x0000
121 #define TEMPLOG3_EVENT_TCRIT_ONLY 0x0004
122 #define TEMPLOG3_EVENT_POL_ACT_LOW 0x0000
123 #define TEMPLOG3_EVENT_POL_ACT_HIGH 0x0002
124 #define TEMPLOG3_EVENT_COMPARATOR_MODE 0x0000
125 #define TEMPLOG3_EVENT_INTERRUPT_MODE 0x0001
126 
132 #define TEMPLOG3_TCRIT_DETECT 0x80
133 #define TEMPLOG3_TUPPER_DETECT 0x40
134 #define TEMPLOG3_TLOWER_DETECT 0x20
135 #define TEMPLOG3_NBYTES_ERROR 0x04
136 #define TEMPLOG3_TEMP_RANGE_ERROR 0x03
137 #define TEMPLOG3_ADDR_ERROR 0x02
138 #define TEMPLOG3_ALARMING 0x01
139 #define TEMPLOG3_OK 0x00
140 
146 #define TEMPLOG3_12BIT_RESOLUTION 0x03
147 #define TEMPLOG3_11BIT_RESOLUTION 0x02
148 #define TEMPLOG3_10BIT_RESOLUTION 0x01
149 #define TEMPLOG3_9BIT_RESOLUTION 0x00
150 
156 #define TEMPLOG3_EEPROM_WRITE 0x00
157 #define TEMPLOG3_SW_WRITE_PROTECT 0x01
158 #define TEMPLOG3_CLEAR_WRITE_PROTECT 0x02
159 
165 #define TEMPLOG3_EEPROM_SIZE 256
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  hal_i2c_address_t slave_address;
191  hal_i2c_address_t slave_eeprom;
192 
193  uint8_t resolution;
194  uint8_t n_bytes;
195 
196 } templog3_t;
197 
201 typedef struct
202 {
203  // Communication gpio pins
204 
205  pin_name_t scl;
206  pin_name_t sda;
207 
208  // Additional gpio pins
209 
210  pin_name_t int_pin;
211 
212  // static variable
213 
214  hal_i2c_speed_t i2c_speed;
215  hal_i2c_address_t i2c_address;
216  hal_i2c_address_t i2c_eeprom;
217 
218  uint8_t dev_resolution;
219  uint8_t dev_n_bytes;
220 
222  // End types group
224 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
225 
231 #ifdef __cplusplus
232 extern "C"{
233 #endif
234 
243 void templog3_cfg_setup ( templog3_cfg_t *cfg );
244 
253 
280 void templog3_default_cfg ( templog3_t *ctx );
281 
292 void templog3_generic_write ( templog3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
293 
305 void templog3_generic_read ( templog3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
306 
318 uint8_t templog3_write_reg ( templog3_t *ctx, uint8_t reg_addr, uint16_t data_in );
319 
331 uint8_t templog3_read_reg ( templog3_t *ctx, uint8_t reg_addr, uint16_t *data_out );
332 
343 uint8_t templog3_set_addr_ptr ( templog3_t *ctx, uint8_t reg_addr );
344 
353 void templog3_repeated_read ( templog3_t *ctx, uint16_t *data_out );
354 
366 uint8_t templog3_get_temp ( templog3_t *ctx, uint8_t temp_sel, float *temp_out );
367 
379 uint8_t templog3_set_temp ( templog3_t *ctx, uint8_t temp_sel, float temp_in );
380 
390 uint8_t templog3_check_alarm ( templog3_t *ctx );
391 
399 void templog3_wait_conv_done ( templog3_t *ctx );
400 
411 void templog3_eeprom_byte_write ( templog3_t *ctx, uint8_t reg_addr, uint8_t data_in, uint8_t eeprom_mode );
412 
422 void templog3_eeprom_page_write ( templog3_t *ctx, uint8_t reg_addr, uint8_t *data_in );
423 
432 void templog3_eeprom_curr_addr_read ( templog3_t *ctx, uint8_t *current_address );
433 
443 void templog3_eeprom_byte_read ( templog3_t *ctx, uint8_t reg_addr, uint8_t *data_out );
444 
458 uint8_t templog3_eeprom_sequential_read ( templog3_t *ctx, uint8_t reg_addr, uint8_t *data_out, uint16_t num_bytes );
459 
460 
461 #ifdef __cplusplus
462 }
463 #endif
464 #endif // _TEMPLOG3_H_
465  // End public_function group
468 
469 // ------------------------------------------------------------------------- END
hal_i2c_address_t slave_eeprom
Definition: templog3.h:191
TEMPLOG3_RETVAL templog3_init(templog3_t *ctx, templog3_cfg_t *cfg)
Initialization function.
#define TEMPLOG3_RETVAL
Definition: templog3.h:63
pin_name_t int_pin
Definition: templog3.h:210
pin_name_t scl
Definition: templog3.h:205
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.
Click configuration structure definition.
Definition: templog3.h:201
uint8_t templog3_read_reg(templog3_t *ctx, uint8_t reg_addr, uint16_t *data_out)
Generic Read function.
i2c_master_t i2c
Definition: templog3.h:186
uint8_t n_bytes
Definition: templog3.h:194
hal_i2c_address_t slave_address
Definition: templog3.h:190
void templog3_repeated_read(templog3_t *ctx, uint16_t *data_out)
Repeated Read function.
uint8_t templog3_check_alarm(templog3_t *ctx)
Alarm-Event Check function.
void templog3_wait_conv_done(templog3_t *ctx)
Conversion Time function.
void templog3_generic_write(templog3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
void templog3_generic_read(templog3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
void templog3_eeprom_page_write(templog3_t *ctx, uint8_t reg_addr, uint8_t *data_in)
EEPROM Page Write function.
void templog3_default_cfg(templog3_t *ctx)
Click Default Configuration function.
void templog3_eeprom_byte_read(templog3_t *ctx, uint8_t reg_addr, uint8_t *data_out)
EEPROM Single Read function.
uint8_t templog3_get_temp(templog3_t *ctx, uint8_t temp_sel, float *temp_out)
Get Temperature function.
void templog3_cfg_setup(templog3_cfg_t *cfg)
Config Object Initialization function.
uint8_t dev_n_bytes
Definition: templog3.h:219
hal_i2c_address_t i2c_eeprom
Definition: templog3.h:216
uint8_t dev_resolution
Definition: templog3.h:218
pin_name_t sda
Definition: templog3.h:206
uint8_t templog3_set_addr_ptr(templog3_t *ctx, uint8_t reg_addr)
Set Address Pointer function.
hal_i2c_address_t i2c_address
Definition: templog3.h:215
Click ctx object definition.
Definition: templog3.h:178
digital_in_t int_pin
Definition: templog3.h:182
void templog3_eeprom_byte_write(templog3_t *ctx, uint8_t reg_addr, uint8_t data_in, uint8_t eeprom_mode)
EEPROM Single Write function.
void templog3_eeprom_curr_addr_read(templog3_t *ctx, uint8_t *current_address)
EEPROM Current Address Read function.
uint8_t templog3_set_temp(templog3_t *ctx, uint8_t temp_sel, float temp_in)
Set Temperature function.
uint8_t resolution
Definition: templog3.h:193
uint8_t templog3_write_reg(templog3_t *ctx, uint8_t reg_addr, uint16_t data_in)
Generic Write function.
hal_i2c_speed_t i2c_speed
Definition: templog3.h:214