buttonpower  2.0.0.0
buttonpower.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 BUTTONPOWER_H
29 #define BUTTONPOWER_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_pwm.h"
38 
59 #define BUTTONPOWER_DEF_FREQ 500
60  // buttonpower_cfg
62 
77 #define BUTTONPOWER_MAP_MIKROBUS( cfg, mikrobus ) \
78  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
79  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
80  // buttonpower_map // buttonpower
83 
93 typedef struct
94 {
95  digital_in_t int_pin;
97  // Modules
98  pwm_t pwm;
100  // ctx variable
101  uint32_t pwm_freq;
103 } buttonpower_t;
104 
109 typedef struct
110 {
111  // Communication gpio pins
112  pin_name_t pwm;
114  pin_name_t int_pin;
116  // Static variable
117  uint32_t dev_pwm_freq;
120 
125 typedef enum
126 {
128  BUTTONPOWER_ERROR = -1
129 
131 
148 
164 
177 err_t buttonpower_set_duty_cycle ( buttonpower_t *ctx, float duty_cycle );
178 
190 err_t buttonpower_pwm_stop ( buttonpower_t *ctx );
191 
203 err_t buttonpower_pwm_start ( buttonpower_t *ctx );
204 
217 
218 #ifdef __cplusplus
219 }
220 #endif
221 #endif // BUTTONPOWER_H
222  // buttonpower
224 
225 // ------------------------------------------------------------------------ END
buttonpower_cfg_t
Button Power Click configuration object.
Definition: buttonpower.h:108
buttonpower_pwm_start
err_t buttonpower_pwm_start(buttonpower_t *ctx)
Button Power start PWM module.
buttonpower_t
Button Power Click driver selector.
Definition: buttonpower.h:92
BUTTONPOWER_OK
Definition: buttonpower.h:126
BUTTONPOWER_ERROR
Definition: buttonpower.h:127
buttonpower_cfg_setup
void buttonpower_cfg_setup(buttonpower_cfg_t *cfg)
Button Power configuration object setup function.
buttonpower_return_value_t
buttonpower_return_value_t
Button Power Click return value data.
Definition: buttonpower.h:124
buttonpower_set_duty_cycle
err_t buttonpower_set_duty_cycle(buttonpower_t *ctx, float duty_cycle)
Button Power sets PWM duty cycle.
buttonpower_get_button_state
uint8_t buttonpower_get_button_state(buttonpower_t *ctx)
Button Power get button state function.
buttonpower_pwm_stop
err_t buttonpower_pwm_stop(buttonpower_t *ctx)
Button Power stop PWM module.
buttonpower_init
err_t buttonpower_init(buttonpower_t *ctx, buttonpower_cfg_t *cfg)
Button Power initialization function.