surfacetemp 2.0.0.0
surfacetemp.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 SURFACETEMP_H
36#define SURFACETEMP_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 SURFACETEMP_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
56 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
63#define SURFACETEMP_RETVAL uint8_t
64
65#define SURFACETEMP_OK 0x00
66#define SURFACETEMP_INIT_ERROR 0xFF
73#define DEVICE_OK 0
74#define DEVICE_ERROR 1
81#define SURFACETEMP_SLAVE_DEVICE_ADDR_0_0 0x48
82#define SURFACETEMP_SLAVE_DEVICE_ADDR_0_1 0x49
83#define SURFACETEMP_SLAVE_DEVICE_ADDR_1_0 0x4A
84#define SURFACETEMP_SLAVE_DEVICE_ADDR_1_1 0x4B
91#define SURFACETEMP_REG_TEMP_MSB 0x00
92#define SURFACETEMP_REG_TEMP_LSB 0x01
93#define SURFACETEMP_REG_STATUS 0x02
94#define SURFACETEMP_REG_CONFIG 0x03
95#define SURFACETEMP_REG_T_HIGH_SETP_MSB 0x04
96#define SURFACETEMP_REG_T_HIGH_SETP_LSB 0x05
97#define SURFACETEMP_REG_T_LOW_SETP_MSB 0x06
98#define SURFACETEMP_REG_T_LOW_SETP_LSB 0x07
99#define SURFACETEMP_REG_T_CRIT_SETP_MSB 0x08
100#define SURFACETEMP_REG_T_CRIT_SETP_LSB 0x09
101#define SURFACETEMP_REG_T_HYST_SETP 0x0A
102#define SURFACETEMP_REG_ID 0x0B
103#define SURFACETEMP_REG_SOFT_RESET 0x2F
110#define SURFACETEMP_T_LOW_MASK 0x10
111#define SURFACETEMP_T_HIGH_MASK 0x20
112#define SURFACETEMP_T_CRIT_MASK 0x40
113#define SURFACETEMP_RDY_MASK 0x80 // End group macro
117// --------------------------------------------------------------- PUBLIC TYPES
126typedef struct
127{
128 // Output pins
129
130 digital_out_t rst;
131 digital_out_t pwm;
132
133 // Modules
134
135 i2c_master_t i2c;
136
137 // ctx variable
138
140
142
146typedef struct
147{
148 // Communication gpio pins
149
150 pin_name_t scl;
151 pin_name_t sda;
152
153 // Additional gpio pins
154
155 pin_name_t rst;
156 pin_name_t pwm;
157
158 // static variable
159
160 uint32_t i2c_speed;
161 uint8_t i2c_address;
162
164 // End types group
166// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
167
173#ifdef __cplusplus
174extern "C"{
175#endif
176
186
196
205
216void surfacetemp_generic_write ( surfacetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
217
229void surfacetemp_generic_read ( surfacetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
230
242
251
262
273
285uint8_t surfacetemp_set_high_threshold ( surfacetemp_t *ctx, float high_threshold );
286
298uint8_t surfacetemp_set_low_threshold ( surfacetemp_t *ctx, float high_threshold );
299
311uint8_t surfacetemp_set_critical_threshold ( surfacetemp_t *ctx, float high_threshold );
312
324uint8_t surfacetemp_set_hysteresis ( surfacetemp_t *ctx, uint8_t hysteresis );
325
343
344#ifdef __cplusplus
345}
346#endif
347#endif // _SURFACETEMP_H_
348 // End public_function group
351
352// ------------------------------------------------------------------------- END
#define SURFACETEMP_RETVAL
Definition: surfacetemp.h:63
float surfacetemp_get_temperature(surfacetemp_t *ctx)
Getting temperature value.
void surfacetemp_soft_reset(surfacetemp_t *ctx)
Soft reset.
uint8_t surfacetemp_get_pwm_pin(surfacetemp_t *ctx)
Getting PWM pin state.
void surfacetemp_default_cfg(surfacetemp_t *ctx)
Click Default Configuration function.
void surfacetemp_generic_read(surfacetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
void surfacetemp_generic_write(surfacetemp_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
uint8_t surfacetemp_setup(surfacetemp_t *ctx)
Device initialization.
uint8_t surfacetemp_set_low_threshold(surfacetemp_t *ctx, float high_threshold)
Setting low threshold limit.
uint8_t surfacetemp_get_status(surfacetemp_t *ctx)
Getting device status.
void surfacetemp_cfg_setup(surfacetemp_cfg_t *cfg)
Config Object Initialization function.
SURFACETEMP_RETVAL surfacetemp_init(surfacetemp_t *ctx, surfacetemp_cfg_t *cfg)
Initialization function.
uint8_t surfacetemp_set_hysteresis(surfacetemp_t *ctx, uint8_t hysteresis)
Setting hysteresis value.
uint8_t surfacetemp_set_critical_threshold(surfacetemp_t *ctx, float high_threshold)
Setting critical threshold limit.
uint8_t surfacetemp_set_high_threshold(surfacetemp_t *ctx, float high_threshold)
Setting high threshold limit.
Click configuration structure definition.
Definition: surfacetemp.h:147
uint32_t i2c_speed
Definition: surfacetemp.h:160
pin_name_t scl
Definition: surfacetemp.h:150
pin_name_t pwm
Definition: surfacetemp.h:156
pin_name_t sda
Definition: surfacetemp.h:151
pin_name_t rst
Definition: surfacetemp.h:155
uint8_t i2c_address
Definition: surfacetemp.h:161
Click ctx object definition.
Definition: surfacetemp.h:127
digital_out_t pwm
Definition: surfacetemp.h:131
i2c_master_t i2c
Definition: surfacetemp.h:135
digital_out_t rst
Definition: surfacetemp.h:130
uint8_t slave_address
Definition: surfacetemp.h:139