Device information tags

The device information tags form the first part of the Peripherals Information XML, and contain high level details about the peripheral device. The device information of the peripheral device appears on the Search/Input Device screen in the AVEVA Mobile Operator app. The device information tags are as follows.

<CommandResponse>1</CommandResponse>

<DeviceCultureInvariant>1</DeviceCultureInvariant>

<StateCheck>1</StateCheck>

<StateCheckCommand>Triggerstate</StateCheckCommand>

<ModelCheckCommand>Heartbeat</ModelCheckCommand>

<AutoPairDeviceUsingPin>1</AutoPairDeviceUsingPin>

<SessionEstablishment TimeDelay="500">1</SessionEstablishment>

<Endianness>1</Endianness>

<CommunicationResource>Bluetooth</CommunicationResource>

<SupportedDeviceType>1</SupportedDeviceType>

<Capabilities>

<SearchCapable>0</SearchCapable>

<InputCapable>1</InputCapable>

<CanTrigger>1</CanTrigger>

</Capabilities>

DeviceInformation (Required)

The DeviceInformation tag is a parent tag, and contains information about the peripheral device.

CommandResponse

The CommandResponse tag contains the peripheral command-response information. It defines whether the peripheral device is command-response type or broadcast type. Its data type is integer.

Possible values include:

0 – Broadcast format.

1 – Command response format.

DeviceCultureInvariant

The DeviceCultureInvariant tag contains the ability of the AVEVA Mobile Operator app to read the data using the peripheral, regardless of the locale settings.

Possible values include:

0 – Variant. Peripheral data read will be culture specific, Peripheral device and Mobile device need to be on the same culture for successful read.

1 – Invariant. Peripheral data read will be culture invariant. Values will be converted to the culture of the Mobile device, irrespective of the Peripheral Device culture.

Note: A data type mismatch error may occur if a value read by a peripheral is not valid for the localization settings configured for your environment. For example, a numeric value of 12.356 is not valid in German, which uses a comma in place of the decimal. Using a peripheral to scan that value in an environment configured for German localization will present the error. To ensure that the software is operating correctly, objects must be configured with valid numeric values for your specific localized environment or the DataType associated with the task must be configured as text. Text fields containing numeric values will be read by the scanning device as numeric if the format of the scanned data matches the localization settings of the scanning device.

StateCheck

The StateCheck tag contains the ability of the peripheral device to check the current state of the peripheral device. For example: triggered, yet to be triggered, triggered and released). Its data type is integer.

Possible values include:

0 – State check is not supported.

1 – State check is supported.

StateCheckCommand

The StateCheckCommand tag contains the command name to use for checking the trigger state of the peripheral device. It refers to the Type tag in DataCommandFormat tag. Its data type is string.

This tag will be used only if the StateCheck tag is set to 1. For more information on DataCommandFormat tags, see Command Tags.

For example, Triggerstate.

ModelCheckCommand

The ModelCheckCommand tag contains the model number of the peripheral device. It refers to the Type tag in the DataCommandFormat tag. Its data type is string.For more information on DataCommandFormat tags, see Command Tags.

Use this tag to get the peripheral device model number in case of multiple models. Use the PeripheralModel tag to define the packets for every possible model. For more information on PeripheralModel tag, see Field configuration tags.

AutoPairDeviceUsingPin

The AutoPairDeviceUsingPin tag contains settings that define the peripheral device support for auto pairing. Its data type is integer.

Possible values include:

0 – Auto pairing is not supported.

1 – Auto pairing is supported.

SessionEstablishment

The SessionEstablishment tag contains the state that determines if the peripheral device requires session establishment for communication. Its data type is integer.

Possible values include:

0 – Session establishment is not required.

1 – Session establishment is required.

The TimeDelay attribute is the time delay, in milliseconds, between each session establishment.

Note: Ensure you define the commands in the SessionEstablishmentCommands tag, if session establishment is required. For more information on SessionEstablismentCommands tag, see Command Tags.

Endianness

The Endiannes tag contains the endianness of the response received from the peripheral device. Its data type is integer.

Possible values include:

0 – Big endian.

1 – Little endian.

CommunicationResource

The CommunicationResource tag contains the communication resources used by the peripheral device. Its data type is string.

Possible values include:

Camera – Camera device.

Bluetooth – Bluetooth device.

ApptoApp - Communication between the AVEVA Mobile Operator Peripheral Plug-in app and AVEVA Mobile Operator Android app.

SupportedDeviceType

The SupportedDeviceType tag contains peripheral support validation for mobile operating systems. It configures peripheral support on different operating systems. For example, if a peripheral is supported on all three platforms, set the value of SupportedDeviceType tag to 7.

Its data type is integer.

Possible values include:

1 - Android device

2 - Apple device

3 - Android and Apple devices

4 - Windows 10 (UWP) device

5 - Android and Windows 10 (UWP) devices

6 - Apple and Windows 10 (UWP) devices

7 - Android, Apple, and Windows 10 (UWP) devices

Capabilities

The Capabilities tag contains the capability of the peripheral device.The different capabilities of the peripheral device are as follows.

SearchCapable

The SearchCapable tag is a part of the Capabilities tag. It contains the state that determines if the peripheral device can search for an asset. Its data type is boolean.

Possible values include:

0 – Peripheral device cannot search for an asset.

1 – Peripheral device can search for an asset.

InputCapable

The InputCapable tag is a part of the Capabilities tag. It contains the state that determines if the peripheral device can return any asset related information. Its data type is boolean.

Possible values include:

0 = Peripheral device cannot return asset related information.

1 = Peripheral device can return asset related information.

CanTrigger

The CanTrigger tag is a part of the Capabilities tag. It contains the state that determines if the peripheral device can trigger. Its data type is boolean.

Possible values are:

0 – Peripheral device needs to be triggered from the UI.

1 – Peripheral device has option to trigger.