charger27  2.1.0.0
charger27.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef CHARGER27_H
29 #define CHARGER27_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 
63 #define CHARGER27_MODE_CHARGE 0
64 #define CHARGER27_MODE_DISCHARGE 1
65 
70 #define CHARGER27_AOK_ERROR 0
71 #define CHARGER27_AOK_GOOD_SOURCE 1
72 
77 #define CHARGER27_CHG_CHARGE 0
78 #define CHARGER27_CHG_COMPL_OR_SUS 1
79  // charger27_set
81 
96 #define CHARGER27_MAP_MIKROBUS( cfg, mikrobus ) \
97  cfg.aok = MIKROBUS( mikrobus, MIKROBUS_AN ); \
98  cfg.md = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
99  cfg.chg = MIKROBUS( mikrobus, MIKROBUS_INT )
100  // charger27_map // charger27
103 
108 typedef struct
109 {
110  digital_out_t md;
112  digital_in_t aok;
113  digital_in_t chg;
115 } charger27_t;
116 
121 typedef struct
122 {
123  pin_name_t aok;
124  pin_name_t md;
125  pin_name_t chg;
128 
133 typedef enum
134 {
136  CHARGER27_ERROR = -1
137 
139 
156 
171 
186 
201 err_t charger27_set_mode ( charger27_t *ctx, uint8_t mode );
202 
217 
218 #ifdef __cplusplus
219 }
220 #endif
221 #endif // CHARGER27_H
222  // charger27
224 
225 // ------------------------------------------------------------------------ END
charger27_cfg_t
Charger 27 Click configuration object.
Definition: charger27.h:122
charger27_t
Charger 27 Click context object.
Definition: charger27.h:109
charger27_check_chg_completion
uint8_t charger27_check_chg_completion(charger27_t *ctx)
Charger 27 checks charging completion indicator function.
charger27_cfg_t::aok
pin_name_t aok
Definition: charger27.h:123
CHARGER27_OK
@ CHARGER27_OK
Definition: charger27.h:135
charger27_t::aok
digital_in_t aok
Definition: charger27.h:112
charger27_set_mode
err_t charger27_set_mode(charger27_t *ctx, uint8_t mode)
Charger 27 sets the operating mode function.
charger27_init
err_t charger27_init(charger27_t *ctx, charger27_cfg_t *cfg)
Charger 27 initialization function.
charger27_cfg_setup
void charger27_cfg_setup(charger27_cfg_t *cfg)
Charger 27 configuration object setup function.
charger27_check_input_supply
uint8_t charger27_check_input_supply(charger27_t *ctx)
Charger 27 checks valid input supply indicator function.
charger27_cfg_t::md
pin_name_t md
Definition: charger27.h:124
CHARGER27_ERROR
@ CHARGER27_ERROR
Definition: charger27.h:136
charger27_cfg_t::chg
pin_name_t chg
Definition: charger27.h:125
charger27_t::md
digital_out_t md
Definition: charger27.h:110
charger27_t::chg
digital_in_t chg
Definition: charger27.h:113
charger27_return_value_t
charger27_return_value_t
Charger 27 Click return value data.
Definition: charger27.h:134