thermo3  2.0.0.0
thermo3.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * 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 
43 // -------------------------------------------------------------- PUBLIC MACROS
53 #define THERMO3_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
55  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
56  cfg. al = MIKROBUS( mikrobus, MIKROBUS_INT )
57 
63 #define THERMO3_RETVAL uint8_t
64 
65 #define THERMO3_OK 0x00
66 #define THERMO3_INIT_ERROR 0xFF
67 
73 #define TMP102_I2C_ADDR 0x48 // TMP102 I2C address (ADD0 pin is connected to ground)
74 
75 //#define TMP102_I2C_ADDR 0x49 // TMP102 I2C address (ADD0 pin is connected to VCC) // End group macro
79 // --------------------------------------------------------------- PUBLIC TYPES
88 typedef struct
89 {
90  // Output pins
91 
92 
93  // Input pins
94 
95  digital_in_t al;
96 
97  // Modules
98 
99  i2c_master_t i2c;
100 
101  // ctx variable
102 
103  hal_i2c_address_t slave_address;
104 
105 } thermo3_t;
106 
110 typedef struct
111 {
112  // Communication gpio pins
113 
114  pin_name_t scl;
115  pin_name_t sda;
116 
117  // Additional gpio pins
118 
119  pin_name_t al;
120 
121  // static variable
122 
123  hal_i2c_speed_t i2c_speed;
124  hal_i2c_address_t i2c_address;
125 
126 } thermo3_cfg_t;
127  // End types group
129 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
130 
136 #ifdef __cplusplus
137 extern "C"{
138 #endif
139 
148 void thermo3_cfg_setup ( thermo3_cfg_t *cfg );
149 
158 
166 void thermo3_default_cfg ( thermo3_t *ctx );
167 
178 void thermo3_generic_write ( thermo3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
179 
191 void thermo3_generic_read ( thermo3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
192 
200  float get_temperature ( thermo3_t *ctx );
201 
202 #ifdef __cplusplus
203 }
204 #endif
205 #endif // _THERMO3_H_
206  // End public_function group
209 
210 // ------------------------------------------------------------------------- END
hal_i2c_address_t slave_address
Definition: thermo3.h:103
digital_in_t al
Definition: thermo3.h:95
void thermo3_cfg_setup(thermo3_cfg_t *cfg)
Config Object Initialization function.
pin_name_t al
Definition: thermo3.h:119
Click ctx object definition.
Definition: thermo3.h:88
Click configuration structure definition.
Definition: thermo3.h:110
void thermo3_generic_write(thermo3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
hal_i2c_address_t i2c_address
Definition: thermo3.h:124
void thermo3_generic_read(thermo3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
pin_name_t sda
Definition: thermo3.h:115
pin_name_t scl
Definition: thermo3.h:114
THERMO3_RETVAL thermo3_init(thermo3_t *ctx, thermo3_cfg_t *cfg)
Initialization function.
i2c_master_t i2c
Definition: thermo3.h:99
#define THERMO3_RETVAL
Definition: thermo3.h:63
void thermo3_default_cfg(thermo3_t *ctx)
Click Default Configuration function.
float get_temperature(thermo3_t *ctx)
Gets temperature.
hal_i2c_speed_t i2c_speed
Definition: thermo3.h:123