remotetemp  2.0.0.0
remotetemp.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 REMOTETEMP_H
36 #define REMOTETEMP_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 REMOTETEMP_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.thm = MIKROBUS( mikrobus, MIKROBUS_AN ); \
56  cfg.alr = MIKROBUS( mikrobus, MIKROBUS_INT )
57 
63 #define REMOTETEMP_RETVAL uint8_t
64 
65 #define REMOTETEMP_OK 0x00
66 #define REMOTETEMP_INIT_ERROR 0xFF
67 
73 #define REMOTETEMP_DEVICE_ADDRESS_4p7 0x7C
74 #define REMOTETEMP_DEVICE_ADDRESS_6p8 0x5C
75 #define REMOTETEMP_DEVICE_ADDRESS_10 0x4C
76 #define REMOTETEMP_DEVICE_ADDRESS_15 0x6C
77 #define REMOTETEMP_DEVICE_ADDRESS_22 0x1C
78 #define REMOTETEMP_DEVICE_ADDRESS_33 0x3C
79 
85 #define REMOTETEMP_RANGE_0_127 0x00
86 #define REMOTETEMP_RANGE_m64_191 0x01
87 
93 #define REMOTETEMP_EXT_DIODE_1 0x01
94 #define REMOTETEMP_EXT_DIODE_2 0x02
95 #define REMOTETEMP_EXT_DIODE_3 0x03
96 #define REMOTETEMP_EXT_DIODE_4 0x04
97 
103 #define REMOTETEMP_STATUS 0x02
104 #define REMOTETEMP_CONFIG 0x09
105 #define REMOTETEMP_CONVERT 0x0A
106 #define REMOTETEMP_INT_DIODE_HIGH_LIMIT 0x0B
107 #define REMOTETEMP_INT_DIODE_LOW_LIMIT 0x0C
108 #define REMOTETEMP_EXT1_HIGH_LIMIT_HIGH_BYTE 0x0D
109 #define REMOTETEMP_EXT1_LOW_LIMIT_HIGH_BYTE 0x0E
110 #define REMOTETEMP_ONE_SHOT 0x0F
111 #define REMOTETEMP_SCRTCHPD1 0x11
112 #define REMOTETEMP_SCRTCHPD2 0x12
113 #define REMOTETEMP_EXT1_HIGH_LIMIT_LOW_BYTE 0x13
114 #define REMOTETEMP_EXT1_LOW_LIMIT_LOW_BYTE 0x14
115 #define REMOTETEMP_EXT2_HIGH_LIMIT_HIGH_BYTE 0x15
116 #define REMOTETEMP_EXT2_LOW_LIMIT_HIGH_BYTE 0x16
117 #define REMOTETEMP_EXT2_HIGH_LIMIT_LOW_BYTE 0x17
118 #define REMOTETEMP_EXT2_LOW_LIMIT_LOW_BYTE 0x18
119 #define REMOTETEMP_EXT1_THERM_LIMIT 0x19
120 #define REMOTETEMP_EXT2_THERM_LIMIT 0x1A
121 #define REMOTETEMP_EXTERNAL_DIODE_FAULT_STATUS 0x1B
122 #define REMOTETEMP_DIODE_FAULT_MASK 0x1F
123 #define REMOTETEMP_INT_DIODE_THERM_LIMIT 0x20
124 #define REMOTETEMP_THRM_HYS 0x21
125 #define REMOTETEMP_CONSEC_ALERT 0x22
126 #define REMOTETEMP_EXT1_BETA_CONFIG 0x25
127 #define REMOTETEMP_EXT2_BETA_CONFIG 0x26
128 #define REMOTETEMP_EXT1_IDEALITY_FACTOR 0x27
129 #define REMOTETEMP_EXT2_IDEALITY_FACTOR 0x28
130 #define REMOTETEMP_EXT3_HIGH_LIMIT_HIGH_BYTE 0x2C
131 #define REMOTETEMP_EXT3_LOW_LIMIT_HIGH_BYTE 0x2D
132 #define REMOTETEMP_EXT3_HIGH_LIMIT_LOW_BYTE 0x2E
133 #define REMOTETEMP_EXT3_LOW_LIMIT_LOW_BYTE 0x2F
134 #define REMOTETEMP_EXT3_THERM_LIMIT 0x30
135 #define REMOTETEMP_EXT3_IDEALITY_FACTOR 0x31
136 #define REMOTETEMP_EXT4_HIGH_LIMIT_HIGH_BYTE 0x34
137 #define REMOTETEMP_EXT4_LOW_LIMIT_HIGH_BYTE 0x35
138 #define REMOTETEMP_EXT4_HIGH_LIMIT_LOW_BYTE 0x36
139 #define REMOTETEMP_EXT4_LOW_LIMIT_LOW_BYTE 0x37
140 #define REMOTETEMP_EXT4_THERM_LIMIT 0x38
141 #define REMOTETEMP_EXT4_IDEALITY_FACTOR 0x39
142 #define REMOTETEMP_HIGH_LIMIT_STATUS 0x3A
143 #define REMOTETEMP_LOW_LIMIT_STATUS 0x3B
144 #define REMOTETEMP_THERM_LIMIT_STATUS 0x3C
145 #define REMOTETEMP_ROC_GAIN 0x3D
146 #define REMOTETEMP_ROC_CONFIG 0x3E
147 #define REMOTETEMP_ROC_STATUS 0x3F
148 #define REMOTETEMP_R1_RESH 0x40
149 #define REMOTETEMP_R1_LIMH 0x41
150 #define REMOTETEMP_R1_LIML 0x42
151 #define REMOTETEMP_R1_SMPL 0x43
152 #define REMOTETEMP_R2_RESH 0x44
153 #define REMOTETEMP_R23_RESL 0x45
154 #define REMOTETEMP_R2_LIMH 0x46
155 #define REMOTETEMP_R2_LIML 0x47
156 #define REMOTETEMP_R2_SMPL 0x48
157 #define REMOTETEMP_PER_MAXT1L 0x4A
158 #define REMOTETEMP_PER_MAXTH 0x4B
159 #define REMOTETEMP_PER_MAXT23L 0x4C
160 #define REMOTETEMP_GBL_MAXT1H 0x4D
161 #define REMOTETEMP_GBL_MAXT1L 0x4E
162 #define REMOTETEMP_GBL_MAXT2H 0x4F
163 #define REMOTETEMP_GBL_MAXT2L 0x50
164 #define REMOTETEMP_FILTER_SEL 0x51
165 #define REMOTETEMP_INT_HIGH_BYTE 0x60
166 #define REMOTETEMP_INT_LOW_BYTE 0x61
167 #define REMOTETEMP_EXT1_HIGH_BYTE 0x62
168 #define REMOTETEMP_EXT1_LOW_BYTE 0x63
169 #define REMOTETEMP_EXT2_HIGH_BYTE 0x64
170 #define REMOTETEMP_EXT2_LOW_BYTE 0x65
171 #define REMOTETEMP_EXT3_HIGH_BYTE 0x66
172 #define REMOTETEMP_EXT3_LOW_BYTE 0x67
173 #define REMOTETEMP_EXT4_HIGH_BYTE 0x68
174 #define REMOTETEMP_EXT4_LOW_BYTE 0x69
175 #define REMOTETEMP_HOTTEST_DIODE_HIGH_BYTE 0x6A
176 #define REMOTETEMP_HOTTEST_DIODE_LOW_BYTE 0x6B
177 #define REMOTETEMP_HOTTEST_STATUS 0x6C
178 #define REMOTETEMP_HOTTEST_CONFIG 0x6D
179 #define REMOTETEMP_PRODUCT_ID 0xFD
180 #define REMOTETEMP_MANUFACTURER_ID 0xFE
181 #define REMOTETEMP_REVISION 0xFF
182  // End group macro
185 // --------------------------------------------------------------- PUBLIC TYPES
194 typedef struct
195 {
196  // Input pins
197 
198  digital_in_t thm;
199  digital_in_t alr;
200 
201  // Modules
202 
203  i2c_master_t i2c;
204 
205  // ctx variable
206 
207  uint8_t slave_address;
208 
209  uint8_t range_set;
210 
211 } remotetemp_t;
212 
216 typedef struct
217 {
218  // Communication gpio pins
219 
220  pin_name_t scl;
221  pin_name_t sda;
222 
223  // Additional gpio pins
224 
225  pin_name_t thm;
226  pin_name_t alr;
227 
228  // static variable
229 
230  uint32_t i2c_speed;
231  uint8_t i2c_address;
232 
234  // End variable group
236 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
237 
243 #ifdef __cplusplus
244 extern "C"{
245 #endif
246 
256 
266 
275 
286 void remotetemp_generic_write ( remotetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
287 
299 void remotetemp_generic_read ( remotetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
300 
301 
313 
325 
337 uint8_t remotetemp_set_range( remotetemp_t *ctx, uint8_t range_setting );
338 
351 void remotetemp_read ( remotetemp_t *ctx, uint8_t register_address, uint8_t * read_buffer, uint8_t n_bytes );
352 
365 void remotetemp_write ( remotetemp_t *ctx, uint8_t register_address, uint8_t * register_values, uint8_t n_bytes );
366 
377 void remotetemp_set_int_diode_high_limit ( remotetemp_t *ctx, int16_t limit_value );
378 
389 void remotetemp_set_int_diode_low_limit ( remotetemp_t *ctx, int16_t limit_value );
390 
402 void remotetemp_set_ext_diode_high_limit ( remotetemp_t *ctx, int16_t limit_value, uint8_t diode );
403 
415 void remotetemp_set_ext_diode_low_limit ( remotetemp_t *ctx, int16_t limit_value, uint8_t diode );
416 
428 void remotetemp_set_ext_diode_therm_limit ( remotetemp_t *ctx, int16_t limit_value, uint8_t diode );
429 
440 void remotetemp_set_int_diode_therm_limit ( remotetemp_t *ctx, int16_t limit_value );
441 
452 
463 float remotetemp_get_external_diode ( remotetemp_t *ctx, uint8_t diode );
464 
475 
476 #ifdef __cplusplus
477 }
478 #endif
479 #endif // _REMOTETEMP_H_
480  // End public_function group
483 
484 // ------------------------------------------------------------------------- END
remotetemp_t::range_set
uint8_t range_set
Definition: remotetemp.h:209
remotetemp_cfg_t::sda
pin_name_t sda
Definition: remotetemp.h:221
remotetemp_an_get
uint8_t remotetemp_an_get(remotetemp_t *ctx)
Getting state of AN pin.
remotetemp_cfg_t::alr
pin_name_t alr
Definition: remotetemp.h:226
remotetemp_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: remotetemp.h:230
remotetemp_cfg_t::scl
pin_name_t scl
Definition: remotetemp.h:220
remotetemp_set_range
uint8_t remotetemp_set_range(remotetemp_t *ctx, uint8_t range_setting)
Setting temperature range.
remotetemp_int_get
uint8_t remotetemp_int_get(remotetemp_t *ctx)
Getting state of INT pin.
remotetemp_get_internal_diode
float remotetemp_get_internal_diode(remotetemp_t *ctx)
Getting internal diode temperature value.
remotetemp_t
Click ctx object definition.
Definition: remotetemp.h:195
remotetemp_set_int_diode_therm_limit
void remotetemp_set_int_diode_therm_limit(remotetemp_t *ctx, int16_t limit_value)
Setting internal diodes thermal limits.
remotetemp_get_external_diode
float remotetemp_get_external_diode(remotetemp_t *ctx, uint8_t diode)
Getting external diode temperature value.
remotetemp_set_ext_diode_low_limit
void remotetemp_set_ext_diode_low_limit(remotetemp_t *ctx, int16_t limit_value, uint8_t diode)
Setting external diodes low limit.
remotetemp_generic_write
void remotetemp_generic_write(remotetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
remotetemp_cfg_t::i2c_address
uint8_t i2c_address
Definition: remotetemp.h:231
remotetemp_cfg_t::thm
pin_name_t thm
Definition: remotetemp.h:225
remotetemp_t::i2c
i2c_master_t i2c
Definition: remotetemp.h:203
remotetemp_read
void remotetemp_read(remotetemp_t *ctx, uint8_t register_address, uint8_t *read_buffer, uint8_t n_bytes)
Reads register content.
remotetemp_t::alr
digital_in_t alr
Definition: remotetemp.h:199
remotetemp_t::slave_address
uint8_t slave_address
Definition: remotetemp.h:207
remotetemp_get_hottest_diode
float remotetemp_get_hottest_diode(remotetemp_t *ctx)
Getting hottest diode temperature value.
remotetemp_write
void remotetemp_write(remotetemp_t *ctx, uint8_t register_address, uint8_t *register_values, uint8_t n_bytes)
Setting register content.
remotetemp_default_cfg
void remotetemp_default_cfg(remotetemp_t *ctx)
Click Default Configuration function.
remotetemp_set_int_diode_high_limit
void remotetemp_set_int_diode_high_limit(remotetemp_t *ctx, int16_t limit_value)
Setting Internal diode high limit.
remotetemp_set_ext_diode_high_limit
void remotetemp_set_ext_diode_high_limit(remotetemp_t *ctx, int16_t limit_value, uint8_t diode)
Setting external diodes high limit.
remotetemp_set_ext_diode_therm_limit
void remotetemp_set_ext_diode_therm_limit(remotetemp_t *ctx, int16_t limit_value, uint8_t diode)
Setting external diodes thermal limits.
remotetemp_cfg_t
Click configuration structure definition.
Definition: remotetemp.h:217
remotetemp_generic_read
void remotetemp_generic_read(remotetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
remotetemp_t::thm
digital_in_t thm
Definition: remotetemp.h:198
remotetemp_cfg_setup
void remotetemp_cfg_setup(remotetemp_cfg_t *cfg)
Config Object Initialization function.
REMOTETEMP_RETVAL
#define REMOTETEMP_RETVAL
Definition: remotetemp.h:63
remotetemp_init
REMOTETEMP_RETVAL remotetemp_init(remotetemp_t *ctx, remotetemp_cfg_t *cfg)
Initialization function.
remotetemp_set_int_diode_low_limit
void remotetemp_set_int_diode_low_limit(remotetemp_t *ctx, int16_t limit_value)
Setting Internal diode low limit.