balancer3  2.0.0.0
balancer3.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright (c) 2019, MikroElektronika - www.mikroe.com
4  * All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef BALANCER3_H
36 #define BALANCER3_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define BALANCER3_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.en= MIKROBUS( mikrobus, MIKROBUS_CS ); \
53  cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
54 
60 #define BALANCER3_RETVAL uint8_t
61 
62 #define BALANCER3_OK 0x00
63 #define BALANCER3_INIT_ERROR 0xFF
64 
70 #define BALANCER3_CELL_BALANCE_EN 0
71 #define BALANCER3_CELL_BALANCE_DIS 1
72 
78 #define BALANCER3_OV_COND_DETECTED 1
79 #define BALANCER3_OV_COND_NOT_DETECTED 0
80  // End group macro
83 // --------------------------------------------------------------- PUBLIC TYPES
92 typedef struct
93 {
94  // Output pins
95 
96  digital_out_t en;
97 
98  // Input pins
99 
100  digital_in_t int_pin;
101 
102 } balancer3_t;
103 
107 typedef struct
108 {
109  // Additional gpio pins
110 
111  pin_name_t en;
112  pin_name_t int_pin;
113 
115  // End types group
117 
118 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
119 
125 #ifdef __cplusplus
126 extern "C"{
127 #endif
128 
138 
147 
156 void balancer3_enable_cell_balance ( balancer3_t *ctx, uint8_t state );
157 
166 
167 #ifdef __cplusplus
168 }
169 #endif
170 #endif // _BALANCER3_H_
171  // End public_function group
174 
175 // ------------------------------------------------------------------------- END
balancer3_cfg_t
Click configuration structure definition.
Definition: balancer3.h:107
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:100
balancer3_check_overvoltage_cond
uint8_t balancer3_check_overvoltage_cond(balancer3_t *ctx)
Overvoltage Condition Check function.
balancer3_t
Click ctx object definition.
Definition: balancer3.h:92
BALANCER3_RETVAL
#define BALANCER3_RETVAL
Definition: balancer3.h:60
balancer3_t::en
digital_out_t en
Definition: balancer3.h:96
balancer3_cfg_setup
void balancer3_cfg_setup(balancer3_cfg_t *cfg)
Config Object Initialization function.
balancer3_init
BALANCER3_RETVAL balancer3_init(balancer3_t *ctx, balancer3_cfg_t *cfg)
Initialization function.
balancer3_cfg_t::en
pin_name_t en
Definition: balancer3.h:111
balancer3_cfg_t::int_pin
pin_name_t int_pin
Definition: balancer3.h:112