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 "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define BATTMAN_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.chg = MIKROBUS( mikrobus, MIKROBUS_AN ); \
63  cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST ); \
64  cfg.flt = MIKROBUS( mikrobus, MIKROBUS_INT )
65 
71 #define BATTMAN_RETVAL uint8_t
72 
73 #define BATTMAN_OK 0x00
74 #define BATTMAN_INIT_ERROR 0xFF
75  // End group macro
78 // --------------------------------------------------------------- PUBLIC TYPES
87 typedef struct
88 {
89  // Output pins
90 
91  digital_out_t en;
92 
93  // Input pins
94 
95  digital_in_t chg;
96  digital_in_t flt;
97 
98 } battman_t;
99 
103 typedef struct
104 {
105  // Additional gpio pins
106 
107  pin_name_t chg;
108  pin_name_t en;
109  pin_name_t flt;
110 
111 } battman_cfg_t;
112  // End types group
114 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
115 
121 #ifdef __cplusplus
122 extern "C"{
123 #endif
124 
134 
144 
153 void battman_set_enable ( battman_t *ctx, uint8_t state );
154 
165 
176 
177 
178 #ifdef __cplusplus
179 }
180 #endif
181 #endif // _BATTMAN_H_
182  // End public_function group
185 
186 // ------------------------------------------------------------------------- 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:88
battman_cfg_t
Click configuration structure definition.
Definition: battman.h:104
battman_get_fault_indicator
uint8_t battman_get_fault_indicator(battman_t *ctx)
Fault indicator status.
BATTMAN_RETVAL
#define BATTMAN_RETVAL
Definition: battman.h:71
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:109
battman_t::chg
digital_in_t chg
Definition: battman.h:95
battman_cfg_t::chg
pin_name_t chg
Definition: battman.h:107
battman_t::en
digital_out_t en
Definition: battman.h:91
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:96
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:108