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
32extern "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
92typedef struct
93{
94 // Modules
95 pwm_t pwm;
97 // ctx variable
98 uint32_t pwm_freq;
101
106typedef struct
107{
108 // Communication gpio pins
109 pin_name_t pwm;
111 // Static variable
112 uint32_t dev_pwm_freq;
115
120typedef enum
121{
124
126
143
159
172err_t vibromotor_set_duty_cycle ( vibromotor_t *ctx, float duty_cycle );
173
186
199
200#ifdef __cplusplus
201}
202#endif
203#endif // VIBROMOTOR_H
204 // vibromotor
206
207// ------------------------------------------------------------------------ END
err_t vibromotor_pwm_stop(vibromotor_t *ctx)
Vibro Motor stop PWM module.
err_t vibromotor_pwm_start(vibromotor_t *ctx)
Vibro Motor start PWM module.
void vibromotor_cfg_setup(vibromotor_cfg_t *cfg)
Vibro Motor configuration object setup function.
err_t vibromotor_set_duty_cycle(vibromotor_t *ctx, float duty_cycle)
Vibro Motor sets PWM duty cycle.
err_t vibromotor_init(vibromotor_t *ctx, vibromotor_cfg_t *cfg)
Vibro Motor initialization function.
Vibro Motor Click configuration object.
Definition: vibromotor.h:107
uint32_t dev_pwm_freq
Definition: vibromotor.h:112
pin_name_t pwm
Definition: vibromotor.h:109
Vibro Motor Click driver selector.
Definition: vibromotor.h:93
uint32_t pwm_freq
Definition: vibromotor.h:98
pwm_t pwm
Definition: vibromotor.h:95
vibromotor_return_value_t
Vibro Motor Click return value data.
Definition: vibromotor.h:121
@ VIBROMOTOR_ERROR
Definition: vibromotor.h:123
@ VIBROMOTOR_OK
Definition: vibromotor.h:122