Xsens DOT iOS SDK  ©2022 Xsens Technologies - Version: 2022.0.0
XsensDotDefine.h
Go to the documentation of this file.
1 //
2 // XsensDotDefine.h
3 // XsensDotSdk
4 //
5 // Created by Nick Yang on 2019/5/13.
6 // Copyright © 2019 Xsens. All rights reserved.
7 //
8 
9 #ifndef XSENSDotDefine_h
10 #define XSENSDotDefine_h
11 
12 #import <Foundation/Foundation.h>
13 
14 
15 extern NSString * const kCBAdvDataLocalName;
16 extern NSString * const kCBAdvDataManufacturerData;
17 extern NSInteger const XSDotDevicePoolCapacityMax;
18 extern float const XSDotDeviceConnectDuration;
19 extern float const XSDotDeviceScanDuration;
20 
27 typedef NS_ENUM(NSInteger, XSDotManagerState)
28 {
29  XSDotManagerStateUnknown = 0,//CBManagerStateUnknown
30  XSDotManagerStateResetting, //CBManagerStateResetting
31  XSDotManagerStateUnsupported, //CBManagerStateUnsupported
32  XSDotManagerStateUnauthorized, //CBManagerStateUnauthorized
33  XSDotManagerStatePoweredOff, //CBManagerStatePoweredOff
34  XSDotManagerStatePoweredOn, //CBManagerStatePoweredOn
35 };
36 
40 typedef NS_ENUM(NSInteger, XSDotDeviceCalibrationType)
41 {
45 
47 };
48 
52 typedef NS_ENUM(NSUInteger, XSDotMFMResultTpye)
53 {
58 };
59 
63 typedef NS_ENUM(NSInteger,XSBleDevicePayloadMode)
64 {
84  XSBleDevicePayloadCustomMode5 //new payload
85 };
86 
91 typedef NS_ENUM(NSUInteger, XSRecordingData)
92 {
106 };
107 
111 typedef NS_ENUM(NSUInteger, XSHeadingStatus)
112 {
116 };
117 
121 typedef NS_ENUM(NSUInteger, XsensDotBleMessageId)
122 {
125 };
126 
130 typedef NS_ENUM(NSUInteger, XsensDotBleMessageRecordingId)
131 {
138 
143 
147 
152 
157 };
158 
162 typedef NS_ENUM(NSUInteger, XsensDotBleMessageSyncId)
163 {
166 };
167 
171 typedef NS_ENUM(NSUInteger, XSBleDeviceReportType)
172 {
181 };
182 
183 #pragma mark - Notification keywords
184 /*
185  Notification keywords.
186  If there is return data, use NSNotification.object to return.
187  */
188 
190 extern NSString * const kXsensDotNotificationManagerStateDidUpdate;
191 
193 extern NSString * const kXsensDotNotificationDeviceConnectSucceeded;
194 
196 extern NSString * const kXsensDotNotificationDeviceConnectFailed;
197 
199 extern NSString * const kXsensDotNotificationDeviceDidDisconnect;
200 
202 extern NSString * const kXsensDotNotificationDeviceBatteryDidUpdate;
203 
206 
208 extern NSString * const kXsensDotNotificationDeviceNameDidRead;
209 
211 extern NSString * const kXsensDotNotificationDeviceMacAddressDidRead;
212 
214 extern NSString * const kXsensDotNotificationDeviceConnectionDidStart;
215 
217 extern NSString * const kXsensDotNotificationDeviceLoggingPath;
218 
221 
223 extern NSString * const kXsensDotNotificationDeviceInitialized;
224 
225 //@"Xsens DOT"
226 extern NSString * const kXsensDotDeviceSpecialName;
227 
228 #endif /* XSENSDotDefine_h */
@ XSBleMessageRecordingGetExportFileData
Definition: XsensDotDefine.h:153
@ XSBleMessageRecordingExportFileInfo
Definition: XsensDotDefine.h:149
@ XSBleMessageRecordingStoreFlashInfo
Definition: XsensDotDefine.h:134
@ XSBleMessageRecordingExportFileInfoDone
Definition: XsensDotDefine.h:150
@ XSBleMessageRecordingStopExportFileData
Definition: XsensDotDefine.h:156
@ XSBleMessageRecordingExportFileData
Definition: XsensDotDefine.h:154
@ XSBleMessageRecordingFlashFull
Definition: XsensDotDefine.h:136
@ XSBleMessageRecordingExportNoFile
Definition: XsensDotDefine.h:151
@ XSBleMessageRecordingRecordingTime
Definition: XsensDotDefine.h:142
@ XSBleMessageRecordingFlashInfoDone
Definition: XsensDotDefine.h:146
@ XSBleMessageRecordingStoreFlashInfoDone
Definition: XsensDotDefine.h:135
@ XSBleMessageRecordingGetRecordingTime
Definition: XsensDotDefine.h:141
@ XSBleMessageRecordingFlashInfo
Definition: XsensDotDefine.h:145
@ XSBleMessageRecordingInvalidFlashFormat
Definition: XsensDotDefine.h:137
@ XSBleMessageRecordingStopRecording
Definition: XsensDotDefine.h:140
@ XSBleMessageRecordingStartRecording
Definition: XsensDotDefine.h:139
@ XSBleMessageRecordingGetFlashInfo
Definition: XsensDotDefine.h:144
@ XSBleMessageRecordingEarseFlash
Definition: XsensDotDefine.h:132
@ XSBleMessageRecordingExportFileDataDone
Definition: XsensDotDefine.h:155
@ XSBleMessageRecordingGetExportFileInfo
Definition: XsensDotDefine.h:148
@ XSBleMessageRecordingEraseFlashDone
Definition: XsensDotDefine.h:133
@ XSDotManagerStateUnauthorized
Definition: XsensDotDefine.h:32
@ XSDotManagerStateUnknown
Definition: XsensDotDefine.h:29
@ XSDotManagerStateUnsupported
Definition: XsensDotDefine.h:31
@ XSDotManagerStatePoweredOff
Definition: XsensDotDefine.h:33
@ XSDotManagerStatePoweredOn
Definition: XsensDotDefine.h:34
@ XSDotManagerStateResetting
Definition: XsensDotDefine.h:30
float const XSDotDeviceScanDuration
NSInteger const XSDotDevicePoolCapacityMax
NSString *const kXsensDotNotificationManagerStateDidUpdate
Notification of Bluetooth state update.
NSString *const kCBAdvDataManufacturerData
float const XSDotDeviceConnectDuration
NSString *const kXsensDotNotificationDeviceBatteryDidUpdate
Notification of Battery information update, return XsensDotDevice *.
NSString *const kXsensDotNotificationDeviceInitialized
Notification of sensor connection has been done. All properties initialized.
NSString *const kCBAdvDataLocalName
NSString *const kXsensDotNotificationDeviceMacAddressDidRead
Notification of Sensor Mac address read, return XsensDotDevice *.
@ XSHeadingStatusXrmHeading
Definition: XsensDotDefine.h:113
@ XSHeadingStatusXrmDefaultAlignment
Definition: XsensDotDefine.h:114
@ XSHeadingStatusXrmNone
Definition: XsensDotDefine.h:115
@ XsensDotBleMessageRecording
Definition: XsensDotDefine.h:123
@ XsensDotBleMessageSync
Definition: XsensDotDefine.h:124
NSString *const kXsensDotNotificationDeviceDidDisconnect
Notification of Connection break, return XsensDotDevice *.
NSString *const kXsensDotNotificationDeviceNameDidRead
Notification of Sensor name read, return XsensDotDevice *.
NSString *const kXsensDotNotificationDeviceConnectionDidStart
Notification of Start to connect sensor, return nil.
NSString *const kXsensDotNotificationDeviceFirmwareVersionDidRead
Notification of Firmware version read, return XsensDotDevice *.
@ XSDotMFMResultGood
Definition: XsensDotDefine.h:57
@ XSDotMFMResultBad
Definition: XsensDotDefine.h:55
@ XSDotMFMResultAcceptable
Definition: XsensDotDefine.h:56
@ XSDotMFMResultFailed
Definition: XsensDotDefine.h:54
NSString *const kXsensDotNotificationDeviceLoggingPath
Notification of Logger path , when start logging return NSString *.
@ XSBleDeviceReportTypeDeviceBusy
Definition: XsensDotDefine.h:175
@ XSBleDeviceReportTypeSuccessful
Definition: XsensDotDefine.h:173
@ XSBleDeviceFilterProfileProperty
Definition: XsensDotDefine.h:180
@ XSBleDeviceReportTypeIllegalCommand
Definition: XsensDotDefine.h:176
@ XSBleDeviceReportTypePowerSaving
Definition: XsensDotDefine.h:177
@ XSBleDeviceReportTypeButtonCallback
Definition: XsensDotDefine.h:178
@ XSBleDeviceReportTypePowerOff
Definition: XsensDotDefine.h:174
@ XSBleDeviceFilterProfileTotalNumber
Definition: XsensDotDefine.h:179
NSString *const kXsensDotNotificationDeviceConnectFailed
Notification of Connect failed, return XsensDotDevice *.
@ XSBleDevicePayloadCustomMode1
Definition: XsensDotDefine.h:80
@ XSBleDevicePayloadCustomMode2
Definition: XsensDotDefine.h:81
@ XSBleDevicePayloadCustomMode5
Definition: XsensDotDefine.h:84
@ XSBleDevicePayloadRateQuantitiesWithMag
Definition: XsensDotDefine.h:78
@ XSBleDevicePayloadOrientationQuaternion
Definition: XsensDotDefine.h:70
@ XSBleDevicePayloadCompleteQuaternion
Definition: XsensDotDefine.h:68
@ XSBleDevicePayloadExtendedEuler
Definition: XsensDotDefine.h:72
@ XSBleDevicePayloadFreeAcceleration
Definition: XsensDotDefine.h:71
@ XSBleDevicePayloadInertialHighFidelityWithMag
Definition: XsensDotDefine.h:66
@ XSBleDevicePayloadDeltaQuantitiesWithMag
Definition: XsensDotDefine.h:76
@ XSBleDevicePayloadCustomMode4
Definition: XsensDotDefine.h:83
@ XSBleDevicePayloadCompleteEuler
Definition: XsensDotDefine.h:74
@ XSBleDevicePayloadHighFidelityNoMag
Definition: XsensDotDefine.h:75
@ XSBleDevicePayloadExtendedQuaternion
Definition: XsensDotDefine.h:67
@ XSBleDevicePayloadOrientationEuler
Definition: XsensDotDefine.h:69
@ XSBleDevicePayloadDeltaQuantitiesNoMag
Definition: XsensDotDefine.h:77
@ XSBleDevicePayloadMFM
Definition: XsensDotDefine.h:73
@ XSBleDevicePayloadCustomMode3
Definition: XsensDotDefine.h:82
@ XSBleDevicePayloadRateQuantitiesNoMag
Definition: XsensDotDefine.h:79
@ XSBleDevicePayloadDefault
Definition: XsensDotDefine.h:65
@ XSBleMessageSyncStopSync
Definition: XsensDotDefine.h:164
@ XSBleMessageSyncGetSyncStatus
Definition: XsensDotDefine.h:165
NSString *const kXsensDotDeviceSpecialName
@ XSRecordingDataIq
Definition: XsensDotDefine.h:95
@ XSRecordingDataClipCountGyr
Definition: XsensDotDefine.h:105
@ XSRecordingDataQuaternion
Definition: XsensDotDefine.h:94
@ XSRecordingDataAngularVelocity
Definition: XsensDotDefine.h:101
@ XSRecordingDataAcceleration
Definition: XsensDotDefine.h:100
@ XSRecordingDataMagneticField
Definition: XsensDotDefine.h:102
@ XSRecordingDataTimestamp
Definition: XsensDotDefine.h:93
@ XSRecordingDataDv
Definition: XsensDotDefine.h:99
@ XSRecordingDataClipCountAcc
Definition: XsensDotDefine.h:104
@ XSRecordingDataStatus
Definition: XsensDotDefine.h:103
@ XSRecordingDataEulerAngles
Definition: XsensDotDefine.h:97
@ XSRecordingDataIv
Definition: XsensDotDefine.h:96
@ XSRecordingDataDq
Definition: XsensDotDefine.h:98
NSString *const kXsensDotNotificationDeviceConnectSucceeded
Notification of Connect succeeded, return XsensDotDevice *.
@ XSDotDeviceCalibrationType1Step
Definition: XsensDotDefine.h:42
@ XSDotDeviceCalibrationTypeDefault
Definition: XsensDotDefine.h:46
@ XSDotDeviceCalibrationType7Steps
Definition: XsensDotDefine.h:44
@ XSDotDeviceCalibrationType4Steps
Definition: XsensDotDefine.h:43
NSString *const kXsensDotNotificationDeviceRecordingStateUpdate
Notification of Recording state changed , when connect sensor this will be notify.