The abstract of the device setting handler of a gForce device. More...

#include <DeviceSetting.h>

Public Types
enum	DeviceService : GF_UINT32 { DeviceService::HID_Joystick = 0x1, DeviceService::HID_Mouse = 0x2, DeviceService::HID_Vendor = 0x3 }

enum	DataNotifFlags { DNF_OFF = 0x00000000, DNF_ACCELERATE = 0x00000001, DNF_GYROSCOPE = 0x00000002, DNF_MAGNETOMETER = 0x00000004, DNF_EULERANGLE = 0x00000008, DNF_QUATERNION = 0x00000010, DNF_ROTATIONMATRIX = 0x00000020, DNF_EMG_GESTURE = 0x00000040, DNF_EMG_RAW = 0x00000080, DNF_HID_MOUSE = 0x00000100, DNF_HID_JOYSTICK = 0x00000200, DNF_DEVICE_STATUS = 0x00000400, DNF_ALL = 0xFFFFFFFF }

enum	SWOLogLevel : GF_UINT32 { SWOLogLevel::All = 0x00, SWOLogLevel::Debug = 0x01, SWOLogLevel::Info = 0x02, SWOLogLevel::Warn = 0x03, SWOLogLevel::Error = 0x04, SWOLogLevel::Fatal = 0x05, SWOLogLevel::None = 0xFF }

enum	SWOModule : GF_UINT32 { SWO_MODULE_NONE = 0x00000000, SWO_MODULE_NPI = 0x00000001, SWO_MODULE_IMU = 0x00000002, SWO_MODULE_RTOS = 0x00000004, SWO_MODULE_ADC = 0x00000008, SWO_MODULE_PROFILE = 0x00000010, SWO_MODULE_APP = 0x00000020, SWO_MODULE_ALL = 0xFFFFFFFF }

enum	KernelMsgType : GF_UINT8 { KernelMsgType::TaskList = 0x00, KernelMsgType::RuntimeState = 0x01 }

enum	VibrateControlType : GF_UINT8 { VibrateControlType::Off = 0x00, VibrateControlType::On = 0x01, VibrateControlType::Disable = 0x02, VibrateControlType::Enable = 0x03 }

enum	LedControlTestType : GF_UINT8 { LedControlTestType::Off = 0x00, LedControlTestType::On = 0x01 }

enum	PackageControlType : GF_UINT8 { PackageControlType::Disable = 0x00, PackageControlType::Enable = 0x01 }

enum	EMGRowDataChannels : GF_UINT16 { ERDC_CHANNEL_NONE = 0x0000, ERDC_CHANNEL0 = 0x0001, ERDC_CHANNEL1 = 0x0002, ERDC_CHANNEL2 = 0x0004, ERDC_CHANNEL3 = 0x0008, ERDC_CHANNEL4 = 0x0010, ERDC_CHANNEL5 = 0x0020, ERDC_CHANNEL6 = 0x0040, ERDC_CHANNEL7 = 0x0080, ERDC_CHANNEL8 = 0x0100, ERDC_CHANNEL9 = 0x0200, ERDC_CHANNEL10 = 0x0400, ERDC_CHANNEL11 = 0x0800, ERDC_CHANNEL12 = 0x1000, ERDC_CHANNEL13 = 0x2000, ERDC_CHANNEL14 = 0x4000, ERDC_CHANNEL15 = 0x8000, ERDC_CHANNEL_ALL = 0xFFFF }

enum	DeviceStatusFlags : GF_UINT16 { DSF_NONE = 0x0000, DSF_RECENTER = 0x0001, DSF_USBSTATUS = 0x0002, DSF_MOTIONLESS = 0x0004 }

Public Member Functions
virtual GF_RET_CODE	getProtocolVer (std::function< void(ResponseResult res, tstring version)> cb)=0

virtual GF_RET_CODE	getFeatureMap (std::function< void(ResponseResult res, GF_UINT32 featureMap)> cb)=0

virtual GF_RET_CODE	getDeviceName (std::function< void(ResponseResult res, tstring name)> cb)=0

virtual GF_RET_CODE	getModelNumber (std::function< void(ResponseResult res, tstring modelNumber)> cb)=0

virtual GF_RET_CODE	getSerialNumber (std::function< void(ResponseResult res, tstring serialNumber)> cb)=0

virtual GF_RET_CODE	getHWRevision (std::function< void(ResponseResult res, tstring version)> cb)=0

virtual GF_RET_CODE	getFWRevision (std::function< void(ResponseResult res, tstring version)> cb)=0

virtual GF_RET_CODE	getManufacturerName (std::function< void(ResponseResult res, tstring name)> cb)=0

virtual GF_RET_CODE	getBootloaderVer (std::function< void(ResponseResult res, tstring version)> cb)=0

virtual GF_RET_CODE	powerOff ()=0

virtual GF_RET_CODE	swithToOAD ()=0

virtual GF_RET_CODE	systemReset ()=0

virtual GF_RET_CODE	switchService (DeviceService service)=0

virtual GF_RET_CODE	oadUpgrade (FILE *file, std::function< void(ResponseResult res, GF_UINT32 percentage)> progress)=0

virtual GF_RET_CODE	sendTrainingModelData (GF_UINT32 length, GF_UINT8 data[], std::function< void(ResponseResult res, GF_UINT32 percentage)> progress)=0

virtual GF_RET_CODE	setDataNotifSwitch (DataNotifFlags flags, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	getBatteryLevel (std::function< void(ResponseResult res, GF_UINT32 percentage)> cb)=0

virtual GF_RET_CODE	getTemperature (std::function< void(ResponseResult res, GF_UINT32 temperature)> cb)=0

virtual GF_RET_CODE	setLogLevel (SWOLogLevel level, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	setLogModuleEnabled (SWOModule modules, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	printKernelMsg (KernelMsgType type, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	vibrateControl (VibrateControlType type, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	ledControlTest (LedControlTestType type, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	packageIdControl (PackageControlType type, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	getAccelerateCap (std::function< void(ResponseResult res, GF_UINT16 maxSampleRateHz, GF_UINT8 maxScaleRange_g, GF_UINT8 maxPackageDataLength)> cb)=0

virtual GF_RET_CODE	setAccelerateConfig (GF_UINT16 sampleRateHz, GF_UINT8 fullScaleRange_g, GF_UINT8 packageDataLength, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	getGyroscopeCap (std::function< void(ResponseResult res, GF_UINT16 maxSampleRateHz, GF_UINT16 maxScaleRange_dps, GF_UINT8 maxPackageDataLength)> cb)=0

virtual GF_RET_CODE	setGyroscopeConfig (GF_UINT16 sampleRateHz, GF_UINT16 fullScaleRange_dps, GF_UINT8 packageDataLength, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	getMagnetometerCap (std::function< void(ResponseResult res, GF_UINT16 maxSampleRateHz, GF_UINT16 maxScaleRange_uT, GF_UINT8 maxPackageDataLength)> cb)=0

virtual GF_RET_CODE	setMagnetometerConfig (GF_UINT16 sampleRateHz, GF_UINT16 fullScaleRange_uT, GF_UINT8 packageDataLength, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	getEulerangleCap (std::function< void(ResponseResult res, GF_UINT16 maxSampleRateHz)> cb)=0

virtual GF_RET_CODE	setEulerangleConfig (GF_UINT16 sampleRateHz, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	getQuaternionCap (std::function< void(ResponseResult res, GF_UINT16 maxSampleRateHz)> cb)=0

virtual GF_RET_CODE	setQuaternionConfig (GF_UINT16 sampleRateHz, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	getRotationMatrixCap (std::function< void(ResponseResult res, GF_UINT16 maxSampleRateHz)> cb)=0

virtual GF_RET_CODE	setRotationMatrixConfig (GF_UINT16 sampleRateHz, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	getGestureCap (std::function< void(ResponseResult res, GF_SIZE number, const Gesture supportedGestures[])> cb)=0

virtual GF_RET_CODE	setGestureConfig (GF_UINT32 number, Gesture interestingGesture[], std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	getEMGRawDataCap (std::function< void(ResponseResult res, GF_UINT16 maxSampleRateHz, EMGRowDataChannels supportedChannels, GF_UINT8 maxPackageDataLength)> cb)=0

virtual GF_RET_CODE	setEMGRawDataConfig (GF_UINT16 sampleRateHz, EMGRowDataChannels interestingChannels, GF_UINT8 packageDataLength, GF_UINT8 adcResolution, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	getMouseDataCap (std::function< void(ResponseResult res, GF_UINT16 maxSampleRateHz)> cb)=0

virtual GF_RET_CODE	setMouseDataConfig (GF_UINT16 sampleRateHz, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	getJoystickDataCap (std::function< void(ResponseResult res, GF_UINT16 maxSampleRateHz)> cb)=0

virtual GF_RET_CODE	setJoystickDataConfig (GF_UINT16 sampleRateHz, std::function< void(ResponseResult res)> cb)=0

virtual GF_RET_CODE	getDeviceStatusCap (std::function< void(ResponseResult res, DeviceStatusFlags flags)> cb)=0

virtual GF_RET_CODE	setDeviceStatusConfig (DeviceStatusFlags flags, std::function< void(ResponseResult res)> cb)=0

Protected Member Functions
virtual	~DeviceSetting ()
	Virtual deconstructor.

Detailed Description

The abstract of the device setting handler of a gForce device.

According to 4.x definition.

Member Enumeration Documentation

◆ DataNotifFlags

enum gf::DeviceSetting::DataNotifFlags

Enumerator
DNF_OFF	Data Notify All Off.
DNF_ACCELERATE	Accelerate On(C.7)
DNF_GYROSCOPE	Gyroscope On(C.8)
DNF_MAGNETOMETER	Magnetometer On(C.9)
DNF_EULERANGLE	Euler Angle On(C.10)
DNF_QUATERNION	Quaternion On(C.11)
DNF_ROTATIONMATRIX	Rotation Matrix On(C.12)
DNF_EMG_GESTURE	EMG Gesture On(C.13)
DNF_EMG_RAW	EMG Raw Data On(C.14)
DNF_HID_MOUSE	HID Mouse On(C.15)
DNF_HID_JOYSTICK	HID Joystick On(C.16)
DNF_DEVICE_STATUS	Device Status On(C.17)
DNF_ALL	Data Notify All On.

◆ DeviceService

enum gf::DeviceSetting::DeviceService : GF_UINT32

strong

Enumerator
HID_Joystick	HID Joystick Service.
HID_Mouse	HID Mouse Service.
HID_Vendor	HID Vendor Service.

◆ DeviceStatusFlags

enum gf::DeviceSetting::DeviceStatusFlags : GF_UINT16

Enumerator
DSF_NONE	None Status Event supported.
DSF_RECENTER	Re-center Status Event supported.
DSF_USBSTATUS	USB plug/unplug Event supported.
DSF_MOTIONLESS	Motionless Status Event supported.

◆ EMGRowDataChannels

enum gf::DeviceSetting::EMGRowDataChannels : GF_UINT16

Enumerator
ERDC_CHANNEL0	None Channel supported.
ERDC_CHANNEL1	Channel 0 supported.
ERDC_CHANNEL2	Channel 1 supported.
ERDC_CHANNEL3	Channel 2 supported.
ERDC_CHANNEL4	Channel 3 supported.
ERDC_CHANNEL5	Channel 4 supported.
ERDC_CHANNEL6	Channel 5 supported.
ERDC_CHANNEL7	Channel 6 supported.
ERDC_CHANNEL8	Channel 7 supported.
ERDC_CHANNEL9	Channel 8 supported.
ERDC_CHANNEL10	Channel 9 supported.
ERDC_CHANNEL11	Channel 10 supported.
ERDC_CHANNEL12	Channel 11 supported.
ERDC_CHANNEL13	Channel 12 supported.
ERDC_CHANNEL14	Channel 13 supported.
ERDC_CHANNEL15	Channel 14 supported.
ERDC_CHANNEL_ALL	Channel 15 supported.

◆ KernelMsgType

enum gf::DeviceSetting::KernelMsgType : GF_UINT8

strong

Enumerator
TaskList	Print Task List.
RuntimeState	Print Runtime State.

◆ LedControlTestType

enum gf::DeviceSetting::LedControlTestType : GF_UINT8

strong

Enumerator
Off	LED Off Test.
On	LED On Test.

◆ PackageControlType

enum gf::DeviceSetting::PackageControlType : GF_UINT8

strong

Enumerator
Disable	Package ID Disable.
Enable	Package ID Enable.

◆ SWOLogLevel

enum gf::DeviceSetting::SWOLogLevel : GF_UINT32

strong

Enumerator
All	All.
Debug	Debug.
Info	Info.
Warn	Warn.
Error	Error.
Fatal	Fatal.
None	None.

◆ SWOModule

enum gf::DeviceSetting::SWOModule : GF_UINT32

Enumerator
SWO_MODULE_NONE	None Module Enable.
SWO_MODULE_NPI	Npi Module Enable.
SWO_MODULE_IMU	IMU Module Enable.
SWO_MODULE_RTOS	RTOS Module Enable.
SWO_MODULE_ADC	ADC Module Enable.
SWO_MODULE_PROFILE	Profile Module Enable.
SWO_MODULE_APP	App Module Enable.
SWO_MODULE_ALL	All Modules Enable.

◆ VibrateControlType

enum gf::DeviceSetting::VibrateControlType : GF_UINT8

strong

Enumerator
Off	Vibrate Off Test.
On	Vibrate On Test.
Disable	Device Vibrate Disable.
Enable	Device Vibrate Enable.

The documentation for this class was generated from the following file:

inc/DeviceSetting.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ DataNotifFlags

◆ DeviceService

◆ DeviceStatusFlags

◆ EMGRowDataChannels

◆ KernelMsgType

◆ LedControlTestType

◆ PackageControlType

◆ SWOLogLevel

◆ SWOModule

◆ VibrateControlType