battman  2.0.0.0
battman.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 BATTMAN_H
36 #define BATTMAN_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define BATTMAN_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.chg = MIKROBUS( mikrobus, MIKROBUS_AN ); \
53  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
54  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
55 
61 #define BATTMAN_RETVAL uint8_t
62 
63 #define BATTMAN_OK 0x00
64 #define BATTMAN_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 chg;
86  digital_in_t flt;
87 
88 } battman_t;
89 
93 typedef struct
94 {
95  // Additional gpio pins
96 
97  pin_name_t chg;
98  pin_name_t en;
99  pin_name_t flt;
100 
101 } battman_cfg_t;
102  // End types group
104 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
105 
111 #ifdef __cplusplus
112 extern "C"{
113 #endif
114 
123 void battman_cfg_setup ( battman_cfg_t *cfg );
124 
134 
143 void battman_set_enable ( battman_t *ctx, uint8_t state );
144 
155 
165 uint8_t battman_get_fault_indicator ( battman_t *ctx );
166 
167 
168 #ifdef __cplusplus
169 }
170 #endif
171 #endif // _BATTMAN_H_
172  // End public_function group
175 
176 // ------------------------------------------------------------------------- END
battman_init
BATTMAN_RETVAL battman_init(battman_t *ctx, battman_cfg_t *cfg)
Initialization function.
battman_t
Click ctx object definition.
Definition: battman.h:77
battman_cfg_t
Click configuration structure definition.
Definition: battman.h:93
battman_get_fault_indicator
uint8_t battman_get_fault_indicator(battman_t *ctx)
Fault indicator status.
BATTMAN_RETVAL
#define BATTMAN_RETVAL
Definition: battman.h:61
battman_cfg_setup
void battman_cfg_setup(battman_cfg_t *cfg)
Config Object Initialization function.
battman_cfg_t::flt
pin_name_t flt
Definition: battman.h:99
battman_t::chg
digital_in_t chg
Definition: battman.h:85
battman_cfg_t::chg
pin_name_t chg
Definition: battman.h:97
battman_t::en
digital_out_t en
Definition: battman.h:81
battman_set_enable
void battman_set_enable(battman_t *ctx, uint8_t state)
Enable/Disable control.
battman_t::flt
digital_in_t flt
Definition: battman.h:86
battman_get_charging_indicator
uint8_t battman_get_charging_indicator(battman_t *ctx)
Charging indicator status.
battman_cfg_t::en
pin_name_t en
Definition: battman.h:98