haptic4 2.1.0.0
Haptic 4 Registers Settings

Settings for registers of Haptic 4 Click driver. More...

Macros

#define HAPTIC4_CHIP_REV   0xBA
 Haptic 4 CHIP REV value.
 
#define HAPTIC4_PIN_STATE_LOW   0x00
 Haptic 4 pin state.
 
#define HAPTIC4_PIN_STATE_HIGH   0x01
 
#define HAPTIC4_TOP_CFG1_EMB_MODE_MANUAL   0x00
 Haptic 4 top CFG 1 register settings.
 
#define HAPTIC4_TOP_CFG1_EMB_MODE_AUTO   0x80
 
#define HAPTIC4_TOP_CFG1_EMB_MODE_MASK   0x80
 
#define HAPTIC4_TOP_CFG1_ACT_TYPE_LRA   0x00
 
#define HAPTIC4_TOP_CFG1_ACT_TYPE_ERM   0x20
 
#define HAPTIC4_TOP_CFG1_ACT_TYPE_MASK   0x20
 
#define HAPTIC4_TOP_CFG1_BEMF_SENSE_CUSTOM_WF   0x00
 
#define HAPTIC4_TOP_CFG1_BEMF_SENSE_STANDARD   0x10
 
#define HAPTIC4_TOP_CFG1_BEMF_SENSE_MASK   0x10
 
#define HAPTIC4_TOP_CFG1_FREQ_TRACK_DISABLE   0x00
 
#define HAPTIC4_TOP_CFG1_FREQ_TRACK_ENABLE   0x08
 
#define HAPTIC4_TOP_CFG1_FREQ_TRACK_MASK   0x08
 
#define HAPTIC4_TOP_CFG1_ACCEL_DISABLE   0x00
 
#define HAPTIC4_TOP_CFG1_ACCEL_ENABLE   0x04
 
#define HAPTIC4_TOP_CFG1_ACCEL_MASK   0x04
 
#define HAPTIC4_TOP_CFG1_RAPID_STOP_DISABLE   0x00
 
#define HAPTIC4_TOP_CFG1_RAPID_STOP_ENABLE   0x02
 
#define HAPTIC4_TOP_CFG1_RAPID_STOP_MASK   0x02
 
#define HAPTIC4_TOP_CFG1_AMPLITUDE_PID_DISABLE   0x00
 
#define HAPTIC4_TOP_CFG1_AMPLITUDE_PID_ENABLE   0x01
 
#define HAPTIC4_TOP_CFG1_AMPLITUDE_PID_MASK   0x01
 
#define HAPTIC4_TOP_CTL1_SEQ_STOP   0x00
 Haptic 4 top CTL 1 register settings.
 
#define HAPTIC4_TOP_CTL1_SEQ_START   0x10
 
#define HAPTIC4_TOP_CTL1_SEQ_MASK   0x10
 
#define HAPTIC4_TOP_CTL1_STANDBY_DISABLE   0x00
 
#define HAPTIC4_TOP_CTL1_STANDBY_ENABLE   0x08
 
#define HAPTIC4_TOP_CTL1_STANDBY_MASK   0x08
 
#define HAPTIC4_TOP_CTL1_OP_MODE_INACTIVE   0x00
 
#define HAPTIC4_TOP_CTL1_OP_MODE_DRO   0x01
 
#define HAPTIC4_TOP_CTL1_OP_MODE_PWM   0x02
 
#define HAPTIC4_TOP_CTL1_OP_MODE_RTWM   0x03
 
#define HAPTIC4_TOP_CTL1_OP_MODE_ETWM   0x04
 
#define HAPTIC4_TOP_CTL1_OP_MODE_MASK   0x07
 
#define HAPTIC4_ACTUATOR_VOLTAGE_MIN   0.0f
 Haptic 4 calculation macros.
 
#define HAPTIC4_ACTUATOR_VOLTAGE_MAX   6.0f
 
#define HAPTIC4_ACTUATOR_VOLTAGE_RESOLUTION   0.0234f
 
#define HAPTIC4_ACTUATOR_IMAX_MIN   28.6f
 
#define HAPTIC4_ACTUATOR_IMAX_MAX   251.8f
 
#define HAPTIC4_ACTUATOR_IMAX_DIVIDER   7.2f
 
#define HAPTIC4_ACTUATOR_IMAX_RESOLUTION   0x1F
 
#define HAPTIC4_ACTUATOR_IMPEDANCE_MIN   4.0f
 
#define HAPTIC4_ACTUATOR_IMPEDANCE_MAX   50.0f
 
#define HAPTIC4_ACTUATOR_V2I_FACTOR_DIVIDER   1.6104f
 
#define HAPTIC4_ACTUATOR_LRA_FREQ_MIN   0.0f
 
#define HAPTIC4_ACTUATOR_LRA_FREQ_MAX   300.0f
 
#define HAPTIC4_ACTUATOR_LRA_FREQ_RESOLUTION   0.00000133332f
 
#define HAPTIC4_VIBRATION_LEVEL_MIN   -1.0f
 
#define HAPTIC4_VIBRATION_LEVEL_MAX   1.0f
 
#define HAPTIC4_VIBRATION_LEVEL_MIN_ACC_EN   0.0f
 
#define HAPTIC4_VIBRATION_LEVEL_RESOLUTION   0.008f
 
#define HAPTIC4_ROUND_TO_NEAREST_INT   0.5f
 
#define HAPTIC4_DEFAULT_ACTUATOR_TYPE   HAPTIC4_TOP_CFG1_ACT_TYPE_LRA
 Haptic 4 actuator settings default values.
 
#define HAPTIC4_DEFAULT_ACTUATOR_ABS_VOLT   2.808f
 
#define HAPTIC4_DEFAULT_ACTUATOR_NOM_VOLT   2.106f
 
#define HAPTIC4_DEFAULT_ACTUATOR_IMAX   194.0f
 
#define HAPTIC4_DEFAULT_ACTUATOR_IMPEDANCE   16.0f
 
#define HAPTIC4_DEFAULT_ACTUATOR_LRA_FREQ   174.0f
 
#define HAPTIC4_DEVICE_ADDRESS   0x4A
 Haptic 4 device address setting.
 

Detailed Description

Settings for registers of Haptic 4 Click driver.

Macro Definition Documentation

◆ HAPTIC4_ACTUATOR_IMAX_DIVIDER

#define HAPTIC4_ACTUATOR_IMAX_DIVIDER   7.2f

◆ HAPTIC4_ACTUATOR_IMAX_MAX

#define HAPTIC4_ACTUATOR_IMAX_MAX   251.8f

◆ HAPTIC4_ACTUATOR_IMAX_MIN

#define HAPTIC4_ACTUATOR_IMAX_MIN   28.6f

◆ HAPTIC4_ACTUATOR_IMAX_RESOLUTION

#define HAPTIC4_ACTUATOR_IMAX_RESOLUTION   0x1F

◆ HAPTIC4_ACTUATOR_IMPEDANCE_MAX

#define HAPTIC4_ACTUATOR_IMPEDANCE_MAX   50.0f

◆ HAPTIC4_ACTUATOR_IMPEDANCE_MIN

#define HAPTIC4_ACTUATOR_IMPEDANCE_MIN   4.0f

◆ HAPTIC4_ACTUATOR_LRA_FREQ_MAX

#define HAPTIC4_ACTUATOR_LRA_FREQ_MAX   300.0f

◆ HAPTIC4_ACTUATOR_LRA_FREQ_MIN

#define HAPTIC4_ACTUATOR_LRA_FREQ_MIN   0.0f

◆ HAPTIC4_ACTUATOR_LRA_FREQ_RESOLUTION

#define HAPTIC4_ACTUATOR_LRA_FREQ_RESOLUTION   0.00000133332f

◆ HAPTIC4_ACTUATOR_V2I_FACTOR_DIVIDER

#define HAPTIC4_ACTUATOR_V2I_FACTOR_DIVIDER   1.6104f

◆ HAPTIC4_ACTUATOR_VOLTAGE_MAX

#define HAPTIC4_ACTUATOR_VOLTAGE_MAX   6.0f

◆ HAPTIC4_ACTUATOR_VOLTAGE_MIN

#define HAPTIC4_ACTUATOR_VOLTAGE_MIN   0.0f

Haptic 4 calculation macros.

Specified calculation macros of Haptic 4 Click driver.

◆ HAPTIC4_ACTUATOR_VOLTAGE_RESOLUTION

#define HAPTIC4_ACTUATOR_VOLTAGE_RESOLUTION   0.0234f

◆ HAPTIC4_CHIP_REV

#define HAPTIC4_CHIP_REV   0xBA

Haptic 4 CHIP REV value.

Specified CHIP REV value of Haptic 4 Click driver.

◆ HAPTIC4_DEFAULT_ACTUATOR_ABS_VOLT

#define HAPTIC4_DEFAULT_ACTUATOR_ABS_VOLT   2.808f

◆ HAPTIC4_DEFAULT_ACTUATOR_IMAX

#define HAPTIC4_DEFAULT_ACTUATOR_IMAX   194.0f

◆ HAPTIC4_DEFAULT_ACTUATOR_IMPEDANCE

#define HAPTIC4_DEFAULT_ACTUATOR_IMPEDANCE   16.0f

◆ HAPTIC4_DEFAULT_ACTUATOR_LRA_FREQ

#define HAPTIC4_DEFAULT_ACTUATOR_LRA_FREQ   174.0f

◆ HAPTIC4_DEFAULT_ACTUATOR_NOM_VOLT

#define HAPTIC4_DEFAULT_ACTUATOR_NOM_VOLT   2.106f

◆ HAPTIC4_DEFAULT_ACTUATOR_TYPE

#define HAPTIC4_DEFAULT_ACTUATOR_TYPE   HAPTIC4_TOP_CFG1_ACT_TYPE_LRA

Haptic 4 actuator settings default values.

Specified actuator settings default values of Haptic 4 Click driver.

◆ HAPTIC4_DEVICE_ADDRESS

#define HAPTIC4_DEVICE_ADDRESS   0x4A

Haptic 4 device address setting.

Specified setting for device slave address selection of Haptic 4 Click driver.

◆ HAPTIC4_PIN_STATE_HIGH

#define HAPTIC4_PIN_STATE_HIGH   0x01

◆ HAPTIC4_PIN_STATE_LOW

#define HAPTIC4_PIN_STATE_LOW   0x00

Haptic 4 pin state.

Specified pin state of Haptic 4 Click driver.

◆ HAPTIC4_ROUND_TO_NEAREST_INT

#define HAPTIC4_ROUND_TO_NEAREST_INT   0.5f

◆ HAPTIC4_TOP_CFG1_ACCEL_DISABLE

#define HAPTIC4_TOP_CFG1_ACCEL_DISABLE   0x00

◆ HAPTIC4_TOP_CFG1_ACCEL_ENABLE

#define HAPTIC4_TOP_CFG1_ACCEL_ENABLE   0x04

◆ HAPTIC4_TOP_CFG1_ACCEL_MASK

#define HAPTIC4_TOP_CFG1_ACCEL_MASK   0x04

◆ HAPTIC4_TOP_CFG1_ACT_TYPE_ERM

#define HAPTIC4_TOP_CFG1_ACT_TYPE_ERM   0x20

◆ HAPTIC4_TOP_CFG1_ACT_TYPE_LRA

#define HAPTIC4_TOP_CFG1_ACT_TYPE_LRA   0x00

◆ HAPTIC4_TOP_CFG1_ACT_TYPE_MASK

#define HAPTIC4_TOP_CFG1_ACT_TYPE_MASK   0x20

◆ HAPTIC4_TOP_CFG1_AMPLITUDE_PID_DISABLE

#define HAPTIC4_TOP_CFG1_AMPLITUDE_PID_DISABLE   0x00

◆ HAPTIC4_TOP_CFG1_AMPLITUDE_PID_ENABLE

#define HAPTIC4_TOP_CFG1_AMPLITUDE_PID_ENABLE   0x01

◆ HAPTIC4_TOP_CFG1_AMPLITUDE_PID_MASK

#define HAPTIC4_TOP_CFG1_AMPLITUDE_PID_MASK   0x01

◆ HAPTIC4_TOP_CFG1_BEMF_SENSE_CUSTOM_WF

#define HAPTIC4_TOP_CFG1_BEMF_SENSE_CUSTOM_WF   0x00

◆ HAPTIC4_TOP_CFG1_BEMF_SENSE_MASK

#define HAPTIC4_TOP_CFG1_BEMF_SENSE_MASK   0x10

◆ HAPTIC4_TOP_CFG1_BEMF_SENSE_STANDARD

#define HAPTIC4_TOP_CFG1_BEMF_SENSE_STANDARD   0x10

◆ HAPTIC4_TOP_CFG1_EMB_MODE_AUTO

#define HAPTIC4_TOP_CFG1_EMB_MODE_AUTO   0x80

◆ HAPTIC4_TOP_CFG1_EMB_MODE_MANUAL

#define HAPTIC4_TOP_CFG1_EMB_MODE_MANUAL   0x00

Haptic 4 top CFG 1 register settings.

Specified top CFG 1 register settings of Haptic 4 Click driver.

◆ HAPTIC4_TOP_CFG1_EMB_MODE_MASK

#define HAPTIC4_TOP_CFG1_EMB_MODE_MASK   0x80

◆ HAPTIC4_TOP_CFG1_FREQ_TRACK_DISABLE

#define HAPTIC4_TOP_CFG1_FREQ_TRACK_DISABLE   0x00

◆ HAPTIC4_TOP_CFG1_FREQ_TRACK_ENABLE

#define HAPTIC4_TOP_CFG1_FREQ_TRACK_ENABLE   0x08

◆ HAPTIC4_TOP_CFG1_FREQ_TRACK_MASK

#define HAPTIC4_TOP_CFG1_FREQ_TRACK_MASK   0x08

◆ HAPTIC4_TOP_CFG1_RAPID_STOP_DISABLE

#define HAPTIC4_TOP_CFG1_RAPID_STOP_DISABLE   0x00

◆ HAPTIC4_TOP_CFG1_RAPID_STOP_ENABLE

#define HAPTIC4_TOP_CFG1_RAPID_STOP_ENABLE   0x02

◆ HAPTIC4_TOP_CFG1_RAPID_STOP_MASK

#define HAPTIC4_TOP_CFG1_RAPID_STOP_MASK   0x02

◆ HAPTIC4_TOP_CTL1_OP_MODE_DRO

#define HAPTIC4_TOP_CTL1_OP_MODE_DRO   0x01

◆ HAPTIC4_TOP_CTL1_OP_MODE_ETWM

#define HAPTIC4_TOP_CTL1_OP_MODE_ETWM   0x04

◆ HAPTIC4_TOP_CTL1_OP_MODE_INACTIVE

#define HAPTIC4_TOP_CTL1_OP_MODE_INACTIVE   0x00

◆ HAPTIC4_TOP_CTL1_OP_MODE_MASK

#define HAPTIC4_TOP_CTL1_OP_MODE_MASK   0x07

◆ HAPTIC4_TOP_CTL1_OP_MODE_PWM

#define HAPTIC4_TOP_CTL1_OP_MODE_PWM   0x02

◆ HAPTIC4_TOP_CTL1_OP_MODE_RTWM

#define HAPTIC4_TOP_CTL1_OP_MODE_RTWM   0x03

◆ HAPTIC4_TOP_CTL1_SEQ_MASK

#define HAPTIC4_TOP_CTL1_SEQ_MASK   0x10

◆ HAPTIC4_TOP_CTL1_SEQ_START

#define HAPTIC4_TOP_CTL1_SEQ_START   0x10

◆ HAPTIC4_TOP_CTL1_SEQ_STOP

#define HAPTIC4_TOP_CTL1_SEQ_STOP   0x00

Haptic 4 top CTL 1 register settings.

Specified top CTL 1 register settings of Haptic 4 Click driver.

◆ HAPTIC4_TOP_CTL1_STANDBY_DISABLE

#define HAPTIC4_TOP_CTL1_STANDBY_DISABLE   0x00

◆ HAPTIC4_TOP_CTL1_STANDBY_ENABLE

#define HAPTIC4_TOP_CTL1_STANDBY_ENABLE   0x08

◆ HAPTIC4_TOP_CTL1_STANDBY_MASK

#define HAPTIC4_TOP_CTL1_STANDBY_MASK   0x08

◆ HAPTIC4_VIBRATION_LEVEL_MAX

#define HAPTIC4_VIBRATION_LEVEL_MAX   1.0f

◆ HAPTIC4_VIBRATION_LEVEL_MIN

#define HAPTIC4_VIBRATION_LEVEL_MIN   -1.0f

◆ HAPTIC4_VIBRATION_LEVEL_MIN_ACC_EN

#define HAPTIC4_VIBRATION_LEVEL_MIN_ACC_EN   0.0f

◆ HAPTIC4_VIBRATION_LEVEL_RESOLUTION

#define HAPTIC4_VIBRATION_LEVEL_RESOLUTION   0.008f