buttonr  2.0.0.0
buttonr.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 BUTTONR_H
29 #define BUTTONR_H
30 
31 #ifdef __cplusplus
32 extern "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 #include "drv_pwm.h"
48 
69 #define BUTTONR_DEF_FREQ 500
70  // buttonr_cfg
72 
87 #define BUTTONR_MAP_MIKROBUS( cfg, mikrobus ) \
88  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
89  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
90  // buttonr_map // buttonr
93 
103 typedef struct
104 {
105  digital_in_t int_pin;
107  // Modules
108  pwm_t pwm;
110  // ctx variable
111  uint32_t pwm_freq;
113 } buttonr_t;
114 
119 typedef struct
120 {
121  // Communication gpio pins
122  pin_name_t pwm;
124  pin_name_t int_pin;
126  // Static variable
127  uint32_t dev_pwm_freq;
129 } buttonr_cfg_t;
130 
135 typedef enum
136 {
138  BUTTONR_ERROR = -1
139 
141 
158 
173 err_t buttonr_init ( buttonr_t *ctx, buttonr_cfg_t *cfg );
174 
187 err_t buttonr_set_duty_cycle ( buttonr_t *ctx, float duty_cycle );
188 
201 
214 
227 
228 #ifdef __cplusplus
229 }
230 #endif
231 #endif // BUTTONR_H
232  // buttonr
234 
235 // ------------------------------------------------------------------------ END
buttonr_get_button_state
uint8_t buttonr_get_button_state(buttonr_t *ctx)
Button R get button state function.
BUTTONR_OK
@ BUTTONR_OK
Definition: buttonr.h:137
buttonr_pwm_start
err_t buttonr_pwm_start(buttonr_t *ctx)
Button R start PWM module.
buttonr_pwm_stop
err_t buttonr_pwm_stop(buttonr_t *ctx)
Button R stop PWM module.
buttonr_set_duty_cycle
err_t buttonr_set_duty_cycle(buttonr_t *ctx, float duty_cycle)
Button R sets PWM duty cycle.
buttonr_t::pwm
pwm_t pwm
Definition: buttonr.h:108
buttonr_t::pwm_freq
uint32_t pwm_freq
Definition: buttonr.h:111
buttonr_cfg_t::int_pin
pin_name_t int_pin
Definition: buttonr.h:124
buttonr_cfg_t
Button R Click configuration object.
Definition: buttonr.h:120
buttonr_init
err_t buttonr_init(buttonr_t *ctx, buttonr_cfg_t *cfg)
Button R initialization function.
buttonr_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: buttonr.h:127
buttonr_t
Button R Click driver selector.
Definition: buttonr.h:104
buttonr_cfg_setup
void buttonr_cfg_setup(buttonr_cfg_t *cfg)
Button R configuration object setup function.
buttonr_cfg_t::pwm
pin_name_t pwm
Definition: buttonr.h:122
buttonr_return_value_t
buttonr_return_value_t
Button R Click return value data.
Definition: buttonr.h:136
BUTTONR_ERROR
@ BUTTONR_ERROR
Definition: buttonr.h:138
buttonr_t::int_pin
digital_in_t int_pin
Definition: buttonr.h:105