Field configuration tags

The field configuration tags form the second part of the Peripheral Information XML, and contain settings information for the peripheral device. The field configuration tags are as follows:

<ConfigParameters>

<PeripheralData>

<PeripheralDevice>

<Parameters>

<Parameter Hidden="1" DependentOn="RunSpeed">

<Key>MyKey</Key>

<Name></Name>

<Value>World</Value>

<Range>

<MinValue></MinValue>

<MaxValue></MaxValue>

<ValidationError></ValidationError>

</Range>

<DataType></DataType>

<DisplayValue>To All</DisplayValue>

</Parameter>

</Parameters>

<Messages>

<Message DependentParameter="ParameterKey">

<MessageCode></MessageCode>

<MessageText>Hello : {{MyKey}} {{MyKey.DisplayValue}}</MessageText>

<MessageType></MessageType>

</Message>

</Messages>

<PeripheralModel ModelName="B">

<PacketFormat>

<MaximumPacketLength>13</MaximumPacketLength>

<PacketStartCharacter>B</PacketStartCharacter>

<PacketEndCharacter>&#xA;</PacketEndCharacter>

<Packet PacketId =”1”>

<PacketLength>13</PacketLength>

<Fields>

<Field>

<Key>7645B9DB-F87A-45CF-AC15-9E65BC73041C</Key>

<!-- Packet Mode Identifier -->

<Offset>1</Offset>

<Length>1</Length>

<Units></Units>

</Field>

</Fields>

</Packet>

<Packet PacketId=”2”>

<PacketLength>12</PacketLength>

<Fields>

<Field>

<Key>7645B9DB-F87A-45CF-AC15-9E65BC73041C</Key>

<Delimiter>,</Delimiter>

</Field>

<Field>

<Key>CF92B680-F070-4768-A495-BC764C46A6AD</Key>

<Offset>2</Offset>

<Length>1</Length>

</Field>

</Fields>

</Packet>

</PacketFormat>

<Conditions>

<Condition>

<Name>ReadMode</Name>

<AllowedValues>C,1,2,3</AllowedValues>

<FieldToRead>7645B9DB-F87A-45CF-AC15-9E65BC73041C</FieldToRead>

</Condition>

<Condition>

<Name>ReleaseMode</Name>

<AllowedValues>H</AllowedValues>

<FieldToRead>7645B9DB-F87A-45CF-AC15-9E65BC73041C</FieldToRead>

<ResponseCommand>Heartbeat</ResponseCommand>

</Condition>

</Conditions>

</PeripheralModel>

</PeripheralDevice>

</PeripheralData>

</ConfigParameters>

ConfigParameters

The ConfigParameters tag contains a single instance of the PeripheralData tag.

PeripheralData

The PeripheralData tag contains a single instance of the PeripheralDevice tag.

PeripheralDevice

The PeripheralDevice tag contains Parameters, Messages, and PeripheralModel tags.

Parameters

The Parameters tag contains the list of Parameter tags. The Advanced search/input device settings lists all the parameter tags on the Search/Input Device screen in the AVEVA Mobile Operator app.

Parameter

The Parameter tag contains the following attributes:

• Hidden – Visible state of the parameter in the Advanced Search/Input Settings screen.
  
  Possible values include:
  0 – Visible
  1 – Hidden

• DependentOn – The parameter it is dependent on. If the DependentOn parameter value is not configured in the Management Center, then the global default value is used for both the DependentOn tag and the current tag.

The types of parameter include:

• Key (Required) – Unique ID of a parameter

• Name – Name of the parameter. It can be a normal ASCII string

• Value – Default value of the parameter. It can be an alpha numeric value

• Range – Range for the values, if any (for example, Celsius)

  • Minimum Value – Minimum value of the range

  • Maximum Value – Maximum value of the range

  • Validation Error – Validation error, if applicable

• DataType (Required) – Data type of the parameter (1 for integer, 0 for string)

• Display Value – Value to display. It is related to the Value parameter (for example, in case of units, the Value can be 1 and the Display Value can be RPM)

Messages

The Messages tag contains multiple Message tags.

Message

The Message tag contains the following properties:

• Message DependentParameter – The parameter the Message tag is dependent on. If the DependentOn parameter is set to true, then the message is displayed. If it is kept blank, then it is considered true by default. Its data type is boolean.

The Message tag has the following tags:

• MessageCode – Code of the message

• MessageText – Message text to display

• MessageType – Type of message. Currently, only the Notification value is used
  
  Possible values include:
  Notification – For notification
  Errors – For error messages
  Information –- For information messages

PeripheralModel

The PeripheralModel tag contains information related to the peripheral model. Use this tag to configure the packet format details for peripherals having multiple models. It contains one PacketFormat tag.

For example, the PeripheralModel tag has the following structure:

<PeripheralModel ModelName="B">

<PacketFormat>...</PacketFormat>

<Conditions>...</Conditions>

</PeripheralModel>

The ModelName attribute should be the value returned by the ModelCheckCommand tag to identify a particular model.

PacketFormat

The PacketFormat tag contains the following tags:

Note: For more information on the PacketFormat tag, refer to the documentation supplied with the peripheral.

MaximumPacketLength

The MaximumPacketLength tag contains the maximum number of bytes for the packet length. Its data type is integer.

PacketStartCharacter

The PacketStartCharacter tag contains the packet start character for the specific model. Its data type is string.

PacketEndCharacter

The PacketEndCharacter tag contains the packet end character for this model. Its data type is string.

Packet

The Packet tag contains information on how to parse the packet. Each packet has the following fields:

PacketID

The PacketID tag contains the ID of the packet format. The ID starts from 1, and is used in the ResponsePacketId tag of the DataCommand tag. Its data type is integer.

PacketLength

The PacketLength tag contains the length of the packet (number of bytes). Its data type is integer.

Fields

The Fields tag contains multiple Field tags.

Field

The Field tag contains packets, each of which contains several peripheral fields.

Key

The Key tag contains the GUID of the peripheral field. The GUID is the same as the Field ID defined in the Management Center. Its data type is GUID.

Offset

The Offset contains the packet field’s offset. Its data type is integer.

Length

The Length tag contains the length of the peripheral field value in the packet. Its data type is integer.

Delimiter

The Delimiter tag contains the delimiter to use for reading a field value in the packet. It is used even if the field has delimiter and offset/length specified for the field. Its data type is string.

Units

The Units tag contains the measuring unit of the peripheral field. For example, Celsius. Its data type is string.

Conditions

The Conditions tag contains the conditions that could identify the modes (Read/Hold mode) of the peripheral device based on the data received from the peripheral device. This tag is commonly used for broadcast peripherals. It contains multiple Condition tags.

Note: For more information on the peripheral modes, refer to the documentation supplied with the peripheral.

Condition

The Condition tag contains the following tags:

Name

The Name tag contains the name of the condition.

AllowedValues

The AllowedValues tag contains the values allowed, separated with commas. Its data type is string.

FieldToRead

The FieldToRead tag contains the field ID of the condition. Its data type is string.

ResponseCommand

The ResponseCommand tag contains the response command to run when a specific condition is satisfied. This relates to the Type tag in the DataCommandFormat tag. Its data type is string.