Xsens DOT iOS SDK
©2022 Xsens Technologies - Version: 2022.0.0
|
#import <XsensDotDevice.h>
Class Methods | |
(instancetype) | + deviceWithPeripheral: |
Properties | |
CBPeripheral * | peripheral |
id< XsensDotCBPeripherialServiceExploreDelegate > | explorieDelegate |
NSString * | uuid |
NSString * | macAddress |
NSNumber * | RSSI |
XsensDotBatteryInfo * | battery |
XsensDotFirmwareVersion * | firmwareVersion |
NSString * | serialNumber |
BOOL | plotMeasureEnable |
XSBleDevicePayloadMode | plotMeasureMode |
BOOL | plotLogEnable |
BOOL | isSupportHeadingReset |
XSHeadingStatus | headingStatus |
void(^ | headingResetResult )(int result) |
UInt8 | timeoutXMinutes |
UInt8 | timeoutXSeconds |
UInt8 | timeoutYMinutes |
UInt8 | timeoutYSeconds |
NSUInteger | totalSpace |
NSUInteger | usedSpace |
XsensDotRecording * | recording |
NSData * | exportDataFormat |
BOOL | exportLogEnable |
int | outputRate |
int | filterIndex |
void(^ | getStorageStatusWithTime )(NSUInteger time) |
XsensDotDevice represents an Xsens DOT sensor object, including basic information and operations, data measurement and data logging.
- (void) clearCrashInfoData |
Clear crash data
clearCrashInfoData is 150ms later then dumpCrashInfoData .
Provided by category XsensDotDevice(Instruction).
+ (instancetype) deviceWithPeripheral: | (CBPeripheral *) | peripheral |
Constructor with a peripheral
peripheral | CBPeripheral object |
- (NSString *) displayAddress |
The mac address
- (NSString *) displayName |
The tag name
- (void) dumpCrashInfoData |
Dump crash data
Provided by category XsensDotDevice(Instruction).
- (BOOL) enableUsbPowerOn: | (BOOL) | isEnable |
Enable the DOT sensor to power on by USB plugin aditionally.
isEnable | The BOOL value |
Provided by category XsensDotDevice(Instruction).
- (BOOL) eraseData |
Earse recording Data
Provided by category XsensDotDevice(Instruction).
- (NSArray <XsensDotFilterProfile *> *) filterProfilesList |
The support filter profile list
- (BOOL) getExportFileInfo |
Get the export file information , this will be initialize RecordingFile.timeStamap
Provided by category XsensDotDevice(Instruction).
- (BOOL) getFlashInfo |
Get sensor flash information, after called it will be initializing totalSpace and usedSpace
Provided by category XsensDotDevice(Instruction).
- (void) getRecordingStatus |
Get Recording Status, after call this method the recording.recordingStatus will be update
Provided by category XsensDotDevice(Instruction).
- (BOOL) getRecordingTime |
If recording.recordingStatus == XSRecordingIsRecording ,and will be get the recording.recordingDate, recording.recordingTime ,recording.remainingTime
Provided by category XsensDotDevice(Instruction).
- (BOOL) isEqual: | (XsensDotDevice *) | object |
Judge the XsensDotDevice object if it's equal
object | The XsensDotDevice object |
- (BOOL) isInitialized |
The flag that the connection is initialized
- (BOOL) isProductV1 |
The sensor's hardware is V1
Provided by category XsensDotDevice(Instruction).
- (BOOL) isProductV2 |
The sensor's hardware is V2
Provided by category XsensDotDevice(Instruction).
- (BOOL) isSynced |
The flag that the sensor is synced
- (BOOL) isUsbPowerOnEnabled |
check if the USB plugin power on is enabled or not.
Provided by category XsensDotDevice(Instruction).
- (void) parseAdvertisementData: | (NSDictionary *) | advertisementData |
Parse BLE advertisement data
advertisementData | Advertisement data |
- (void) parseMacAddress: | (NSData *) | macAddressData |
Parse mac address
macAddressData | Mac address data |
- (NSString *) peripheralName |
The peripheral name
- (void) powerOff |
Power off the sensor
Provided by category XsensDotDevice(Instruction).
- (void) readRSSI: | (void(^)(NSNumber *signal)) | block |
Read the sensor signal strength
block | Return block after read the RSSI |
After read the RSSI the RSSI propertity will also be updated
Provided by category XsensDotDevice(Instruction).
- (void) readStatisticsInfo |
Read statistics info
Provided by category XsensDotDevice(Instruction).
- (void) setDeviceName: | (NSString *) | name |
Set the sensor tag name
name | The tag name |
Provided by category XsensDotDevice(Instruction).
- (void) setDidButtonCallbackBlock: | (void(^)(int timestamp)) | block |
Button callback block
block | The timestamp block |
Provided by category XsensDotDevice(Instruction).
- (void) setDidMFMProgress: | (void(^)(NSString *address, int progress)) | block |
Set the progress block when start mfm
block | The block from mfm data parse |
Provided by category XsensDotDevice(Instruction).
- (void) setDidMFMResult: | (void(^)(NSString *address, XSDotMFMResultTpye type)) | block |
Set the result block when mfm has been done
block | The block from mfm process done |
Provided by category XsensDotDevice(Instruction).
- (void) setDidParseExportFileDataBlock: | (void(^)(XsensDotPlotData *_Nonnull plotData)) | block |
The block of startExportFileData
block | Return the XsensDotPlotData object |
Provided by category XsensDotDevice(Instruction).
- (void) setDidParsePlotDataBlock: | (void(^)(XsensDotPlotData *_Nonnull plotData)) | block |
The plotting(real-time streaming) data block, after set plotMeasureEnable = YES, this will outout plotData
block | Return the XsensDotPlotData data |
Provided by category XsensDotDevice(Instruction).
- (void) setDidPowerOffBlock: | (void(^)(void)) | block |
The block when sensor did power off
block | The return block |
Provided by category XsensDotDevice(Instruction).
- (void) setDidreadRotLocal: | (void(^)(float *_Nonnull rotLocal)) | block |
- (void) setEraseDataDoneBlock: | (void(^)(int success)) | block |
The eraseData done block
block | Return the success result |
Provided by category XsensDotDevice(Instruction).
- (void) setExportFileInfoDone: | (void(^)(BOOL success)) | block |
The getExportFileInfo done block
block | Return the success result |
Provided by category XsensDotDevice(Instruction).
- (void) setFirmwareUpdate: | (NSString *) | file |
Start firmeare update
file | The firmeware file |
Provided by category XsensDotDevice(Instruction).
- (void) setFlashInfoDoneBlock: | (void(^)(XSFlashInfoStatus status)) | block |
The getFlashInfo done block
block | The XSFlashInfoStatus object |
Provided by category XsensDotDevice(Instruction).
- (void) setOutputRate: | (int) | outputRate | |
filterIndex: | (int) | filterIndex | |
Set the outputRate and filterIndex
outputRate | outputRate |
filterIndex | filterIndex |
Provided by category XsensDotDevice(Instruction).
- (void) setPowerSavingTimeout: | (UInt8) | xMinutes | |
xSecond: | (UInt8) | xSeconds | |
yMinutes: | (UInt8) | yMinutes | |
ySeconds: | (UInt8) | ySeconds | |
Set power saving time
xMinutes | The advertisement minutes |
xSeconds | The advertisement seconds |
yMinutes | The connection minutes |
ySeconds | The connection seconds |
Provided by category XsensDotDevice(Instruction).
- (BOOL) startExportFileData |
Start export recording file data, when call this method, Please ensure two prerequisites
Provided by category XsensDotDevice(Instruction).
- (BOOL) startHeadingReset |
Start heading reset
Provided by category XsensDotDevice(Instruction).
- (BOOL) startHeadingRevert |
Start heading revert
Provided by category XsensDotDevice(Instruction).
- (void) startIdentifying |
Start identifying
Provided by category XsensDotDevice(Instruction).
- (void) startMfm |
Start MFM
Provided by category XsensDotDevice(Instruction).
- (BOOL) startRecording: | (UInt16) | recordingTime |
Start recording
recordingTime | The recording time that you want |
If no clear time, please set it to 0xFFFF, the recording will always do until storage is full
Provided by category XsensDotDevice(Instruction).
- (void) startSync: | (NSString *) | address | |
type: | (UInt8) | type | |
Start synchronization
address | The sensor macAddress |
type | The sync type |
Provided by category XsensDotDevice(Instruction).
- (CBPeripheralState) state |
The current bluetooth state
- (BOOL) stateIsConnected |
The flag that BLE is connected
- (BOOL) statisticsFeatureEnable |
The flat of support statistics feature
Provided by category XsensDotDevice(Instruction).
- (BOOL) stopExportFileData |
Stop export recording file data, Recording export status in this block: recording.updateExportingStatus
Provided by category XsensDotDevice(Instruction).
- (NSString *) stopMfm |
- (BOOL) stopRecording |
Stop recording
Provided by category XsensDotDevice(Instruction).
- (void) stopSync |
Stop Synchronization
Provided by category XsensDotDevice(Instruction).
- (void) writeMfmResult: | (NSData *) | mfmData |
Write mtb data to firmware
mfmData | The mtb data |
Provided by category XsensDotDevice(Instruction).
|
readwritenonatomicstrong |
The XsensDotBatteryInfo object
|
readwritenonatomicweak |
The delegate object that will expore services
|
readwritenonatomicstrong |
The recording export data format
Examples :UInt8 bytes[4] = { XSRecordingDataTimestamp, XSRecordingDataEulerAngles, XSRecordingDataAcceleration, XSRecordingDataAngularVelocity }; NSData *exportData = [NSData dataWithBytes:bytes length:sizeof(bytes)];
|
readwritenonatomicassign |
The log enable flag when start export recording data, if YES this will save log file to app's folder.
|
readwritenonatomicassign |
The property of outoutRate
Currently only support 0 and 1
|
readwritenonatomicstrong |
The XsensDotFirmwareVersion object
|
readwritenonatomiccopy |
Before recording start when you give a time to check sensor storage status. Unit is minute.
|
readwritenonatomiccopy |
The heading result block after do heading reset or revert
The result != 0 means heading reset success otherwise heading reset fail.
|
readwritenonatomicassign |
The current heading status
|
readwritenonatomicassign |
The flag of support heading reset feature
|
readnonatomicstrong |
Mac address
|
readwritenonatomicassign |
The property of outoutRate
Should be 1Hz, 4Hz, 10Hz, 12Hz, 15Hz, 20Hz, 30Hz and 60Hz 120Hz(only for recording modes).
|
readnonatomicstrong |
The CBPeripheral object
|
readwritenonatomicassign |
The plotting(real- time streaming) log enable flag
|
readwritenonatomicassign |
The plotting(real- time streaming) enable flag
|
readwritenonatomicassign |
The current payload mode
|
readwritenonatomicstrong |
The XsensDotRecording object
|
readwritenonatomicstrong |
The RSSI signal after XsensDotConnectionManager scan
|
readwritenonatomicstrong |
The Serial number
|
readwritenonatomicassign |
The Advertisement timeout minutes
|
readwritenonatomicassign |
The Advertisement timeout seconds
|
readwritenonatomicassign |
The Connection timeout minutes
|
readwritenonatomicassign |
The Connection timeout seconds
|
readwritenonatomicassign |
The Sensor total storage space
|
readwritenonatomicassign |
The Sensor used storage space in recording mode.
|
readnonatomicstrong |
uuid