haptic 2.0.0.0
haptic.h
Go to the documentation of this file.
1/*
2 * MikroSDK - MikroE Software Development Kit
3 * Copyright© 2020 MikroElektronika d.o.o.
4 *
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation
7 * files (the "Software"), to deal in the Software without restriction,
8 * including without limitation the rights to use, copy, modify, merge,
9 * publish, distribute, sublicense, and/or sell copies of the Software,
10 * and to permit persons to whom the Software is furnished to do so,
11 * subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22 * OR OTHER DEALINGS IN THE SOFTWARE.
23 */
32// ----------------------------------------------------------------------------
33
34#ifndef HAPTIC_H
35#define HAPTIC_H
36
37#include "drv_digital_out.h"
38#include "drv_digital_in.h"
39#include "drv_i2c_master.h"
40#include "drv_pwm.h"
41
42// -------------------------------------------------------------- PUBLIC MACROS
52#define HAPTIC_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
56 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
63#define HAPTIC_RETVAL uint8_t
64
65#define HAPTIC_OK 0x00
66#define HAPTIC_INIT_ERROR 0xFF
73#define HAPTIC_I2C_ADDRESS 0x5A
80#define HAPTIC_REG_STATUS 0x00
81#define HAPTIC_REG_MODE 0x01
82#define HAPTIC_REG_RTPIN 0x02
83#define HAPTIC_REG_LIBRARY 0x03
84#define HAPTIC_REG_WAVESEQ1 0x04
85#define HAPTIC_REG_WAVESEQ2 0x05
86#define HAPTIC_REG_WAVESEQ3 0x06
87#define HAPTIC_REG_WAVESEQ4 0x07
88#define HAPTIC_REG_WAVESEQ5 0x08
89#define HAPTIC_REG_WAVESEQ6 0x09
90#define HAPTIC_REG_WAVESEQ7 0x0A
91#define HAPTIC_REG_WAVESEQ8 0x0B
92
93#define HAPTIC_REG_GO 0x0C
94#define HAPTIC_REG_OVERDRIVE 0x0D
95#define HAPTIC_REG_SUSTAINPOS 0x0E
96#define HAPTIC_REG_SUSTAINNEG 0x0F
97#define HAPTIC_REG_BREAK 0x10
98#define HAPTIC_REG_AUDIOCTRL 0x11
99#define HAPTIC_REG_AUDIOMININ 0x12
100#define HAPTIC_REG_AUDIOMAXIN 0x13
101#define HAPTIC_REG_AUDIOMINOUT 0x14
102#define HAPTIC_REG_AUDIOMAXOUT 0x15
103#define HAPTIC_REG_RATEDV 0x16
104#define HAPTIC_REG_CLAMPV 0x17
105#define HAPTIC_REG_AUTOCALCOMP 0x18
106#define HAPTIC_REG_AUTOCALEMF 0x19
107#define HAPTIC_REG_FEEDBACK 0x1A
108#define HAPTIC_REG_CONTROL1 0x1B
109#define HAPTIC_REG_CONTROL2 0x1C
110#define HAPTIC_REG_CONTROL3 0x1D
111#define HAPTIC_REG_CONTROL4 0x1E
112#define HAPTIC_REG_VBAT 0x21
113#define HAPTIC_REG_LRARESON 0x22
120#define HAPTIC_MODE_INTTRIG 0x00
121#define HAPTIC_MODE_EXTTRIGEDGE 0x01
122#define HAPTIC_MODE_EXTTRIGLVL 0x02
123#define HAPTIC_MODE_PWMANALOG 0x03
124#define HAPTIC_MODE_AUDIOVIBE 0x04
125#define HAPTIC_MODE_REALTIME 0x05
126#define HAPTIC_MODE_DIAGNOS 0x06
127#define HAPTIC_MODE_AUTOCAL 0x07
134#define HAPTIC_DEFAULT_MIN_INPUT 0x19
135#define HAPTIC_DEFAULT_MAX_INPUT 0xFF // End group macro
139// --------------------------------------------------------------- PUBLIC TYPES
148typedef struct
149{
150 // Output pins
151
152 digital_out_t cs;
153
154 // Modules
155
156 i2c_master_t i2c;
157 pwm_t pwm;
158
159 // ctx variable
160
162 uint32_t pwm_freq;
163
164} haptic_t;
165
169typedef struct
170{
171 // Communication gpio pins
172
173 pin_name_t scl;
174 pin_name_t sda;
175 pin_name_t pwm;
176
177 // Additional gpio pins
178
179 pin_name_t cs;
180
181 // static variable
182
183 uint32_t i2c_speed;
184 uint8_t i2c_address;
185 uint32_t dev_pwm_freq;
186
188 // End types group
190// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
191
197#ifdef __cplusplus
198extern "C"{
199#endif
200
210
220
231void haptic_generic_write ( haptic_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
232
243void haptic_generic_read ( haptic_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
244
257
267
278void haptic_write_byte ( haptic_t *ctx, uint8_t reg_address, uint8_t write_data );
279
293uint8_t haptic_read_byte ( haptic_t *ctx, uint8_t reg_address );
294
304void haptic_set_mode ( haptic_t *ctx, uint8_t sel_mode );
305
315
328
338void haptic_set_rtp_input ( haptic_t *ctx, uint8_t input );
339
349
359uint8_t haptic_set_library ( haptic_t *ctx, uint8_t library );
360
371
382void haptic_set_overdrive_offset ( haptic_t *ctx, uint8_t temp_data );
383
394void haptic_set_sustain_offset_positive ( haptic_t *ctx, uint8_t temp_data );
395
406void haptic_set_sustain_offset_negative ( haptic_t *ctx, uint8_t temp_data );
407
418void haptic_set_brake_time_offset ( haptic_t *ctx, uint8_t temp_data );
419
430void haptic_set_audio_minimum_input ( haptic_t *ctx, uint8_t temp_data );
431
442void haptic_set_audio_maximum_input ( haptic_t *ctx, uint8_t temp_data );
443
454void haptic_set_audio_minimum_output ( haptic_t *ctx, uint8_t temp_data );
455
466void haptic_set_audio_maximum_output ( haptic_t *ctx, uint8_t temp_data );
467
478void haptic_set_rated_voltage ( haptic_t *ctx, uint8_t temp_data );
479
490void haptic_set_overdrive_clamp_voltage ( haptic_t *ctx, uint8_t temp_data );
491
505uint8_t haptic_set_audio_peak_time ( haptic_t *ctx, uint8_t temp_data );
506
517uint8_t haptic_set_audio_low_pass_filter ( haptic_t *ctx, uint8_t temp_data );
518
532
546
559
575
586
597
613uint8_t haptic_setBrakeFactor( haptic_t *ctx, uint8_t brake_factor );
614
628uint8_t haptic_set_loop_gain ( haptic_t *ctx, uint8_t gain );
629
640
651
666void haptic_set_sequence ( haptic_t *ctx, uint8_t temp_data );
667
678
688void haptic_set_duty_cycle ( haptic_t *ctx, float duty_cycle );
689
698
707
708#ifdef __cplusplus
709}
710#endif
711#endif // _HAPTIC_H_
712 // End public_function group
715
716// ------------------------------------------------------------------------- END
#define HAPTIC_RETVAL
Definition: haptic.h:63
void haptic_cfg_setup(haptic_cfg_t *cfg)
Config Object Initialization function.
void haptic_set_to_erm_mode(haptic_t *ctx)
Sets the Haptic click in ERM mode function.
uint8_t haptic_get_calibration_result_emf(haptic_t *ctx)
Reads the rated back - EMF function.
uint8_t haptic_setBrakeFactor(haptic_t *ctx, uint8_t brake_factor)
Sets the feedback gain ratio function.
void haptic_soft_reset(haptic_t *ctx)
Resets all the registers function.
void haptic_set_brake_time_offset(haptic_t *ctx, uint8_t temp_data)
Sets desired brake time offset function.
void haptic_set_duty_cycle(haptic_t *ctx, float duty_cycle)
Generic sets PWM duty cycle.
void haptic_set_sustain_offset_positive(haptic_t *ctx, uint8_t temp_data)
Sets desired sustain offset - positive function.
void haptic_set_input_to_pwm(haptic_t *ctx)
Sets the input for PWM control function.
void haptic_set_to_lra_mode(haptic_t *ctx)
Sets the Haptic click in LRA mode function.
void haptic_set_audio_maximum_input(haptic_t *ctx, uint8_t temp_data)
Sets maximum input for audio to vibe mode function.
uint8_t haptic_set_audio_peak_time(haptic_t *ctx, uint8_t temp_data)
Sets the peak detection time function.
void haptic_enable(haptic_t *ctx)
Enable the device function.
void haptic_pwm_stop(haptic_t *ctx)
Stop PWM module.
void haptic_set_audio_minimum_input(haptic_t *ctx, uint8_t temp_data)
Sets minimum input for audio to vibe mode function.
void haptic_set_state_hi(haptic_t *ctx)
Generic read function.
void haptic_pwm_start(haptic_t *ctx)
Start PWM module.
void haptic_set_overdrive_clamp_voltage(haptic_t *ctx, uint8_t temp_data)
Sets a clamp function.
void haptic_set_rated_voltage(haptic_t *ctx, uint8_t temp_data)
Sets the reference voltage function.
uint8_t haptic_get_lra_resonance_period(haptic_t *ctx)
Reads the measurement of the LRA resonance period function.
void haptic_set_audio_maximum_output(haptic_t *ctx, uint8_t temp_data)
Sets maximum output for audio to vibe mode function.
uint8_t haptic_read_byte(haptic_t *ctx, uint8_t reg_address)
Generic read the byte of data function.
void haptic_set_sequence(haptic_t *ctx, uint8_t temp_data)
Sets the waveform identifier function.
void haptic_set_mode(haptic_t *ctx, uint8_t sel_mode)
Sets the Haptic click to desired mode function.
void haptic_set_sustain_offset_negative(haptic_t *ctx, uint8_t temp_data)
Sets desired sustain offset - negative function.
void haptic_write_byte(haptic_t *ctx, uint8_t reg_address, uint8_t write_data)
Generic write the byte of data function.
void haptic_disable(haptic_t *ctx)
Disable the device function.
HAPTIC_RETVAL haptic_init(haptic_t *ctx, haptic_cfg_t *cfg)
Initialization function.
uint8_t haptic_set_library(haptic_t *ctx, uint8_t library)
Sets the desired library of vibrating patterns to read function.
void haptic_set_overdrive_offset(haptic_t *ctx, uint8_t temp_data)
Sets overdrive offset function.
uint8_t haptic_set_audio_low_pass_filter(haptic_t *ctx, uint8_t temp_data)
Sets the low-pass filter frequency function.
uint8_t haptic_set_loop_gain(haptic_t *ctx, uint8_t gain)
Selects a loop gain function.
uint8_t haptic_get_calibration_result_comp(haptic_t *ctx)
Reads the voltage-compensation function.
void haptic_set_audio_minimum_output(haptic_t *ctx, uint8_t temp_data)
Sets minimum output for audio to vibe mode function.
void haptic_enable_ac_coulping(haptic_t *ctx)
Applies a 0.9-V common mode voltage function.
void haptic_generic_read(haptic_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
void haptic_set_rtp_input(haptic_t *ctx, uint8_t input)
Sets the desired input for RTP mode function.
uint8_t haptic_get_status(haptic_t *ctx)
Get status register value function.
void haptic_set_input_to_analog(haptic_t *ctx)
Sets the input to analog function.
uint8_t haptic_get_supply_voltage_value(haptic_t *ctx)
Reading of the supply voltage function.
void haptic_start_motor(haptic_t *ctx)
Starts moving the motor function.
void haptic_generic_write(haptic_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
Click configuration structure definition.
Definition: haptic.h:170
uint32_t i2c_speed
Definition: haptic.h:183
uint32_t dev_pwm_freq
Definition: haptic.h:185
pin_name_t scl
Definition: haptic.h:173
pin_name_t pwm
Definition: haptic.h:175
pin_name_t sda
Definition: haptic.h:174
pin_name_t cs
Definition: haptic.h:179
uint8_t i2c_address
Definition: haptic.h:184
Click ctx object definition.
Definition: haptic.h:149
digital_out_t cs
Definition: haptic.h:152
uint32_t pwm_freq
Definition: haptic.h:162
i2c_master_t i2c
Definition: haptic.h:156
uint8_t slave_address
Definition: haptic.h:161
pwm_t pwm
Definition: haptic.h:157