buttonplay  2.0.0.0
buttonplay.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 BUTTONPLAY_H
29 #define BUTTONPLAY_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 BUTTONPLAY_DEF_FREQ 500
60  // buttonplay_cfg
62 
77 #define BUTTONPLAY_MAP_MIKROBUS( cfg, mikrobus ) \
78  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
79  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
80  // buttonplay_map // buttonplay
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 } buttonplay_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  BUTTONPLAY_ERROR = -1
129 
131 
148 
164 
177 err_t buttonplay_set_duty_cycle ( buttonplay_t *ctx, float duty_cycle );
178 
191 
204 
217 
218 #ifdef __cplusplus
219 }
220 #endif
221 #endif // BUTTONPLAY_H
222  // buttonplay
224 
225 // ------------------------------------------------------------------------ END
BUTTONPLAY_ERROR
@ BUTTONPLAY_ERROR
Definition: buttonplay.h:128
buttonplay_get_button_state
uint8_t buttonplay_get_button_state(buttonplay_t *ctx)
Button Play get button state function.
buttonplay_t
Button Play Click driver selector.
Definition: buttonplay.h:94
buttonplay_pwm_stop
err_t buttonplay_pwm_stop(buttonplay_t *ctx)
Button Play stop PWM module.
buttonplay_cfg_t::int_pin
pin_name_t int_pin
Definition: buttonplay.h:114
buttonplay_t::pwm_freq
uint32_t pwm_freq
Definition: buttonplay.h:101
buttonplay_cfg_t::pwm
pin_name_t pwm
Definition: buttonplay.h:112
BUTTONPLAY_OK
@ BUTTONPLAY_OK
Definition: buttonplay.h:127
buttonplay_pwm_start
err_t buttonplay_pwm_start(buttonplay_t *ctx)
Button Play start PWM module.
buttonplay_t::pwm
pwm_t pwm
Definition: buttonplay.h:98
buttonplay_cfg_t
Button Play Click configuration object.
Definition: buttonplay.h:110
buttonplay_set_duty_cycle
err_t buttonplay_set_duty_cycle(buttonplay_t *ctx, float duty_cycle)
Button Play sets PWM duty cycle.
buttonplay_t::int_pin
digital_in_t int_pin
Definition: buttonplay.h:95
buttonplay_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: buttonplay.h:117
buttonplay_init
err_t buttonplay_init(buttonplay_t *ctx, buttonplay_cfg_t *cfg)
Button Play initialization function.
buttonplay_cfg_setup
void buttonplay_cfg_setup(buttonplay_cfg_t *cfg)
Button Play configuration object setup function.
buttonplay_return_value_t
buttonplay_return_value_t
Button Play Click return value data.
Definition: buttonplay.h:126