solarenergy  2.0.0.0
solarenergy.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 SOLARENERGY_H
36 #define SOLARENERGY_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define SOLARENERGY_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.out= MIKROBUS( mikrobus, MIKROBUS_AN ); \
53  cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
54  cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT )
55 
61 #define SOLARENERGY_RETVAL uint8_t
62 
63 #define SOLARENERGY_OK 0x00
64 #define SOLARENERGY_INIT_ERROR 0xFF
65  // End group macro
68 // --------------------------------------------------------------- PUBLIC TYPES
77 typedef struct
78 {
79  // Output pins
80 
81  digital_out_t en;
82 
83  // Input pins
84 
85  digital_in_t out;
86  digital_in_t int_pin;
87 
89 
93 typedef struct
94 {
95  // Additional gpio pins
96 
97  pin_name_t out;
98  pin_name_t en;
99  pin_name_t int_pin;
100 
102  // End types group
104 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
105 
111 #ifdef __cplusplus
112 extern "C"{
113 #endif
114 
124 
133 
143 
153 
168 
169 #ifdef __cplusplus
170 }
171 #endif
172 #endif // _SOLARENERGY_H_
173  // End public_function group
176 
177 // ------------------------------------------------------------------------- END
solarenergy_cfg_t::out
pin_name_t out
Definition: solarenergy.h:97
solarenergy_cfg_t
Click configuration structure definition.
Definition: solarenergy.h:93
solarenergy_t::out
digital_in_t out
Definition: solarenergy.h:85
solarenergy_check_indicator
uint8_t solarenergy_check_indicator(solarenergy_t *ctx)
Battery good indicator functions.
solarenergy_t
Click ctx object definition.
Definition: solarenergy.h:77
solarenergy_init
SOLARENERGY_RETVAL solarenergy_init(solarenergy_t *ctx, solarenergy_cfg_t *cfg)
Initialization function.
solarenergy_charge_disable
void solarenergy_charge_disable(solarenergy_t *ctx)
Charge disable functions.
solarenergy_t::int_pin
digital_in_t int_pin
Definition: solarenergy.h:86
solarenergy_t::en
digital_out_t en
Definition: solarenergy.h:81
solarenergy_cfg_t::en
pin_name_t en
Definition: solarenergy.h:98
solarenergy_charge_enable
void solarenergy_charge_enable(solarenergy_t *ctx)
Charge enable function.
solarenergy_cfg_t::int_pin
pin_name_t int_pin
Definition: solarenergy.h:99
solarenergy_cfg_setup
void solarenergy_cfg_setup(solarenergy_cfg_t *cfg)
Config Object Initialization function.
SOLARENERGY_RETVAL
#define SOLARENERGY_RETVAL
Definition: solarenergy.h:61