thermo27  2.1.0.0
thermo27.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 THERMO27_H
29 #define THERMO27_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_i2c_master.h"
52 
73 #define THERMO27_TEMP_RESULT_REG 0x00
74 #define THERMO27_SLEW_RESULT_REG 0x01
75 #define THERMO27_ALERT_STATUS_REG 0x02
76 #define THERMO27_CONFIGURATION_REG 0x03
77 #define THERMO27_TLOW_LIMIT_REG 0x04
78 #define THERMO27_THIGH_LIMIT_REG 0x05
79 #define THERMO27_HYSTERESIS_REG 0x06
80 #define THERMO27_SLEW_LIMIT_REG 0x07
81 #define THERMO27_UNIQUE_ID1_REG 0x08
82 #define THERMO27_UNIQUE_ID2_REG 0x09
83 #define THERMO27_UNIQUE_ID3_REG 0x0A
84 #define THERMO27_DEVICE_ID_REG 0x0B
85  // thermo27_reg
87 
102 #define THERMO27_CRC_MODE_ENABLED 0x01
103 #define THERMO27_CRC_MODE_DISABLED 0x00
104 #define THERMO27_POLYNOMIAL 0x07
105 #define THERMO27_DEVICE_ID 0x1114
106 #define THERMO27_TEMP_COEF 0.0078125
107 #define THERMO27_LSB_VAL 0.03125
108 #define THERMO27_LOW_TEMP_LIMIT_VAL -25
109 #define THERMO27_HIGH_TEMP_LIMIT_VAL 80
110 #define THERMO27_SW_RESET 0x06
111 
117 #define THERMO27_ADC_TIME_6mS_MODE_CMD 0x0000
118 #define THERMO27_ADC_TIME_4mS_MODE_CMD 0x0200
119 #define THERMO27_ADC_TIME_2mS_MODE_CMD 0x0400
120 #define THERMO27_ADC_TIME_1mS_MODE_CMD 0x0600
121 #define THERMO27_SW_RESET_CMD 0x0100
122 #define THERMO27_ENABLE_AVG_CMD 0x0080
123 #define THERMO27_ENABLE_CRC_CMD 0x0040
124 #define THERMO27_ONE_SHOT_CMD 0x0010
125 #define THERMO27_CONTINUOUS_MODE_CMD 0x0000
126 #define THERMO27_SHOUTDOWN_MODE_CMD 0x0008
127 #define THERMO27_CONVERSION_TIME_7mS_MODE_CMD 0x0000
128 #define THERMO27_CONVERSION_TIME_32mS_MODE_CMD 0x0001
129 #define THERMO27_CONVERSION_TIME_63mS_MODE_CMD 0x0002
130 #define THERMO27_CONVERSION_TIME_125mS_MODE_CMD 0x0003
131 #define THERMO27_CONVERSION_TIME_250mS_MODE_CMD 0x0004
132 #define THERMO27_CONVERSION_TIME_500mS_MODE_CMD 0x0005
133 #define THERMO27_CONVERSION_TIME_1S_MODE_CMD 0x0006
134 #define THERMO27_CONVERSION_TIME_2S_MODE_CMD 0x0007
135 
141 #define THERMO27_CRC_FLAG 0x80
142 #define THERMO27_SLEW_STATUS 0x40
143 #define THERMO27_SLEW_FLAG 0x20
144 #define THERMO27_THIGH_STATUS 0x10
145 #define THERMO27_TLOW_STATUS 0x08
146 #define THERMO27_THIGH_FLAG 0x04
147 #define THERMO27_TLOW_FLAG 0x02
148 #define THERMO27_DATA_READY_FLAG 0x01
149 
150 
156 #define THERMO27_DEVICE_ADDRESS 0x4D
157 #define THERMO27_RESET_DEVICE_ADDRESS 0x00
158  // thermo27_set
160 
175 #define THERMO27_MAP_MIKROBUS( cfg, mikrobus ) \
176  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
177  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
178  // thermo27_map // thermo27
181 
186 typedef struct
187 {
188  // Modules
189  i2c_master_t i2c;
191  // I2C slave address
192  uint8_t slave_address;
194  uint8_t crc_mode;
196 } thermo27_t;
197 
202 typedef struct
203 {
204  pin_name_t scl;
205  pin_name_t sda;
207  uint32_t i2c_speed;
208  uint8_t i2c_address;
211 
216 typedef enum
217 {
219  THERMO27_ERROR = -1
220 
222 
239 
254 
268 
283 err_t thermo27_generic_write ( thermo27_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
284 
299 err_t thermo27_generic_read ( thermo27_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
300 
314 err_t thermo27_write_register ( thermo27_t *ctx, uint8_t reg, uint16_t data_in );
315 
329 err_t thermo27_read_register ( thermo27_t *ctx, uint8_t reg, uint16_t *data_out );
330 
343 err_t thermo27_get_device_id ( thermo27_t *ctx, uint16_t *device_id );
344 
356 
369 err_t thermo27_read_temp ( thermo27_t *ctx, float *temp_out );
370 
383 
395 err_t thermo27_set_low_temp_limit ( thermo27_t *ctx, float low_temp_limit );
396 
408 err_t thermo27_set_high_temp_limit ( thermo27_t *ctx, float high_temp_limit );
409 
422 err_t thermo27_set_hysteresis ( thermo27_t *ctx, uint8_t thigh_hyst, uint8_t tlow_hyst );
423 
435 err_t thermo27_set_slew_limit ( thermo27_t *ctx, float slew_limit );
436 
448 err_t thermo27_get_alert_reg ( thermo27_t *ctx, uint8_t *register_flags );
449 
450 #ifdef __cplusplus
451 }
452 #endif
453 #endif // THERMO27_H
454  // thermo27
456 
457 // ------------------------------------------------------------------------ END
thermo27_t::slave_address
uint8_t slave_address
Definition: thermo27.h:192
thermo27_set_hysteresis
err_t thermo27_set_hysteresis(thermo27_t *ctx, uint8_t thigh_hyst, uint8_t tlow_hyst)
Thermo 27 set hysteresis function.
thermo27_enable_crc
err_t thermo27_enable_crc(thermo27_t *ctx)
Thermo 27 enable CRC function.
thermo27_sw_reset
err_t thermo27_sw_reset(thermo27_t *ctx)
Thermo 27 software reset function.
THERMO27_ERROR
@ THERMO27_ERROR
Definition: thermo27.h:219
thermo27_cfg_t::i2c_address
uint8_t i2c_address
Definition: thermo27.h:208
thermo27_set_high_temp_limit
err_t thermo27_set_high_temp_limit(thermo27_t *ctx, float high_temp_limit)
Thermo 27 set high temperature limit function.
thermo27_cfg_t::sda
pin_name_t sda
Definition: thermo27.h:205
thermo27_set_slew_limit
err_t thermo27_set_slew_limit(thermo27_t *ctx, float slew_limit)
Thermo 27 set slew limit function.
thermo27_init
err_t thermo27_init(thermo27_t *ctx, thermo27_cfg_t *cfg)
Thermo 27 initialization function.
thermo27_cfg_t::scl
pin_name_t scl
Definition: thermo27.h:204
thermo27_read_temp
err_t thermo27_read_temp(thermo27_t *ctx, float *temp_out)
Thermo 27 get read temperature function.
thermo27_cfg_t
Thermo 27 Click configuration object.
Definition: thermo27.h:203
thermo27_generic_write
err_t thermo27_generic_write(thermo27_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Thermo 27 I2C writing function.
thermo27_get_device_id
err_t thermo27_get_device_id(thermo27_t *ctx, uint16_t *device_id)
Thermo 27 get device id function.
thermo27_return_value_t
thermo27_return_value_t
Thermo 27 Click return value data.
Definition: thermo27.h:217
thermo27_set_low_temp_limit
err_t thermo27_set_low_temp_limit(thermo27_t *ctx, float low_temp_limit)
Thermo 27 set low temperature limit function.
thermo27_t::i2c
i2c_master_t i2c
Definition: thermo27.h:189
THERMO27_OK
@ THERMO27_OK
Definition: thermo27.h:218
thermo27_read_register
err_t thermo27_read_register(thermo27_t *ctx, uint8_t reg, uint16_t *data_out)
Thermo 27 register reading function.
thermo27_t::crc_mode
uint8_t crc_mode
Definition: thermo27.h:194
thermo27_write_register
err_t thermo27_write_register(thermo27_t *ctx, uint8_t reg, uint16_t data_in)
Thermo 27 register writing function.
thermo27_get_alert_reg
err_t thermo27_get_alert_reg(thermo27_t *ctx, uint8_t *register_flags)
Thermo 27 get alert register staus function.
thermo27_cfg_setup
void thermo27_cfg_setup(thermo27_cfg_t *cfg)
Thermo 27 configuration object setup function.
thermo27_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: thermo27.h:207
thermo27_default_cfg
err_t thermo27_default_cfg(thermo27_t *ctx)
Thermo 27 default configuration function.
thermo27_generic_read
err_t thermo27_generic_read(thermo27_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Thermo 27 I2C reading function.
thermo27_t
Thermo 27 Click context object.
Definition: thermo27.h:187