haptic3 2.0.0.0
HAPTIC 3 Registers Settings

Settings for registers of HAPTIC 3 Click driver. More...

Macros

#define HAPTIC3_CHIP_REV   0xDA
 HAPTIC 3 chip rev value.
 
#define HAPTIC3_TOP_CFG1_EMB_MODE_MANUAL   0x00
 HAPTIC 3 top cfg 1 register settings.
 
#define HAPTIC3_TOP_CFG1_EMB_MODE_AUTO   0x80
 
#define HAPTIC3_TOP_CFG1_EMB_MODE_MASK   0x80
 
#define HAPTIC3_TOP_CFG1_ACT_TYPE_LRA   0x00
 
#define HAPTIC3_TOP_CFG1_ACT_TYPE_ERM   0x20
 
#define HAPTIC3_TOP_CFG1_ACT_TYPE_MASK   0x20
 
#define HAPTIC3_TOP_CFG1_BEMF_SENSE_CUSTOM_WF   0x00
 
#define HAPTIC3_TOP_CFG1_BEMF_SENSE_STANDARD   0x10
 
#define HAPTIC3_TOP_CFG1_BEMF_SENSE_MASK   0x10
 
#define HAPTIC3_TOP_CFG1_FREQ_TRACK_DISABLE   0x00
 
#define HAPTIC3_TOP_CFG1_FREQ_TRACK_ENABLE   0x08
 
#define HAPTIC3_TOP_CFG1_FREQ_TRACK_MASK   0x08
 
#define HAPTIC3_TOP_CFG1_ACCEL_DISABLE   0x00
 
#define HAPTIC3_TOP_CFG1_ACCEL_ENABLE   0x04
 
#define HAPTIC3_TOP_CFG1_ACCEL_MASK   0x04
 
#define HAPTIC3_TOP_CFG1_RAPID_STOP_DISABLE   0x00
 
#define HAPTIC3_TOP_CFG1_RAPID_STOP_ENABLE   0x02
 
#define HAPTIC3_TOP_CFG1_RAPID_STOP_MASK   0x02
 
#define HAPTIC3_TOP_CFG1_AMPLITUDE_PID_DISABLE   0x00
 
#define HAPTIC3_TOP_CFG1_AMPLITUDE_PID_ENABLE   0x01
 
#define HAPTIC3_TOP_CFG1_AMPLITUDE_PID_MASK   0x01
 
#define HAPTIC3_TOP_CTL1_SEQ_STOP   0x00
 HAPTIC 3 top ctl 1 register settings.
 
#define HAPTIC3_TOP_CTL1_SEQ_START   0x10
 
#define HAPTIC3_TOP_CTL1_SEQ_MASK   0x10
 
#define HAPTIC3_TOP_CTL1_STANDBY_DISABLE   0x00
 
#define HAPTIC3_TOP_CTL1_STANDBY_ENABLE   0x08
 
#define HAPTIC3_TOP_CTL1_STANDBY_MASK   0x08
 
#define HAPTIC3_TOP_CTL1_OP_MODE_INACTIVE   0x00
 
#define HAPTIC3_TOP_CTL1_OP_MODE_DRO   0x01
 
#define HAPTIC3_TOP_CTL1_OP_MODE_PWM   0x02
 
#define HAPTIC3_TOP_CTL1_OP_MODE_RTWM   0x03
 
#define HAPTIC3_TOP_CTL1_OP_MODE_ETWM   0x04
 
#define HAPTIC3_TOP_CTL1_OP_MODE_MASK   0x07
 
#define HAPTIC3_ACTUATOR_VOLTAGE_MIN   0.0
 HAPTIC 3 calculation macros.
 
#define HAPTIC3_ACTUATOR_VOLTAGE_MAX   6.0
 
#define HAPTIC3_ACTUATOR_VOLTAGE_RESOLUTION   0.0234
 
#define HAPTIC3_ACTUATOR_IMAX_MIN   28.6
 
#define HAPTIC3_ACTUATOR_IMAX_MAX   251.8
 
#define HAPTIC3_ACTUATOR_IMAX_DIVIDER   7.2
 
#define HAPTIC3_ACTUATOR_IMAX_RESOLUTION   0x1F
 
#define HAPTIC3_ACTUATOR_IMPEDANCE_MIN   4.0
 
#define HAPTIC3_ACTUATOR_IMPEDANCE_MAX   50.0
 
#define HAPTIC3_ACTUATOR_V2I_FACTOR_DIVIDER   1.6104
 
#define HAPTIC3_ACTUATOR_LRA_FREQ_MIN   0.0
 
#define HAPTIC3_ACTUATOR_LRA_FREQ_MAX   300.0
 
#define HAPTIC3_ACTUATOR_LRA_FREQ_RESOLUTION   0.00000133332
 
#define HAPTIC3_VIBRATION_LEVEL_MIN   -1.0
 
#define HAPTIC3_VIBRATION_LEVEL_MAX   1.0
 
#define HAPTIC3_VIBRATION_LEVEL_MIN_ACC_EN   0.0
 
#define HAPTIC3_VIBRATION_LEVEL_RESOLUTION   0.008
 
#define HAPTIC3_ROUND_TO_NEAREST_INT   0.5
 
#define HAPTIC3_DEFAULT_ACTUATOR_TYPE   HAPTIC3_TOP_CFG1_ACT_TYPE_LRA
 HAPTIC 3 actuator settings default values.
 
#define HAPTIC3_DEFAULT_ACTUATOR_ABS_VOLT   2.808
 
#define HAPTIC3_DEFAULT_ACTUATOR_NOM_VOLT   2.106
 
#define HAPTIC3_DEFAULT_ACTUATOR_IMAX   194.0
 
#define HAPTIC3_DEFAULT_ACTUATOR_IMPEDANCE   16.0
 
#define HAPTIC3_DEFAULT_ACTUATOR_LRA_FREQ   174.0
 
#define HAPTIC3_DEVICE_ADDRESS   0x4A
 HAPTIC 3 device address setting.
 

Detailed Description

Settings for registers of HAPTIC 3 Click driver.

Macro Definition Documentation

◆ HAPTIC3_ACTUATOR_IMAX_DIVIDER

#define HAPTIC3_ACTUATOR_IMAX_DIVIDER   7.2

◆ HAPTIC3_ACTUATOR_IMAX_MAX

#define HAPTIC3_ACTUATOR_IMAX_MAX   251.8

◆ HAPTIC3_ACTUATOR_IMAX_MIN

#define HAPTIC3_ACTUATOR_IMAX_MIN   28.6

◆ HAPTIC3_ACTUATOR_IMAX_RESOLUTION

#define HAPTIC3_ACTUATOR_IMAX_RESOLUTION   0x1F

◆ HAPTIC3_ACTUATOR_IMPEDANCE_MAX

#define HAPTIC3_ACTUATOR_IMPEDANCE_MAX   50.0

◆ HAPTIC3_ACTUATOR_IMPEDANCE_MIN

#define HAPTIC3_ACTUATOR_IMPEDANCE_MIN   4.0

◆ HAPTIC3_ACTUATOR_LRA_FREQ_MAX

#define HAPTIC3_ACTUATOR_LRA_FREQ_MAX   300.0

◆ HAPTIC3_ACTUATOR_LRA_FREQ_MIN

#define HAPTIC3_ACTUATOR_LRA_FREQ_MIN   0.0

◆ HAPTIC3_ACTUATOR_LRA_FREQ_RESOLUTION

#define HAPTIC3_ACTUATOR_LRA_FREQ_RESOLUTION   0.00000133332

◆ HAPTIC3_ACTUATOR_V2I_FACTOR_DIVIDER

#define HAPTIC3_ACTUATOR_V2I_FACTOR_DIVIDER   1.6104

◆ HAPTIC3_ACTUATOR_VOLTAGE_MAX

#define HAPTIC3_ACTUATOR_VOLTAGE_MAX   6.0

◆ HAPTIC3_ACTUATOR_VOLTAGE_MIN

#define HAPTIC3_ACTUATOR_VOLTAGE_MIN   0.0

HAPTIC 3 calculation macros.

Specified calculation macros of HAPTIC 3 Click driver.

◆ HAPTIC3_ACTUATOR_VOLTAGE_RESOLUTION

#define HAPTIC3_ACTUATOR_VOLTAGE_RESOLUTION   0.0234

◆ HAPTIC3_CHIP_REV

#define HAPTIC3_CHIP_REV   0xDA

HAPTIC 3 chip rev value.

Specified chip rev value of HAPTIC 3 Click driver.

◆ HAPTIC3_DEFAULT_ACTUATOR_ABS_VOLT

#define HAPTIC3_DEFAULT_ACTUATOR_ABS_VOLT   2.808

◆ HAPTIC3_DEFAULT_ACTUATOR_IMAX

#define HAPTIC3_DEFAULT_ACTUATOR_IMAX   194.0

◆ HAPTIC3_DEFAULT_ACTUATOR_IMPEDANCE

#define HAPTIC3_DEFAULT_ACTUATOR_IMPEDANCE   16.0

◆ HAPTIC3_DEFAULT_ACTUATOR_LRA_FREQ

#define HAPTIC3_DEFAULT_ACTUATOR_LRA_FREQ   174.0

◆ HAPTIC3_DEFAULT_ACTUATOR_NOM_VOLT

#define HAPTIC3_DEFAULT_ACTUATOR_NOM_VOLT   2.106

◆ HAPTIC3_DEFAULT_ACTUATOR_TYPE

#define HAPTIC3_DEFAULT_ACTUATOR_TYPE   HAPTIC3_TOP_CFG1_ACT_TYPE_LRA

HAPTIC 3 actuator settings default values.

Specified actuator settings default values of HAPTIC 3 Click driver.

◆ HAPTIC3_DEVICE_ADDRESS

#define HAPTIC3_DEVICE_ADDRESS   0x4A

HAPTIC 3 device address setting.

Specified setting for device slave address selection of HAPTIC 3 Click driver.

◆ HAPTIC3_ROUND_TO_NEAREST_INT

#define HAPTIC3_ROUND_TO_NEAREST_INT   0.5

◆ HAPTIC3_TOP_CFG1_ACCEL_DISABLE

#define HAPTIC3_TOP_CFG1_ACCEL_DISABLE   0x00

◆ HAPTIC3_TOP_CFG1_ACCEL_ENABLE

#define HAPTIC3_TOP_CFG1_ACCEL_ENABLE   0x04

◆ HAPTIC3_TOP_CFG1_ACCEL_MASK

#define HAPTIC3_TOP_CFG1_ACCEL_MASK   0x04

◆ HAPTIC3_TOP_CFG1_ACT_TYPE_ERM

#define HAPTIC3_TOP_CFG1_ACT_TYPE_ERM   0x20

◆ HAPTIC3_TOP_CFG1_ACT_TYPE_LRA

#define HAPTIC3_TOP_CFG1_ACT_TYPE_LRA   0x00

◆ HAPTIC3_TOP_CFG1_ACT_TYPE_MASK

#define HAPTIC3_TOP_CFG1_ACT_TYPE_MASK   0x20

◆ HAPTIC3_TOP_CFG1_AMPLITUDE_PID_DISABLE

#define HAPTIC3_TOP_CFG1_AMPLITUDE_PID_DISABLE   0x00

◆ HAPTIC3_TOP_CFG1_AMPLITUDE_PID_ENABLE

#define HAPTIC3_TOP_CFG1_AMPLITUDE_PID_ENABLE   0x01

◆ HAPTIC3_TOP_CFG1_AMPLITUDE_PID_MASK

#define HAPTIC3_TOP_CFG1_AMPLITUDE_PID_MASK   0x01

◆ HAPTIC3_TOP_CFG1_BEMF_SENSE_CUSTOM_WF

#define HAPTIC3_TOP_CFG1_BEMF_SENSE_CUSTOM_WF   0x00

◆ HAPTIC3_TOP_CFG1_BEMF_SENSE_MASK

#define HAPTIC3_TOP_CFG1_BEMF_SENSE_MASK   0x10

◆ HAPTIC3_TOP_CFG1_BEMF_SENSE_STANDARD

#define HAPTIC3_TOP_CFG1_BEMF_SENSE_STANDARD   0x10

◆ HAPTIC3_TOP_CFG1_EMB_MODE_AUTO

#define HAPTIC3_TOP_CFG1_EMB_MODE_AUTO   0x80

◆ HAPTIC3_TOP_CFG1_EMB_MODE_MANUAL

#define HAPTIC3_TOP_CFG1_EMB_MODE_MANUAL   0x00

HAPTIC 3 top cfg 1 register settings.

Specified top cfg 1 register settings of HAPTIC 3 Click driver.

◆ HAPTIC3_TOP_CFG1_EMB_MODE_MASK

#define HAPTIC3_TOP_CFG1_EMB_MODE_MASK   0x80

◆ HAPTIC3_TOP_CFG1_FREQ_TRACK_DISABLE

#define HAPTIC3_TOP_CFG1_FREQ_TRACK_DISABLE   0x00

◆ HAPTIC3_TOP_CFG1_FREQ_TRACK_ENABLE

#define HAPTIC3_TOP_CFG1_FREQ_TRACK_ENABLE   0x08

◆ HAPTIC3_TOP_CFG1_FREQ_TRACK_MASK

#define HAPTIC3_TOP_CFG1_FREQ_TRACK_MASK   0x08

◆ HAPTIC3_TOP_CFG1_RAPID_STOP_DISABLE

#define HAPTIC3_TOP_CFG1_RAPID_STOP_DISABLE   0x00

◆ HAPTIC3_TOP_CFG1_RAPID_STOP_ENABLE

#define HAPTIC3_TOP_CFG1_RAPID_STOP_ENABLE   0x02

◆ HAPTIC3_TOP_CFG1_RAPID_STOP_MASK

#define HAPTIC3_TOP_CFG1_RAPID_STOP_MASK   0x02

◆ HAPTIC3_TOP_CTL1_OP_MODE_DRO

#define HAPTIC3_TOP_CTL1_OP_MODE_DRO   0x01

◆ HAPTIC3_TOP_CTL1_OP_MODE_ETWM

#define HAPTIC3_TOP_CTL1_OP_MODE_ETWM   0x04

◆ HAPTIC3_TOP_CTL1_OP_MODE_INACTIVE

#define HAPTIC3_TOP_CTL1_OP_MODE_INACTIVE   0x00

◆ HAPTIC3_TOP_CTL1_OP_MODE_MASK

#define HAPTIC3_TOP_CTL1_OP_MODE_MASK   0x07

◆ HAPTIC3_TOP_CTL1_OP_MODE_PWM

#define HAPTIC3_TOP_CTL1_OP_MODE_PWM   0x02

◆ HAPTIC3_TOP_CTL1_OP_MODE_RTWM

#define HAPTIC3_TOP_CTL1_OP_MODE_RTWM   0x03

◆ HAPTIC3_TOP_CTL1_SEQ_MASK

#define HAPTIC3_TOP_CTL1_SEQ_MASK   0x10

◆ HAPTIC3_TOP_CTL1_SEQ_START

#define HAPTIC3_TOP_CTL1_SEQ_START   0x10

◆ HAPTIC3_TOP_CTL1_SEQ_STOP

#define HAPTIC3_TOP_CTL1_SEQ_STOP   0x00

HAPTIC 3 top ctl 1 register settings.

Specified top ctl 1 register settings of HAPTIC 3 Click driver.

◆ HAPTIC3_TOP_CTL1_STANDBY_DISABLE

#define HAPTIC3_TOP_CTL1_STANDBY_DISABLE   0x00

◆ HAPTIC3_TOP_CTL1_STANDBY_ENABLE

#define HAPTIC3_TOP_CTL1_STANDBY_ENABLE   0x08

◆ HAPTIC3_TOP_CTL1_STANDBY_MASK

#define HAPTIC3_TOP_CTL1_STANDBY_MASK   0x08

◆ HAPTIC3_VIBRATION_LEVEL_MAX

#define HAPTIC3_VIBRATION_LEVEL_MAX   1.0

◆ HAPTIC3_VIBRATION_LEVEL_MIN

#define HAPTIC3_VIBRATION_LEVEL_MIN   -1.0

◆ HAPTIC3_VIBRATION_LEVEL_MIN_ACC_EN

#define HAPTIC3_VIBRATION_LEVEL_MIN_ACC_EN   0.0

◆ HAPTIC3_VIBRATION_LEVEL_RESOLUTION

#define HAPTIC3_VIBRATION_LEVEL_RESOLUTION   0.008