Skip to main content
Version: 2.6

Driver Configuration

Plugin Configuration

The plugin configuration file is named settings.json located in <install directory>\Config\HumanOS.UHAL.FileReader\. It contains all global settings of the plugin.

See Generic Plugin Configuration for more details.

Device Information File

The device information file is used to configure the access to files. It contains:

  • Id: unique device id (GUID)
  • DriverId: 94CAFEC2-7910-41F6-8185-C35CA768FABA
  • Address: Connection address
  • Data Access

See Device Information Model for more details.

Connection Address

The plugin is designed so that one device info file must be created for each monitoring XML or JSON file. The address points to the monitored file (path).

NOTE

Environment variables inside the path are resolved, e.g. %userprofile%.

Examples:

TypeExampleResolved path
AbsoluteC:\Temp\FileToRead.jsonC:\Temp\FileToRead.json
Relative.\Files\FileToRead.json${AppConfig:CommonAppPath}\Files\FileToRead.json
Environment variable%userprofile%\Files\FileToRead.jsonfor windows typically C:\Users\${username}\Files\FileToRead.json

Additional Properties

The property Encoding allows to specify the file encoding. If the property is not specified, the standard encoding of the operating system is used.

Following values are possible for the property "Encoding":

Property ValueDescription
ASCIIUS-ASCII encoding
UnicodeUnicode (UTF-16)
BigEndianUnicodeUnicode (Big endian)
UTF7UTF-7 encoding
UTF8UTF-8 encoding
UTF32Unicode (UTF-32)
Latin1Western European (iso-8859-1)

Example

Following example shows a device info file for the HumanOS.UHAL.FileReader plugin:

{
"Id": "50CC3DA6-5874-40F8-9A5B-820F1F445365",
"Name": "My Device Name",
"DriverId": "94CAFEC2-7910-41F6-8185-C35CA768FABA",
"Address": "C:\\Projects\\HumanOS\\FileToRead.xml",
"Properties": [
{
"Name": "Encoding",
"Value": "UTF8"
}
],
"DataNodes": []
}