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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 // -------------------------------------------------------------- PUBLIC MACROS
62 #define REMOTETEMP_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.thm = MIKROBUS( mikrobus, MIKROBUS_AN ); \
66  cfg.alr = MIKROBUS( mikrobus, MIKROBUS_INT )
67 
73 #define REMOTETEMP_RETVAL uint8_t
74 
75 #define REMOTETEMP_OK 0x00
76 #define REMOTETEMP_INIT_ERROR 0xFF
77 
83 #define REMOTETEMP_DEVICE_ADDRESS_4p7 0x7C
84 #define REMOTETEMP_DEVICE_ADDRESS_6p8 0x5C
85 #define REMOTETEMP_DEVICE_ADDRESS_10 0x4C
86 #define REMOTETEMP_DEVICE_ADDRESS_15 0x6C
87 #define REMOTETEMP_DEVICE_ADDRESS_22 0x1C
88 #define REMOTETEMP_DEVICE_ADDRESS_33 0x3C
89 
95 #define REMOTETEMP_RANGE_0_127 0x00
96 #define REMOTETEMP_RANGE_m64_191 0x01
97 
103 #define REMOTETEMP_EXT_DIODE_1 0x01
104 #define REMOTETEMP_EXT_DIODE_2 0x02
105 #define REMOTETEMP_EXT_DIODE_3 0x03
106 #define REMOTETEMP_EXT_DIODE_4 0x04
107 
113 #define REMOTETEMP_STATUS 0x02
114 #define REMOTETEMP_CONFIG 0x09
115 #define REMOTETEMP_CONVERT 0x0A
116 #define REMOTETEMP_INT_DIODE_HIGH_LIMIT 0x0B
117 #define REMOTETEMP_INT_DIODE_LOW_LIMIT 0x0C
118 #define REMOTETEMP_EXT1_HIGH_LIMIT_HIGH_BYTE 0x0D
119 #define REMOTETEMP_EXT1_LOW_LIMIT_HIGH_BYTE 0x0E
120 #define REMOTETEMP_ONE_SHOT 0x0F
121 #define REMOTETEMP_SCRTCHPD1 0x11
122 #define REMOTETEMP_SCRTCHPD2 0x12
123 #define REMOTETEMP_EXT1_HIGH_LIMIT_LOW_BYTE 0x13
124 #define REMOTETEMP_EXT1_LOW_LIMIT_LOW_BYTE 0x14
125 #define REMOTETEMP_EXT2_HIGH_LIMIT_HIGH_BYTE 0x15
126 #define REMOTETEMP_EXT2_LOW_LIMIT_HIGH_BYTE 0x16
127 #define REMOTETEMP_EXT2_HIGH_LIMIT_LOW_BYTE 0x17
128 #define REMOTETEMP_EXT2_LOW_LIMIT_LOW_BYTE 0x18
129 #define REMOTETEMP_EXT1_THERM_LIMIT 0x19
130 #define REMOTETEMP_EXT2_THERM_LIMIT 0x1A
131 #define REMOTETEMP_EXTERNAL_DIODE_FAULT_STATUS 0x1B
132 #define REMOTETEMP_DIODE_FAULT_MASK 0x1F
133 #define REMOTETEMP_INT_DIODE_THERM_LIMIT 0x20
134 #define REMOTETEMP_THRM_HYS 0x21
135 #define REMOTETEMP_CONSEC_ALERT 0x22
136 #define REMOTETEMP_EXT1_BETA_CONFIG 0x25
137 #define REMOTETEMP_EXT2_BETA_CONFIG 0x26
138 #define REMOTETEMP_EXT1_IDEALITY_FACTOR 0x27
139 #define REMOTETEMP_EXT2_IDEALITY_FACTOR 0x28
140 #define REMOTETEMP_EXT3_HIGH_LIMIT_HIGH_BYTE 0x2C
141 #define REMOTETEMP_EXT3_LOW_LIMIT_HIGH_BYTE 0x2D
142 #define REMOTETEMP_EXT3_HIGH_LIMIT_LOW_BYTE 0x2E
143 #define REMOTETEMP_EXT3_LOW_LIMIT_LOW_BYTE 0x2F
144 #define REMOTETEMP_EXT3_THERM_LIMIT 0x30
145 #define REMOTETEMP_EXT3_IDEALITY_FACTOR 0x31
146 #define REMOTETEMP_EXT4_HIGH_LIMIT_HIGH_BYTE 0x34
147 #define REMOTETEMP_EXT4_LOW_LIMIT_HIGH_BYTE 0x35
148 #define REMOTETEMP_EXT4_HIGH_LIMIT_LOW_BYTE 0x36
149 #define REMOTETEMP_EXT4_LOW_LIMIT_LOW_BYTE 0x37
150 #define REMOTETEMP_EXT4_THERM_LIMIT 0x38
151 #define REMOTETEMP_EXT4_IDEALITY_FACTOR 0x39
152 #define REMOTETEMP_HIGH_LIMIT_STATUS 0x3A
153 #define REMOTETEMP_LOW_LIMIT_STATUS 0x3B
154 #define REMOTETEMP_THERM_LIMIT_STATUS 0x3C
155 #define REMOTETEMP_ROC_GAIN 0x3D
156 #define REMOTETEMP_ROC_CONFIG 0x3E
157 #define REMOTETEMP_ROC_STATUS 0x3F
158 #define REMOTETEMP_R1_RESH 0x40
159 #define REMOTETEMP_R1_LIMH 0x41
160 #define REMOTETEMP_R1_LIML 0x42
161 #define REMOTETEMP_R1_SMPL 0x43
162 #define REMOTETEMP_R2_RESH 0x44
163 #define REMOTETEMP_R23_RESL 0x45
164 #define REMOTETEMP_R2_LIMH 0x46
165 #define REMOTETEMP_R2_LIML 0x47
166 #define REMOTETEMP_R2_SMPL 0x48
167 #define REMOTETEMP_PER_MAXT1L 0x4A
168 #define REMOTETEMP_PER_MAXTH 0x4B
169 #define REMOTETEMP_PER_MAXT23L 0x4C
170 #define REMOTETEMP_GBL_MAXT1H 0x4D
171 #define REMOTETEMP_GBL_MAXT1L 0x4E
172 #define REMOTETEMP_GBL_MAXT2H 0x4F
173 #define REMOTETEMP_GBL_MAXT2L 0x50
174 #define REMOTETEMP_FILTER_SEL 0x51
175 #define REMOTETEMP_INT_HIGH_BYTE 0x60
176 #define REMOTETEMP_INT_LOW_BYTE 0x61
177 #define REMOTETEMP_EXT1_HIGH_BYTE 0x62
178 #define REMOTETEMP_EXT1_LOW_BYTE 0x63
179 #define REMOTETEMP_EXT2_HIGH_BYTE 0x64
180 #define REMOTETEMP_EXT2_LOW_BYTE 0x65
181 #define REMOTETEMP_EXT3_HIGH_BYTE 0x66
182 #define REMOTETEMP_EXT3_LOW_BYTE 0x67
183 #define REMOTETEMP_EXT4_HIGH_BYTE 0x68
184 #define REMOTETEMP_EXT4_LOW_BYTE 0x69
185 #define REMOTETEMP_HOTTEST_DIODE_HIGH_BYTE 0x6A
186 #define REMOTETEMP_HOTTEST_DIODE_LOW_BYTE 0x6B
187 #define REMOTETEMP_HOTTEST_STATUS 0x6C
188 #define REMOTETEMP_HOTTEST_CONFIG 0x6D
189 #define REMOTETEMP_PRODUCT_ID 0xFD
190 #define REMOTETEMP_MANUFACTURER_ID 0xFE
191 #define REMOTETEMP_REVISION 0xFF
192  // End group macro
195 // --------------------------------------------------------------- PUBLIC TYPES
204 typedef struct
205 {
206  // Input pins
207 
208  digital_in_t thm;
209  digital_in_t alr;
210 
211  // Modules
212 
213  i2c_master_t i2c;
214 
215  // ctx variable
216 
217  uint8_t slave_address;
218 
219  uint8_t range_set;
220 
221 } remotetemp_t;
222 
226 typedef struct
227 {
228  // Communication gpio pins
229 
230  pin_name_t scl;
231  pin_name_t sda;
232 
233  // Additional gpio pins
234 
235  pin_name_t thm;
236  pin_name_t alr;
237 
238  // static variable
239 
240  uint32_t i2c_speed;
241  uint8_t i2c_address;
242 
244  // End variable group
246 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
247 
253 #ifdef __cplusplus
254 extern "C"{
255 #endif
256 
266 
276 
285 
296 void remotetemp_generic_write ( remotetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
297 
309 void remotetemp_generic_read ( remotetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
310 
311 
323 
335 
347 uint8_t remotetemp_set_range( remotetemp_t *ctx, uint8_t range_setting );
348 
361 void remotetemp_read ( remotetemp_t *ctx, uint8_t register_address, uint8_t * read_buffer, uint8_t n_bytes );
362 
375 void remotetemp_write ( remotetemp_t *ctx, uint8_t register_address, uint8_t * register_values, uint8_t n_bytes );
376 
387 void remotetemp_set_int_diode_high_limit ( remotetemp_t *ctx, int16_t limit_value );
388 
399 void remotetemp_set_int_diode_low_limit ( remotetemp_t *ctx, int16_t limit_value );
400 
412 void remotetemp_set_ext_diode_high_limit ( remotetemp_t *ctx, int16_t limit_value, uint8_t diode );
413 
425 void remotetemp_set_ext_diode_low_limit ( remotetemp_t *ctx, int16_t limit_value, uint8_t diode );
426 
438 void remotetemp_set_ext_diode_therm_limit ( remotetemp_t *ctx, int16_t limit_value, uint8_t diode );
439 
450 void remotetemp_set_int_diode_therm_limit ( remotetemp_t *ctx, int16_t limit_value );
451 
462 
473 float remotetemp_get_external_diode ( remotetemp_t *ctx, uint8_t diode );
474 
485 
486 #ifdef __cplusplus
487 }
488 #endif
489 #endif // _REMOTETEMP_H_
490  // End public_function group
493 
494 // ------------------------------------------------------------------------- END
remotetemp_t::range_set
uint8_t range_set
Definition: remotetemp.h:219
remotetemp_cfg_t::sda
pin_name_t sda
Definition: remotetemp.h:231
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:236
remotetemp_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: remotetemp.h:240
remotetemp_cfg_t::scl
pin_name_t scl
Definition: remotetemp.h:230
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:205
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:241
remotetemp_cfg_t::thm
pin_name_t thm
Definition: remotetemp.h:235
remotetemp_t::i2c
i2c_master_t i2c
Definition: remotetemp.h:213
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:209
remotetemp_t::slave_address
uint8_t slave_address
Definition: remotetemp.h:217
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:227
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:208
remotetemp_cfg_setup
void remotetemp_cfg_setup(remotetemp_cfg_t *cfg)
Config Object Initialization function.
REMOTETEMP_RETVAL
#define REMOTETEMP_RETVAL
Definition: remotetemp.h:73
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.