charger13 2.0.0.0
charger13.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 CHARGER13_H
36#define CHARGER13_H
37
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40
41// -------------------------------------------------------------- PUBLIC MACROS
51#define CHARGER13_MAP_MIKROBUS( cfg, mikrobus ) \
52 cfg.en= MIKROBUS( mikrobus, MIKROBUS_PWM ); \
53 cfg.int_pin= MIKROBUS( mikrobus, MIKROBUS_INT );
60#define CHARGER13_RETVAL uint8_t
61
62#define CHARGER13_OK 0x00
63#define CHARGER13_INIT_ERROR 0xFF // End group macro
67// --------------------------------------------------------------- PUBLIC TYPES
76typedef struct
77{
78 // Output pins
79
80 digital_out_t en;
81
82 // Input pins
83
84 digital_in_t int_pin;
85
87
91typedef struct
92{
93 // Additional gpio pins
94
95 pin_name_t en;
96 pin_name_t int_pin;
97
99 // End types group
101// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
102
108#ifdef __cplusplus
109extern "C"{
110#endif
111
121
130
141
152
162
163#ifdef __cplusplus
164}
165#endif
166#endif // _CHARGER13_H_
167 // End public_function group
170
171// ------------------------------------------------------------------------- END
#define CHARGER13_RETVAL
Definition: charger13.h:60
void charger13_enable(charger13_t *ctx)
Enabled charging function.
void charger13_disable(charger13_t *ctx)
Disabled charging function.
CHARGER13_RETVAL charger13_init(charger13_t *ctx, charger13_cfg_t *cfg)
Initialization function.
void charger13_cfg_setup(charger13_cfg_t *cfg)
Config Object Initialization function.
uint8_t charger13_check(charger13_t *ctx)
Check battery charging function.
Click configuration structure definition.
Definition: charger13.h:92
pin_name_t en
Definition: charger13.h:95
pin_name_t int_pin
Definition: charger13.h:96
Click ctx object definition.
Definition: charger13.h:77
digital_in_t int_pin
Definition: charger13.h:84
digital_out_t en
Definition: charger13.h:80