UgiFarsens Class Reference

Overview

Support for reading Farsens tags

Class Methods
(void)	+ readFenixVortexTemperature:withStatusCallback:withCompletion:
	Read the temperature from a Fenix-Vortex tag More...
(void)	+ readFenixVortexPressure:withStatusCallback:withCompletion:
	Read the pressure from a Fenix-Vortex tag More...
(void)	+ readKineo:withStatusCallback:withCompletion:
	Read the orientation from a Kineo tag More...
(void)	+ readTitan:withStatusCallback:withCompletion:
	Read the relay setting from a Kineo tag More...
(void)	+ writeTitan:withSetPosition1:withStatusCallback:withCompletion:
	Set the relay state of a Kineo tag More...

Types
typedef void(^	UgiFarsensReadFenixVortexPressureCompletion) (UgiTagAccessReturnValues result, float pressure)
	Completion for readFenixVortexTemperature More...
typedef void(^	UgiFarsensReadKineoCompletion) (UgiTagAccessReturnValues result, float x, float y, float z)
	Completion for readKineo More...
typedef void(^	UgiFarsensReadTitanCompletion) (UgiTagAccessReturnValues result, BOOL isValid, BOOL isPosition1)
	Completion for readTitan More...
typedef void(^	UgiFarsensWriteTitanCompletion) (UgiTagAccessReturnValues result)
	Completion for writeTitan. More...

Protected Types
typedef void(^	UgiFarsensStatusCallback) (NSString *_Nonnull status)
	Completion for readFenixVortexTemperature More...
typedef void(^	UgiFarsensReadFenixVortexTemperatureCompletion) (UgiTagAccessReturnValues result, float temperatureC)
	Completion for readFenixVortexTemperature More...

Instance Method Documentation

readFenixVortexTemperature:withStatusCallback:withCompletion:()

+ (void) readFenixVortexTemperature:		(UgiTag *_Nonnull)	tag
withStatusCallback:		(nullable UgiFarsensStatusCallback)	statusCallback
withCompletion:		(nonnull UgiFarsensReadFenixVortexTemperatureCompletion)	completion

Read the temperature from a Fenix-Vortex tag

Parameters

tag	Tag to read
statusCallback	Callback for each step of the process (intended for use with showWaiting)
completion	Completion when finished

readFenixVortexPressure:withStatusCallback:withCompletion:()

+ (void) readFenixVortexPressure:		(UgiTag *_Nonnull)	tag
withStatusCallback:		(nullable UgiFarsensStatusCallback)	statusCallback
withCompletion:		(nonnull UgiFarsensReadFenixVortexPressureCompletion)	completion

Read the pressure from a Fenix-Vortex tag

Parameters

tag	Tag to read
statusCallback	Callback for each step of the process (intended for use with showWaiting)
completion	Completion when finished

readKineo:withStatusCallback:withCompletion:()

+ (void) readKineo:		(UgiTag *_Nonnull)	tag
withStatusCallback:		(nullable UgiFarsensStatusCallback)	statusCallback
withCompletion:		(nonnull UgiFarsensReadKineoCompletion)	completion

Read the orientation from a Kineo tag

Parameters

tag	Tag to read
statusCallback	Callback for each step of the process (intended for use with showWaiting)
completion	Completion when finished

readTitan:withStatusCallback:withCompletion:()

+ (void) readTitan:		(UgiTag *_Nonnull)	tag
withStatusCallback:		(nullable UgiFarsensStatusCallback)	statusCallback
withCompletion:		(nonnull UgiFarsensReadTitanCompletion)	completion

Read the relay setting from a Kineo tag

Parameters

tag	Tag to read
statusCallback	Callback for each step of the process (intended for use with showWaiting)
completion	Completion when finished

writeTitan:withSetPosition1:withStatusCallback:withCompletion:()

+ (void) writeTitan:		(UgiTag *_Nonnull)	tag
withSetPosition1:		(BOOL)	setPosition1
withStatusCallback:		(nullable UgiFarsensStatusCallback)	statusCallback
withCompletion:		(nonnull UgiFarsensWriteTitanCompletion)	completion

Set the relay state of a Kineo tag

Parameters

setPosition1	YES to set position 1, NO to set position 2
tag	Tag to read
statusCallback	Callback for each step of the process (intended for use with showWaiting)
completion	Completion when finished

Member Typedef Documentation

UgiFarsensStatusCallback

- (typedef void(^ UgiFarsensStatusCallback) (NSString *_Nonnull status))

protected

Completion for readFenixVortexTemperature

Parameters

status

Description of current state

UgiFarsensReadFenixVortexTemperatureCompletion

- (typedef void(^ UgiFarsensReadFenixVortexTemperatureCompletion) (UgiTagAccessReturnValues result, float temperatureC))

protected

Completion for readFenixVortexTemperature

Parameters

result	Result of the operation
temperatureC	Temperature, in degreesC (if successful)

UgiFarsensReadFenixVortexPressureCompletion

- (typedef void(^ UgiFarsensReadFenixVortexPressureCompletion) (UgiTagAccessReturnValues result, float pressure))

Completion for readFenixVortexTemperature

Parameters

result	Result of the operation
pressure	Pressure (if successful)

UgiFarsensReadKineoCompletion

- (typedef void(^ UgiFarsensReadKineoCompletion) (UgiTagAccessReturnValues result, float x, float y, float z))

Completion for readKineo

Parameters

result	Result of the operation
x	Oreintation, x
y	Oreintation, y
z	Oreintation, z

UgiFarsensReadTitanCompletion

- (typedef void(^ UgiFarsensReadTitanCompletion) (UgiTagAccessReturnValues result, BOOL isValid, BOOL isPosition1))

Completion for readTitan

Parameters

result	Result of the operation
isValid	YES if the position value is valid
isPosition1	YES if relay is set to position 1

UgiFarsensWriteTitanCompletion

- (typedef void(^ UgiFarsensWriteTitanCompletion) (UgiTagAccessReturnValues result))

Completion for writeTitan.

Parameters

result

Result of the operation