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
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_i2c_master.h"
41
42// -------------------------------------------------------------- PUBLIC MACROS
52#define TEMPLOG5_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55 cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
62#define TEMPLOG5_RETVAL uint8_t
63
64#define TEMPLOG5_OK 0x00
65#define TEMPLOG5_INIT_ERROR 0xFF
72#define TEMPLOG5_REG_CAPABILITY 0x00
73#define TEMPLOG5_REG_CONFIGURATION 0x01
74#define TEMPLOG5_REG_HIGH_LIMIT 0x02
75#define TEMPLOG5_REG_LOW_LIMIT 0x03
76#define TEMPLOG5_REG_CRITICAL_LIMIT 0x04
77#define TEMPLOG5_REG_TEMPERATURE 0x05
78#define TEMPLOG5_REG_MANUFACTURER_ID 0x06
79#define TEMPLOG5_REG_DEVICE_ID 0x07
86#define TEMPLOG5_CFG_DISABLE_HYSTERESIS 0x0000
87#define TEMPLOG5_CFG_HYSTERESIS_TO_1p5C 0x0200
88#define TEMPLOG5_CFG_HYSTERESIS_TO_3C 0x0400
89#define TEMPLOG5_CFG_HYSTERESIS_TO_6C 0x0600
90#define TEMPLOG5_CFG_TEMP_SENSOR_ENABLE 0x0000
91#define TEMPLOG5_CFG_TEMP_SENSOR_DISABLE 0x0100
92#define TEMPLOG5_CFG_CRITICAL_TRIP_ENABLE 0x0000
93#define TEMPLOG5_CFG_CRITICAL_TRIP_DISABLE 0x0080
94#define TEMPLOG5_CFG_ALARM_TRIP_ENABLE 0x0000
95#define TEMPLOG5_CFG_ALARM_TRIP_DISABLE 0x0040
96#define TEMPLOG5_CFG_EVENT_INT_PIN_ENABLE 0x0010
97#define TEMPLOG5_CFG_EVENT_INT_PIN_DISABLE 0x0000
98#define TEMPLOG5_CFG_EVENT_OUT_ENABLE 0x0008
99#define TEMPLOG5_CFG_EVENT_OUT_DISABLE 0x0000
100#define TEMPLOG5_CFG_EVENT_OUT_ACTIVE_LOW 0x0000
101#define TEMPLOG5_CFG_EVENT_OUT_ACTIVE_HIGH 0x0002
102#define TEMPLOG5_CFG_EVENT_MODE_COMPARATOR 0x0000
103#define TEMPLOG5_CFG_EVENT_MODE_INTERRUPT 0x0001
110#define TEMPLOG5_CAP_EVSD_FROZEN 0x0000
111#define TEMPLOG5_CAP_EVSD_CLEARD 0x0080
112#define TEMPLOG5_CAP_TMOUT_10ms_60ms 0x0000
113#define TEMPLOG5_CAP_TMOUT_25ms_35ms 0x0040
114#define TEMPLOG5_CAP_RSWP_NOT_EXPLICITLY_STATED 0x0000
115#define TEMPLOG5_CAP_RSWP_EXPLICITLY_STATED 0x0020
116#define TEMPLOG5_CAP_TEMP_RES_9bit 0x0000
117#define TEMPLOG5_CAP_TEMP_RES_10bit 0x0008
118#define TEMPLOG5_CAP_TEMP_RES_11bit 0x0010
119#define TEMPLOG5_CAP_TEMP_RES_12bit 0x0018
120#define TEMPLOG5_CAP_POS_TEMP_ONLY 0x0000
121#define TEMPLOG5_CAP_POS_AND_NEG_TEMP 0x0004
122#define TEMPLOG5_CAP_ACC_CLASS_C 0x0000
123#define TEMPLOG5_CAP_ACC_CLASS_B 0x0002
124#define TEMPLOG5_CAP_EV_CRITICAL_TEMP_ONLY 0x0000
125#define TEMPLOG5_CAP_EV_ALARM_AND_CRITICAL_TEMP 0x0001
132#define TEMPLOG5_TS_SLAVE_ADDR_000 0x18
133#define TEMPLOG5_TS_SLAVE_ADDR_001 0x19
134#define TEMPLOG5_TS_SLAVE_ADDR_010 0x1A
135#define TEMPLOG5_TS_SLAVE_ADDR_011 0x1B
136#define TEMPLOG5_TS_SLAVE_ADDR_100 0x1C
137#define TEMPLOG5_TS_SLAVE_ADDR_101 0x1D
138#define TEMPLOG5_TS_SLAVE_ADDR_110 0x1E
139#define TEMPLOG5_TS_SLAVE_ADDR_111 0x1F
146#define TEMPLOG5_EEPROM_SLAVE_ADDR_000 0x50
147#define TEMPLOG5_EEPROM_SLAVE_ADDR_001 0x51
148#define TEMPLOG5_EEPROM_SLAVE_ADDR_010 0x52
149#define TEMPLOG5_EEPROM_SLAVE_ADDR_011 0x53
150#define TEMPLOG5_EEPROM_SLAVE_ADDR_100 0x54
151#define TEMPLOG5_EEPROM_SLAVE_ADDR_101 0x55
152#define TEMPLOG5_EEPROM_SLAVE_ADDR_110 0x56
153#define TEMPLOG5_EEPROM_SLAVE_ADDR_111 0x57
160#define TEMPLOG5_MANUFACTURER_ID 0x1B09
161#define TEMPLOG5_DEVICE_ID_REV_B 0x0813
162#define TEMPLOG5_DEVICE_ID_REV_C 0x0A00 // End group macro
166// --------------------------------------------------------------- PUBLIC TYPES
175typedef struct
176{
177 // Input pins
178
179 digital_in_t int_pin;
180
181 // Modules
182
183 i2c_master_t i2c;
184
185 // ctx variable
186
187 uint8_t ts_slave;
189 uint8_t temp_status;
190
191} templog5_t;
192
196typedef struct
197{
198 // Communication gpio pins
199
200 pin_name_t scl;
201 pin_name_t sda;
202
203 // Additional gpio pins
204
205 pin_name_t int_pin;
206
207 // static variable
208
209 uint32_t i2c_speed;
210 uint8_t ts_slave;
212
213
215 // End types group
217// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
218
224#ifdef __cplusplus
225extern "C"{
226#endif
227
237
247
270
280void templog5_write_data ( templog5_t *ctx, uint8_t reg, uint16_t data_in );
281
294void templog5_write_eeprom ( templog5_t *ctx, uint8_t start_addr, uint8_t *data_in, uint8_t n_byte );
295
306uint16_t templog5_read_data ( templog5_t *ctx, uint8_t reg );
307
318void templog5_read_eeprom ( templog5_t *ctx, uint8_t start_addr, uint8_t *data_out, uint8_t n_byte );
319
330
341
352
353#ifdef __cplusplus
354}
355#endif
356#endif // _TEMPLOG5_H_
357 // End public_function group
360
361// ------------------------------------------------------------------------- END
#define TEMPLOG5_RETVAL
Definition: templog5.h:62
uint8_t templog5_get_temperature_status(templog5_t *ctx)
Teperature Status.
void templog5_cfg_setup(templog5_cfg_t *cfg)
Config Object Initialization function.
TEMPLOG5_RETVAL templog5_init(templog5_t *ctx, templog5_cfg_t *cfg)
Initialization function.
float templog5_get_temperature(templog5_t *ctx)
Temperature Data.
uint8_t templog5_get_interrupt_status(templog5_t *ctx)
EVENT Interrupt status.
uint16_t templog5_read_data(templog5_t *ctx, uint8_t reg)
Functions for read data from registers.
void templog5_write_data(templog5_t *ctx, uint8_t reg, uint16_t data_in)
Functions for write data to the TS register.
void templog5_default_cfg(templog5_t *ctx)
Click Default Configuration function.
void templog5_read_eeprom(templog5_t *ctx, uint8_t start_addr, uint8_t *data_out, uint8_t n_byte)
Reads data from 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 ).
Click configuration structure definition.
Definition: templog5.h:197
uint8_t eeprom_slave
Definition: templog5.h:211
uint8_t ts_slave
Definition: templog5.h:210
uint32_t i2c_speed
Definition: templog5.h:209
pin_name_t scl
Definition: templog5.h:200
pin_name_t int_pin
Definition: templog5.h:205
pin_name_t sda
Definition: templog5.h:201
Click ctx object definition.
Definition: templog5.h:176
uint8_t eeprom_slave
Definition: templog5.h:188
uint8_t temp_status
Definition: templog5.h:189
uint8_t ts_slave
Definition: templog5.h:187
digital_in_t int_pin
Definition: templog5.h:179
i2c_master_t i2c
Definition: templog5.h:183