surfacetemp2  2.0.0.0
surfacetemp2.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 SURFACETEMP2_H
36 #define SURFACETEMP2_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 SURFACETEMP2_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
66  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
67 
73 #define SURFACETEMP2_RETVAL uint8_t
74 
75 #define SURFACETEMP2_OK 0x00
76 #define SURFACETEMP2_INIT_ERROR 0xFF
77 
83 #define SURFACETEMP2_I2C_DEV_ADR_0_0 0x48
84 #define SURFACETEMP2_I2C_DEV_ADR_0_1 0x49
85 #define SURFACETEMP2_I2C_DEV_ADR_1_0 0x4A
86 #define SURFACETEMP2_I2C_DEV_ADR_1_1 0x4B
87 
93 #define SURFACETEMP2_REG_TEMP_MSB 0x00
94 #define SURFACETEMP2_REG_TEMP_LSB 0x01
95 #define SURFACETEMP2_REG_STAT 0x02
96 #define SURFACETEMP2_REG_CFG 0x03
97 #define SURFACETEMP2_REG_T_HIGH_SETP_MSB 0x04
98 #define SURFACETEMP2_REG_T_HIGH_SETP_LSB 0x05
99 #define SURFACETEMP2_REG_T_LOW_SETP_MSB 0x06
100 #define SURFACETEMP2_REG_T_LOW_SETP_LSB 0x07
101 #define SURFACETEMP2_REG_T_CRIT_SETP_MSB 0x08
102 #define SURFACETEMP2_REG_T_CRIT_SETP_LSB 0x09
103 #define SURFACETEMP2_REG_T_HYST_SETP 0x0A
104 #define SURFACETEMP2_REG_ID 0x0B
105 #define SURFACETEMP2_REG_SOFT_RESET 0x2F
106 
112 #define SURFACETEMP2_STAT_T_LOW_MSK 0x10
113 #define SURFACETEMP2_STAT_T_HIGH_MSK 0x20
114 #define SURFACETEMP2_STAT_T_CRIT_MSK 0x40
115 #define SURFACETEMP2_STAT_RDY_MSK 0x80
116 
122 #define SURFACETEMP2_CFG_FLT_Q_1 0x00
123 #define SURFACETEMP2_CFG_FLT_Q_2 0x01
124 #define SURFACETEMP2_CFG_FLT_Q_3 0x02
125 #define SURFACETEMP2_CFG_FLT_Q_4 0x03
126 #define SURFACETEMP2_CFG_CT_POL_ACT_H 0x04
127 #define SURFACETEMP2_CFG_CT_POL_ACT_L 0x00
128 #define SURFACETEMP2_CFG_INT_POL_ACT_H 0x08
129 #define SURFACETEMP2_CFG_INT_POL_ACT_L 0x00
130 #define SURFACETEMP2_CFG_INT_MODE 0x00
131 #define SURFACETEMP2_CFG_CT_MODE 0x10
132 #define SURFACETEMP2_CFG_OP_MODE_CONT 0x00
133 #define SURFACETEMP2_CFG_OP_MODE_ONE_SHT 0x20
134 #define SURFACETEMP2_CFG_OP_MODE_SPS 0x40
135 #define SURFACETEMP2_CFG_OP_MODE_SHDN 0x60
136 #define SURFACETEMP2_CFG_RES_13 0x00
137 #define SURFACETEMP2_CFG_RES_16 0x80
138 
144 #define SURFACETEMP2_RES_13_BIT 0.0625
145 #define SURFACETEMP2_RES_16_BIT 0.0078125
146 
152 #define SURFACETEMP2_DEV_ID_VAL 0xCB
153 
159 #define SURFACETEMP2_DEV_OK 0x00
160 #define SURFACETEMP2_DEV_NOK 0x01
161  // End group macro
164 // --------------------------------------------------------------- PUBLIC TYPES
173 typedef struct
174 {
175  // Input pins
176 
177  digital_in_t pwm;
178  digital_in_t int_pin;
179 
180  // Modules
181 
182  i2c_master_t i2c;
183 
184  // ctx variable
185 
186  uint8_t slave_address;
187 
189 
193 typedef struct
194 {
195  // Communication gpio pins
196 
197  pin_name_t scl;
198  pin_name_t sda;
199 
200  // Additional gpio pins
201 
202  pin_name_t pwm;
203  pin_name_t int_pin;
204 
205  // static variable
206 
207  uint32_t i2c_speed;
208  uint8_t i2c_address;
209 
211  // End types group
213 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
214 
220 #ifdef __cplusplus
221 extern "C"{
222 #endif
223 
233 
242 
253 void surfacetemp2_generic_write ( surfacetemp2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
254 
266 void surfacetemp2_generic_read ( surfacetemp2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
267 
277 
291 uint8_t surfacetemp2_setup ( surfacetemp2_t *ctx, uint8_t setup );
292 
302 void surfacetemp2_set_hys_val ( surfacetemp2_t *ctx, uint8_t hys_val );
303 
315 
324 void surfacetemp2_set_high_trsh ( surfacetemp2_t *ctx, float trsh );
325 
334 void surfacetemp2_set_low_trsh ( surfacetemp2_t *ctx, float trsh );
335 
344 void surfacetemp2_set_crit_trsh ( surfacetemp2_t *ctx, float trsh );
345 
358 
371 
372 #ifdef __cplusplus
373 }
374 #endif
375 #endif // _SURFACETEMP2_H_
376  // End public_function group
379 
380 // ------------------------------------------------------------------------- END
surfacetemp2_get_ct_pin
uint8_t surfacetemp2_get_ct_pin(surfacetemp2_t *ctx)
Get CT pin state function.
surfacetemp2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: surfacetemp2.h:207
surfacetemp2_t::slave_address
uint8_t slave_address
Definition: surfacetemp2.h:186
surfacetemp2_cfg_t
Click configuration structure definition.
Definition: surfacetemp2.h:194
SURFACETEMP2_RETVAL
#define SURFACETEMP2_RETVAL
Definition: surfacetemp2.h:73
surfacetemp2_cfg_t::scl
pin_name_t scl
Definition: surfacetemp2.h:197
surfacetemp2_t::i2c
i2c_master_t i2c
Definition: surfacetemp2.h:182
surfacetemp2_cfg_t::i2c_address
uint8_t i2c_address
Definition: surfacetemp2.h:208
surfacetemp2_setup
uint8_t surfacetemp2_setup(surfacetemp2_t *ctx, uint8_t setup)
Setup function.
surfacetemp2_cfg_t::sda
pin_name_t sda
Definition: surfacetemp2.h:198
surfacetemp2_t::int_pin
digital_in_t int_pin
Definition: surfacetemp2.h:178
surfacetemp2_t::pwm
digital_in_t pwm
Definition: surfacetemp2.h:177
surfacetemp2_set_hys_val
void surfacetemp2_set_hys_val(surfacetemp2_t *ctx, uint8_t hys_val)
Set Hysteresis function.
surfacetemp2_get_int_pin
uint8_t surfacetemp2_get_int_pin(surfacetemp2_t *ctx)
Get INT pin state function.
surfacetemp2_soft_reset
void surfacetemp2_soft_reset(surfacetemp2_t *ctx)
Software Reset function.
surfacetemp2_cfg_t::pwm
pin_name_t pwm
Definition: surfacetemp2.h:202
surfacetemp2_t
Click ctx object definition.
Definition: surfacetemp2.h:174
surfacetemp2_generic_write
void surfacetemp2_generic_write(surfacetemp2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
surfacetemp2_generic_read
void surfacetemp2_generic_read(surfacetemp2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
surfacetemp2_set_high_trsh
void surfacetemp2_set_high_trsh(surfacetemp2_t *ctx, float trsh)
Set Over Temperature Threshold function.
surfacetemp2_get_temperature
float surfacetemp2_get_temperature(surfacetemp2_t *ctx)
Get Temperature function.
surfacetemp2_set_crit_trsh
void surfacetemp2_set_crit_trsh(surfacetemp2_t *ctx, float trsh)
Set Critical Temperature Threshold function.
surfacetemp2_cfg_t::int_pin
pin_name_t int_pin
Definition: surfacetemp2.h:203
surfacetemp2_set_low_trsh
void surfacetemp2_set_low_trsh(surfacetemp2_t *ctx, float trsh)
Set Under Temperature Threshold function.
surfacetemp2_init
SURFACETEMP2_RETVAL surfacetemp2_init(surfacetemp2_t *ctx, surfacetemp2_cfg_t *cfg)
Initialization function.
surfacetemp2_cfg_setup
void surfacetemp2_cfg_setup(surfacetemp2_cfg_t *cfg)
Config Object Initialization function.