> ## Documentation Index > Fetch the complete documentation index at: https://dragonwingdocs-staging.qualcomm.com/llms.txt > Use this file to discover all available pages before exploring further. # WSA Haptics VI API **Header:** `spf/api/modules/wsa_haptics_vi_api.h` ## Structures ### `param_id_haptics_vi_static_config_t` **Members** } } Pilot tone frequency values MUST be the same for the RX/TH/EX modules} Pilot tone amplitude values MUST be the same for the RX/TH/EX modules} dB ### `param_id_haptics_vi_op_mode_param_t` **Members** } ### `param_id_haptics_vi_ex_FTM_mode_param_t` **Members** When enabled, the estimated lra parameters are averaged and pushed out to HAL for parameter display and saving into audio.cal} ### `param_id_haptics_th_vi_r0t0_set_param_t` **Members** } This field is valid only in Normal mode (operation\_mode = 0). Default = 8Ohms, Range: 2 to 64Ohms} ### `param_id_haptics_vi_calib_param_t` **Members** } Default = 8Ohm, Range: 2 to 128Ohms} Default = 160Hz, Range = 50 to 400Hz} Default = 1, Range: 0.01 to 128} Default = 0.0945kg/s, Range = 0.0001 to 20kg/s} Default = 0, Range: 0 to 1} ### `param_id_haptics_vi_calib_param_v2_t` **Members** } Default = 8Ohm, Range: 2 to 128Ohms} Default = 160Hz, Range = 50 to 400Hz} Default = 1, Range: 0.01 to 128} Default = 0.0945kg/s, Range = 0.0001 to 20kg/s} Default = 0, Range: 0 to 1} Default = 0.04mH, Range: 0.001mH to 128mH} Default = 0, Range: 0 to 100} Default = 0, Range: 0 to 4} ### `param_id_haptics_vi_ftm_cfg_t` **Members** ### `param_id_haptics_th_vi_r0_get_param_t` **Members** ### `wsa_haptics_th_lra_param_t` **Members** Default = 25 deg C, Range: -30 to 80 deg C.} Default = 10, Range: 0 to 32} Default = 254.45, Range: 0 to 511.99} Default = 10.48, Range: 0 to 31.99} Default = 6.90, Range: 0 to 31.99} Default = 8Ohms, Range: 2 to 128Ohms} Default = 2, Range: 1 to 8} ### `wsa_haptics_r0t0_cali_param_t` **Members** } } } Default = 0 deg C, Range: -30 to 80 deg C} Default = 50 deg C, Range: -30 to 80 deg C} ### `param_id_haptics_th_vi_dynamic_param_t` **Members** Default = -30 deg C, Range: -30 to 200 deg C} Default = 200 deg C, Range: -30 to 80 deg C} ### `param_id_haptics_th_vi_ftm_set_cfg` **Members** ### `param_id_haptics_th_vi_ftm_get_param_t` **Members** ### `wsa_haptics_ex_lra_param_t` **Members** Default = 8Ohm, Range: 2 to 128Ohms} Default = 0.04mH, Range: 0.001mH to 128mH} Default = 1, Range: 0.01 to 128} Default = 1g, Range: 0.05 to 128g} Default = 0.0945kg/s, Range = 0.0001 to 20kg/s} Default = 1.838N/mm, Range = 0.1 to 50N/mm} Default = 160Hz, Range = 50 to 400Hz} Default = 10, Range: 0 to 128} Default = 10.48, Range: 0 to 128} Default = 6.90, Range: 0 to 128} Default = 0Ohm, Range: 0 to 128Ohm} Default = 0.01, Range: 0 to 128} Default = 10, Range: 0 to 128} Default = 0.001Kg/sec, Range: 0 to 128Kg/sec} Default = 20Kg/sec, Range: 0 to 128Kg/sec} Default = 0.1N/mm, Range: 0 to 128N/mm} Default = 50N/mm, Range: 0 to 128N/mm} ### `param_id_haptics_ex_vi_dynamic_param_t` **Members** ### `param_id_haptics_ex_vi_persistent` **Members** Default = 8Ohm, Range: 2 to 128Ohms} Default = 0.04mH, Range: 0.001mH to 128mH} Default = 1, Range: 0.01 to 128} Default = 0.0945kg/s, Range = 0.0001 to 20kg/s} Default = 1.838N/mm, Range = 0.1 to 50N/mm} Default = 160Hz, Range = 50 to 400Hz} ### `param_id_haptics_ex_vi_ftm_set_cfg` **Members** ### `wsa_ex_vi_ftm_get_param_t` **Members** ### `param_id_haptics_ex_vi_ftm_get` **Members** ### `param_id_haptics_lra_diag_getpkt_param_t` **Members** ### `param_id_haptics_ex_vi_demo_pkt_param_t` **Members** ### `param_id_haptics_vi_ftm_data_param_t` **Members** } ### `param_id_haptics_vi_calib_data_param_t` **Members** } ### `param_id_haptics_vi_channel_map_cfg_t` **Members** } HAPTICS\_VI\_VSENS\_LEFT\_CHAN(1) HAPTICS\_VI\_ISENS\_LEFT\_CHAN(2) HAPTICS\_VI\_VSENS\_RIGHT\_CHAN(3) HAPTICS\_VI\_ISENS\_RIGHT\_CHAN(4) Some possible configurations are (1,2,3,4), (4,2,1,3), (1,2,0,0),(4,3,0,0), and (2,1,0,0). All channels must be unique. The order does not matter as long as the channels are valid. If only two channels are sent (V and I), they must be first two channels: Eg: (4,3), (1,2), etc.} ### `param_id_haptics_vi_tuning_data_0_param_t` **Members** } ### `param_id_haptics_vi_tuning_data_1_param_t` **Members** } ### `param_id_haptics_vi_tuning_data_2_param_t` **Members** } ### `param_id_haptics_vi_tuning_data_3_param_t` **Members** } ### `param_id_haptics_vi_tuning_data_4_param_t` **Members** } ### `haptics_lra_selection_range_param_t` **Members** ### `param_id_haptics_lra_selection_param_t` **Members** ## Type Definitions ### `param_id_haptics_vi_static_config_t` ```cpp theme={null} typedef struct param_id_haptics_vi_static_config_t param_id_haptics_vi_static_config_t ``` ### `param_id_haptics_vi_op_mode_param_t` ```cpp theme={null} typedef struct param_id_haptics_vi_op_mode_param_t param_id_haptics_vi_op_mode_param_t ``` ### `param_id_haptics_vi_ex_FTM_mode_param_t` ```cpp theme={null} typedef struct param_id_haptics_vi_ex_FTM_mode_param_t param_id_haptics_vi_ex_FTM_mode_param_t ``` ### `param_id_haptics_th_vi_r0t0_set_param_t` ```cpp theme={null} typedef struct param_id_haptics_th_vi_r0t0_set_param_t param_id_haptics_th_vi_r0t0_set_param_t ``` ### `param_id_haptics_vi_calib_param_t` ```cpp theme={null} typedef struct param_id_haptics_vi_calib_param_t param_id_haptics_vi_calib_param_t ``` ### `param_id_haptics_vi_calib_param_v2_t` ```cpp theme={null} typedef struct param_id_haptics_vi_calib_param_v2_t param_id_haptics_vi_calib_param_v2_t ``` ### `param_id_haptics_vi_ftm_cfg_t` ```cpp theme={null} typedef struct param_id_haptics_vi_ftm_cfg_t param_id_haptics_vi_ftm_cfg_t ``` ### `param_id_haptics_th_vi_r0_get_param_t` ```cpp theme={null} typedef struct param_id_haptics_th_vi_r0_get_param_t param_id_haptics_th_vi_r0_get_param_t ``` ### `wsa_haptics_th_lra_param_t` ```cpp theme={null} typedef struct wsa_haptics_th_lra_param_t wsa_haptics_th_lra_param_t ``` ### `wsa_haptics_r0t0_cali_param_t` ```cpp theme={null} typedef struct wsa_haptics_r0t0_cali_param_t wsa_haptics_r0t0_cali_param_t ``` ### `param_id_haptics_th_vi_dynamic_param_t` ```cpp theme={null} typedef struct param_id_haptics_th_vi_dynamic_param_t param_id_haptics_th_vi_dynamic_param_t ``` ### `param_id_haptics_th_vi_ftm_set_cfg` ```cpp theme={null} typedef struct param_id_haptics_th_vi_ftm_set_cfg param_id_haptics_th_vi_ftm_set_cfg ``` ### `param_id_haptics_th_vi_ftm_get_param_t` ```cpp theme={null} typedef struct param_id_haptics_th_vi_ftm_get_param_t param_id_haptics_th_vi_ftm_get_param_t ``` ### `wsa_haptics_ex_lra_param_t` ```cpp theme={null} typedef struct wsa_haptics_ex_lra_param_t wsa_haptics_ex_lra_param_t ``` ### `param_id_haptics_ex_vi_dynamic_param_t` ```cpp theme={null} typedef struct param_id_haptics_ex_vi_dynamic_param_t param_id_haptics_ex_vi_dynamic_param_t ``` ### `param_id_haptics_ex_vi_persistent` ```cpp theme={null} typedef struct param_id_haptics_ex_vi_persistent param_id_haptics_ex_vi_persistent ``` ### `param_id_haptics_ex_vi_ftm_set_cfg` ```cpp theme={null} typedef struct param_id_haptics_ex_vi_ftm_set_cfg param_id_haptics_ex_vi_ftm_set_cfg ``` ### `wsa_ex_vi_ftm_get_param_t` ```cpp theme={null} typedef struct wsa_ex_vi_ftm_get_param_t wsa_ex_vi_ftm_get_param_t ``` ### `param_id_haptics_ex_vi_ftm_get` ```cpp theme={null} typedef struct param_id_haptics_ex_vi_ftm_get param_id_haptics_ex_vi_ftm_get ``` ### `param_id_haptics_lra_diag_getpkt_param_t` ```cpp theme={null} typedef struct param_id_haptics_lra_diag_getpkt_param_t param_id_haptics_lra_diag_getpkt_param_t ``` ### `param_id_haptics_ex_vi_demo_pkt_param_t` ```cpp theme={null} typedef struct param_id_haptics_ex_vi_demo_pkt_param_t param_id_haptics_ex_vi_demo_pkt_param_t ``` ### `param_id_haptics_vi_ftm_data_param_t` ```cpp theme={null} typedef struct param_id_haptics_vi_ftm_data_param_t param_id_haptics_vi_ftm_data_param_t ``` ### `param_id_haptics_vi_calib_data_param_t` ```cpp theme={null} typedef struct param_id_haptics_vi_calib_data_param_t param_id_haptics_vi_calib_data_param_t ``` ### `param_id_haptics_vi_channel_map_cfg_t` ```cpp theme={null} typedef struct param_id_haptics_vi_channel_map_cfg_t param_id_haptics_vi_channel_map_cfg_t ``` ### `param_id_haptics_vi_tuning_data_0_param_t` ```cpp theme={null} typedef struct param_id_haptics_vi_tuning_data_0_param_t param_id_haptics_vi_tuning_data_0_param_t ``` ### `param_id_haptics_vi_tuning_data_1_param_t` ```cpp theme={null} typedef struct param_id_haptics_vi_tuning_data_1_param_t param_id_haptics_vi_tuning_data_1_param_t ``` ### `param_id_haptics_vi_tuning_data_2_param_t` ```cpp theme={null} typedef struct param_id_haptics_vi_tuning_data_2_param_t param_id_haptics_vi_tuning_data_2_param_t ``` ### `param_id_haptics_vi_tuning_data_3_param_t` ```cpp theme={null} typedef struct param_id_haptics_vi_tuning_data_3_param_t param_id_haptics_vi_tuning_data_3_param_t ``` ### `param_id_haptics_vi_tuning_data_4_param_t` ```cpp theme={null} typedef struct param_id_haptics_vi_tuning_data_4_param_t param_id_haptics_vi_tuning_data_4_param_t ``` ### `haptics_lra_selection_range_param_t` ```cpp theme={null} typedef struct haptics_lra_selection_range_param_t haptics_lra_selection_range_param_t ``` ### `param_id_haptics_lra_selection_param_t` ```cpp theme={null} typedef struct param_id_haptics_lra_selection_param_t param_id_haptics_lra_selection_param_t ``` ## Macros ### `HAPTICS_VI_VSENS_LEFT_CHAN` ```c theme={null} #define HAPTICS_VI_VSENS_LEFT_CHAN 1 ``` ### `HAPTICS_VI_ISENS_LEFT_CHAN` ```c theme={null} #define HAPTICS_VI_ISENS_LEFT_CHAN 2 ``` ### `HAPTICS_VI_VSENS_RIGHT_CHAN` ```c theme={null} #define HAPTICS_VI_VSENS_RIGHT_CHAN 3 ``` ### `HAPTICS_VI_ISENS_RIGHT_CHAN` ```c theme={null} #define HAPTICS_VI_ISENS_RIGHT_CHAN 4 ``` ### `HAPTICS_MAX_OUT_CHAN` ```c theme={null} #define HAPTICS_MAX_OUT_CHAN (2) ``` ### `MAX_SAMPLES_IN_PACKET` ```c theme={null} #define MAX_SAMPLES_IN_PACKET 480 ``` ### `PARAM_ID_HAPTICS_VI_STATIC_CONFIG` ```c theme={null} #define PARAM_ID_HAPTICS_VI_STATIC_CONFIG 0x080013A4 ``` ### `PARAM_ID_HAPTICS_VI_OP_MODE_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_VI_OP_MODE_PARAM 0x080013A5 ``` ### `PARAM_ID_HAPTICS_VI_EX_FTM_MODE_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_VI_EX_FTM_MODE_PARAM 0x080013A6 ``` ### `PARAM_ID_HAPTICS_TH_VI_R0T0_SET_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_TH_VI_R0T0_SET_PARAM 0x080013A7 ``` ### `PARAM_ID_HAPTICS_VI_CALIB_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_VI_CALIB_PARAM 0x08001ADD ``` ### `PARAM_ID_HAPTICS_VI_CALIB_PARAM_V2` ```c theme={null} #define PARAM_ID_HAPTICS_VI_CALIB_PARAM_V2 0x08001B24 ``` ### `PARAM_ID_HAPTICS_VI_FTM_CFG` ```c theme={null} #define PARAM_ID_HAPTICS_VI_FTM_CFG 0x08001B1D ``` ### `PARAM_ID_HAPTICS_TH_VI_R0_GET_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_TH_VI_R0_GET_PARAM 0x080013A8 ``` ### `PARAM_ID_HAPTICS_TH_VI_DYNAMIC_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_TH_VI_DYNAMIC_PARAM 0x080013A9 ``` ### `PARAM_ID_HAPTICS_TH_VI_FTM_SET_CFG` ```c theme={null} #define PARAM_ID_HAPTICS_TH_VI_FTM_SET_CFG 0x080013AA ``` ### `PARAM_ID_HAPTICS_TH_VI_FTM_GET_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_TH_VI_FTM_GET_PARAM 0x080013AB ``` ### `PARAM_ID_HAPTICS_EX_VI_DYNAMIC_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_EX_VI_DYNAMIC_PARAM 0x080013AC ``` ### `PARAM_ID_HAPTICS_EX_VI_PERSISTENT` ```c theme={null} #define PARAM_ID_HAPTICS_EX_VI_PERSISTENT 0x080013AD ``` ### `PARAM_ID_HAPTICS_EX_VI_FTM_SET_CFG` ```c theme={null} #define PARAM_ID_HAPTICS_EX_VI_FTM_SET_CFG 0x080013AE ``` ### `PARAM_ID_HAPTICS_EX_VI_FTM_GET` ```c theme={null} #define PARAM_ID_HAPTICS_EX_VI_FTM_GET 0x080013AF ``` ### `PARAM_ID_HAPTICS_LRA_DIAG_GETPKT_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_LRA_DIAG_GETPKT_PARAM 0x080013B0 ``` ### `PARAM_ID_HAPTICS_EX_VI_DEMO_PKT_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_EX_VI_DEMO_PKT_PARAM 0x080013B1 ``` ### `PARAM_ID_HAPTICS_VI_FTM_DATA_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_VI_FTM_DATA_PARAM 0x08001ADC ``` ### `PARAM_ID_HAPTICS_VI_CALIB_DATA_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_VI_CALIB_DATA_PARAM 0x08001ADB ``` ### `PARAM_ID_HAPTICS_VI_CHANNEL_MAP_CFG` ```c theme={null} #define PARAM_ID_HAPTICS_VI_CHANNEL_MAP_CFG 0x080013BE ``` ### `PARAM_ID_HAPTICS_VI_TUNING_DATA_0_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_VI_TUNING_DATA_0_PARAM 0x08001B1E ``` ### `PARAM_ID_HAPTICS_VI_TUNING_DATA_1_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_VI_TUNING_DATA_1_PARAM 0x08001B1F ``` ### `PARAM_ID_HAPTICS_VI_TUNING_DATA_2_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_VI_TUNING_DATA_2_PARAM 0x08001B20 ``` ### `PARAM_ID_HAPTICS_VI_TUNING_DATA_3_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_VI_TUNING_DATA_3_PARAM 0x08001B21 ``` ### `PARAM_ID_HAPTICS_VI_TUNING_DATA_4_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_VI_TUNING_DATA_4_PARAM 0x08001B22 ``` ### `PARAM_ID_HAPTICS_LRA_SELECTION_PARAM` ```c theme={null} #define PARAM_ID_HAPTICS_LRA_SELECTION_PARAM 0x08001B23 ``` ### `EVENT_ID_HAPTICS_VI_CALIBRATION` ```c theme={null} #define EVENT_ID_HAPTICS_VI_CALIBRATION 0x080013B4 ``` ### `EVENT_ID_HAPTICS_LRA_DIAGNOSTICS` ```c theme={null} #define EVENT_ID_HAPTICS_LRA_DIAGNOSTICS 0x080013B3 ``` ### `HAPTICS_VI_MAX_INPUT_PORTS` ```c theme={null} #define HAPTICS_VI_MAX_INPUT_PORTS 1 ``` ### `HAPTICS_VI_MAX_OUTPUT_PORTS` ```c theme={null} #define HAPTICS_VI_MAX_OUTPUT_PORTS 1 ``` ### `HAPTICS_VI_STACK_SIZE` ```c theme={null} #define HAPTICS_VI_STACK_SIZE 4096 ``` ### `MODULE_ID_HAPTICS_VI` ```c theme={null} #define MODULE_ID_HAPTICS_VI 0x070010E5 ```