i4SCADA Knowledge Base

i4SCADA IoT Manager Settings

An advanced user can organize multiple settings to manage the i4SCADA IoT Manager. Settings are stored in the configurations file of the i4SCADA IoT Manager, are read every time a specific operation is needed and can be changed at run-time.

Interval to read the log data – „MillisecondsIntervalReadLogData“
Abstract

Check out this article to learn about the i4SCADA IoT Manager internal timer and why is this setting relevant.

The i4SCADA IoT Manager has an internal timer, used to periodically iterate through the list of the IoT enabled logs. For every log it gets the log data sent to the IoT Hub. This setting is defining the interval that will be used for this timer.

The interval is always defined in milliseconds. The minimum supported value is 100 milliseconds and the maximum represents the highest Int32 type value (C#). The default value is 10000 milliseconds (10 seconds). When installed, the timer interval is set to 30000 (30 seconds).

Amount of log data to read for a log – „CounterReadLogData“
Abstract

Define the amount of log data that will be read for a specific log, that was previously enabled for the i4SCADA IoT Manager.

This setting is defining the amount of log data that will be read for a specific log, that was previously enabled for IoT. The minimum supported value is 1, the maximum supported value is 10000 and the default supported value is 1000. When installed, the value is set to 1000.

Interval to read alarm events – „MillisecondsIntervalReadAlarmEvents“
Abstract

Set up the i4SCADA IoT Manager internal timer to ensure a periodical reading of the IoT alarm events to be pushed to the IoT Hub.

The i4SCADA IoT Manager has an internal timer which is used to periodically read the IoT enabled alarm events and send them to the IoT Hub.

This setting is defining the interval that will be used for this timer. The interval is always defined in milliseconds. The minimum supported value is 100 milliseconds; the maximum supported value is the maximum value for Int32 type (C#) and the default supported value is 10000 milliseconds (10 seconds). When installed, the timer interval is set to 30000 (30 seconds).

Amount of alarm events to read – „CounterReadAlarmEvents“
Abstract

Set the maximum and minimum amount of IoT enabled alarm events that can be read.

This setting is defining the amount of IoT enabled alarm events to be read. The minimum supported value is 1; the maximum supported value is 10000; the default supported value is 1000. When installed, the value is set to 1000.

Interval to read user activity events – „MillisecondsIntervalReadUserActivityEvents“
Abstract

Enable the i4SCADA IoT Manager internal timer used to periodically read the user activity events enabled for the IoT and send them to the IoT Hub.

The i4SCADA IoT Manager has an internal timer used to periodically read the user activity events enabled for the IoT and send them to the IoT Hub.

This setting is defining the interval that will be used for this timer.

The interval is always defined in milliseconds. The minimum supported value is 100 milliseconds; the maximum supported value is the maximum value for Int32 type (C#); the default supported value is 10000 milliseconds (10 seconds). When installed, the timer interval is set to 30000 (30 seconds).

Amount of user activity events to read – „CounterReadUserActivityEvents“
Abstract

Set up the maximum and minimum amount of user activity events that the IoT Manager is allowed to read.

This setting is defining the amount of user activity events to be read.

The minimum supported value is 1; the maximum supported value is 10000; the default supported value is 1000. When installed, the value is set to 100.

Interval to read user log-on events – „MillisecondsIntervalReadUserLogonEvents“
Abstract

Set up the internal timer which is used to periodically read the IoT enabled user log-on events and send them to the IoT Hub.

The i4SCADA IoT Manager has an internal timer which is used to periodically read the IoT enabled user log-on events and send them to the IoT Hub. This setting is defining the interval that will be used for this timer.

The interval is always defined in milliseconds. The minimum supported value is 100 milliseconds; the maximum supported value is the maximum value for Int32 type (C#); the default supported value is 10000 milliseconds (10 seconds). When installed, the timer interval is set to 30000 (30 seconds).

Amount of user log-on events to read – „CounterReadUserLogonEvents“
Abstract

Set up the maximum and minimum amount of user log-on events to be read by the IoT Manager.

This setting is defining the amount of user log-on events to read.

The minimum supported value is 1; the maximum supported value is 10000; the default supported value is 1000. When installed, the value is set to 100.

Interval to read user modification events – "MillisecondsIntervalReadUserModificationEvents“
Abstract

Define the interval for the internal times used to periodically read the user modification events enabled for the IoT and then sent them to the IoT Hub.

The i4SCADA IoT Manager has an internal timer which is used to periodically read the user modification events enabled for the IoT and then sent them to the IoT Hub. This setting is defining the interval that will be used for this timer.

The interval is always defined in milliseconds. The minimum supported value is 100 milliseconds; the maximum supported value is the maximum value for Int32 type (C#); the default supported value is 10000 milliseconds (10 seconds). When installed, the timer interval is set to 30000 (30 seconds).

Amount of user modification events to read – „CounterReadUserModificationEvents“
Abstract

Set up the maximum and minimum amount of user modification events that the IoT Manager can read.

This setting is defining the amount of user modification events to be read.

The minimum supported value is 1; the maximum supported value is 10000; the default supported value is 1000. When installed, the value is set to 100.

Interval to read system events – „MillisecondsIntervalReadSystemEvents“
Abstract

Define the interval of the internal timer used to periodically read the system events enabled for the IoT and then send them to the IoT Hub.

The i4SCADA IoT Manager has an internal timer which is used to periodically read the system events enabled for the IoT and then send them to the IoT Hub. This setting is defining the interval that will be used for this timer.

The interval is always defined in milliseconds. The minimum supported value is 100 milliseconds; the maximum supported value is the maximum value for Int32 type (C#); the default supported value is 10000 milliseconds (10 seconds). When installed, the timer interval is set to 30000 (30 seconds).

Amount of system events to read – „CounterReadSystemEvents“
Abstract

Organise the setting to defining the amount of system events to be read by the i4SCADA IoT Manager.

This setting is defining the amount of system events to be read.

The minimum supported value is 1; the maximum supported value is 10000; the default supported value is 1000. When installed, the value is set to 100.

Interval to read system alarm events – „MillisecondsIntervalReadSystemAlarmEvents“
Abstract

Set up the interval for the internal timer used to periodically read the system alarm events, enabled for the IoT and send them to the IoT Hub.

The i4SCADA IoT Manager has an internal timer which is used to periodically read the system alarm events, enabled for the IoT and then sent them to the IoT Hub. This setting is defining the interval that will be used for this timer.

The interval is always defined in milliseconds. The minimum supported value is 100 milliseconds; the maximum supported value is the maximum value for Int32 type (C#); the default supported value is 10000 milliseconds (10 seconds). When installed, the timer interval is set to 30000 (30 seconds).

Amount of system alarm events to read – „CounterReadSystemAlarmEvents“
Abstract

Set up the maximum and minimum amount of system alarm events to be read by the IoT Manager.

This setting is defining the amount of system alarm events to be read.

The minimum supported value is 1; the maximum supported value is 10000; the default supported value is 1000. When installed, the value is set to 100.

Interval to check changes in IoT Settings – „MinutesIntervalCheckConfigSettings“
Abstract

Set up the interval for the internal timer used to periodically check for any changes into the IoT settings such as communication and event types.

The i4SCADA IoT Manager has an internal timer which is used to periodically check for any changes into the IoT settings (communication, event types). This setting is defining the interval that will be used for this timer.

The interval is always defined in minutes. The minimum supported value is 1 minute; the maximum supported value is 21600 (15 days); the default supported value is 5 minutes. When installed, the timer interval is set to 5 minutes.

Interval to check changes in logs definitions – „MinutesIntervalCheckLogDefinitions“
Abstract

Set up the interval for the internal timer used to periodically check for any changes into the IoT Manager logs definitions.

The i4SCADA IoT Manager has an internal timer used to periodically check for any changes into the logs definitions (i.e. any new logs that were enabled for the IoT or any logs that were disabled for the IoT). This setting is defining the interval that will be used for this timer.

The interval is always defined in minutes. The minimum supported value is 1 minute; the maximum supported value is 21600 (15 days); the default supported value is 5 minutes. When installed, the timer interval is set to 3 minutes.

Interval to check changes in alarms definitions – „MinutesIntervalCheckAlarmDefinitions“
Abstract

Set up the interval for the internal timer used to periodically check for any changes into the alarms definitions of the IoT Manager.

The i4SCADA IoT Manager has an internal timer used to periodically check for any changes into the alarms definitions (i.e. any new alarms that were enabled for the oT or any alarms that were disabled for the IoT). This setting is defining the interval that will be used for this timer.

The interval is always defined in minutes. The minimum supported value is 1 minute; the maximum supported value is 21600 (15 days); the default supported value is 5 minutes. When installed, the timer interval is set to 3 minutes.

Interval to check changes in signals definitions – „MinutesIntervalCheckSignalDefinitions“
Abstract

Set up the interval for the internal timer used to periodically check for any changes into the signals definitions of the IoT Manager.

The i4SCADA IoT Manager has an internal timer which is used to periodically check for any changes into the signals definitions (i.e. any new signals that were enabled for the IoT or any signals that were disabled for the IoT). This setting is defining the interval that will be used for this timer.

The interval is always defined in minutes. The minimum supported value is 1 minute; the maximum supported value is 21600 (15 days); the default supported value is 5 minutes. When installed, the timer interval is set to 1 minute.

Interval to send data to the IoT – „MillisecondsIntervalSendDataToCloud“
Abstract

Set up the interval for the internal timer used to periodically send data to the IoT Hub.

The i4SCADA IoT Manager has an internal timer used to periodically send data to the IoT Hub. This setting is defining the interval that will be used for this timer.

The interval is always defined in milliseconds. The minimum supported value is 10 milliseconds; the maximum supported value is the maximum value for Int32 type (C#); the default supported value is 1000 milliseconds (1 second). When installed, the timer interval is set to 10 milliseconds.

Payload for data sent to IoT Hub
Abstract

Check out the list of all the data types sent to the i4SCADA IoT Hub and their corresponding values.

The data that is sent to the IoT Hub is formatted using JSON. All the sent data will contain a type, in order to distinguish between different types of data sent to the IoT Hub. This is the list of all the data types sent to the IoT Hub and their corresponding values:

  • Log = 0

  • Alarm On = 1

  • Alarm Off = 2

  • Alarm Acknowledgement = 3

  • Server Started = 4

  • Server Stopped = 5

  • User Logged In = 6

  • User Logged Out = 7

  • User Wrote Signal = 8

  • Alarm Activated = 9

  • Alarm Deactivated = 10

  • User Created = 11

  • User Modified = 12

  • User Deleted = 13

  • User Password Changed = 14

  • Signal Update = 15

Payload for log data
Abstract

Check out this article for the log format of the Log Data payload and some useful examples.

The log is having the following format:

{"[Signal Name][Log Tag]":Logging Value,"Timestamp":"Logging Time","Type":0}

Here are some samples:

{"[Signal 1][LogTag]":59.0,"Timestamp":"2016-07-12T08:56:00.237","Type":0}

{"[Signal 2][LogTag]":8.0,"Timestamp":"2016-07-12T08:57:34.553","Type":0}

{"[Signal 3][LogTag]":"21.6896633758368","Timestamp":"2016-07-12T08:59:43.803","Type":0}
Payload for alarm data

The alarm data is having the following format:

{"[Signal Name][Alarm Name]":"Timestamp", "Type":Type Value}

Here are some samples:

Alarm on: {"[Signal 1][Alarm 1]":"2016-08-12T08:12:00","Type":1}

Alarm off: {"[Signal 1][Alarm 1]":"2016-08-12T08:16:00","Type:"2}

Alarm acknowledged: {"[Signal 1][Alarm 1]":"2016-08-12T08:17:00","Type":3}

Alarm activated: {"[Signal 1][Alarm 1]":"2016-08-12T09:23:00","Type":9}

Alarm deactivated: {"[Signal 1][Alarm 1]":"2016-08-12T09:56:00","Type":10}
Payload for system events
Abstract

Check out this article for the log format of the IoT Hub System Events payload and some useful examples.

The event data is having the following format:

{"[Server Name]":"Timestamp","Type":Type Value}

Here are some samples:

Server started: {"[Server 1]":"2016-08-12T06:00:00","Type":4}

Server stopped: {"[Server 1]":"2016-08-12T22:00:00","Type":5}
Payload for events involving user logon operations
Abstract

Check out this article for the events involving user logon operations of the IoT Hub System Events payload and some useful examples.

The event data is having the following format:

{"[User Name]":"Timestamp","Type":Type Value}

Here are some examples:

User logged in: {"[admin]":"2016-08-12T08:00:00","Type":6}

User logged out: {"[admin]":"2016-08-12T08:22:00","Type":7}
Payload for events involving user write operations
Abstract

Check out this article for the events involving user write operations of the IoT Hub System Events payload and some useful examples.

The event data is having the following format:

{"[User Name][Signal Name]":"Timestamp","Type":Type Value}

Here is a sample:

User wrote signal: {"[admin][Signal 1]":"2016-08-12T09:10:00","Type":8}
Payload for events involving user modifications
Abstract

Check out this article for the events involving user modifications of the IoT Hub System Events payload and some useful examples.

The event data is having the following format:

{"[User Name – logged in][User Name – affected by modifications]":"Timestamp","Type":Type Value}

Here are some samples:

User created: {"[admin][NewUser]":"2016-08-12T08:22:00","Type":11}

User modified: {"[admin][NewUser]":"2016-08-12T08:22:00","Type":12}

User deleted: {"[admin][NewUser]":"2016-08-12T08:22:00","Type":13}

User password changed: {"[admin][NewUser]":"2016-08-12T08:22:00","Type":14}
Payload for signal updates
Abstract

Check out this article for the signal updates of the IoT Hub System Events payload and some useful examples.

The signal update data is having the following format:

{"[Signal Name] ":Signal Value,"Timestamp":"Signal Update Time","Type":15}

Here are some examples:

{"[ Signal 1]":-16.496933166745187,"Timestamp":"2016-07-04T13:56:39.6337077Z","Type":15}

{"[Signal 2] ":8.0,"Timestamp":"2016-07-12T08:57:34.553","Type":15}