vibromotor  2.0.0.0
vibromotor.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 VIBROMOTOR_H
29 #define VIBROMOTOR_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 VIBROMOTOR_DEF_FREQ 5000
74  // vibromotor_cfg
76 
91 #define VIBROMOTOR_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
93  // vibromotor_map // vibromotor
96 
106 typedef struct
107 {
108  // Modules
109  pwm_t pwm;
111  // ctx variable
112  uint32_t pwm_freq;
114 } vibromotor_t;
115 
120 typedef struct
121 {
122  // Communication gpio pins
123  pin_name_t pwm;
125  // Static variable
126  uint32_t dev_pwm_freq;
129 
134 typedef enum
135 {
137  VIBROMOTOR_ERROR = -1
138 
140 
157 
173 
186 err_t vibromotor_set_duty_cycle ( vibromotor_t *ctx, float duty_cycle );
187 
200 
213 
214 #ifdef __cplusplus
215 }
216 #endif
217 #endif // VIBROMOTOR_H
218  // vibromotor
220 
221 // ------------------------------------------------------------------------ END
vibromotor_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: vibromotor.h:126
vibromotor_cfg_setup
void vibromotor_cfg_setup(vibromotor_cfg_t *cfg)
Vibro Motor configuration object setup function.
VIBROMOTOR_ERROR
@ VIBROMOTOR_ERROR
Definition: vibromotor.h:137
vibromotor_t
Vibro Motor Click driver selector.
Definition: vibromotor.h:107
vibromotor_cfg_t
Vibro Motor Click configuration object.
Definition: vibromotor.h:121
vibromotor_pwm_start
err_t vibromotor_pwm_start(vibromotor_t *ctx)
Vibro Motor start PWM module.
vibromotor_t::pwm
pwm_t pwm
Definition: vibromotor.h:109
vibromotor_cfg_t::pwm
pin_name_t pwm
Definition: vibromotor.h:123
vibromotor_set_duty_cycle
err_t vibromotor_set_duty_cycle(vibromotor_t *ctx, float duty_cycle)
Vibro Motor sets PWM duty cycle.
VIBROMOTOR_OK
@ VIBROMOTOR_OK
Definition: vibromotor.h:136
vibromotor_t::pwm_freq
uint32_t pwm_freq
Definition: vibromotor.h:112
vibromotor_return_value_t
vibromotor_return_value_t
Vibro Motor Click return value data.
Definition: vibromotor.h:135
vibromotor_init
err_t vibromotor_init(vibromotor_t *ctx, vibromotor_cfg_t *cfg)
Vibro Motor initialization function.
vibromotor_pwm_stop
err_t vibromotor_pwm_stop(vibromotor_t *ctx)
Vibro Motor stop PWM module.