thermo3  2.0.0.0
thermo3.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 THERMO3_H
36 #define THERMO3_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 THERMO3_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg. al = MIKROBUS( mikrobus, MIKROBUS_INT )
56 
62 #define THERMO3_RETVAL uint8_t
63 
64 #define THERMO3_OK 0x00
65 #define THERMO3_INIT_ERROR 0xFF
66 
72 #define TMP102_I2C_ADDR 0x48 // TMP102 I2C address (ADD0 pin is connected to ground)
73 
74 //#define TMP102_I2C_ADDR 0x49 // TMP102 I2C address (ADD0 pin is connected to VCC) // End group macro
78 // --------------------------------------------------------------- PUBLIC TYPES
87 typedef struct
88 {
89  // Input pins
90 
91  digital_in_t al;
92 
93  // Modules
94 
95  i2c_master_t i2c;
96 
97  // ctx variable
98 
99  uint8_t slave_address;
100 
101 } thermo3_t;
102 
106 typedef struct
107 {
108  // Communication gpio pins
109 
110  pin_name_t scl;
111  pin_name_t sda;
112 
113  // Additional gpio pins
114 
115  pin_name_t al;
116 
117  // static variable
118 
119  uint32_t i2c_speed;
120  uint8_t i2c_address;
121 
122 } thermo3_cfg_t;
123  // End types group
125 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
126 
132 #ifdef __cplusplus
133 extern "C"{
134 #endif
135 
144 void thermo3_cfg_setup ( thermo3_cfg_t *cfg );
145 
155 
163 void thermo3_default_cfg ( thermo3_t *ctx );
164 
175 void thermo3_generic_write ( thermo3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
176 
187 void thermo3_generic_read ( thermo3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
188 
196  float get_temperature ( thermo3_t *ctx );
197 
198 #ifdef __cplusplus
199 }
200 #endif
201 #endif // _THERMO3_H_
202  // End public_function group
205 
206 // ------------------------------------------------------------------------- END
thermo3_cfg_t::sda
pin_name_t sda
Definition: thermo3.h:111
thermo3_cfg_t::al
pin_name_t al
Definition: thermo3.h:115
thermo3_cfg_setup
void thermo3_cfg_setup(thermo3_cfg_t *cfg)
Config Object Initialization function.
thermo3_t::i2c
i2c_master_t i2c
Definition: thermo3.h:95
thermo3_t::al
digital_in_t al
Definition: thermo3.h:91
thermo3_t::slave_address
uint8_t slave_address
Definition: thermo3.h:99
thermo3_default_cfg
void thermo3_default_cfg(thermo3_t *ctx)
Click Default Configuration function.
thermo3_generic_read
void thermo3_generic_read(thermo3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
thermo3_cfg_t
Click configuration structure definition.
Definition: thermo3.h:106
thermo3_t
Click ctx object definition.
Definition: thermo3.h:87
thermo3_init
THERMO3_RETVAL thermo3_init(thermo3_t *ctx, thermo3_cfg_t *cfg)
Initialization function.
thermo3_generic_write
void thermo3_generic_write(thermo3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
THERMO3_RETVAL
#define THERMO3_RETVAL
Definition: thermo3.h:62
thermo3_cfg_t::i2c_address
uint8_t i2c_address
Definition: thermo3.h:120
thermo3_cfg_t::scl
pin_name_t scl
Definition: thermo3.h:110
thermo3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: thermo3.h:119
get_temperature
float get_temperature(thermo3_t *ctx)
Gets temperature.