Xsens DOT iOS SDK  ©2022 Xsens Technologies - Version: 2022.0.0
XsensDotDevice(Instruction) Category Reference

#import <XsensDotDevice.h>

Instance Methods

(void) - setDidParsePlotDataBlock:
 
(void) - setDeviceName:
 
(void) - startIdentifying
 
(void) - powerOff
 
(void) - readStatisticsInfo
 
(BOOL) - statisticsFeatureEnable
 
(void) - setDidPowerOffBlock:
 
(void) - setOutputRate:filterIndex:
 
(void) - readRSSI:
 
(void) - startMfm
 
(NSString *) - stopMfm
 
(void) - writeMfmResult:
 
(void) - setDidMFMProgress:
 
(void) - setDidMFMResult:
 
(void) - setFirmwareUpdate:
 
(void) - setPowerSavingTimeout:xSecond:yMinutes:ySeconds:
 
(BOOL) - startHeadingReset
 
(BOOL) - startHeadingRevert
 
(void) - setDidreadRotLocal:
 
(void) - dumpCrashInfoData
 
(void) - clearCrashInfoData
 
(void) - startSync:type:
 
(void) - stopSync
 
(void) - getRecordingStatus
 
(BOOL) - startRecording:
 
(BOOL) - stopRecording
 
(BOOL) - getFlashInfo
 
(void) - setFlashInfoDoneBlock:
 
(BOOL) - getRecordingTime
 
(BOOL) - eraseData
 
(void) - setEraseDataDoneBlock:
 
(BOOL) - getExportFileInfo
 
(void) - setExportFileInfoDone:
 
(BOOL) - startExportFileData
 
(BOOL) - stopExportFileData
 
(void) - setDidParseExportFileDataBlock:
 
(void) - setDidButtonCallbackBlock:
 
(BOOL) - isProductV2
 
(BOOL) - isProductV1
 
(BOOL) - enableUsbPowerOn:
 
(BOOL) - isUsbPowerOnEnabled
 

Detailed Description

Instruction method

Method Documentation

◆ clearCrashInfoData

- (void) clearCrashInfoData

Clear crash data

clearCrashInfoData is 150ms later then dumpCrashInfoData .

Extends class XsensDotDevice.

◆ dumpCrashInfoData

- (void) dumpCrashInfoData

Dump crash data

Extends class XsensDotDevice.

◆ enableUsbPowerOn:

- (BOOL) enableUsbPowerOn: (BOOL)  isEnable

Enable the DOT sensor to power on by USB plugin aditionally.

Parameters
isEnableThe BOOL value

Extends class XsensDotDevice.

◆ eraseData

- (BOOL) eraseData

Earse recording Data

Returns
If firmware support recording feature this will be YES, otherwise it's NO

Extends class XsensDotDevice.

◆ getExportFileInfo

- (BOOL) getExportFileInfo

Get the export file information , this will be initialize RecordingFile.timeStamap

Returns
If firmware support recording feature this will be YES, otherwise it's NO

Extends class XsensDotDevice.

◆ getFlashInfo

- (BOOL) getFlashInfo

Get sensor flash information, after called it will be initializing totalSpace and usedSpace

Returns
If firmware support recording feature this will be YES, otherwise it's NO

Extends class XsensDotDevice.

◆ getRecordingStatus

- (void) getRecordingStatus

Get Recording Status, after call this method the recording.recordingStatus will be update

Extends class XsensDotDevice.

◆ getRecordingTime

- (BOOL) getRecordingTime

If recording.recordingStatus == XSRecordingIsRecording ,and will be get the recording.recordingDate, recording.recordingTime ,recording.remainingTime

Returns
If firmware support recording feature this will be YES, otherwise it's NO

Extends class XsensDotDevice.

◆ isProductV1

- (BOOL) isProductV1

The sensor's hardware is V1

Extends class XsensDotDevice.

◆ isProductV2

- (BOOL) isProductV2

The sensor's hardware is V2

Extends class XsensDotDevice.

◆ isUsbPowerOnEnabled

- (BOOL) isUsbPowerOnEnabled

check if the USB plugin power on is enabled or not.

Extends class XsensDotDevice.

◆ powerOff

- (void) powerOff

Power off the sensor

Extends class XsensDotDevice.

◆ readRSSI:

- (void) readRSSI: (void(^)(NSNumber *signal))  block

Read the sensor signal strength

Parameters
blockReturn block after read the RSSI

After read the RSSI the RSSI propertity will also be updated

Extends class XsensDotDevice.

◆ readStatisticsInfo

- (void) readStatisticsInfo

Read statistics info

Extends class XsensDotDevice.

◆ setDeviceName:

- (void) setDeviceName: (NSString *)  name

Set the sensor tag name

Parameters
nameThe tag name

Extends class XsensDotDevice.

◆ setDidButtonCallbackBlock:

- (void) setDidButtonCallbackBlock: (void(^)(int timestamp))  block

Button callback block

Parameters
blockThe timestamp block

Extends class XsensDotDevice.

◆ setDidMFMProgress:

- (void) setDidMFMProgress: (void(^)(NSString *address, int progress))  block

Set the progress block when start mfm

Parameters
blockThe block from mfm data parse

Extends class XsensDotDevice.

◆ setDidMFMResult:

- (void) setDidMFMResult: (void(^)(NSString *address, XSDotMFMResultTpye type))  block

Set the result block when mfm has been done

Parameters
blockThe block from mfm process done

Extends class XsensDotDevice.

◆ setDidParseExportFileDataBlock:

- (void) setDidParseExportFileDataBlock: (void(^)(XsensDotPlotData *_Nonnull plotData))  block

The block of startExportFileData

Parameters
blockReturn the XsensDotPlotData object

Extends class XsensDotDevice.

◆ setDidParsePlotDataBlock:

- (void) setDidParsePlotDataBlock: (void(^)(XsensDotPlotData *_Nonnull plotData))  block

The plotting(real-time streaming) data block, after set plotMeasureEnable = YES, this will outout plotData

Parameters
blockReturn the XsensDotPlotData data

Extends class XsensDotDevice.

◆ setDidPowerOffBlock:

- (void) setDidPowerOffBlock: (void(^)(void))  block

The block when sensor did power off

Parameters
blockThe return block

Extends class XsensDotDevice.

◆ setDidreadRotLocal:

- (void) setDidreadRotLocal: (void(^)(float *_Nonnull rotLocal))  block

Read Rot local block

Parameters
blockReturn block

Extends class XsensDotDevice.

◆ setEraseDataDoneBlock:

- (void) setEraseDataDoneBlock: (void(^)(int success))  block

The eraseData done block

Parameters
blockReturn the success result

Extends class XsensDotDevice.

◆ setExportFileInfoDone:

- (void) setExportFileInfoDone: (void(^)(BOOL success))  block

The getExportFileInfo done block

Parameters
blockReturn the success result

Extends class XsensDotDevice.

◆ setFirmwareUpdate:

- (void) setFirmwareUpdate: (NSString *)  file

Start firmeare update

Parameters
fileThe firmeware file

Extends class XsensDotDevice.

◆ setFlashInfoDoneBlock:

- (void) setFlashInfoDoneBlock: (void(^)(XSFlashInfoStatus status))  block

The getFlashInfo done block

Parameters
blockThe XSFlashInfoStatus object

Extends class XsensDotDevice.

◆ setOutputRate:filterIndex:

- (void) setOutputRate: (int)  outputRate
filterIndex: (int)  filterIndex 

Set the outputRate and filterIndex

Parameters
outputRateoutputRate
filterIndexfilterIndex

Extends class XsensDotDevice.

◆ setPowerSavingTimeout:xSecond:yMinutes:ySeconds:

- (void) setPowerSavingTimeout: (UInt8)  xMinutes
xSecond: (UInt8)  xSeconds
yMinutes: (UInt8)  yMinutes
ySeconds: (UInt8)  ySeconds 

Set power saving time

Parameters
xMinutesThe advertisement minutes
xSecondsThe advertisement seconds
yMinutesThe connection minutes
ySecondsThe connection seconds

Extends class XsensDotDevice.

◆ startExportFileData

- (BOOL) startExportFileData

Start export recording file data, when call this method, Please ensure two prerequisites

  1. set device.exportDataFormat
  2. set recording.exportFileList recording export status in this block: recording.updateExportingStatus
Returns
If firmware support recording feature this will be YES, otherwise it's NO

Extends class XsensDotDevice.

◆ startHeadingReset

- (BOOL) startHeadingReset

Start heading reset

Returns
If firmware support heading reset feature this will be YES, otherwise it's NO

Extends class XsensDotDevice.

◆ startHeadingRevert

- (BOOL) startHeadingRevert

Start heading revert

Returns
If firmware support heading reset feature this will be YES, otherwise it's NO

Extends class XsensDotDevice.

◆ startIdentifying

- (void) startIdentifying

Start identifying

Extends class XsensDotDevice.

◆ startMfm

- (void) startMfm

Start MFM

Extends class XsensDotDevice.

◆ startRecording:

- (BOOL) startRecording: (UInt16)  recordingTime

Start recording

Parameters
recordingTimeThe recording time that you want

If no clear time, please set it to 0xFFFF, the recording will always do until storage is full

Returns
If firmware support recording feature this will be YES, otherwise it's NO

Extends class XsensDotDevice.

◆ startSync:type:

- (void) startSync: (NSString *)  address
type: (UInt8)  type 

Start synchronization

Parameters
addressThe sensor macAddress
typeThe sync type

Extends class XsensDotDevice.

◆ statisticsFeatureEnable

- (BOOL) statisticsFeatureEnable

The flat of support statistics feature

Extends class XsensDotDevice.

◆ stopExportFileData

- (BOOL) stopExportFileData

Stop export recording file data, Recording export status in this block: recording.updateExportingStatus

Returns
If firmware support recording feature this will be YES, otherwise it's NO

Extends class XsensDotDevice.

◆ stopMfm

- (NSString *) stopMfm

Stop MFM

Returns
The mtb file path

Extends class XsensDotDevice.

◆ stopRecording

- (BOOL) stopRecording

Stop recording

Returns
If firmware support recording feature this will be YES, otherwise it's NO

Extends class XsensDotDevice.

◆ stopSync

- (void) stopSync

Stop Synchronization

Extends class XsensDotDevice.

◆ writeMfmResult:

- (void) writeMfmResult: (NSData *)  mfmData

Write mtb data to firmware

Parameters
mfmDataThe mtb data

Extends class XsensDotDevice.


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