templog2  2.0.0.0
templog2.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 _TEMPLOG2_H_
36 #define _TEMPLOG2_H_
37 
38 #include "drv_digital_in.h"
39 #include "drv_i2c_master.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
56 #define TEMPLOG2_TEMP_REG 0x00
57 #define TEMPLOG2_CONFIG_REG 0x01
58 #define TEMPLOG2_HIGH_LIMIT_REG 0x02
59 #define TEMPLOG2_LOW_LIMIT_REG 0x03
60 #define TEMPLOG2_EEPROM_UNLOCK_REG 0x04
61 #define TEMPLOG2_EEPROM1_REG 0x05
62 #define TEMPLOG2_EEPROM2_REG 0x06
63 #define TEMPLOG2_EEPROM3_REG 0x07
64 #define TEMPLOG2_EEPROM4_REG 0x08
65 #define TEMPLOG2_ID_REG 0x0F
66 
72 #define TEMPLOG2_15_MILISEC_0_AVG 0x00
73 #define TEMPLOG2_125_MILISEC_0_AVG 0x0080
74 #define TEMPLOG2_250_MILISEC_0_AVG 0x0100
75 #define TEMPLOG2_500_MILISEC_0_AVG 0x0180
76 #define TEMPLOG2_1_SEC_0_AVG 0x0200
77 #define TEMPLOG2_4_SEC_0_AVG 0x0280
78 #define TEMPLOG2_8_SEC_0_AVG 0x0300
79 #define TEMPLOG2_16_SEC_0_AVG 0x0380
80 #define TEMPLOG2_125_MILISEC_8_AVG 0x0020
81 #define TEMPLOG2_250_MILISEC_8_AVG 0x0120
82 #define TEMPLOG2_500_MILISEC_8_AVG 0x01A0
83 #define TEMPLOG2_1_SEC_8_AVG 0x0220
84 #define TEMPLOG2_4_SEC_8_AVG 0x02A0
85 #define TEMPLOG2_8_SEC_8_AVG 0x0320
86 #define TEMPLOG2_16_SEC_8_AVG 0x03A0
87 #define TEMPLOG2_500_MILISEC_32_AVG 0x0040
88 #define TEMPLOG2_1_SEC_32_AVG 0x0240
89 #define TEMPLOG2_4_SEC_32_AVG 0x02C0
90 #define TEMPLOG2_8_SEC_32_AVG 0x0340
91 #define TEMPLOG2_16_SEC_32_AVG 0x03C0
92 #define TEMPLOG2_1_SEC_64_AVG 0x0060
93 #define TEMPLOG2_4_SEC_64_AVG 0x02E0
94 #define TEMPLOG2_8_SEC_64_AVG 0x0360
95 #define TEMPLOG2_16_SEC_64_AVG 0x03E0
96 #define TEMPLOG2_POL_ACTIVE_LOW 0x00
97 #define TEMPLOG2_POL_ACTIVE_HIGH 0x0008
98 #define TEMPLOG2_PIN_ALERT_FLAGS 0x00
99 #define TEMPLOG2_PIN_DATAREADY_FLAG 0x0004
100 
105 #define TEMPLOG2_LOCK_EEPROM 0x00
106 #define TEMPLOG2_UNLOCK_EEPROM 0x8000
107 
113 #define TEMPLOG2_0_CELSIUS 0x00
114 #define TEMPLOG2_1_CELSIUS_POS 0x0080
115 #define TEMPLOG2_25_CELSIUS_POS 0x0C80
116 #define TEMPLOG2_25_CELSIUS_NEG 0xF380
117 #define TEMPLOG2_100_CELSIUS_POS 0x3200
118 #define TEMPLOG2_256_CELSIUS_POS 0x7FFF
119 #define TEMPLOG2_256_CELSIUS_NEG 0x8000
120 
126 #define TEMPLOG2_CONT_CONV_OP_MODE 0x00
127 #define TEMPLOG2_SHUTDOWN_OP_MODE 0x01
128 #define TEMPLOG2_ONE_SHOT_OP_MODE 0x02
129 #define TEMPLOG2_ALERT_MODE 0x00
130 #define TEMPLOG2_THERM_MODE 0x01
131  // End settings group
134 
139 #define TEMPLOG2_DATA_READY_MASK 0x01
140 #define TEMPLOG2_LOW_LIMIT_MASK 0x02
141 #define TEMPLOG2_HIGH_LIMIT_MASK 0x04
142 #define TEMPLOG2_BUSY_MASK 0x4000
143  // End registers group
146 
156 #define TEMPLOG2_OK 0x00
157 #define TEMPLOG2_INVALID_ADDR 0xFF
158 #define TEMPLOG2_INVALID_PARAM 0xFE
159 #define TEMPLOG2_INIT_DRV_ERROR 0xFD
160 
166 #define TEMPLOG2_RETVAL uint8_t
167  // End error group
170 
175 #define TEMPLOG2_MAP_MIKROBUS( cfg, mikrobus ) \
176  cfg.alt = MIKROBUS( mikrobus, MIKROBUS_INT ); \
177  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
178  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
179  // End macros group
182 // --------------------------------------------------------------- PUBLIC TYPES
191 typedef struct
192 {
193  // Click mikrobus DRV objects.
194  digital_in_t alt;
195  i2c_master_t i2c;
196 
197  // Used I2C slave address.
198  uint8_t slave_addr;
199 
200 } templog2_t;
201 
205 typedef struct
206 {
207  // Used mikrobus pins.
208  pin_name_t alt;
209  pin_name_t scl;
210  pin_name_t sda;
211 
216  bool addr_sel;
217  uint32_t i2c_speed;
218 
220  // End types group
222 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
228 #ifdef __cplusplus
229 extern "C"{
230 #endif
231 
243 void
245 
259 
268 void
270 
283 templog2_write_reg( templog2_t *ctx, uint8_t reg_addr, uint16_t transfer_data );
284 
297 templog2_read_reg( templog2_t *ctx, uint8_t reg_addr, uint16_t *data_out );
298 
308 uint8_t
310 
321 uint8_t
323 
333 float
335 
348 templog2_set_mode( templog2_t *ctx, uint8_t op_mode, uint8_t alert_mode );
349 
362 templog2_write_eeprom( templog2_t *ctx, uint8_t eeprom_addr, uint16_t data_in );
363 
372 void
374 
375 #ifdef __cplusplus
376 }
377 #endif
378 #endif // _TEMPLOG2_H_
379  // End public_function group
382 
383 // ------------------------------------------------------------------------ END
templog2_reset
void templog2_reset(templog2_t *ctx)
Reset function.
templog2_default_config
void templog2_default_config(templog2_t *ctx)
Click Default Configuration function.
templog2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: templog2.h:217
templog2_t::i2c
i2c_master_t i2c
Definition: templog2.h:195
templog2_t::alt
digital_in_t alt
Definition: templog2.h:194
templog2_read_temp
float templog2_read_temp(templog2_t *ctx)
Read Temperature function.
templog2_write_eeprom
TEMPLOG2_RETVAL templog2_write_eeprom(templog2_t *ctx, uint8_t eeprom_addr, uint16_t data_in)
EEPROM Writing function.
templog2_init
TEMPLOG2_RETVAL templog2_init(templog2_t *ctx, templog2_cfg_t *cfg)
Click Initialization function.
templog2_check_alert
uint8_t templog2_check_alert(templog2_t *ctx)
Alert Checking function.
TEMPLOG2_RETVAL
#define TEMPLOG2_RETVAL
Definition: templog2.h:166
templog2_cfg_t::alt
pin_name_t alt
Definition: templog2.h:208
templog2_cfg_setup
void templog2_cfg_setup(templog2_cfg_t *cfg)
Configuration Object Setup function.
templog2_write_reg
TEMPLOG2_RETVAL templog2_write_reg(templog2_t *ctx, uint8_t reg_addr, uint16_t transfer_data)
Write Register function.
templog2_t::slave_addr
uint8_t slave_addr
Definition: templog2.h:198
templog2_cfg_t::scl
pin_name_t scl
Definition: templog2.h:209
templog2_cfg_t::addr_sel
bool addr_sel
Definition: templog2.h:216
templog2_read_reg
TEMPLOG2_RETVAL templog2_read_reg(templog2_t *ctx, uint8_t reg_addr, uint16_t *data_out)
Read Register function.
templog2_cfg_t::sda
pin_name_t sda
Definition: templog2.h:210
templog2_set_mode
TEMPLOG2_RETVAL templog2_set_mode(templog2_t *ctx, uint8_t op_mode, uint8_t alert_mode)
Mode Setting function.
templog2_data_ready
uint8_t templog2_data_ready(templog2_t *ctx)
Data Ready function.
templog2_t
Click context object definition.
Definition: templog2.h:192
templog2_cfg_t
Click configuration structure definition.
Definition: templog2.h:206