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 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_pwm.h"
38 
59 #define VIBROMOTOR_DEF_FREQ 5000
60  // vibromotor_cfg
62 
77 #define VIBROMOTOR_MAP_MIKROBUS( cfg, mikrobus ) \
78  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
79  // vibromotor_map // vibromotor
82 
92 typedef struct
93 {
94  // Modules
95  pwm_t pwm;
97  // ctx variable
98  uint32_t pwm_freq;
100 } vibromotor_t;
101 
106 typedef struct
107 {
108  // Communication gpio pins
109  pin_name_t pwm;
111  // Static variable
112  uint32_t dev_pwm_freq;
115 
120 typedef enum
121 {
123  VIBROMOTOR_ERROR = -1
124 
126 
143 
158 err_t vibromotor_init ( vibromotor_t *ctx, vibromotor_cfg_t *cfg );
159 
172 err_t vibromotor_set_duty_cycle ( vibromotor_t *ctx, float duty_cycle );
173 
185 err_t vibromotor_pwm_stop ( vibromotor_t *ctx );
186 
198 err_t vibromotor_pwm_start ( vibromotor_t *ctx );
199 
200 #ifdef __cplusplus
201 }
202 #endif
203 #endif // VIBROMOTOR_H
204  // vibromotor
206 
207 // ------------------------------------------------------------------------ END
vibromotor_cfg_setup
void vibromotor_cfg_setup(vibromotor_cfg_t *cfg)
Vibro Motor configuration object setup function.
VIBROMOTOR_ERROR
Definition: vibromotor.h:122
vibromotor_t
Vibro Motor Click driver selector.
Definition: vibromotor.h:91
vibromotor_cfg_t
Vibro Motor Click configuration object.
Definition: vibromotor.h:105
vibromotor_pwm_start
err_t vibromotor_pwm_start(vibromotor_t *ctx)
Vibro Motor start PWM module.
vibromotor_set_duty_cycle
err_t vibromotor_set_duty_cycle(vibromotor_t *ctx, float duty_cycle)
Vibro Motor sets PWM duty cycle.
VIBROMOTOR_OK
Definition: vibromotor.h:121
vibromotor_return_value_t
vibromotor_return_value_t
Vibro Motor Click return value data.
Definition: vibromotor.h:119
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.