Table of Contents

Class FindTagCommand

Namespace
TechnologySolutions.Rfid.AsciiProtocol.Commands
Assembly
TechnologySolutions.Rfid.AsciiProtocol.Core.dll

The .ft FindTag Command of the Technology Solutions UK Ltd ASCII 2 Protocol

(.ft) ASCII command to perform find a transponder by EPC. Performs/configures find transponder using the reader. When armed, use the trigger to start/stop finding and double-click to disarm. RP: response is scaled across min/max RSSI seen.

[AsciiCommand(".ft")]
public class FindTagCommand : AsciiCommandBase, IAsciiCommand, IAntennaParametersWithBounds, IAntennaParameters, IAntennaParameterBounds, IAntennaParameterCommandBounds, ICommandParameters, IResponseParameters
Inheritance
FindTagCommand
Implements
Inherited Members
Extension Methods

Constructors

FindTagCommand()

Initializes a new instance of the InventoryCommand class

public FindTagCommand()

Properties

BuzzerVolume

Gets or sets the volume of the buzzer (where supported)

[AsciiParameter("l")]
public BuzzerVolume? BuzzerVolume { get; set; }

Property Value

BuzzerVolume?

ByTrigger

Gets or sets a value to arm or disarm the FindTagCommand by trigger.

[AsciiParameter("st")]
public StartStop? ByTrigger { get; set; }

Property Value

StartStop?

Remarks

When started the primary trigger action is replaced by find tag. The find tag command will be executed while the trigger is held

When stopped the primary trigger action is restore to its configured value.

IncludeDateTime

Gets or sets a value indicating whether the date and time is included in the response when a barcode is read

[AsciiParameter("dt", "includes")]
public TriState? IncludeDateTime { get; set; }

Property Value

TriState?

IncludeEpc

Gets or sets a value indicating whether to include transponder epc in reader responses

[AsciiParameter("ie", "includes")]
public TriState? IncludeEpc { get; set; }

Property Value

TriState?

IncludeRssi

Gets or sets a value indicating whether to include transponder rssi in reader responses

[AsciiParameter("r", "includes")]
public TriState? IncludeRssi { get; set; }

Property Value

TriState?

IncludeRssiPercentage

Gets or sets a value indicating whether to include transponder epc in reader responses

[AsciiParameter("ip", "includes")]
public TriState? IncludeRssiPercentage { get; set; }

Property Value

TriState?

MaximumOutputPower

Gets or sets the maximum output power (used to bounds check OutputPower)

public int MaximumOutputPower { get; set; }

Property Value

int

Remarks

This value does not need to be initialized. If the value is not set it will assume the value from Current

MinimumOutputPower

Gets or sets the minimum output power (used to bounds check OutputPower)

public int MinimumOutputPower { get; set; }

Property Value

int

Remarks

This value does not need to be initialized. If the value is not set it will assume the value from Current

OutputPower

Gets or sets the output power in dBm between MinimumOutputPower and MaximumOutputPower or null to use the reader's current value

[AsciiParameter("o")]
public int? OutputPower { get; set; }

Property Value

int?

ReadParameters

Gets or sets a value indicating whether the response to the command should report all supported parameters and their current values

[AsciiParameter("p")]
public bool ReadParameters { get; set; }

Property Value

bool

ResetParameters

Gets or sets a value indicating whether to set all parameters to their default values before executing the command

[AsciiParameter("x")]
public bool ResetParameters { get; set; }

Property Value

bool

SelectBank

Gets or sets the Bank to use for the select mask

[AsciiParameter("sb", "select")]
public Databank? SelectBank { get; set; }

Property Value

Databank?

SelectData

Gets or sets the select mask data in 2 character ASCII Hex pairs padded to ensure full bytes

[AsciiParameter("sd", "select")]
public string SelectData { get; set; }

Property Value

string

SelectLength

Gets or sets the length in bits of the select mask

[AsciiParameter("sl", "select")]
public int? SelectLength { get; set; }

Property Value

int?

SelectOffset

Gets or sets the number of bits from the start of the block to the start of the select mask

[AsciiParameter("so", "select")]
public int? SelectOffset { get; set; }

Property Value

int?

SoundPercentageThresholdOne

Gets or sets the sound percentage threshold 1 (beeps and tone)

[AsciiParameter("t1", "feedback")]
public int? SoundPercentageThresholdOne { get; set; }

Property Value

int?

SoundPercentageThresholdThree

Gets or sets the sound percentage threshold 3 (beeps and tone)

[AsciiParameter("t3", "feedback")]
public int? SoundPercentageThresholdThree { get; set; }

Property Value

int?

SoundPercentageThresholdTwo

Gets or sets the sound percentage threshold 2 (beeps and tone)

[AsciiParameter("t2", "feedback")]
public int? SoundPercentageThresholdTwo { get; set; }

Property Value

int?

TakeNoAction

Gets or sets a value indicating whether the command should only update the parameters and not perform the action of the command

[AsciiParameter("n")]
public bool TakeNoAction { get; set; }

Property Value

bool

Timestamp

Gets the timestamp when the command started if date and time stamp is enabled (-dt on)

[AsciiResponse("DT")]
public DateTime Timestamp { get; }

Property Value

DateTime

ToneVariableFrequency

Gets or sets a value indicating whether to use a variable tone (Yes) or discrete beeps (No) as as audible prompt to the proximity to the target. Set to null (Nothing is Visual Basic) to not affect the current value

[AsciiParameter("to", "feedback")]
public TriState? ToneVariableFrequency { get; set; }

Property Value

TriState?

Transponders

Gets the transponders received since the start of the last command

[AsciiResponse("CR", AsciiResponseRepeat.PerTransponder, "requires -c on")]
[AsciiResponse("EP", AsciiResponseRepeat.PerTransponder, "requires -ie on")]
[AsciiResponse("IX", AsciiResponseRepeat.PerTransponder, "requires -ix on")]
[AsciiResponse("PC", AsciiResponseRepeat.PerTransponder, "requires -e on")]
[AsciiResponse("RI", AsciiResponseRepeat.PerTransponder, "requires -r on")]
[AsciiResponse("EA", AsciiResponseRepeat.PerTransponder, "tag access commands only")]
[AsciiResponse("EB", AsciiResponseRepeat.PerTransponder, "tag access commands only")]
[AsciiResponse("KS", AsciiResponseRepeat.PerTransponder, "tag access commands only")]
[AsciiResponse("LS", AsciiResponseRepeat.PerTransponder, "tag access commands only")]
[AsciiResponse("TD", AsciiResponseRepeat.PerTransponder, "requires -fi on")]
[AsciiResponse("CF", AsciiResponseRepeat.PerTransponder, "requires -ic on")]
[AsciiResponse("PH", AsciiResponseRepeat.PerTransponder, "requires -ip on")]
[AsciiResponse("RD", AsciiResponseRepeat.PerTransponder, "read transponder command only")]
[AsciiResponse("RP", AsciiResponseRepeat.PerTransponder, "find tag command only")]
[AsciiResponse("QT", AsciiResponseRepeat.PerTransponder, "read transponder command only")]
[AsciiResponse("WW", AsciiResponseRepeat.PerTransponder, "write transponder command only")]
public IEnumerable<TransponderData> Transponders { get; }

Property Value

IEnumerable<TransponderData>

UseAlert

Gets or sets a value indicating whether the alert is sounded when a barcode is read. Set to null to not change the value

[AsciiParameter("al")]
public TriState? UseAlert { get; set; }

Property Value

TriState?

Methods

OnTransponderReceived(TransponderData, bool)

Called for each transponder received in the response

protected virtual void OnTransponderReceived(TransponderData transponder, bool moreToFollow)

Parameters

transponder TransponderData

The transponder to report

moreToFollow bool

True if more transponder are already queued

Events

TransponderReceived

Raised when a transponder is received

public event EventHandler<TransponderDataEventArgs> TransponderReceived

Event Type

EventHandler<TransponderDataEventArgs>