vibromotor3 2.0.0.0
|
API for configuring and manipulating Vibro Motor 3 Click driver. More...
Topics | |
Vibro Motor 3 Registers List | |
List of registers of Vibro Motor 3 Click driver. | |
Vibro Motor 3 Registers Settings | |
Settings for registers of Vibro Motor 3 Click driver. | |
Vibro Motor 3 MikroBUS Map | |
MikroBUS pin mapping of Vibro Motor 3 Click driver. | |
Functions | |
void | vibromotor3_cfg_setup (vibromotor3_cfg_t *cfg) |
Vibro Motor 3 configuration object setup function. | |
err_t | vibromotor3_init (vibromotor3_t *ctx, vibromotor3_cfg_t *cfg) |
Vibro Motor 3 initialization function. | |
err_t | vibromotor3_default_cfg (vibromotor3_t *ctx) |
Vibro Motor 3 default configuration function. | |
err_t | vibromotor3_generic_write (vibromotor3_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len) |
Vibro Motor 3 I2C writing function. | |
err_t | vibromotor3_generic_read (vibromotor3_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len) |
Vibro Motor 3 I2C reading function. | |
err_t | vibromotor3_set_duty_cycle (vibromotor3_t *ctx, float duty_cycle) |
Vibro Motor 3 sets PWM duty cycle. | |
err_t | vibromotor3_pwm_stop (vibromotor3_t *ctx) |
Vibro Motor 3 stop PWM module. | |
err_t | vibromotor3_pwm_start (vibromotor3_t *ctx) |
Vibro Motor 3 start PWM module. | |
void | vibromotor3_enable (vibromotor3_t *ctx, uint8_t state) |
Enable the device function. | |
void | vibromotor3_write_byte (vibromotor3_t *ctx, uint8_t reg, uint8_t wr_data) |
Generic write the byte of data function. | |
uint8_t | vibromotor3_read_byte (vibromotor3_t *ctx, uint8_t reg) |
Generic read the byte of data function. | |
void | vibromotor3_set_mode (vibromotor3_t *ctx, uint8_t mode_sel) |
Sets the desired mode function. | |
void | vibromotor3_soft_rst (vibromotor3_t *ctx) |
Reset function. | |
void | vibromotor3_stb_mode (vibromotor3_t *ctx, uint8_t state) |
Software standby mode. | |
uint8_t | vibromotor3_get_stat (vibromotor3_t *ctx) |
Get status register value function. | |
void | vibromotor3_set_rtp_input (vibromotor3_t *ctx, uint8_t data_in) |
Sets the desired input for RTP mode function. | |
void | vibromotor3_set_state_hi_z (vibromotor3_t *ctx, uint8_t state) |
Set the devices in HI-Z state function. | |
void | vibromotor3_set_library (vibromotor3_t *ctx, uint8_t lib_sel) |
Set the desired vibrating patterns library. | |
void | vibromotor3_start_motor (vibromotor3_t *ctx, uint8_t state) |
Starts or stops moving the motor function. | |
void | vibromotor3_set_ovdr_offset (vibromotor3_t *ctx, uint8_t data_in) |
Sets overdrive offset function. | |
void | vibromotor3_set_sustain_offset_pos (vibromotor3_t *ctx, uint8_t data_in) |
Sets sustain offset - positive function. | |
void | vibromotor3_set_sustain_offset_neg (vibromotor3_t *ctx, uint8_t data_in) |
Sets sustain offset - negative function. | |
void | vibromotor3_set_brake_time_offset (vibromotor3_t *ctx, uint8_t data_in) |
Sets brake time offset function. | |
void | vibromotor3_set_rated_volt (vibromotor3_t *ctx, uint8_t data_in) |
Sets the reference voltage function. | |
void | vibromotor3_set_ovdrv_clamp_volt (vibromotor3_t *ctx, uint8_t data_in) |
Sets a clamp function. | |
uint8_t | vibromotor3_get_calib_res_comp (vibromotor3_t *ctx) |
Reads the voltage-compensation function. | |
float | vibromotor3_get_supply_volt_val (vibromotor3_t *ctx) |
Reading of the supply voltage function. | |
float | vibromotor3_get_lra_resonance_period (vibromotor3_t *ctx) |
Reads the measurement of the LRA resonance period function. | |
void | vibromotor3_set_lra_mode (vibromotor3_t *ctx, uint8_t state) |
Sets the device in LRA mode function. | |
void | vibromotor3_set_brake_factor (vibromotor3_t *ctx, uint8_t brk_fac) |
Set brake factor function. | |
void | vibromotor3_set_loop_gain (vibromotor3_t *ctx, uint8_t gain) |
Selects a loop gain function. | |
void | vibromotor3_set_input (vibromotor3_t *ctx, uint8_t data_in) |
Sets the input to PWM or analog function. | |
void | vibromotor3_enable_ac_coulping (vibromotor3_t *ctx) |
Applies a 0.9-V common mode voltage function. | |
API for configuring and manipulating Vibro Motor 3 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void vibromotor3_cfg_setup | ( | vibromotor3_cfg_t * | cfg | ) |
Vibro Motor 3 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See vibromotor3_cfg_t object definition for detailed explanation. |
err_t vibromotor3_default_cfg | ( | vibromotor3_t * | ctx | ) |
Vibro Motor 3 default configuration function.
This function executes a default configuration of Vibro Motor 3 click board.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
0
- Success, -1
- Error.void vibromotor3_enable | ( | vibromotor3_t * | ctx, |
uint8_t | state ) |
Enable the device function.
The function is used to enable or disable the device.
[out] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | state | : 8-bit value that defines the state of the device |
void vibromotor3_enable_ac_coulping | ( | vibromotor3_t * | ctx | ) |
Applies a 0.9-V common mode voltage function.
Function applies a 0.9-V common mode voltage to the IN/TRIG pin.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
err_t vibromotor3_generic_read | ( | vibromotor3_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | rx_buf, | ||
uint8_t | rx_len ) |
Vibro Motor 3 I2C reading function.
This function reads a desired number of data bytes starting from the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[out] | rx_buf | : Output read data. |
[in] | rx_len | : Number of bytes to be read. |
0
- Success, -1
- Error.err_t vibromotor3_generic_write | ( | vibromotor3_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | tx_buf, | ||
uint8_t | tx_len ) |
Vibro Motor 3 I2C writing function.
This function writes a desired number of data bytes starting from the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[in] | tx_buf | : Data to be written. |
[in] | tx_len | : Number of bytes to be written. |
0
- Success, -1
- Error.uint8_t vibromotor3_get_calib_res_comp | ( | vibromotor3_t * | ctx | ) |
Reads the voltage-compensation function.
Function gets the voltage-compensation result after execution of auto calibration.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
float vibromotor3_get_lra_resonance_period | ( | vibromotor3_t * | ctx | ) |
Reads the measurement of the LRA resonance period function.
Function gets the measurement of the LRA resonance period.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
uint8_t vibromotor3_get_stat | ( | vibromotor3_t * | ctx | ) |
Get status register value function.
The function is used to read the value from the status register.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
float vibromotor3_get_supply_volt_val | ( | vibromotor3_t * | ctx | ) |
Reading of the supply voltage function.
Function does a real-time reading of the supply voltage at the VDD pin.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
err_t vibromotor3_init | ( | vibromotor3_t * | ctx, |
vibromotor3_cfg_t * | cfg ) |
Vibro Motor 3 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See vibromotor3_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t vibromotor3_pwm_start | ( | vibromotor3_t * | ctx | ) |
Vibro Motor 3 start PWM module.
This function starts the PWM moudle output.
[out] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t vibromotor3_pwm_stop | ( | vibromotor3_t * | ctx | ) |
Vibro Motor 3 stop PWM module.
This function stops the PWM moudle output.
[out] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
0
- Success, -1
- Error.uint8_t vibromotor3_read_byte | ( | vibromotor3_t * | ctx, |
uint8_t | reg ) |
Generic read the byte of data function.
The function is used to read 8-bit data from the target 8-bit register address.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | reg | : 8-bit register address. |
void vibromotor3_set_brake_factor | ( | vibromotor3_t * | ctx, |
uint8_t | brk_fac ) |
Set brake factor function.
Function selects the feedback gain ratio between braking gain and driving gain.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | brk_fac | : Value that defines brake factor |
void vibromotor3_set_brake_time_offset | ( | vibromotor3_t * | ctx, |
uint8_t | data_in ) |
Sets brake time offset function.
Function sets the desired brake time offset.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | data_in | : 8-bit desired brake time offset |
err_t vibromotor3_set_duty_cycle | ( | vibromotor3_t * | ctx, |
float | duty_cycle ) |
Vibro Motor 3 sets PWM duty cycle.
This function sets the PWM duty cycle in percentages ( Range[ 0..1 ] ).
[out] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | duty_ratio | : PWM duty_ratio. |
0
- Success, -1
- Error.void vibromotor3_set_input | ( | vibromotor3_t * | ctx, |
uint8_t | data_in ) |
Sets the input to PWM or analog function.
The function is used to select the input mode for the IN/TRIG(PWM) pin.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | state | : 8-bit value that defines the input mode |
void vibromotor3_set_library | ( | vibromotor3_t * | ctx, |
uint8_t | lib_sel ) |
Set the desired vibrating patterns library.
Function is used to set waveform library selection value.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | lib_sel | : Value that defines selected library |
void vibromotor3_set_loop_gain | ( | vibromotor3_t * | ctx, |
uint8_t | gain ) |
Selects a loop gain function.
Function selects a loop gain for the feedback control.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | gain | : Value that defines a loop gain |
void vibromotor3_set_lra_mode | ( | vibromotor3_t * | ctx, |
uint8_t | state ) |
Sets the device in LRA mode function.
The function is used to sets the device in LRA mode.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | state | : 8-bit value that defines the device's mode |
void vibromotor3_set_mode | ( | vibromotor3_t * | ctx, |
uint8_t | mode_sel ) |
Sets the desired mode function.
Function is used to apply the desired mode.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | mode_sel | : Value that defines selected mode |
void vibromotor3_set_ovdr_offset | ( | vibromotor3_t * | ctx, |
uint8_t | data_in ) |
Sets overdrive offset function.
Function sets the desired overdrive offset.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | data_in | : 8-bit desired overdrive offset |
void vibromotor3_set_ovdrv_clamp_volt | ( | vibromotor3_t * | ctx, |
uint8_t | data_in ) |
Sets a clamp function.
Function sets a clamp so that the automatic overdrive is bounded.
[in] | data_in | : 8-bit desired imput value |
void vibromotor3_set_rated_volt | ( | vibromotor3_t * | ctx, |
uint8_t | data_in ) |
Sets the reference voltage function.
Function sets the reference voltage for full-scale output during closed-loop.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | data_in | : 8-bit desired value represetning the voltage |
void vibromotor3_set_rtp_input | ( | vibromotor3_t * | ctx, |
uint8_t | data_in ) |
Sets the desired input for RTP mode function.
Function sets the desired Real-Time Playback Input.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | data_in | : 8-bit desired input for RTP mode |
void vibromotor3_set_state_hi_z | ( | vibromotor3_t * | ctx, |
uint8_t | state ) |
Set the devices in HI-Z state function.
The function is used to enable or disable the HI-Z state.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | state | : 8-bit value that defines the HI-Z state |
void vibromotor3_set_sustain_offset_neg | ( | vibromotor3_t * | ctx, |
uint8_t | data_in ) |
Sets sustain offset - negative function.
Function sets the desired sustain offset - negative.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | data_in | : 8-bit desired negative sustain offset |
void vibromotor3_set_sustain_offset_pos | ( | vibromotor3_t * | ctx, |
uint8_t | data_in ) |
Sets sustain offset - positive function.
Function sets the desired sustain offset - positive.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | data_in | : 8-bit desired positive sustain offset |
void vibromotor3_soft_rst | ( | vibromotor3_t * | ctx | ) |
Reset function.
The function is used to perform software reset.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
void vibromotor3_start_motor | ( | vibromotor3_t * | ctx, |
uint8_t | state ) |
Starts or stops moving the motor function.
The function is used to start or stop the motor.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | state | : 8-bit value that defines the motor's state |
void vibromotor3_stb_mode | ( | vibromotor3_t * | ctx, |
uint8_t | state ) |
Software standby mode.
The function is used to enable or disable the standby mode.
[in] | state | : 8-bit value that defines the state of the standby mode |
void vibromotor3_write_byte | ( | vibromotor3_t * | ctx, |
uint8_t | reg, | ||
uint8_t | wr_data ) |
Generic write the byte of data function.
The function is used to write 8-bit data to the target 8-bit register address.
[in] | ctx | : Click context object. See vibromotor3_t object definition for detailed explanation. |
[in] | reg | : 8-bit register address. |
[in] | wr_data | : 8-bit input data. |