irthermo2 2.0.0.0
irthermo2.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
25#ifndef IRTHERMO2_H
26#define IRTHERMO2_H
27
28#ifdef __cplusplus
29extern "C"{
30#endif
31
32#include "drv_digital_out.h"
33#include "drv_digital_in.h"
34#include "drv_i2c_master.h"
35
36
57#define IRTHERMO2_SENSOR_VOLTAGE 0x00
58#define IRTHERMO2_LOCAL_TEMPERATURE 0x01
59#define IRTHERMO2_CONFIGURATION 0x02
60#define IRTHERMO2_OBJECT_TEMPERATURE 0x03
61#define IRTHERMO2_STATUS 0x04
62#define IRTHERMO2_STATUS_MASK_AND_ENABLE 0x05
63#define IRTHERMO2_OBJECT_HIGH_LIMIT_TEMP 0x06
64#define IRTHERMO2_OBJECT_LOW_LIMIT_TEMP 0x07
65#define IRTHERMO2_LOCAL_HIGH_LIMIT_TEMP 0x08
66#define IRTHERMO2_LOCAL_LOW_LIMIT_TEMP 0x09
67#define IRTHERMO2_S0_COEFFICIENT 0x0A
68#define IRTHERMO2_A0_COEFFICIENT 0x0B
69#define IRTHERMO2_A1_COEFFICIENT 0x0C
70#define IRTHERMO2_B0_COEFFICIENT 0x0D
71#define IRTHERMO2_B1_COEFFICIENT 0x0E
72#define IRTHERMO2_B2_COEFFICIENT 0x0F
73#define IRTHERMO2_C_COEFFICIENT 0x10
74#define IRTHERMO2_TC0_COEFFICIENT 0X11
75#define IRTHERMO2_TC1_COEFFICIENT 0x12
76#define IRTHERMO2_DEVICE_ID 0x1F
77#define IRTHERMO2_MEMORY_ACCESS 0x2A
78 // irthermo2_reg
80
95#define IRTHERMO2_RESULT_OK 1
96#define IRTHERMO2_RESULT_ERROR 0
97#define IRTHERMO2_CFG_MODEON 0x1000
98#define IRTHERMO2_CFG_RESET 0x8000
99#define IRTHERMO2_CFG_1SAMPLE 0x0000
100#define IRTHERMO2_CFG_2SAMPLE 0x0200
101#define IRTHERMO2_CFG_4SAMPLE 0x0400
102#define IRTHERMO2_CFG_8SAMPLE 0x0600
103#define IRTHERMO2_CFG_16SAMPLE 0x0800
104#define IRTHERMO2_CFG_ALERTEN 0x0100
105#define IRTHERMO2_CFG_ALERTF 0x0080
106#define IRTHERMO2_CFG_TRANSC 0x0040
107#define IRTHERMO2_STAT_ALERTEN 0x8000
108#define IRTHERMO2_STAT_CRTEN 0x4000
109#define IRTHERMO2_DEVICE_ID_VALUE 0x0078
110
116#define IRTHERMO2_I2C_ADDRESS_0 0x40
117#define IRTHERMO2_I2C_ADDRESS_1 0x41
118#define IRTHERMO2_I2C_ADDRESS_2 0x44
119#define IRTHERMO2_I2C_ADDRESS_3 0x45
120 // irthermo2_set
122
137#define IRTHERMO2_MAP_MIKROBUS( cfg, mikrobus ) \
138 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
139 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
140 cfg.al = MIKROBUS( mikrobus, MIKROBUS_INT )
141 // irthermo2_map // irthermo2
144
145
146
147
151typedef struct
152{
153 // Input pins
154 digital_in_t al;
156 // Modules
157 i2c_master_t i2c;
159 // ctx variable
160
164
168typedef struct
169{
170 // Communication gpio pins
171
172 pin_name_t scl;
173 pin_name_t sda;
175 // Additional gpio pins
176
177 pin_name_t al;
179 // static variable
180
181 uint32_t i2c_speed;
182 uint8_t i2c_address;
185
190typedef enum
191{
193 IRTHERMO2_ERROR = -1
194
196
213
227
236
247void irthermo2_generic_write ( irthermo2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
248
259void irthermo2_generic_read ( irthermo2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
260
270void irthermo2_write_data ( irthermo2_t *ctx, uint8_t address, uint16_t write_data );
271
280uint16_t irthermo2_read_data ( irthermo2_t *ctx, uint8_t address );
281
293
305
315
327
336
337#ifdef __cplusplus
338}
339#endif
340#endif // _IRTHERMO2_H_
341
343// ------------------------------------------------------------------------- END
err_t irthermo2_init(irthermo2_t *ctx, irthermo2_cfg_t *cfg)
Initialization function.
float irthermo2_get_object_temperature_c(irthermo2_t *ctx)
Get object temperature in degrees Celsius function.
void irthermo2_write_data(irthermo2_t *ctx, uint8_t address, uint16_t write_data)
Generic write 16-bit data function.
void irthermo2_generic_read(irthermo2_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Generic read function.
void irthermo2_default_cfg(irthermo2_t *ctx)
Click Default Configuration function.
void irthermo2_generic_write(irthermo2_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Generic write function.
uint16_t irthermo2_read_data(irthermo2_t *ctx, uint8_t address)
Generic read 16-bit data from 8-bit address function.
uint8_t irhhermo2_get_alert(irthermo2_t *ctx)
Get state of alert function.
err_t irthermo2_check_id(irthermo2_t *ctx)
Check device ID function.
void irthermo2_cfg_setup(irthermo2_cfg_t *cfg)
Config Object Initialization function.
float irthermo2_get_object_temperature_f(irthermo2_t *ctx)
Get object temperature in degrees Fahrenheit function.
float irthermo2_get_raw_temperature(irthermo2_t *ctx)
Get raw temperature in degrees Celsius function.
irthermo2_return_value_t
IrThermo 2 Click return value data.
Definition: irthermo2.h:191
@ IRTHERMO2_ERROR
Definition: irthermo2.h:193
@ IRTHERMO2_OK
Definition: irthermo2.h:192
Click configuration structure definition.
Definition: irthermo2.h:169
uint32_t i2c_speed
Definition: irthermo2.h:181
pin_name_t al
Definition: irthermo2.h:177
pin_name_t scl
Definition: irthermo2.h:172
pin_name_t sda
Definition: irthermo2.h:173
uint8_t i2c_address
Definition: irthermo2.h:182
Click ctx object definition.
Definition: irthermo2.h:152
digital_in_t al
Definition: irthermo2.h:154
i2c_master_t i2c
Definition: irthermo2.h:157
uint8_t slave_address
Definition: irthermo2.h:161