thermo15 2.0.0.0
thermo15.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 THERMO15_H
36#define THERMO15_H
37
38#include "drv_digital_in.h"
39#include "drv_i2c_master.h"
40
41// -------------------------------------------------------------- PUBLIC MACROS
51#define THERMO15_MAP_MIKROBUS( cfg, mikrobus ) \
52 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
53 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
54 cfg.alt = MIKROBUS( mikrobus, MIKROBUS_INT );
61#define THERMO15_RETVAL uint8_t
62
63#define THERMO15_OK 0x00
64#define THERMO15_INIT_ERROR 0xFF
71#define THERMO15_DEVICE_SLAVE_ADDR_000 0x48
72#define THERMO15_DEVICE_SLAVE_ADDR_001 0x49
73#define THERMO15_DEVICE_SLAVE_ADDR_010 0x4A
74#define THERMO15_DEVICE_SLAVE_ADDR_011 0x4B
75#define THERMO15_DEVICE_SLAVE_ADDR_100 0x4C
76#define THERMO15_DEVICE_SLAVE_ADDR_101 0x4D
77#define THERMO15_DEVICE_SLAVE_ADDR_110 0x4E
78#define THERMO15_DEVICE_SLAVE_ADDR_111 0x4F
85#define THERMO15_REG_STORED_TEMPERATURE 0x00
86#define THERMO15_REG_CONFIGURATION 0x01
87#define THERMO15_REG_TEMPERATURE_HYSTERESIS 0x02
88#define THERMO15_REG_TEMPERATURE_LIMIT 0x03
89#define THERMO15_REG_ONE_SHOT 0x04
96#define THERMO15_DEF_TEMP_HYSTERESIS 75
97#define THERMO15_DEF_TEMP_LIMIT 80
98#define THERMO15_REG_ONE_SHOT 0x04
105#define THERMO15_CFG_WMODE_NORMAL 0x00
106#define THERMO15_CFG_WMODE_ONE_SHOT 0x20
107#define THERMO15_CFG_WMODE_SHUTDOWN 0x01
108#define THERMO15_CFG_FAULT_QUEUE_1 0x00
109#define THERMO15_CFG_FAULT_QUEUE_2 0x08
110#define THERMO15_CFG_FAULT_QUEUE_4 0x10
111#define THERMO15_CFG_FAULT_QUEUE_6 0x18
112#define THERMO15_CFG_ALERT_ACTIVE_LOW 0x00
113#define THERMO15_CFG_ALERT_ACTIVE_HIGH 0x04
114#define THERMO15_CFG_TMODE_COMPARATOR 0x00
115#define THERMO15_CFG_TMODE_INTERRUPT 0x02
122#define THERMO15_TEMP_IN_CELSIUS 0x00
123#define THERMO15_TEMP_IN_KELVIN 0x01
124#define THERMO15_TEMP_IN_FAHRENHEIT 0x02 // End group macro
128// --------------------------------------------------------------- PUBLIC TYPES
137typedef struct
138{
139 digital_in_t alt;
140
141 // Modules
142
143 i2c_master_t i2c;
144
145 // ctx variable
146
148
149} thermo15_t;
150
154typedef struct
155{
156 // Communication gpio pins
157
158 pin_name_t scl;
159 pin_name_t sda;
160
161 // Additional gpio pins
162
163 pin_name_t alt;
164
165 // static variable
166
167 uint32_t i2c_speed;
168 uint8_t i2c_address;
169
171 // End types group
173// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
174
180#ifdef __cplusplus
181extern "C"{
182#endif
183
193
202
211
222void thermo15_generic_write ( thermo15_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len );
223
234void thermo15_generic_read ( thermo15_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len );
235
243float thermo15_get_temperature_data ( thermo15_t *ctx, uint8_t temp_format );
244
257void thermo15_set_temp_register ( thermo15_t *ctx, uint8_t temp_reg, float temp_data );
258
271float thermo15_get_temp_register ( thermo15_t *ctx, uint8_t temp_reg );
272
279
280#ifdef __cplusplus
281}
282#endif
283#endif // _THERMO15_H_
284 // End public_function group
287
288// ------------------------------------------------------------------------- END
#define THERMO15_RETVAL
Definition: thermo15.h:61
void thermo15_generic_read(thermo15_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len)
Generic read function.
THERMO15_RETVAL thermo15_init(thermo15_t *ctx, thermo15_cfg_t *cfg)
Initialization function.
void thermo15_set_temp_register(thermo15_t *ctx, uint8_t temp_reg, float temp_data)
Set temperature register.
void thermo15_cfg_setup(thermo15_cfg_t *cfg)
Config Object Initialization function.
float thermo15_get_temperature_data(thermo15_t *ctx, uint8_t temp_format)
Ambient temperature data.
void thermo15_default_cfg(thermo15_t *ctx)
Click Default Configuration function.
uint8_t thermo15_get_interrupt_state(thermo15_t *ctx)
Interrupt state.
float thermo15_get_temp_register(thermo15_t *ctx, uint8_t temp_reg)
Get temperature register.
void thermo15_generic_write(thermo15_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len)
Generic write function.
Click configuration structure definition.
Definition: thermo15.h:155
pin_name_t alt
Definition: thermo15.h:163
uint32_t i2c_speed
Definition: thermo15.h:167
pin_name_t scl
Definition: thermo15.h:158
pin_name_t sda
Definition: thermo15.h:159
uint8_t i2c_address
Definition: thermo15.h:168
Click ctx object definition.
Definition: thermo15.h:138
digital_in_t alt
Definition: thermo15.h:139
i2c_master_t i2c
Definition: thermo15.h:143
uint8_t slave_address
Definition: thermo15.h:147