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 "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 THERMO3_MAP_MIKROBUS( cfg, mikrobus ) \
63  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
64  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
65  cfg. al = MIKROBUS( mikrobus, MIKROBUS_INT )
66 
72 #define THERMO3_RETVAL uint8_t
73 
74 #define THERMO3_OK 0x00
75 #define THERMO3_INIT_ERROR 0xFF
76 
82 #define TMP102_I2C_ADDR 0x48 // TMP102 I2C address (ADD0 pin is connected to ground)
83 
84 //#define TMP102_I2C_ADDR 0x49 // TMP102 I2C address (ADD0 pin is connected to VCC) // End group macro
88 // --------------------------------------------------------------- PUBLIC TYPES
97 typedef struct
98 {
99  // Input pins
100 
101  digital_in_t al;
102 
103  // Modules
104 
105  i2c_master_t i2c;
106 
107  // ctx variable
108 
109  uint8_t slave_address;
110 
111 } thermo3_t;
112 
116 typedef struct
117 {
118  // Communication gpio pins
119 
120  pin_name_t scl;
121  pin_name_t sda;
122 
123  // Additional gpio pins
124 
125  pin_name_t al;
126 
127  // static variable
128 
129  uint32_t i2c_speed;
130  uint8_t i2c_address;
131 
132 } thermo3_cfg_t;
133  // End types group
135 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
136 
142 #ifdef __cplusplus
143 extern "C"{
144 #endif
145 
155 
165 
174 
185 void thermo3_generic_write ( thermo3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
186 
197 void thermo3_generic_read ( thermo3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
198 
206  float get_temperature ( thermo3_t *ctx );
207 
208 #ifdef __cplusplus
209 }
210 #endif
211 #endif // _THERMO3_H_
212  // End public_function group
215 
216 // ------------------------------------------------------------------------- END
thermo3_cfg_t::sda
pin_name_t sda
Definition: thermo3.h:121
thermo3_cfg_t::al
pin_name_t al
Definition: thermo3.h:125
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:105
thermo3_t::al
digital_in_t al
Definition: thermo3.h:101
thermo3_t::slave_address
uint8_t slave_address
Definition: thermo3.h:109
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:117
thermo3_t
Click ctx object definition.
Definition: thermo3.h:98
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:72
thermo3_cfg_t::i2c_address
uint8_t i2c_address
Definition: thermo3.h:130
thermo3_cfg_t::scl
pin_name_t scl
Definition: thermo3.h:120
thermo3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: thermo3.h:129
get_temperature
float get_temperature(thermo3_t *ctx)
Gets temperature.