haptic2  2.0.0.0
haptic2.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 HAPTIC2_H
29 #define HAPTIC2_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 HAPTIC2_DEF_FREQ 8000
74  // haptic2_cfg
76 
91 #define HAPTIC2_MAP_MIKROBUS( cfg, mikrobus ) \
92  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
93  // haptic2_map // haptic2
96 
106 typedef struct
107 {
108  // Modules
109 
110  pwm_t pwm;
112  // ctx variable
113 
114  uint32_t pwm_freq;
116 } haptic2_t;
117 
122 typedef struct
123 {
124  // Communication gpio pins
125 
126  pin_name_t pwm;
128  // Static variable
129 
130  uint32_t dev_pwm_freq;
132 } haptic2_cfg_t;
133 
150 
165 err_t haptic2_init ( haptic2_t *ctx, haptic2_cfg_t *cfg );
166 
181 
194 err_t haptic2_set_duty_cycle ( haptic2_t *ctx, float duty_ratio );
195 
208 
221 
222 #ifdef __cplusplus
223 }
224 #endif
225 #endif // HAPTIC2_H
226  // haptic2
228 
229 // ------------------------------------------------------------------------ END
haptic2_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: haptic2.h:130
haptic2_t::pwm
pwm_t pwm
Definition: haptic2.h:110
haptic2_default_cfg
err_t haptic2_default_cfg(haptic2_t *ctx)
HAPTIC 2 default configuration function.
haptic2_t::pwm_freq
uint32_t pwm_freq
Definition: haptic2.h:114
haptic2_cfg_t::pwm
pin_name_t pwm
Definition: haptic2.h:126
haptic2_init
err_t haptic2_init(haptic2_t *ctx, haptic2_cfg_t *cfg)
HAPTIC 2 initialization function.
haptic2_cfg_t
HAPTIC 2 Click configuration object.
Definition: haptic2.h:123
haptic2_pwm_start
err_t haptic2_pwm_start(haptic2_t *ctx)
HAPTIC 2 start PWM module.
haptic2_cfg_setup
void haptic2_cfg_setup(haptic2_cfg_t *cfg)
HAPTIC 2 configuration object setup function.
haptic2_t
HAPTIC 2 Click driver selector.
Definition: haptic2.h:107
haptic2_set_duty_cycle
err_t haptic2_set_duty_cycle(haptic2_t *ctx, float duty_ratio)
HAPTIC 2 sets PWM duty cycle.
haptic2_pwm_stop
err_t haptic2_pwm_stop(haptic2_t *ctx)
HAPTIC 2 stop PWM module.