balancer3  2.0.0.0
balancer3.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 BALANCER3_H
36 #define BALANCER3_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 BALANCER3_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
63  cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
64 
70 #define BALANCER3_OK 0
71 #define BALANCER3_ERROR -1
72 
78 #define BALANCER3_CELL_BALANCE_EN 0
79 #define BALANCER3_CELL_BALANCE_DIS 1
80 
86 #define BALANCER3_OV_COND_DETECTED 1
87 #define BALANCER3_OV_COND_NOT_DETECTED 0
88  // End group macro
91 // --------------------------------------------------------------- PUBLIC TYPES
100 typedef struct
101 {
102  // Output pins
103  digital_out_t en;
104 
105  // Input pins
106  digital_in_t int_pin;
107 
108 } balancer3_t;
109 
113 typedef struct
114 {
115  // Additional gpio pins
116  pin_name_t en;
117  pin_name_t int_pin;
118 
120  // End types group
122 
123 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
124 
130 #ifdef __cplusplus
131 extern "C"{
132 #endif
133 
143 
152 
161 void balancer3_enable_cell_balance ( balancer3_t *ctx, uint8_t state );
162 
171 
172 #ifdef __cplusplus
173 }
174 #endif
175 #endif // _BALANCER3_H_
176  // End public_function group
179 
180 // ------------------------------------------------------------------------- END
balancer3_cfg_t
Click configuration structure definition.
Definition: balancer3.h:114
balancer3_enable_cell_balance
void balancer3_enable_cell_balance(balancer3_t *ctx, uint8_t state)
Cell Balance Enable function.
balancer3_t::int_pin
digital_in_t int_pin
Definition: balancer3.h:106
balancer3_check_overvoltage
uint8_t balancer3_check_overvoltage(balancer3_t *ctx)
Overvoltage Condition Check function.
balancer3_t
Click ctx object definition.
Definition: balancer3.h:101
balancer3_t::en
digital_out_t en
Definition: balancer3.h:103
balancer3_cfg_setup
void balancer3_cfg_setup(balancer3_cfg_t *cfg)
Config Object Initialization function.
balancer3_cfg_t::en
pin_name_t en
Definition: balancer3.h:116
balancer3_cfg_t::int_pin
pin_name_t int_pin
Definition: balancer3.h:117
balancer3_init
err_t balancer3_init(balancer3_t *ctx, balancer3_cfg_t *cfg)
Initialization function.