vibromotor2  2.0.0.0
vibromotor2.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 VIBROMOTOR2_H
29 #define VIBROMOTOR2_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 VIBROMOTOR2_DEF_FREQ 5000
70  // vibromotor2_cfg
72 
87 #define VIBROMOTOR2_MAP_MIKROBUS( cfg, mikrobus ) \
88  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
89  // vibromotor2_map // vibromotor2
92 
102 typedef struct
103 {
104  // Modules
105  pwm_t pwm;
107  // ctx variable
108  uint32_t pwm_freq;
110 } vibromotor2_t;
111 
116 typedef struct
117 {
118  // Communication gpio pins
119  pin_name_t pwm;
121  // Static variable
122  uint32_t dev_pwm_freq;
125 
130 typedef enum
131 {
133  VIBROMOTOR2_ERROR = -1
134 
136 
153 
169 
182 err_t vibromotor2_set_duty_cycle ( vibromotor2_t *ctx, float duty_cycle );
183 
196 
209 
210 #ifdef __cplusplus
211 }
212 #endif
213 #endif // VIBROMOTOR2_H
214  // vibromotor2
216 
217 // ------------------------------------------------------------------------ END
vibromotor2_cfg_t
Vibro Motor 2 Click configuration object.
Definition: vibromotor2.h:117
VIBROMOTOR2_OK
@ VIBROMOTOR2_OK
Definition: vibromotor2.h:132
vibromotor2_pwm_stop
err_t vibromotor2_pwm_stop(vibromotor2_t *ctx)
Vibro Motor 2 stop PWM module.
vibromotor2_t
Vibro Motor 2 Click driver selector.
Definition: vibromotor2.h:103
vibromotor2_t::pwm_freq
uint32_t pwm_freq
Definition: vibromotor2.h:108
vibromotor2_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: vibromotor2.h:122
vibromotor2_cfg_setup
void vibromotor2_cfg_setup(vibromotor2_cfg_t *cfg)
Vibro Motor 2 configuration object setup function.
vibromotor2_return_value_t
vibromotor2_return_value_t
Vibro Motor 2 Click return value data.
Definition: vibromotor2.h:131
vibromotor2_set_duty_cycle
err_t vibromotor2_set_duty_cycle(vibromotor2_t *ctx, float duty_cycle)
Vibro Motor 2 sets PWM duty cycle.
vibromotor2_t::pwm
pwm_t pwm
Definition: vibromotor2.h:105
VIBROMOTOR2_ERROR
@ VIBROMOTOR2_ERROR
Definition: vibromotor2.h:133
vibromotor2_init
err_t vibromotor2_init(vibromotor2_t *ctx, vibromotor2_cfg_t *cfg)
Vibro Motor 2 initialization function.
vibromotor2_pwm_start
err_t vibromotor2_pwm_start(vibromotor2_t *ctx)
Vibro Motor 2 start PWM module.
vibromotor2_cfg_t::pwm
pin_name_t pwm
Definition: vibromotor2.h:119