axis-sdk 2.4.1
API for axis-sdk
 
Loading...
Searching...
No Matches
Enumerations
Enums

Enumerations

enum  Refract::AXIS::AxisRuntimeErrors : uint16_t {
  Refract::AXIS::OK , Refract::AXIS::PacketCallbackNotSet , Refract::AXIS::InvalidDongleCommand , Refract::AXIS::HubTimeout ,
  Refract::AXIS::InvalidIPAddress , Refract::AXIS::InvalidParameter , Refract::AXIS::NoLANAdapter , Refract::AXIS::HTTPError ,
  Refract::AXIS::HTTPException , Refract::AXIS::SocketError , Refract::AXIS::SocketException , Refract::AXIS::PreviousOpInProgress ,
  Refract::AXIS::DongleNotConnected , Refract::AXIS::SerialPortError , Refract::AXIS::InternalError , Refract::AXIS::SDKNotStarted ,
  Refract::AXIS::NoSubnet , RUNTIME_ERROR_COUNT
}
 Runtime error codes. More...
 
enum  Refract::AXIS::AxisPacketTypes : uint16_t {
  Refract::AXIS::IMUData , Refract::AXIS::VisibleNodes , Refract::AXIS::PairedNodes , Refract::AXIS::SetWifiResponse ,
  Refract::AXIS::ReportWifi , Refract::AXIS::ReportBatt , Refract::AXIS::DoubleClick , Refract::AXIS::Versions ,
  Refract::AXIS::SuitInfo , Refract::AXIS::NodeAssignAck , Refract::AXIS::DevPacket , Refract::AXIS::NodeConfigResponse ,
  Refract::AXIS::SkeletonData , PACKET_TYPES_COUNT
}
 Packet types. More...
 
enum  Refract::AXIS::AxisNodePositions : uint16_t {
  Refract::AXIS::RightThigh , Refract::AXIS::RightCalf , Refract::AXIS::LeftThigh , Refract::AXIS::LeftCalf ,
  Refract::AXIS::RightUpperArm , Refract::AXIS::RightForearm , Refract::AXIS::LeftUpperArm , Refract::AXIS::LeftForearm ,
  Refract::AXIS::Spine , Refract::AXIS::RightFoot , Refract::AXIS::LeftFoot , Refract::AXIS::RightHand ,
  Refract::AXIS::LeftHand , Refract::AXIS::RightShoulder , Refract::AXIS::LeftShoulder , Refract::AXIS::Head ,
  Refract::AXIS::Hip , Refract::AXIS::Unassigned , NODE_INDEX_COUNT
}
 NodeIndex and what position on the body they represent. More...
 
enum  Refract::AXIS::AxisNodeOperationModes : uint16_t { Refract::AXIS::Unsupported , Refract::AXIS::Fusion , Refract::AXIS::FusionNoMag , OPERATION_MODE_COUNT }
 Operating modes used by AXIS nodes. More...
 
enum  Refract::AXIS::AxisDongleCommandTypes : uint16_t {
  Refract::AXIS::Shutdown , Refract::AXIS::GetWifi , Refract::AXIS::GetBatt , Refract::AXIS::GetVersions ,
  Refract::AXIS::Suitinfo , Refract::AXIS::Reboot , Refract::AXIS::SetWifi , Refract::AXIS::NodeAssign ,
  Refract::AXIS::NodeInfo , Refract::AXIS::NodeAssignSingle , Refract::AXIS::NodeConfigSet , Refract::AXIS::Calibration ,
  Refract::AXIS::NodeOperationMode , Refract::AXIS::Buzz , Refract::AXIS::LED , Refract::AXIS::BuzzMAC ,
  Refract::AXIS::LEDMAC , Refract::AXIS::NodeConfigGet , DONGLE_COMMAND_TYPES_COUNT
}
 Command types. More...
 
enum  Refract::AXIS::AxisHipProviderModes : uint16_t { Refract::AXIS::HipProviderNone , Refract::AXIS::HipProviderNode , Refract::AXIS::HipProviderHub , AXIS_HIP_PROVIDER_MODES_COUNT }
 Hip Provider modes. More...
 
enum  Refract::AXIS::AxisHubLocations : uint16_t { Refract::AXIS::HubLocationBack , Refract::AXIS::HubLocationFront , AXIS_HUB_LOCATION_COUNT }
 Axis Hub locations. More...
 
enum  Refract::AXIS::AxisNodeConfigCategories : uint16_t { Refract::AXIS::DEV , Refract::AXIS::Power , AXIS_NODE_CONFIG_CATEGORIES_COUNT }
 Categories for node configuration. See Refract::AXIS::NodeConfig_t. More...
 
enum  Refract::AXIS::AxisNodeConfigDevParams : uint16_t { Refract::AXIS::DevPacketBitflags , AXIS_NODE_CONFIG_DEV_PARAMETERS_COUNT }
 Parameters for node configuration in Refract::AXIS::AxisNodeConfigCategories::DEV category. More...
 
enum  Refract::AXIS::AxisNodeConfigPowerParams : uint16_t { Refract::AXIS::TransmissionPower , Refract::AXIS::TransmissionFrequency , AXIS_NODE_CONFIG_POWER_PARAMETERS_COUNT }
 Parameters for node configuration in Refract::AXIS::AxisNodeConfigCategories::Power category. More...
 
enum  Refract::AXIS::AxisVmcConfigBones : uint16_t {
  Refract::AXIS::VMCHips , Refract::AXIS::VMCLeftUpperLeg , Refract::AXIS::VMCRightUpperLeg , Refract::AXIS::VMCLeftLowerLeg ,
  Refract::AXIS::VMCRightLowerLeg , Refract::AXIS::VMCLeftFoot , Refract::AXIS::VMCRightFoot , Refract::AXIS::VMCSpine ,
  Refract::AXIS::VMCChest , Refract::AXIS::VMCUpperChest , Refract::AXIS::VMCNeck , Refract::AXIS::VMCHead ,
  Refract::AXIS::VMCLeftShoulder , Refract::AXIS::VMCRightShoulder , Refract::AXIS::VMCLeftUpperArm , Refract::AXIS::VMCRightUpperArm ,
  Refract::AXIS::VMCLeftLowerArm , Refract::AXIS::VMCRightLowerArm , Refract::AXIS::VMCLeftHand , Refract::AXIS::VMCRightHand ,
  Refract::AXIS::VMC_CONFIG_COUNT
}
 Bones used for VMC. More...
 
enum  Refract::AXIS::AxisSkeletonJoints : uint16_t {
  Refract::AXIS::SKHMD , Refract::AXIS::SKHead , Refract::AXIS::SKNeck , Refract::AXIS::SKUpperSpine ,
  Refract::AXIS::SKMiddleSpine , Refract::AXIS::SKLowerSpine , Refract::AXIS::SKHip , Refract::AXIS::SKRightHip ,
  Refract::AXIS::SKRightKnee , Refract::AXIS::SKRightAnkle , Refract::AXIS::SKRightFoot , Refract::AXIS::SKLeftHip ,
  Refract::AXIS::SKLeftKnee , Refract::AXIS::SKLeftAnkle , Refract::AXIS::SKLeftFoot , Refract::AXIS::SKRightScapula ,
  Refract::AXIS::SKRightShoulder , Refract::AXIS::SKRightElbow , Refract::AXIS::SKRightWrist , Refract::AXIS::SKRightHand ,
  Refract::AXIS::SKLeftScapula , Refract::AXIS::SKLeftShoulder , Refract::AXIS::SKLeftElbow , Refract::AXIS::SKLeftWrist ,
  Refract::AXIS::SKLeftHand , Refract::AXIS::SK_JOINT_COUNT
}
 Joints used for Refract::AXIS::SkeletonData_t. More...
 

Detailed Description

Enumeration Type Documentation

◆ AxisRuntimeErrors

enum Refract::AXIS::AxisRuntimeErrors : uint16_t

Runtime error codes.

Enumerator
OK 

No error

PacketCallbackNotSet 

No packet callback was set in the config

InvalidDongleCommand 

Dongle command was invalid. Please check parameters

HubTimeout 

Command to Axis Hub timed out

InvalidIPAddress 

IP address is invalid

InvalidParameter 

Parameter passed into function was invalid

NoLANAdapter 

Could not find a LAN adapter to try and search for Axis Hubs

HTTPError 

HTTP Request error code. Check the errorCode parameter

HTTPException 

Exception occurred while making a HTTP Request. Check the errorString parameter

SocketError 

Error occurred while trying to reading from a socket. Check the errorCode parameter

SocketException 

Exception occurred while trying to open a socket. Check the errorString parameter

PreviousOpInProgress 

Previous operation still in progress. Wait for it to complete first

DongleNotConnected 

Tried to send a dongle command when the dongle wasn't connected

SerialPortError 

A serial port error has occurred. Error codes are platform dependant

InternalError 

Something went wrong within the SDK. Shouldn't happen

SDKNotStarted 

SDK has not been started.

NoSubnet 

Ip address given was not in the same subnet as any LAN adapters

◆ AxisPacketTypes

enum Refract::AXIS::AxisPacketTypes : uint16_t

Packet types.

Enumerator
IMUData 

Stream of orientation and linear acceleration data from the nodes. Refer to Refract::AXIS::IMUData_t

VisibleNodes 

Array of nodes' MAC addresses visible to the dongle. Refer to Refract::AXIS::NodesInfo_t

PairedNodes 

Array of nodes' MAC addresses paired with the dongle. Refer to Refract::AXIS::NodesInfo_t

SetWifiResponse 

Response from the dongle after sending a SetWifi command. Refer to Refract::AXIS::WifiRes_t

ReportWifi 

Current wifi channel used by the dongle and nodes. Refer to Refract::AXIS::WifiRes_t

ReportBatt 

Battery info of paired nodes. Refer to Refract::AXIS::BattInfo_t

DoubleClick 

MAC address of the node where user pressed the button twice. Refer to Refract::AXIS::NodesInfo_t

Versions 

Versions of the dongle and paired nodes. Refer to Refract::AXIS::VersionsInfo_t

SuitInfo 

Info for the entire suit. Refer to Refract::AXIS::SuitInfo_t

NodeAssignAck 

Array of nodes' MAC addresses and their positions. Refer to Refract::AXIS::NodesInfo_t

DevPacket 

Stream of DevPackets from the dongle. Refer to Refract::AXIS::DevPacket_t

NodeConfigResponse 

Node configuration information. Refer to Refract::AXIS::NodeConfigResponse_t

SkeletonData 

Stream of orientation and position data of joints. Refer to Refract::AXIS::SkeletonData_t

◆ AxisNodePositions

enum Refract::AXIS::AxisNodePositions : uint16_t

NodeIndex and what position on the body they represent.

Enumerator
RightThigh 

Right thigh

RightCalf 

Right shin

LeftThigh 

Left thigh

LeftCalf 

Left shin

RightUpperArm 

Right upper Arm

RightForearm 

Right forearm

LeftUpperArm 

Left upper Arm

LeftForearm 

Left forearm

Spine 

Spine

RightFoot 

Right foot

LeftFoot 

Left foot

RightHand 

Right hand

LeftHand 

Left hand

RightShoulder 

Right shoulder

LeftShoulder 

Left shoulder

Head 

Head

Hip 

Hip / Waist

Unassigned 

Unpaired nodes will have this as their node index

◆ AxisNodeOperationModes

enum Refract::AXIS::AxisNodeOperationModes : uint16_t

Operating modes used by AXIS nodes.

Enumerator
Unsupported 

A node with unsupported operation mode is probably a node with old firmware and needs to be updated

Fusion 

Sensor fusion using magnetometer. This is the default

FusionNoMag 

Alternative sensor fusion algorithm without magnetometer

◆ AxisDongleCommandTypes

enum Refract::AXIS::AxisDongleCommandTypes : uint16_t

Command types.

Enumerator
Shutdown 

Turn off all paired nodes

GetWifi 

Get the current wifi channel being used by the dongle

GetBatt 

Get the battery info of all paired nodes

GetVersions 

Get the version info of the dongle and all paired nodes

Suitinfo 

Get info for entire suit

Reboot 

Reboot paired nodes.

SetWifi 

Set Wifi channel to be used by the dongle.

NodeAssign 

Assign nodes to specific body positions.

NodeInfo 

Get node info for paired / visible nodes.

NodeAssignSingle 

Assign a node to a specific body position

NodeConfigSet 

Set a specific node configuration. From firmware version 2.4.x onwards

Calibration 

Perform calibration

NodeOperationMode 

Set nodes to a specific operation mode

Buzz 

Vibrate a specific node by body position

LED 

Change the color and/or brightness of a specific node by body position

BuzzMAC 

Vibrate a specific node by MAC address

LEDMAC 

Change the color and/or brightness of a specific node by MAC address

NodeConfigGet 

Get node configuration. From firmware version 2.4.x onwards

◆ AxisHipProviderModes

enum Refract::AXIS::AxisHipProviderModes : uint16_t

Hip Provider modes.

Enumerator
HipProviderNone 

No Hip provider

HipProviderNode 

Using Axis node for hip

HipProviderHub 

UUsing Axis Hub for hip

◆ AxisHubLocations

enum Refract::AXIS::AxisHubLocations : uint16_t

Axis Hub locations.

Enumerator
HubLocationBack 

Axis hub is located on user's back

HubLocationFront 

Axis hub is located on user's front

◆ AxisNodeConfigCategories

enum Refract::AXIS::AxisNodeConfigCategories : uint16_t

Categories for node configuration. See Refract::AXIS::NodeConfig_t.

Enumerator
DEV 

Dev category

Power 

Power configuration category

◆ AxisNodeConfigDevParams

enum Refract::AXIS::AxisNodeConfigDevParams : uint16_t

Parameters for node configuration in Refract::AXIS::AxisNodeConfigCategories::DEV category.

Enumerator
DevPacketBitflags 

Flags for Refract::AXIS::DevPacket_t. See Refract::AXIS::DevPacket_t::DevPacketComponents

◆ AxisNodeConfigPowerParams

enum Refract::AXIS::AxisNodeConfigPowerParams : uint16_t

Parameters for node configuration in Refract::AXIS::AxisNodeConfigCategories::Power category.

Enumerator
TransmissionPower 

Transmission Power (0-20dbm). Lower values save more power but decrease range

TransmissionFrequency 

Transmission Frequency. Lower value saves more power but decreases tracking smoothness

◆ AxisVmcConfigBones

enum Refract::AXIS::AxisVmcConfigBones : uint16_t

Bones used for VMC.

Enumerator
VMCHips 

Hips

VMCLeftUpperLeg 

Left upper leg

VMCRightUpperLeg 

Right upper leg

VMCLeftLowerLeg 

Left knee

VMCRightLowerLeg 

Right knee

VMCLeftFoot 

Left ankle

VMCRightFoot 

Right ankle

VMCSpine 

Spine

VMCChest 

Chest

VMCUpperChest 

Upper chest

VMCNeck 

Neck

VMCHead 

Head

VMCLeftShoulder 

Left shoulder

VMCRightShoulder 

Right shoulder

VMCLeftUpperArm 

Left upper arm

VMCRightUpperArm 

Right upper arm

VMCLeftLowerArm 

Left elbow

VMCRightLowerArm 

Right elbow

VMCLeftHand 

Left wrist

VMCRightHand 

Right wrist

VMC_CONFIG_COUNT 

Maximum number of VMC bones

◆ AxisSkeletonJoints

enum Refract::AXIS::AxisSkeletonJoints : uint16_t

Joints used for Refract::AXIS::SkeletonData_t.

Enumerator
SKHMD 

Head mounted display

SKHead 

Head

SKNeck 

Neck

SKUpperSpine 

Upper spine

SKMiddleSpine 

Middle spine

SKLowerSpine 

Lower spine

SKHip 

Hip

SKRightHip 

Right hip

SKRightKnee 

Right knee

SKRightAnkle 

Right ankle

SKRightFoot 

Right foot

SKLeftHip 

Left hip

SKLeftKnee 

Left knee

SKLeftAnkle 

Left ankle

SKLeftFoot 

Left foot

SKRightScapula 

Right shoulder (scapula)

SKRightShoulder 

Right shoulder (glenohumeral)

SKRightElbow 

Right elbow

SKRightWrist 

Right wrist

SKRightHand 

Right hand

SKLeftScapula 

Left shoulder (scapula)

SKLeftShoulder 

Left shoulder (glenohumeral)

SKLeftElbow 

Left elbow

SKLeftWrist 

Left wrist

SKLeftHand 

Left hand

SK_JOINT_COUNT 

Maximum number of VMC bones