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 )
57 
63 #define HAPTIC_RETVAL uint8_t
64 
65 #define HAPTIC_OK 0x00
66 #define HAPTIC_INIT_ERROR 0xFF
67 
73 #define HAPTIC_I2C_ADDRESS 0x5A
74 
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
114 
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
128 
134 #define HAPTIC_DEFAULT_MIN_INPUT 0x19
135 #define HAPTIC_DEFAULT_MAX_INPUT 0xFF
136  // End group macro
139 // --------------------------------------------------------------- PUBLIC TYPES
148 typedef 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 
161  uint8_t slave_address;
162  uint32_t pwm_freq;
163 
164 } haptic_t;
165 
169 typedef 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 
187 } haptic_cfg_t;
188  // End types group
190 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
191 
197 #ifdef __cplusplus
198 extern "C"{
199 #endif
200 
209 void haptic_cfg_setup ( haptic_cfg_t *cfg );
210 
220 
231 void haptic_generic_write ( haptic_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
232 
243 void haptic_generic_read ( haptic_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
244 
256 void haptic_enable ( haptic_t *ctx );
257 
266 void haptic_disable ( haptic_t *ctx );
267 
278 void haptic_write_byte ( haptic_t *ctx, uint8_t reg_address, uint8_t write_data );
279 
293 uint8_t haptic_read_byte ( haptic_t *ctx, uint8_t reg_address );
294 
304 void haptic_set_mode ( haptic_t *ctx, uint8_t sel_mode );
305 
314 void haptic_soft_reset ( haptic_t *ctx );
315 
327 uint8_t haptic_get_status ( haptic_t *ctx );
328 
338 void haptic_set_rtp_input ( haptic_t *ctx, uint8_t input );
339 
348 void haptic_set_state_hi ( haptic_t *ctx );
349 
359 uint8_t haptic_set_library ( haptic_t *ctx, uint8_t library );
360 
370 void haptic_start_motor ( haptic_t *ctx );
371 
382 void haptic_set_overdrive_offset ( haptic_t *ctx, uint8_t temp_data );
383 
394 void haptic_set_sustain_offset_positive ( haptic_t *ctx, uint8_t temp_data );
395 
406 void haptic_set_sustain_offset_negative ( haptic_t *ctx, uint8_t temp_data );
407 
418 void haptic_set_brake_time_offset ( haptic_t *ctx, uint8_t temp_data );
419 
430 void haptic_set_audio_minimum_input ( haptic_t *ctx, uint8_t temp_data );
431 
442 void haptic_set_audio_maximum_input ( haptic_t *ctx, uint8_t temp_data );
443 
454 void haptic_set_audio_minimum_output ( haptic_t *ctx, uint8_t temp_data );
455 
466 void haptic_set_audio_maximum_output ( haptic_t *ctx, uint8_t temp_data );
467 
478 void haptic_set_rated_voltage ( haptic_t *ctx, uint8_t temp_data );
479 
490 void haptic_set_overdrive_clamp_voltage ( haptic_t *ctx, uint8_t temp_data );
491 
505 uint8_t haptic_set_audio_peak_time ( haptic_t *ctx, uint8_t temp_data );
506 
517 uint8_t haptic_set_audio_low_pass_filter ( haptic_t *ctx, uint8_t temp_data );
518 
532 
546 
559 
575 
585 void haptic_set_to_erm_mode ( haptic_t *ctx );
586 
596 void haptic_set_to_lra_mode ( haptic_t *ctx );
597 
613 uint8_t haptic_setBrakeFactor( haptic_t *ctx, uint8_t brake_factor );
614 
628 uint8_t haptic_set_loop_gain ( haptic_t *ctx, uint8_t gain );
629 
640 
650 void haptic_set_input_to_pwm ( haptic_t *ctx );
651 
666 void haptic_set_sequence ( haptic_t *ctx, uint8_t temp_data );
667 
677 void haptic_enable_ac_coulping ( haptic_t *ctx );
678 
688 void haptic_set_duty_cycle ( haptic_t *ctx, float duty_cycle );
689 
697 void haptic_pwm_stop ( haptic_t *ctx );
698 
706 void haptic_pwm_start ( haptic_t *ctx );
707 
708 #ifdef __cplusplus
709 }
710 #endif
711 #endif // _HAPTIC_H_
712  // End public_function group
715 
716 // ------------------------------------------------------------------------- END
haptic_set_audio_minimum_output
void haptic_set_audio_minimum_output(haptic_t *ctx, uint8_t temp_data)
Sets minimum output for audio to vibe mode function.
haptic_set_to_lra_mode
void haptic_set_to_lra_mode(haptic_t *ctx)
Sets the Haptic click in LRA mode function.
haptic_set_audio_minimum_input
void haptic_set_audio_minimum_input(haptic_t *ctx, uint8_t temp_data)
Sets minimum input for audio to vibe mode function.
haptic_set_duty_cycle
void haptic_set_duty_cycle(haptic_t *ctx, float duty_cycle)
Generic sets PWM duty cycle.
haptic_set_brake_time_offset
void haptic_set_brake_time_offset(haptic_t *ctx, uint8_t temp_data)
Sets desired brake time offset function.
haptic_soft_reset
void haptic_soft_reset(haptic_t *ctx)
Resets all the registers function.
haptic_cfg_t::cs
pin_name_t cs
Definition: haptic.h:179
haptic_set_sustain_offset_positive
void haptic_set_sustain_offset_positive(haptic_t *ctx, uint8_t temp_data)
Sets desired sustain offset - positive function.
haptic_set_rated_voltage
void haptic_set_rated_voltage(haptic_t *ctx, uint8_t temp_data)
Sets the reference voltage function.
haptic_t
Click ctx object definition.
Definition: haptic.h:148
haptic_pwm_start
void haptic_pwm_start(haptic_t *ctx)
Start PWM module.
haptic_cfg_t
Click configuration structure definition.
Definition: haptic.h:169
haptic_set_library
uint8_t haptic_set_library(haptic_t *ctx, uint8_t library)
Sets the desired library of vibrating patterns to read function.
haptic_get_calibration_result_comp
uint8_t haptic_get_calibration_result_comp(haptic_t *ctx)
Reads the voltage-compensation function.
haptic_t::cs
digital_out_t cs
Definition: haptic.h:152
haptic_set_audio_maximum_input
void haptic_set_audio_maximum_input(haptic_t *ctx, uint8_t temp_data)
Sets maximum input for audio to vibe mode function.
haptic_set_input_to_analog
void haptic_set_input_to_analog(haptic_t *ctx)
Sets the input to analog function.
haptic_cfg_t::scl
pin_name_t scl
Definition: haptic.h:173
haptic_init
HAPTIC_RETVAL haptic_init(haptic_t *ctx, haptic_cfg_t *cfg)
Initialization function.
HAPTIC_RETVAL
#define HAPTIC_RETVAL
Definition: haptic.h:63
haptic_generic_read
void haptic_generic_read(haptic_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
haptic_set_rtp_input
void haptic_set_rtp_input(haptic_t *ctx, uint8_t input)
Sets the desired input for RTP mode function.
haptic_pwm_stop
void haptic_pwm_stop(haptic_t *ctx)
Stop PWM module.
haptic_read_byte
uint8_t haptic_read_byte(haptic_t *ctx, uint8_t reg_address)
Generic read the byte of data function.
haptic_set_audio_maximum_output
void haptic_set_audio_maximum_output(haptic_t *ctx, uint8_t temp_data)
Sets maximum output for audio to vibe mode function.
haptic_set_loop_gain
uint8_t haptic_set_loop_gain(haptic_t *ctx, uint8_t gain)
Selects a loop gain function.
haptic_get_lra_resonance_period
uint8_t haptic_get_lra_resonance_period(haptic_t *ctx)
Reads the measurement of the LRA resonance period function.
haptic_enable
void haptic_enable(haptic_t *ctx)
Enable the device function.
haptic_t::i2c
i2c_master_t i2c
Definition: haptic.h:156
haptic_cfg_t::pwm
pin_name_t pwm
Definition: haptic.h:175
haptic_set_audio_low_pass_filter
uint8_t haptic_set_audio_low_pass_filter(haptic_t *ctx, uint8_t temp_data)
Sets the low-pass filter frequency function.
haptic_set_audio_peak_time
uint8_t haptic_set_audio_peak_time(haptic_t *ctx, uint8_t temp_data)
Sets the peak detection time function.
haptic_set_overdrive_clamp_voltage
void haptic_set_overdrive_clamp_voltage(haptic_t *ctx, uint8_t temp_data)
Sets a clamp function.
haptic_t::pwm
pwm_t pwm
Definition: haptic.h:157
haptic_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: haptic.h:185
haptic_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: haptic.h:183
haptic_setBrakeFactor
uint8_t haptic_setBrakeFactor(haptic_t *ctx, uint8_t brake_factor)
Sets the feedback gain ratio function.
haptic_get_calibration_result_emf
uint8_t haptic_get_calibration_result_emf(haptic_t *ctx)
Reads the rated back - EMF function.
haptic_disable
void haptic_disable(haptic_t *ctx)
Disable the device function.
haptic_set_sustain_offset_negative
void haptic_set_sustain_offset_negative(haptic_t *ctx, uint8_t temp_data)
Sets desired sustain offset - negative function.
haptic_set_to_erm_mode
void haptic_set_to_erm_mode(haptic_t *ctx)
Sets the Haptic click in ERM mode function.
haptic_enable_ac_coulping
void haptic_enable_ac_coulping(haptic_t *ctx)
Applies a 0.9-V common mode voltage function.
haptic_get_status
uint8_t haptic_get_status(haptic_t *ctx)
Get status register value function.
haptic_generic_write
void haptic_generic_write(haptic_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
haptic_t::slave_address
uint8_t slave_address
Definition: haptic.h:161
haptic_set_overdrive_offset
void haptic_set_overdrive_offset(haptic_t *ctx, uint8_t temp_data)
Sets overdrive offset function.
haptic_t::pwm_freq
uint32_t pwm_freq
Definition: haptic.h:162
haptic_set_sequence
void haptic_set_sequence(haptic_t *ctx, uint8_t temp_data)
Sets the waveform identifier function.
haptic_set_mode
void haptic_set_mode(haptic_t *ctx, uint8_t sel_mode)
Sets the Haptic click to desired mode function.
haptic_start_motor
void haptic_start_motor(haptic_t *ctx)
Starts moving the motor function.
haptic_get_supply_voltage_value
uint8_t haptic_get_supply_voltage_value(haptic_t *ctx)
Reading of the supply voltage function.
haptic_cfg_t::i2c_address
uint8_t i2c_address
Definition: haptic.h:184
haptic_write_byte
void haptic_write_byte(haptic_t *ctx, uint8_t reg_address, uint8_t write_data)
Generic write the byte of data function.
haptic_cfg_t::sda
pin_name_t sda
Definition: haptic.h:174
haptic_set_state_hi
void haptic_set_state_hi(haptic_t *ctx)
Generic read function.
haptic_cfg_setup
void haptic_cfg_setup(haptic_cfg_t *cfg)
Config Object Initialization function.
haptic_set_input_to_pwm
void haptic_set_input_to_pwm(haptic_t *ctx)
Sets the input for PWM control function.