Xsens DOT iOS SDK  ©2022 Xsens Technologies - Version: 2022.0.0
XsensDotDefine.h File Reference
#import <Foundation/Foundation.h>

Go to the source code of this file.

Enumerations

enum  {
  XSDotManagerStateUnknown = 0 , XSDotManagerStateResetting , XSDotManagerStateUnsupported , XSDotManagerStateUnauthorized ,
  XSDotManagerStatePoweredOff , XSDotManagerStatePoweredOn
}
 
enum  { XSDotDeviceCalibrationType1Step = 1 , XSDotDeviceCalibrationType4Steps = 4 , XSDotDeviceCalibrationType7Steps = 7 , XSDotDeviceCalibrationTypeDefault = XSDotDeviceCalibrationType7Steps }
 
enum  { XSDotMFMResultFailed = 0 , XSDotMFMResultBad , XSDotMFMResultAcceptable , XSDotMFMResultGood }
 
enum  {
  XSBleDevicePayloadDefault = 0 , XSBleDevicePayloadInertialHighFidelityWithMag , XSBleDevicePayloadExtendedQuaternion , XSBleDevicePayloadCompleteQuaternion ,
  XSBleDevicePayloadOrientationEuler , XSBleDevicePayloadOrientationQuaternion , XSBleDevicePayloadFreeAcceleration , XSBleDevicePayloadExtendedEuler ,
  XSBleDevicePayloadMFM = 15 , XSBleDevicePayloadCompleteEuler , XSBleDevicePayloadHighFidelityNoMag , XSBleDevicePayloadDeltaQuantitiesWithMag ,
  XSBleDevicePayloadDeltaQuantitiesNoMag , XSBleDevicePayloadRateQuantitiesWithMag , XSBleDevicePayloadRateQuantitiesNoMag , XSBleDevicePayloadCustomMode1 ,
  XSBleDevicePayloadCustomMode2 , XSBleDevicePayloadCustomMode3 , XSBleDevicePayloadCustomMode4 , XSBleDevicePayloadCustomMode5
}
 
enum  {
  XSRecordingDataTimestamp = 0x00 , XSRecordingDataQuaternion , XSRecordingDataIq , XSRecordingDataIv ,
  XSRecordingDataEulerAngles , XSRecordingDataDq , XSRecordingDataDv , XSRecordingDataAcceleration ,
  XSRecordingDataAngularVelocity , XSRecordingDataMagneticField , XSRecordingDataStatus , XSRecordingDataClipCountAcc ,
  XSRecordingDataClipCountGyr
}
 
enum  { XSHeadingStatusXrmHeading = 1 , XSHeadingStatusXrmDefaultAlignment = 7 , XSHeadingStatusXrmNone }
 
enum  { XsensDotBleMessageRecording = 1 , XsensDotBleMessageSync }
 
enum  {
  XSBleMessageRecordingEarseFlash = 0x30 , XSBleMessageRecordingEraseFlashDone , XSBleMessageRecordingStoreFlashInfo , XSBleMessageRecordingStoreFlashInfoDone ,
  XSBleMessageRecordingFlashFull , XSBleMessageRecordingInvalidFlashFormat , XSBleMessageRecordingStartRecording = 0x40 , XSBleMessageRecordingStopRecording ,
  XSBleMessageRecordingGetRecordingTime , XSBleMessageRecordingRecordingTime , XSBleMessageRecordingGetFlashInfo = 0x50 , XSBleMessageRecordingFlashInfo ,
  XSBleMessageRecordingFlashInfoDone , XSBleMessageRecordingGetExportFileInfo = 0x60 , XSBleMessageRecordingExportFileInfo , XSBleMessageRecordingExportFileInfoDone ,
  XSBleMessageRecordingExportNoFile , XSBleMessageRecordingGetExportFileData = 0x70 , XSBleMessageRecordingExportFileData , XSBleMessageRecordingExportFileDataDone ,
  XSBleMessageRecordingStopExportFileData
}
 
enum  { XSBleMessageSyncStopSync = 0x50 , XSBleMessageSyncGetSyncStatus = 0x51 }
 
enum  {
  XSBleDeviceReportTypeSuccessful = 0 , XSBleDeviceReportTypePowerOff , XSBleDeviceReportTypeDeviceBusy , XSBleDeviceReportTypeIllegalCommand ,
  XSBleDeviceReportTypePowerSaving , XSBleDeviceReportTypeButtonCallback , XSBleDeviceFilterProfileTotalNumber , XSBleDeviceFilterProfileProperty
}
 

Variables

NSString *const kCBAdvDataLocalName
 
NSString *const kCBAdvDataManufacturerData
 
NSInteger const XSDotDevicePoolCapacityMax
 
float const XSDotDeviceConnectDuration
 
float const XSDotDeviceScanDuration
 
NSString *const kXsensDotNotificationManagerStateDidUpdate
 Notification of Bluetooth state update. More...
 
NSString *const kXsensDotNotificationDeviceConnectSucceeded
 Notification of Connect succeeded, return XsensDotDevice *. More...
 
NSString *const kXsensDotNotificationDeviceConnectFailed
 Notification of Connect failed, return XsensDotDevice *. More...
 
NSString *const kXsensDotNotificationDeviceDidDisconnect
 Notification of Connection break, return XsensDotDevice *. More...
 
NSString *const kXsensDotNotificationDeviceBatteryDidUpdate
 Notification of Battery information update, return XsensDotDevice *. More...
 
NSString *const kXsensDotNotificationDeviceFirmwareVersionDidRead
 Notification of Firmware version read, return XsensDotDevice *. More...
 
NSString *const kXsensDotNotificationDeviceNameDidRead
 Notification of Sensor name read, return XsensDotDevice *. More...
 
NSString *const kXsensDotNotificationDeviceMacAddressDidRead
 Notification of Sensor Mac address read, return XsensDotDevice *. More...
 
NSString *const kXsensDotNotificationDeviceConnectionDidStart
 Notification of Start to connect sensor, return nil. More...
 
NSString *const kXsensDotNotificationDeviceLoggingPath
 Notification of Logger path , when start logging return NSString *. More...
 
NSString *const kXsensDotNotificationDeviceRecordingStateUpdate
 Notification of Recording state changed , when connect sensor this will be notify. More...
 
NSString *const kXsensDotNotificationDeviceInitialized
 Notification of sensor connection has been done. All properties initialized. More...
 
NSString *const kXsensDotDeviceSpecialName
 

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Bluetooth state of phone

Equivalent to CBManagerState, CBCentralManagerState and CBPeripheralManagerState. The purpose is to solve the compatibility problem of CBCentralManager.state type in different versions of iOS.

Enumerator
XSDotManagerStateUnknown 
XSDotManagerStateResetting 
XSDotManagerStateUnsupported 
XSDotManagerStateUnauthorized 
XSDotManagerStatePoweredOff 
XSDotManagerStatePoweredOn 

◆ anonymous enum

anonymous enum

The sensor calibration type

Enumerator
XSDotDeviceCalibrationType1Step 
XSDotDeviceCalibrationType4Steps 
XSDotDeviceCalibrationType7Steps 
XSDotDeviceCalibrationTypeDefault 

◆ anonymous enum

anonymous enum

The MFM result type after done the mfm process.

Enumerator
XSDotMFMResultFailed 
XSDotMFMResultBad 
XSDotMFMResultAcceptable 
XSDotMFMResultGood 

◆ anonymous enum

anonymous enum

Payload mode of Measurement

Enumerator
XSBleDevicePayloadDefault 
XSBleDevicePayloadInertialHighFidelityWithMag 
XSBleDevicePayloadExtendedQuaternion 
XSBleDevicePayloadCompleteQuaternion 
XSBleDevicePayloadOrientationEuler 
XSBleDevicePayloadOrientationQuaternion 
XSBleDevicePayloadFreeAcceleration 
XSBleDevicePayloadExtendedEuler 
XSBleDevicePayloadMFM 
XSBleDevicePayloadCompleteEuler 
XSBleDevicePayloadHighFidelityNoMag 
XSBleDevicePayloadDeltaQuantitiesWithMag 
XSBleDevicePayloadDeltaQuantitiesNoMag 
XSBleDevicePayloadRateQuantitiesWithMag 
XSBleDevicePayloadRateQuantitiesNoMag 
XSBleDevicePayloadCustomMode1 
XSBleDevicePayloadCustomMode2 
XSBleDevicePayloadCustomMode3 
XSBleDevicePayloadCustomMode4 
XSBleDevicePayloadCustomMode5 

◆ anonymous enum

anonymous enum

The data of exporting recording data from recording file

See also
XsensDotDevice.exportDataFormat
Enumerator
XSRecordingDataTimestamp 
XSRecordingDataQuaternion 
XSRecordingDataIq 
XSRecordingDataIv 
XSRecordingDataEulerAngles 
XSRecordingDataDq 
XSRecordingDataDv 
XSRecordingDataAcceleration 
XSRecordingDataAngularVelocity 
XSRecordingDataMagneticField 
XSRecordingDataStatus 
XSRecordingDataClipCountAcc 
XSRecordingDataClipCountGyr 

◆ anonymous enum

anonymous enum

Sensor heading reset status

Enumerator
XSHeadingStatusXrmHeading 
XSHeadingStatusXrmDefaultAlignment 
XSHeadingStatusXrmNone 

◆ anonymous enum

anonymous enum

The BLE message ID

Enumerator
XsensDotBleMessageRecording 
XsensDotBleMessageSync 

◆ anonymous enum

anonymous enum

The BLE recording message ID

Enumerator
XSBleMessageRecordingEarseFlash 
XSBleMessageRecordingEraseFlashDone 
XSBleMessageRecordingStoreFlashInfo 
XSBleMessageRecordingStoreFlashInfoDone 
XSBleMessageRecordingFlashFull 
XSBleMessageRecordingInvalidFlashFormat 
XSBleMessageRecordingStartRecording 
XSBleMessageRecordingStopRecording 
XSBleMessageRecordingGetRecordingTime 
XSBleMessageRecordingRecordingTime 
XSBleMessageRecordingGetFlashInfo 
XSBleMessageRecordingFlashInfo 
XSBleMessageRecordingFlashInfoDone 
XSBleMessageRecordingGetExportFileInfo 
XSBleMessageRecordingExportFileInfo 
XSBleMessageRecordingExportFileInfoDone 
XSBleMessageRecordingExportNoFile 
XSBleMessageRecordingGetExportFileData 
XSBleMessageRecordingExportFileData 
XSBleMessageRecordingExportFileDataDone 
XSBleMessageRecordingStopExportFileData 

◆ anonymous enum

anonymous enum

The BLE sync message ID

Enumerator
XSBleMessageSyncStopSync 
XSBleMessageSyncGetSyncStatus 

◆ anonymous enum

anonymous enum

The sensor report type

Enumerator
XSBleDeviceReportTypeSuccessful 
XSBleDeviceReportTypePowerOff 
XSBleDeviceReportTypeDeviceBusy 
XSBleDeviceReportTypeIllegalCommand 
XSBleDeviceReportTypePowerSaving 
XSBleDeviceReportTypeButtonCallback 
XSBleDeviceFilterProfileTotalNumber 
XSBleDeviceFilterProfileProperty 

Variable Documentation

◆ kCBAdvDataLocalName

NSString* const kCBAdvDataLocalName
extern

◆ kCBAdvDataManufacturerData

NSString* const kCBAdvDataManufacturerData
extern

◆ kXsensDotDeviceSpecialName

NSString* const kXsensDotDeviceSpecialName
extern

◆ kXsensDotNotificationDeviceBatteryDidUpdate

NSString* const kXsensDotNotificationDeviceBatteryDidUpdate
extern

Notification of Battery information update, return XsensDotDevice *.

◆ kXsensDotNotificationDeviceConnectFailed

NSString* const kXsensDotNotificationDeviceConnectFailed
extern

Notification of Connect failed, return XsensDotDevice *.

◆ kXsensDotNotificationDeviceConnectionDidStart

NSString* const kXsensDotNotificationDeviceConnectionDidStart
extern

Notification of Start to connect sensor, return nil.

◆ kXsensDotNotificationDeviceConnectSucceeded

NSString* const kXsensDotNotificationDeviceConnectSucceeded
extern

Notification of Connect succeeded, return XsensDotDevice *.

◆ kXsensDotNotificationDeviceDidDisconnect

NSString* const kXsensDotNotificationDeviceDidDisconnect
extern

Notification of Connection break, return XsensDotDevice *.

◆ kXsensDotNotificationDeviceFirmwareVersionDidRead

NSString* const kXsensDotNotificationDeviceFirmwareVersionDidRead
extern

Notification of Firmware version read, return XsensDotDevice *.

◆ kXsensDotNotificationDeviceInitialized

NSString* const kXsensDotNotificationDeviceInitialized
extern

Notification of sensor connection has been done. All properties initialized.

◆ kXsensDotNotificationDeviceLoggingPath

NSString* const kXsensDotNotificationDeviceLoggingPath
extern

Notification of Logger path , when start logging return NSString *.

◆ kXsensDotNotificationDeviceMacAddressDidRead

NSString* const kXsensDotNotificationDeviceMacAddressDidRead
extern

Notification of Sensor Mac address read, return XsensDotDevice *.

◆ kXsensDotNotificationDeviceNameDidRead

NSString* const kXsensDotNotificationDeviceNameDidRead
extern

Notification of Sensor name read, return XsensDotDevice *.

◆ kXsensDotNotificationDeviceRecordingStateUpdate

NSString* const kXsensDotNotificationDeviceRecordingStateUpdate
extern

Notification of Recording state changed , when connect sensor this will be notify.

◆ kXsensDotNotificationManagerStateDidUpdate

NSString* const kXsensDotNotificationManagerStateDidUpdate
extern

Notification of Bluetooth state update.

◆ XSDotDeviceConnectDuration

float const XSDotDeviceConnectDuration
extern

◆ XSDotDevicePoolCapacityMax

NSInteger const XSDotDevicePoolCapacityMax
extern

◆ XSDotDeviceScanDuration

float const XSDotDeviceScanDuration
extern