ambient7  2.0.0.0
ambient7.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 
35 #ifndef AMBIENT7_H
36 #define AMBIENT7_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_analog_in.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
43 
53 #define AMBIENT7_MAP_MIKROBUS( cfg, mikrobus ) \
54  cfg.an_pin = MIKROBUS( mikrobus, MIKROBUS_AN )
55 
61 #define AMBIENT7_RETVAL uint8_t
62 
63 #define AMBIENT7_OK 0x00
64 #define AMBIENT7_INIT_ERROR 0xFF
65  // End group macro
68 // --------------------------------------------------------------- PUBLIC TYPES
77 typedef uint16_t ambient7_data_t;
78 
82 typedef struct
83 {
84  // Modules
85 
86  analog_in_t adc;
87 
88 } ambient7_t;
89 
93 typedef struct
94 {
95  // Communication gpio pins
96 
97  pin_name_t an_pin;
98 
99  // static variable
100 
101  analog_in_resolution_t resolution; // Resolution
102  float vref; // VRef
103 
105  // End types group
107 
108 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
109 
115 #ifdef __cplusplus
116 extern "C"{
117 #endif
118 
128 
138 
148 
149 
150 #ifdef __cplusplus
151 }
152 #endif
153 #endif // _AMBIENT7_H_
154  // End public_function group
157 
158 // ------------------------------------------------------------------------ END
ambient7_cfg_t::an_pin
pin_name_t an_pin
Definition: ambient7.h:97
ambient7_generic_read
ambient7_data_t ambient7_generic_read(ambient7_t *ctx)
Generic read function.
ambient7_cfg_t::resolution
analog_in_resolution_t resolution
Definition: ambient7.h:101
ambient7_cfg_t
Click configuration structure definition.
Definition: ambient7.h:94
ambient7_t::adc
analog_in_t adc
Definition: ambient7.h:86
AMBIENT7_RETVAL
#define AMBIENT7_RETVAL
Definition: ambient7.h:61
ambient7_cfg_t::vref
float vref
Definition: ambient7.h:102
ambient7_t
Click ctx object definition.
Definition: ambient7.h:83
ambient7_cfg_setup
void ambient7_cfg_setup(ambient7_cfg_t *cfg)
Config Object Initialization function.
ambient7_init
AMBIENT7_RETVAL ambient7_init(ambient7_t *ctx, ambient7_cfg_t *cfg)
Initialization function.
ambient7_data_t
uint16_t ambient7_data_t
Analog data type.
Definition: ambient7.h:77