buttonalarm  2.0.0.0
buttonalarm.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 BUTTONALARM_H
29 #define BUTTONALARM_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 BUTTONALARM_DEF_FREQ 500
70  // buttonalarm_cfg
72 
87 #define BUTTONALARM_MAP_MIKROBUS( cfg, mikrobus ) \
88  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
89  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
90  // buttonalarm_map // buttonalarm
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 } buttonalarm_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;
130 
135 typedef enum
136 {
138  BUTTONALARM_ERROR = -1
139 
141 
158 
174 
187 err_t buttonalarm_set_duty_cycle ( buttonalarm_t *ctx, float duty_cycle );
188 
201 
214 
227 
228 #ifdef __cplusplus
229 }
230 #endif
231 #endif // BUTTONALARM_H
232  // buttonalarm
234 
235 // ------------------------------------------------------------------------ END
236 
buttonalarm_init
err_t buttonalarm_init(buttonalarm_t *ctx, buttonalarm_cfg_t *cfg)
Button Alarm initialization function.
buttonalarm_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: buttonalarm.h:127
buttonalarm_pwm_stop
err_t buttonalarm_pwm_stop(buttonalarm_t *ctx)
Button Alarm stop PWM module.
buttonalarm_t::int_pin
digital_in_t int_pin
Definition: buttonalarm.h:105
buttonalarm_set_duty_cycle
err_t buttonalarm_set_duty_cycle(buttonalarm_t *ctx, float duty_cycle)
Button Alarm sets PWM duty cycle.
buttonalarm_cfg_t
Button Alarm Click configuration object.
Definition: buttonalarm.h:120
buttonalarm_return_value_t
buttonalarm_return_value_t
Button Alarm Click return value data.
Definition: buttonalarm.h:136
buttonalarm_cfg_t::pwm
pin_name_t pwm
Definition: buttonalarm.h:122
buttonalarm_cfg_setup
void buttonalarm_cfg_setup(buttonalarm_cfg_t *cfg)
Button Alarm configuration object setup function.
BUTTONALARM_ERROR
@ BUTTONALARM_ERROR
Definition: buttonalarm.h:138
buttonalarm_get_button_state
uint8_t buttonalarm_get_button_state(buttonalarm_t *ctx)
Button Alarm get button state function.
BUTTONALARM_OK
@ BUTTONALARM_OK
Definition: buttonalarm.h:137
buttonalarm_t::pwm
pwm_t pwm
Definition: buttonalarm.h:108
buttonalarm_t
Button Alarm Click driver selector.
Definition: buttonalarm.h:104
buttonalarm_pwm_start
err_t buttonalarm_pwm_start(buttonalarm_t *ctx)
Button Alarm start PWM module.
buttonalarm_t::pwm_freq
uint32_t pwm_freq
Definition: buttonalarm.h:111
buttonalarm_cfg_t::int_pin
pin_name_t int_pin
Definition: buttonalarm.h:124