thermo16 2.0.0.0
thermo16.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
34#ifndef THERMO16_H
35#define THERMO16_H
36
37#include "drv_analog_in.h"
38
39// -------------------------------------------------------------- PUBLIC MACROS
40
50#define THERMO16_MAP_MIKROBUS( cfg, mikrobus ) \
51 cfg.an_pin = MIKROBUS( mikrobus, MIKROBUS_AN )
58#define THERMO16_RETVAL uint8_t
59
60#define THERMO16_OK 0x00
61#define THERMO16_INIT_ERROR 0xFF
68#define THERMO16_TEMP_IN_CELSIUS 0x00
69#define THERMO16_TEMP_IN_KELVIN 0x01
70#define THERMO16_TEMP_IN_FAHRENHEIT 0x02 // End group macro
74// --------------------------------------------------------------- PUBLIC TYPES
83typedef uint16_t thermo16_data_t;
84
88typedef struct
89{
90 // Modules
91
92 analog_in_t adc;
93 analog_in_resolution_t adc_res;
94
96
100typedef struct
101{
102 // Communication gpio pins
103
104 pin_name_t an_pin;
105
106 // static variable
107
108 analog_in_resolution_t resolution; // Resolution
109 float vref; // VRef
110
112 // End types group
114// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
115
121#ifdef __cplusplus
122extern "C"{
123#endif
124
134
144
154
164float thermo16_get_temperature ( thermo16_t *ctx, uint8_t temp_format );
165
166
167#ifdef __cplusplus
168}
169#endif
170#endif // _THERMO16_H_
171 // End public_function group
174
175// ------------------------------------------------------------------------ END
#define THERMO16_RETVAL
Definition: thermo16.h:58
thermo16_data_t thermo16_generic_read(thermo16_t *ctx)
Generic read function.
float thermo16_get_temperature(thermo16_t *ctx, uint8_t temp_format)
Temperature function.
void thermo16_cfg_setup(thermo16_cfg_t *cfg)
Config Object Initialization function.
THERMO16_RETVAL thermo16_init(thermo16_t *ctx, thermo16_cfg_t *cfg)
Initialization function.
uint16_t thermo16_data_t
Analog data type.
Definition: thermo16.h:83
Click configuration structure definition.
Definition: thermo16.h:101
analog_in_resolution_t resolution
Definition: thermo16.h:108
float vref
Definition: thermo16.h:109
pin_name_t an_pin
Definition: thermo16.h:104
Click ctx object definition.
Definition: thermo16.h:89
analog_in_resolution_t adc_res
Definition: thermo16.h:93
analog_in_t adc
Definition: thermo16.h:92