batterysource 2.1.0.0
batterysource.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 BATTERYSOURCE_H
29#define BATTERYSOURCE_H
30
31#ifdef __cplusplus
32extern "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
68#define BATTERYSOURCE_ENABLE_OUTPUT 0x01
69#define BATTERYSOURCE_DISABLE_OUTPUT 0x00
70 // batterysource_set
72
87#define BATTERYSOURCE_MAP_MIKROBUS( cfg, mikrobus ) \
88 cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM )
89 // batterysource_map // batterysource
92
97typedef struct
98{
99 digital_out_t en;
102
107typedef struct
108{
109 pin_name_t en;
112
117typedef enum
118{
121
123
140
155
166void batterysource_set_output ( batterysource_t *ctx, uint8_t output_state );
167
168
169#ifdef __cplusplus
170}
171#endif
172#endif // BATTERYSOURCE_H
173 // batterysource
175
176// ------------------------------------------------------------------------ END
batterysource_return_value_t
Battery Source Click return value data.
Definition: batterysource.h:118
@ BATTERYSOURCE_OK
Definition: batterysource.h:119
@ BATTERYSOURCE_ERROR
Definition: batterysource.h:120
void batterysource_cfg_setup(batterysource_cfg_t *cfg)
Battery Source configuration object setup function.
err_t batterysource_init(batterysource_t *ctx, batterysource_cfg_t *cfg)
Battery Source initialization function.
void batterysource_set_output(batterysource_t *ctx, uint8_t output_state)
Battery Source set output state function.
Battery Source Click configuration object.
Definition: batterysource.h:108
pin_name_t en
Definition: batterysource.h:109
Battery Source Click context object.
Definition: batterysource.h:98
digital_out_t en
Definition: batterysource.h:99