Skip to main content
Version: 0.1.5

HandleStatusResponse

Haply::HardwareAPI::Devices::Handle::HandleStatusResponse

The current state of the handle.

Index

Members

NameTypeDescription
device_iduint16_tShort non-unique device id for the device.
quaternionfloatThe orientation of the handle represented as a quaternion ...
error_flaguint8_tIndicates whether an error was detected.
handle_connection_sensoruint8_tIndicates whether the device is attached to an ...
user_data_lengthuint8_tThe number of bytes that can be read in the ...
user_datauint8_tUser bytes whose representation is specific to the handle.

Members

device_id

uint16_t device_id 0

Short non-unique device id for the device.

Device identifier for the handle. This short device is not guaranteed to be unique and may be overloaded as the hardware_version and the device_model_number changes.

quaternion

float quaternion 0

The orientation of the handle represented as a quaternion in the WXYZ order.

The handle rotation is calibrated when it's powered on and can be reset using the calibration button.

error_flag

uint8_t error_flag 0

Indicates whether an error was detected.

DEPRECATED This field is being repurposed and should not be used or relied upon.

handle_connection_sensor

uint8_t handle_connection_sensor 0

Indicates whether the device is attached to an Inverse3 device.

The value 1 indicates that the handle is attached to an Invers3.

For environments that uses multiple Inverse3 simultaneously, it is currently not possible to determine programmatically which Inverse3 a given handle is attached to.

user_data_length

uint8_t user_data_length 0

The number of bytes that can be read in the user_data field.

This value can't exceed USER_DATA_MAX.

user_data

uint8_t user_data

User bytes whose representation is specific to the handle.

Consult the documentation for your handle to determine how to interpret the bytes.