tempalarm 2.1.0.0
tempalarm.h
Go to the documentation of this file.
1/****************************************************************************
2** Copyright (C) 2020 MikroElektronika d.o.o.
3** Contact: https://www.mikroe.com/contact
4**
5** Permission is hereby granted, free of charge, to any person obtaining a copy
6** of this software and associated documentation files (the "Software"), to deal
7** in the Software without restriction, including without limitation the rights
8** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9** copies of the Software, and to permit persons to whom the Software is
10** furnished to do so, subject to the following conditions:
11** The above copyright notice and this permission notice shall be
12** included in all copies or substantial portions of the Software.
13**
14** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20** USE OR OTHER DEALINGS IN THE SOFTWARE.
21****************************************************************************/
22
28#ifndef TEMPALARM_H
29#define TEMPALARM_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_i2c_master.h"
38
59// TODO -- dodati makroe koji definisu adrese registara
60#define TEMPALARM_TEMP_LOCAL_REG 0x00
61#define TEMPALARM_TEMP_REMOTE_MSB_REG 0x01
62#define TEMPALARM_ALERT_STATUS_REG 0x02
63#define TEMPALARM_CONFIGURATION_REG 0x03
64#define TEMPALARM_CONV_PERIOD_REG 0x04
65#define TEMPALARM_THIGH_LIMIT_LOCAL_REG 0x05
66#define TEMPALARM_THIGH_LIMIT_REMOTE_MSB_REG 0x07
67#define TEMPALARM_TLOW_LIMIT_REMOTE_MSB_REG 0x08
68#define TEMPALARM_ONE_SHOT_REG 0x0F
69#define TEMPALARM_TEMP_REMOTE_LSB_REG 0x10
70#define TEMPALARM_REMOTE_OFFSET_MSB_REG 0x11
71#define TEMPALARM_REMOTE_OFFSET_LSB_REG 0x12
72#define TEMPALARM_THIGH_LIMIT_REMOTE_LSB_REG 0x13
73#define TEMPALARM_TLOW_LIMIT_REMOTE_LSB_REG 0x14
74#define TEMPALARM_ALERT_MASK_REG 0x16
75#define TEMPALARM_THIGH_CRIT_REMOTE_REG 0x19
76#define TEMPALARM_THIGH_CRIT_LOCAL_REG 0x20
77#define TEMPALARM_CRIT_HYSTERESIS_REG 0x21
78#define TEMPALARM_LOG1_REG 0x2D
79#define TEMPALARM_LOG2_REG 0x2E
80#define TEMPALARM_LOG3_REG 0x2F
81#define TEMPALARM_FILTER_ALERT_MODE_REG 0xBF
82#define TEMPALARM_CHIP_ID_REG 0xFD
83#define TEMPALARM_VENDOR_ID_REG 0xFE
84#define TEMPALARM_DEVICE_REV_ID_REG 0xFF
85
86 // tempalarm_reg
88
105#define TEMPALARM_THIGH_LA_ALERT_DIS_MASK 0x80
106#define TEMPALARM_THIGH_LA_ALERT_ENABLE_MASK 0x80
107#define TEMPALARM_THIGH_RA_ALERT_DIS_MASK 0x10
108#define TEMPALARM_THIGH_RA_ALERT_ENABLE_MASK 0x00
109#define TEMPALARM_TLOW_RA_ALERT_DIS_MASK 0x08
110#define TEMPALARM_TLOW_RA_ALERT_ENABLE_MASK 0x00
111#define TEMPALARM_TCRIT_R_ALERT_DIS_MASK 0x02
112#define TEMPALARM_TCRIT_R_ALERT_ENABLE_MASK 0x00
113#define TEMPALARM_TCRIT_L_ALERT_DIS_MASK 0x01
114#define TEMPALARM_TCRIT_L_ALERT_ENABLE_MASK 0x00
115
120#define TEMPALARM_ADC_BUSY_MASK 0x80
121#define TEMPALARM_THIGH_LA_MASK 0x40
122#define TEMPALARM_THIGH_RA_MASK 0x10
123#define TEMPALARM_TLOW_RA_MASK 0x08
124#define TEMPALARM_REMOTE_DC_MASK 0x04
125#define TEMPALARM_TCRIT_R_MASK 0x02
126#define TEMPALARM_TCRIT_L_MASK 0x01
127
132#define TEMPALARM_FILTER_LEVEL_0_MASK 0x00
133#define TEMPALARM_FILTER_LEVEL_4_MASK 0x02
134#define TEMPALARM_FILTER_LEVEL_8_MASK 0x06
135#define TEMPALARM_INTERRUPT_ALERT_MODE 0x00
136#define TEMPALARM_COMPARATOR_MODE 0x01
137
142#define TEMPALARM_ALERT_DISABLED 0x80
143#define TEMPALARM_SHUTDOWN_MODE 0x40
144#define TEMPALARM_CONTINUOUS_MODE 0x00
145#define TEMPALARM_REMOTE_EN 0x04
146#define TEMPALARM_REMOTE_DIS 0x00
147#define TEMPALARM_WTC_EN 0x02
148#define TEMPALARM_WTC_DIS 0x00
149#define TEMPALARM_FAULT_QUE_EN 0x01
150#define TEMPALARM_FAULT_QUE_DIS 0x00
151
156#define TEMPALARM_CONVERSION_PERIOD_16S 0x00
157#define TEMPALARM_CONVERSION_PERIOD_8S 0x01
158#define TEMPALARM_CONVERSION_PERIOD_4S 0x02
159#define TEMPALARM_CONVERSION_PERIOD_2S 0x03
160#define TEMPALARM_CONVERSION_PERIOD_1S 0x04
161#define TEMPALARM_CONVERSION_PERIOD_500MS 0x05
162#define TEMPALARM_CONVERSION_PERIOD_250MS 0x06
163#define TEMPALARM_CONVERSION_PERIOD_125MS 0x07
164#define TEMPALARM_CONVERSION_PERIOD_62MS5 0x08
165
170#define TEMPALARM_PIN_STATE_HIGH 0x01
171#define TEMPALARM_PIN_STATE_LOW 0x00
172
173#define TEMPALARM_CHIP_ID 0x50
174#define TEMPALARM_VENDOR_ID 0x60
175
176#define TEMPALARM_TEMP_CLC 0.125f
177
183#define TEMPALARM_DEVICE_ADDRESS 0x4C
184 // tempalarm_set
186
201#define TEMPALARM_MAP_MIKROBUS( cfg, mikrobus ) \
202 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
203 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
204 cfg.tcr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
205 cfg.alr = MIKROBUS( mikrobus, MIKROBUS_INT )
206 // tempalarm_map // tempalarm
209
214typedef struct
215{
216 // Input pins
217 digital_in_t tcr;
218 digital_in_t alr;
220 // Modules
221 i2c_master_t i2c;
223 // I2C slave address
227
232typedef struct
233{
234 pin_name_t scl;
235 pin_name_t sda;
237 pin_name_t tcr;
238 pin_name_t alr;
240 uint32_t i2c_speed;
241 uint8_t i2c_address;
244
249typedef enum
250{
252 TEMPALARM_ERROR = -1
253
255
272
287
301
316err_t tempalarm_generic_write ( tempalarm_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
317
332err_t tempalarm_generic_read ( tempalarm_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
333
344
355
369err_t tempalarm_write_reg ( tempalarm_t *ctx, uint8_t reg, uint8_t data_in );
370
384err_t tempalarm_read_reg ( tempalarm_t *ctx, uint8_t reg, uint8_t *data_out );
385
397err_t tempalarm_read_temperature ( tempalarm_t *ctx, int8_t *temperature );
398
410err_t tempalarm_read_remote_temperature ( tempalarm_t *ctx, float *temperature );
411
423err_t tempalarm_set_crit_thigh ( tempalarm_t *ctx, int8_t max_temperature );
424
436err_t tempalarm_set_limit_thigh ( tempalarm_t *ctx, int8_t max_temperature );
437
449err_t tempalarm_set_alarm_low_limit ( tempalarm_t *ctx, float min_temperature );
450
462err_t tempalarm_set_alarm_high_limit ( tempalarm_t *ctx, float max_temperature );
463
475err_t tempalarm_get_alarms ( tempalarm_t *ctx, uint8_t *alarms );
476
477#ifdef __cplusplus
478}
479#endif
480#endif // TEMPALARM_H
481 // tempalarm
483
484// ------------------------------------------------------------------------ END
err_t tempalarm_write_reg(tempalarm_t *ctx, uint8_t reg, uint8_t data_in)
Temp Alarm register writing function.
err_t tempalarm_read_reg(tempalarm_t *ctx, uint8_t reg, uint8_t *data_out)
Temp Alarm register reading function.
void tempalarm_cfg_setup(tempalarm_cfg_t *cfg)
Temp Alarm configuration object setup function.
err_t tempalarm_set_limit_thigh(tempalarm_t *ctx, int8_t max_temperature)
Temp Alarm local sensor set limit high temperature function.
err_t tempalarm_read_remote_temperature(tempalarm_t *ctx, float *temperature)
Temp Alarm remote sensor read temperature function.
err_t tempalarm_set_crit_thigh(tempalarm_t *ctx, int8_t max_temperature)
Temp Alarm local sensor set critical high temperature function.
err_t tempalarm_read_temperature(tempalarm_t *ctx, int8_t *temperature)
Temp Alarm local sensor read temperature function.
uint8_t tempalarm_get_tcr_pin(tempalarm_t *ctx)
Temp Alarm get critical temperature alert pin state function.
err_t tempalarm_default_cfg(tempalarm_t *ctx)
Temp Alarm default configuration function.
err_t tempalarm_generic_write(tempalarm_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Temp Alarm I2C writing function.
err_t tempalarm_generic_read(tempalarm_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Temp Alarm I2C reading function.
err_t tempalarm_get_alarms(tempalarm_t *ctx, uint8_t *alarms)
Temp Alarm read alarms state function.
err_t tempalarm_set_alarm_low_limit(tempalarm_t *ctx, float min_temperature)
Temp Alarm remote sensor set limit low temperature function.
uint8_t tempalarm_get_alr_pin(tempalarm_t *ctx)
Temp Alarm get alarm pin state function.
err_t tempalarm_init(tempalarm_t *ctx, tempalarm_cfg_t *cfg)
Temp Alarm initialization function.
err_t tempalarm_set_alarm_high_limit(tempalarm_t *ctx, float max_temperature)
Temp Alarm remote sensor set limit high temperature function.
Temp Alarm Click configuration object.
Definition: tempalarm.h:233
pin_name_t alr
Definition: tempalarm.h:238
uint32_t i2c_speed
Definition: tempalarm.h:240
pin_name_t scl
Definition: tempalarm.h:234
pin_name_t tcr
Definition: tempalarm.h:237
pin_name_t sda
Definition: tempalarm.h:235
uint8_t i2c_address
Definition: tempalarm.h:241
Temp Alarm Click context object.
Definition: tempalarm.h:215
digital_in_t tcr
Definition: tempalarm.h:217
digital_in_t alr
Definition: tempalarm.h:218
i2c_master_t i2c
Definition: tempalarm.h:221
uint8_t slave_address
Definition: tempalarm.h:224
tempalarm_return_value_t
Temp Alarm Click return value data.
Definition: tempalarm.h:250
@ TEMPALARM_OK
Definition: tempalarm.h:251
@ TEMPALARM_ERROR
Definition: tempalarm.h:252