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 
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 #include "drv_pwm.h"
52 
73 #define BUTTONALARM_DEF_FREQ 500
74  // buttonalarm_cfg
76 
91 #define BUTTONALARM_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
93  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
94  // buttonalarm_map // buttonalarm
97 
107 typedef struct
108 {
109  digital_in_t int_pin;
111  // Modules
112  pwm_t pwm;
114  // ctx variable
115  uint32_t pwm_freq;
117 } buttonalarm_t;
118 
123 typedef struct
124 {
125  // Communication gpio pins
126  pin_name_t pwm;
128  pin_name_t int_pin;
130  // Static variable
131  uint32_t dev_pwm_freq;
134 
139 typedef enum
140 {
142  BUTTONALARM_ERROR = -1
143 
145 
162 
178 
191 err_t buttonalarm_set_duty_cycle ( buttonalarm_t *ctx, float duty_cycle );
192 
205 
218 
231 
232 #ifdef __cplusplus
233 }
234 #endif
235 #endif // BUTTONALARM_H
236  // buttonalarm
238 
239 // ------------------------------------------------------------------------ END
240 
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:131
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:109
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:124
buttonalarm_return_value_t
buttonalarm_return_value_t
Button Alarm Click return value data.
Definition: buttonalarm.h:140
buttonalarm_cfg_t::pwm
pin_name_t pwm
Definition: buttonalarm.h:126
buttonalarm_cfg_setup
void buttonalarm_cfg_setup(buttonalarm_cfg_t *cfg)
Button Alarm configuration object setup function.
BUTTONALARM_ERROR
@ BUTTONALARM_ERROR
Definition: buttonalarm.h:142
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:141
buttonalarm_t::pwm
pwm_t pwm
Definition: buttonalarm.h:112
buttonalarm_t
Button Alarm Click driver selector.
Definition: buttonalarm.h:108
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:115
buttonalarm_cfg_t::int_pin
pin_name_t int_pin
Definition: buttonalarm.h:128