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
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 HAPTIC2_DEF_FREQ 8000
60 // haptic2_cfg
62
77#define HAPTIC2_MAP_MIKROBUS( cfg, mikrobus ) \
78 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
79 // haptic2_map // haptic2
82
92typedef struct
93{
94 // Modules
95
96 pwm_t pwm;
98 // ctx variable
99
100 uint32_t pwm_freq;
102} haptic2_t;
103
108typedef struct
109{
110 // Communication gpio pins
111
112 pin_name_t pwm;
114 // Static variable
115
116 uint32_t dev_pwm_freq;
119
136
152
167
180err_t haptic2_set_duty_cycle ( haptic2_t *ctx, float duty_ratio );
181
194
207
208#ifdef __cplusplus
209}
210#endif
211#endif // HAPTIC2_H
212 // haptic2
214
215// ------------------------------------------------------------------------ END
void haptic2_cfg_setup(haptic2_cfg_t *cfg)
HAPTIC 2 configuration object setup function.
err_t haptic2_pwm_stop(haptic2_t *ctx)
HAPTIC 2 stop PWM module.
err_t haptic2_init(haptic2_t *ctx, haptic2_cfg_t *cfg)
HAPTIC 2 initialization function.
err_t haptic2_default_cfg(haptic2_t *ctx)
HAPTIC 2 default configuration function.
err_t haptic2_set_duty_cycle(haptic2_t *ctx, float duty_ratio)
HAPTIC 2 sets PWM duty cycle.
err_t haptic2_pwm_start(haptic2_t *ctx)
HAPTIC 2 start PWM module.
HAPTIC 2 Click configuration object.
Definition: haptic2.h:109
uint32_t dev_pwm_freq
Definition: haptic2.h:116
pin_name_t pwm
Definition: haptic2.h:112
HAPTIC 2 Click driver selector.
Definition: haptic2.h:93
uint32_t pwm_freq
Definition: haptic2.h:100
pwm_t pwm
Definition: haptic2.h:96