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
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 
72 #define BATTERYSOURCE_ENABLE_OUTPUT 0x01
73 #define BATTERYSOURCE_DISABLE_OUTPUT 0x00
74  // batterysource_set
76 
91 #define BATTERYSOURCE_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM )
93  // batterysource_map // batterysource
96 
101 typedef struct
102 {
103  digital_out_t en;
106 
111 typedef struct
112 {
113  pin_name_t en;
116 
121 typedef enum
122 {
125 
127 
144 
159 
170 void batterysource_set_output ( batterysource_t *ctx, uint8_t output_state );
171 
172 
173 #ifdef __cplusplus
174 }
175 #endif
176 #endif // BATTERYSOURCE_H
177  // batterysource
179 
180 // ------------------------------------------------------------------------ END
BATTERYSOURCE_OK
@ BATTERYSOURCE_OK
Definition: batterysource.h:123
batterysource_cfg_t::en
pin_name_t en
Definition: batterysource.h:113
BATTERYSOURCE_ERROR
@ BATTERYSOURCE_ERROR
Definition: batterysource.h:124
batterysource_t
Battery Source Click context object.
Definition: batterysource.h:102
batterysource_cfg_t
Battery Source Click configuration object.
Definition: batterysource.h:112
batterysource_set_output
void batterysource_set_output(batterysource_t *ctx, uint8_t output_state)
Battery Source set output state function.
batterysource_cfg_setup
void batterysource_cfg_setup(batterysource_cfg_t *cfg)
Battery Source configuration object setup function.
batterysource_init
err_t batterysource_init(batterysource_t *ctx, batterysource_cfg_t *cfg)
Battery Source initialization function.
batterysource_return_value_t
batterysource_return_value_t
Battery Source Click return value data.
Definition: batterysource.h:122
batterysource_t::en
digital_out_t en
Definition: batterysource.h:103