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 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 
55 // -------------------------------------------------------------- PUBLIC MACROS
65 #define BATTMAN_MAP_MIKROBUS( cfg, mikrobus ) \
66  cfg.chg = MIKROBUS( mikrobus, MIKROBUS_AN ); \
67  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
68  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
69 
75 #define BATTMAN_RETVAL uint8_t
76 
77 #define BATTMAN_OK 0x00
78 #define BATTMAN_INIT_ERROR 0xFF
79  // End group macro
82 // --------------------------------------------------------------- PUBLIC TYPES
91 typedef struct
92 {
93  // Output pins
94 
95  digital_out_t en;
96 
97  // Input pins
98 
99  digital_in_t chg;
100  digital_in_t flt;
101 
102 } battman_t;
103 
107 typedef struct
108 {
109  // Additional gpio pins
110 
111  pin_name_t chg;
112  pin_name_t en;
113  pin_name_t flt;
114 
115 } battman_cfg_t;
116  // End types group
118 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
119 
125 #ifdef __cplusplus
126 extern "C"{
127 #endif
128 
138 
148 
157 void battman_set_enable ( battman_t *ctx, uint8_t state );
158 
169 
180 
181 
182 #ifdef __cplusplus
183 }
184 #endif
185 #endif // _BATTMAN_H_
186  // End public_function group
189 
190 // ------------------------------------------------------------------------- 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:92
battman_cfg_t
Click configuration structure definition.
Definition: battman.h:108
battman_get_fault_indicator
uint8_t battman_get_fault_indicator(battman_t *ctx)
Fault indicator status.
BATTMAN_RETVAL
#define BATTMAN_RETVAL
Definition: battman.h:75
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:113
battman_t::chg
digital_in_t chg
Definition: battman.h:99
battman_cfg_t::chg
pin_name_t chg
Definition: battman.h:111
battman_t::en
digital_out_t en
Definition: battman.h:95
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:100
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:112