Command Tags

The command tags form the last part of the Peripheral Information XML, and contain a set of commands to get data from the peripheral device. The command tags are as follows.

<SessionEstablishmentCommands>

<Type>ENABLE_CHANNEL</Type>

<FieldID></FieldID>

<Syntax>9700010197</Syntax>

<Responseheader>97</Responseheader>

<Responsesize>4</Responsesize>

<ValueIndex>0</ValueIndex>

<ValueSize>4</ValueSize>

<SuccessResponseValue>97000097</SuccessResponseValue>

<DelayRequiredAfterExecution>500</DelayRequiredAfterExecution>

<EncodingFormat>HEX</EncodingFormat>

</SessionEstablishmentCommands>

<SessionClosingCommands>

<Type>ENABLE_CHANNEL</Type>

<FieldID></FieldID>

<Syntax>9700010096</Syntax>

<Responseheader>97</Responseheader>

<Responsesize>4</Responsesize>

<ValueIndex>0</ValueIndex>

<ValueSize>4</ValueSize>

<SuccessResponseValue>97000097</SuccessResponseValue>

<EncodingFormat>HEX</EncodingFormat>

</SessionClosingCommands>

<DataCommandFormat>

<Type> </Type>

<FieldID> </FieldID>

<FieldCode>A</FieldCode>

<Syntax></Syntax>

<Responseheader></Responseheader>

<Responsesize></Responsesize>

<ValueIndex></ValueIndex>

<ValueSize></ValueSize>

<SuccessResponseValue></SuccessResponseValue>

<Response> </Response>

<DelayRequiredAfterExecution>500</DelayRequiredAfterExecution>

<TimestampLengthBytes>6</TimestampLengthBytes>

<ChecksumLengthBytes>1</ChecksumLengthBytes>

<Failureresponseheader>1f</Failureresponseheader>

<EncodingFormat>HEX</EncodingFormat>

<OutputDataType> </OutputDataType>

</DataCommandFormat>

<DataCommandFormat>

<Type>Instantaneous</Type>

<FieldID>DF7CB0E9-69B6-401d-A316-F4640068F346</FieldID>

<Syntax>?T\r\n</Syntax>

<Responseheader>!T</Responseheader>

<Responsesize>9</Responsesize>

<ValueIndex>2</ValueIndex>

<ValueSize>5</ValueSize>

<EncodingFormat>ASCII</EncodingFormat>

<OutputDataType>Number</OutputDataType>

</DataCommandFormat>

SessionEstablishmentCommands

The SessionEstablishmentCommands is a parent tag, and contains commands used to establish a session with the peripheral device. Users can define multiple commands, if required.

Note: Ensure commands are declared in the sequence as defined in the DataCommandFormat tag.

SessionClosingCommands

The SessionClosingCommands is a parent tag, and contains commands used to close a session with the peripheral device. Users can define multiple commands, if required.

Note: Ensure commands are declared in the sequence as defined in the DataCommandFormat tag.

DataCommandFormat

The DataCommandFormat is a parent tag, and contains formats for commands sent to the peripheral device to read a specific value. It also specifies the response format expected from the peripheral device, the value index, and the length in the response packet. It appears multiple times. The DataCommandFormat tag appears multiple times and contains the following data command tags. Additionally, when a peripheral has multiple models , the ModelName attribute within the DataCommandFormat tag must be used to specify the model name of the peripheral. For example, <DataCommandFormat ModelName="0"> for TPI 9080 and <DataCommandFormat ModelName="2"> for TPI 9085.

Type (Required)

The Type tag contains the type or name of the peripheral field. Ensure this value is the same as the Field Name defined in the Management Center. Its data type is string.

FieldID (Required)

The FieldID tag contains the ID of the peripheral field. Ensure this value is the same as the Field ID defined in th Management Center. Its data type is GUID.

Syntax (Required)

The Syntax tag contains the command that should be sent to the peripheral device to read the field. Its data type is string.

ResponseHeader (Required)

The ResponseHeader tag contains the header of the response packet expected from the peripheral device. Its data type is string.

ResponseSize (Required)

The ResponseSize tag contains the size of the response packet expected from the peripheral device. Its data type is integer.

ValueIndex

The ValueIndex tag contains the index or offset of the value in the response packet.Its data type is integer.

ValueSize

The ValueSize tag contains the length of the value in the response packet. Its data type is integer.

SuccessResponseValue

The SuccessResponseValue tag contains the expected success response value from the peripheral device. This is applicable in case of trigger state command. Its data type is string.

DelayRequiredAfterExecution

The DelayRequiredAfterExecution tag contains the delay in milliseconds required after sending a command. The app will wait for the defined period before performing any read/write operations to the stream. Its data type is string.

TimestampLengthBytes

The TimestampLengthBytes tag contains the length of the timestamp, if the peripheral device responds with a time stamp. Its data type is integer.

ChecksumLengthBytes

The ChecksumLengthBytes tag contains the length of the checksum value in the response, if any. Its data type is integer.

FailureResponseHeader

The FailureResponseHeader tag contains the header of the failure response packet, if any. Its data type is string.

OutputDataType

The OutputDataType tag contains the Data Type of the field read by the peripheral. Configure this tag for each field that the peripheral reads within the DataCommandFormat tag. Its data type is string. The default value is Text.

Possible values are:

Text: Peripheral reads field as text

Number: Peripheral reads field as number

Date: Peripheral reads field as Date

Date/Time: Peripheral reads field as DateTime

EncodingFormat

The EncodingFormat tag contains the encoding format. Its data type is string.

Possible values include:

ASCII – ASCII encoding format

HEX – Hexadecimal encoding format

ResponsePacketID

The ResponsePacketID tag contains the packet ID of the Packet tag. Its data type is integer.