thermo21  2.0.0.0
thermo21.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef THERMO21_H
29 #define THERMO21_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 #include "spi_specifics.h"
39 
64 #define THERMO21_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
65 #define THERMO21_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
66  // thermo21_set
68 
83 #define THERMO21_MAP_MIKROBUS( cfg, mikrobus ) \
84  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
85  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
86  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
87  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
88  // thermo21_map // thermo21
91 
96 typedef struct
97 {
98  // Modules
99  spi_master_t spi;
100  pin_name_t chip_select;
102 } thermo21_t;
103 
108 typedef struct
109 {
110  // Communication gpio pins
111  pin_name_t miso;
112  pin_name_t mosi;
113  pin_name_t sck;
114  pin_name_t cs;
116  // static variable
117  uint32_t spi_speed;
118  spi_master_mode_t spi_mode;
119  spi_master_chip_select_polarity_t cs_polarity;
122 
127 typedef enum
128 {
131 
133 
149 void thermo21_cfg_setup ( thermo21_cfg_t *cfg );
150 
165 err_t thermo21_init ( thermo21_t *ctx, thermo21_cfg_t *cfg );
166 
181 err_t thermo21_generic_read ( thermo21_t *ctx, uint8_t *data_out, uint8_t len );
182 
195 err_t thermo21_temperature_read ( thermo21_t *ctx, float *data_out );
196 
197 #ifdef __cplusplus
198 }
199 #endif
200 #endif // THERMO21_H
201  // thermo21
203 
204 // ------------------------------------------------------------------------ END
thermo21_t
Thermo 21 Click context object.
Definition: thermo21.h:96
spi_specifics.h
This file contains SPI specific macros, functions, etc.
thermo21_t::chip_select
pin_name_t chip_select
Definition: thermo21.h:100
thermo21_generic_read
err_t thermo21_generic_read(thermo21_t *ctx, uint8_t *data_out, uint8_t len)
Data reading function.
thermo21_cfg_t::cs
pin_name_t cs
Definition: thermo21.h:114
thermo21_cfg_setup
void thermo21_cfg_setup(thermo21_cfg_t *cfg)
Thermo 21 configuration object setup function.
thermo21_cfg_t
Thermo 21 Click configuration object.
Definition: thermo21.h:108
thermo21_return_value_t
thermo21_return_value_t
Thermo 21 Click return value data.
Definition: thermo21.h:127
thermo21_cfg_t::sck
pin_name_t sck
Definition: thermo21.h:113
thermo21_cfg_t::spi_speed
uint32_t spi_speed
Definition: thermo21.h:117
thermo21_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: thermo21.h:119
thermo21_cfg_t::miso
pin_name_t miso
Definition: thermo21.h:111
thermo21_init
err_t thermo21_init(thermo21_t *ctx, thermo21_cfg_t *cfg)
Thermo 21 initialization function.
thermo21_temperature_read
err_t thermo21_temperature_read(thermo21_t *ctx, float *data_out)
Temperature reading function.
thermo21_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: thermo21.h:118
THERMO21_OK
Definition: thermo21.h:129
thermo21_cfg_t::mosi
pin_name_t mosi
Definition: thermo21.h:112
THERMO21_ERROR
Definition: thermo21.h:130
thermo21_t::spi
spi_master_t spi
Definition: thermo21.h:99