Device Version 1.12
Group 'Device Settings'
Settings to communicate with the remote device
This is a configuration group that has 20 parameters.
| Parameter | Tag Name | ID | Value Type | Tag Value Type | IO Type | Default Value | Limits | Default Units | Allowed Units | Description | Sync Enabled | Sync Default | Export Enabled | Publish MQTT Enabled | Subscribe MQTT Enabled | Show in Manager Enabled |
| Device Name | name | 1114112 | string | i | device | minChars:4;maxChars:32; spaces:True; lettersNumbersOnly:False; | The name of the remote device | |||||||||
| Device Description | desc | 1114113 | string | i | minChars:0;maxChars:64; spaces:True; lettersNumbersOnly:False; | An optional description for the remote device | ||||||||||
| Metadata | devMetadata | 1114130 | string | i | minChars:0;maxChars:128; spaces:True; lettersNumbersOnly:False; | Optional metadata for the device. Metadata will be transferred to the PLC Shift Cloud when cloud export is enabled. Enter metadata as key:value pairs separated by semicolons. For example, "units:°C;size:large;" | ||||||||||
| Host Name | hostName | 1114114 | string | i | 192.168.0.16 | minChars:2;maxChars:128; spaces:False; lettersNumbersOnly:True; | The IP address or host name of the remote device | |||||||||
| SSH Port | sshPort | 1114115 | ui16 | i | 22 | min:1;max:65535; | The port on the remote device for SSH connections | ✓ | ||||||||
| SSH User Name | sshUserName | 1114116 | string | i | root | minChars:2;maxChars:32; spaces:False; lettersNumbersOnly:True; | The user name to connect to the remote device over SSH | |||||||||
| SSH Authentication Type | sshAuthType | 1114117 | i32 | i | 0:Password | 0:Password; 1:Public Key; | The type of authentication to use for the SSH connection. Select Password to use a password. The program will prompt for a password the first time that you connect. Choose Public Key to use public key authentication. When the Public Key option is selected make sure to configure the SSH Public Key File Name correctly. If the key file is password protected, the program will prompt for a password on the first connection attempt | ✓ | ||||||||
| SSH Public Key File Name | sshRsaKeyFile | 1114118 | string | i | id_rsa.pub | minChars:0;maxChars:32; spaces:False; lettersNumbersOnly:True; | The name of the file in the '\Users\ | |||||||||
| Enable Tag DB | enTagDb | 1114123 | bool | i | False | min:False;max:True; | Whether to enable communications with the logic controller's tag database | ✓ | ||||||||
| Database Protocol | dbProtocol | 1114119 | i32 | i | 0:Modbus TCP | 0:Modbus TCP; 1:EIP; 2:OPC UA; 3:SP47xi; | The type of tag database | ✓ | ||||||||
| Database Host Name | dbHostName | 1114120 | string | i | 192.168.0.17 | minChars:2;maxChars:128; spaces:False; lettersNumbersOnly:True; | The host name or IP address of the tag database | |||||||||
| EIP CPU Slot | eipCpuSlot | 1114122 | i16 | i | 0 | min:0;max:31; | The slot number of the CPU to communicate with. This is only required when the selected Database Protocol is EIP | ✓ | ||||||||
| Modbus Station Address | mbStationAddress | 1114124 | i16 | i | 1 | min:1;max:240; | The Modbus station address of the logic controller. This is only required when the Database Protocol is Modbus | ✓ | ||||||||
| Modbus TCP Addressing Type | mbAddrTyp | 1114129 | i32 | i | 0:Five Digit | 0:Five Digit; 1:Six Digit; | The type of addressing to use when the Database Protocol is Modbus TCP. Select Five Digit when there are less than 9999 registers available. Choose Six Digit to access all possible registers. The type of addressing selected here must be supported in the Modbus client | ✓ | ||||||||
| Modbus Int32 Register Ordering | mbIntOrder | 1114125 | i32 | i | 0:High Bytes Low Register | 0:High Bytes Low Register; 1:High Bytes High Register; | Modbus does not specify a register ordering for 32 bit values. Select the register ordering for 32 bit signed and unsigned integer values. Choose 'High Bytes Low Register' when the higher order 16 bits are in the first register. Choose 'High Bytes High Register' when the higher order 16 bits are in the second register | ✓ | ||||||||
| Modbus Float Register Ordering | mbFltOrder | 1114126 | i32 | i | 0:High Bytes Low Register | 0:High Bytes Low Register; 1:High Bytes High Register; | Modbus does not specify a register ordering for 32 bit values. Select the register ordering for 32 bit floating point values. Choose 'High Bytes Low Register' when the higher order 16 bits are in the first register. Choose 'High Bytes High Register' when the higher order 16 bits are in the second register | ✓ | ||||||||
| Modbus Align 32 Bit | mbAlign32Bit | 1114127 | bool | i | False | min:False;max:True; | Whether to align 32 bit values to an even Modbus register. Dummy registers will be inserted as required in the Modbus export to ensure that 32 bit values are in an even numbered register. Note that '40001' is an even register from a Modbus perspective when the Modbus Register Offset is 1 | ✓ | ||||||||
| Modbus Register Offset | mbRegOffset | 1114128 | i32 | i | 1:One | 0:Zero; 1:One; | The offset between the configured base addresses and the actual register number used by the Modbus protocol. For example, if the offset is One then a base address of 40001 means the first register and the request is for register 0. If the offset is Zero then a base address of 40001 means the second register and the request is for register 1. | ✓ | ||||||||
| OPC UA Namespace Index | opcNsIndex | 1114131 | i16 | i | 4 | min:0;max:255; | The index of the namespace where tags for PLC Shift apps can be found on the controller. The value here is put after 'ns=' in the OPC-UA Node ID for each app. | ✓ | ||||||||
| OPC UA Node ID | opcNodeId | 1114132 | string | i | |var|Opto22-Cortex-Linux.Application | minChars:4;maxChars:128; spaces:False; lettersNumbersOnly:False; | The name of the OPC UA node that contains the PLC Shift application tags without the Global Variable List (GVL) or tag name parts. The GVL and tag name are set at the app level. |
Group 'Export Settings'
Configure data export locations
This is a configuration group that has 32 parameters.
| Parameter | Tag Name | ID | Value Type | Tag Value Type | IO Type | Default Value | Limits | Default Units | Allowed Units | Description | Sync Enabled | Sync Default | Export Enabled | Publish MQTT Enabled | Subscribe MQTT Enabled | Show in Manager Enabled |
| Device Export Name | deviceExportName | 1179648 | string | i | minChars:0;maxChars:32; spaces:False; lettersNumbersOnly:True; | Enter a string value to uniquely identify exported data from this device. This is only required if export is enabled. If this is left empty the Device Name will be used instead | ||||||||||
| Export Core Logs | enExCoreLog | 1179673 | bool | i | False | min:False;max:True; | Whether to export log files generated at the device level. These logs contain information about requests from the management app, creating and deleting apps, etc. At least one file export location must be enabled for files to acutally be exported. | ✓ | ||||||||
| Export PLC Driver Logs | enExPlcDrvLog | 1179671 | bool | i | False | min:False;max:True; | Whether to export log files generated by the PLC driver. At least one file export location must be enabled for files to acutally be exported. | ✓ | ||||||||
| Export MQTT Logs | enExMqttLog | 1179672 | bool | i | False | min:False;max:True; | Whether to export log files generated by the MQTT interface. At least one file export location must be enabled for files to acutally be exported. | ✓ | ||||||||
| Export IO Task Logs | enExIoLog | 1179678 | bool | i | False | min:False;max:True; | Whether to export log files generated by the IO Task, which is responsible for direct communications with IO devices like multivariable sensors. At least one file export location must be enabled for files to acutally be exported. | ✓ | ||||||||
| Export Partial Logs | exportPartialLogs | 1179674 | bool | i | False | min:False;max:True; | When this option is selected, partial log files will be uploaded periodically during the day that they are generated. It's not possible to append to a log file in the cloud, so this involves deleting the existing log file in cloud storage and replacing it with the new, larger log file for the current day. This uses more bandwidth than uploading the log files once, after the day is complete and the log file is no longer growing. | ✓ | ||||||||
| Enable File Export to Azure Blob Storage | enFlExpAzBlob | 1179649 | bool | i | False | min:False;max:True; | Upload application log files to Azure Blob storage | ✓ | ||||||||
| Enable Table Export to Azure Table Storage | enTblExAzTbl | 1179650 | bool | i | False | min:False;max:True; | Export tabular data, like flow computer history or Data Logger data to Azure Table Storage | ✓ | ||||||||
| Enable Stream Export to Azure Event Hub | enStrmExAzHub | 1179651 | bool | i | False | min:False;max:True; | Export tag values to Azure Event Hub | ✓ | ||||||||
| Azure Blob Storage SAS Token | azBlobConnS | 1179652 | string | i | minChars:0;maxChars:1024; spaces:False; lettersNumbersOnly:False; | The Shared Access Signature (SAS) URI used to connect to a specific Blob Container in Azure Storage. This is only required when 'Enable File Export to Azure Blob Storage' is selected. Do not enter the connection string for the storage account here, but instead create a SAS token with limited validity on an existing container. The token must have the 'read', 'add', 'write', 'create', 'delete' and 'list' permissions for the container. The token will normally start with the URI to the blob container ("https://") | ||||||||||
| Azure Table Storage SAS Token | azTblConnS | 1179653 | string | i | minChars:0;maxChars:1024; spaces:False; lettersNumbersOnly:False; | The Shared Access Signature (SAS) URI used to connect to Azure Table Storage. This is only required when 'Enable Table Export to Azure Table Storage' is selected. Do not enter the connection string for the storage account here, but instead create a SAS token with limited validity. The token must have the 'read', 'write', 'list', 'add', 'create' and 'update' permissions for the Table Service. The token should also have access to 'service', 'container' and 'object' resources. The token will normally start with "SharedAccessSignature" and also contain the Table Endpoint URI | ||||||||||
| Azure Event Hub Connection String | azEvtHubConnS | 1179654 | string | i | minChars:0;maxChars:1024; spaces:False; lettersNumbersOnly:False; | The connection string to use to connect to an Azure Event Hub. This is only required when 'Enable Stream Export to Azure Event Hub' is selected . Generate a Shared Access Policy on the event hub in the Azure Portal and copy the string from there. The policy must have the 'send' permission. The string should start with 'Endpoint=sb:' and must contain the 'EntityPath' parameter | ||||||||||
| Enable Configuration Backup to PLC Shift Cloud | enCfgExpPlcShft | 1179679 | bool | i | False | min:False;max:True; | Backup device and application configurations to the PLC Shift cloud periodically. Backed up configurations can be downloaded from the PLC Shift Cloud and restored via PLC Shift Manager. | ✓ | ||||||||
| Enable File Export to PLC Shift Cloud | enFlExpPlcShft | 1179655 | bool | i | False | min:False;max:True; | Upload application log files to the PLC Shift Cloud service | ✓ | ||||||||
| Enable Table Export to PLC Shift Cloud | enTblExPlcShft | 1179656 | bool | i | False | min:False;max:True; | Export tabular data, like flow computer history or Data Logger data to the PLC Shift Cloud | ✓ | ||||||||
| Enable Stream Export to PLC Shift Cloud | enStrmExPlcShift | 1179657 | bool | i | False | min:False;max:True; | Export tag values to the PLC Shift Cloud | ✓ | ||||||||
| PLC Shift Cloud Queue Connection String | plcShiftQueConnS | 1179658 | string | i | minChars:0;maxChars:1024; spaces:False; lettersNumbersOnly:False; | Enter the queue connection string here if using PLC Shift Cloud services. | ||||||||||
| PLC Shift Cloud Blob Connection String | plcShiftBlbConnS | 1179680 | string | i | minChars:0;maxChars:1024; spaces:False; lettersNumbersOnly:False; | Enter the blob connection string here if using PLC Shift Cloud services. A blob connection string is only required if 'Enable Configuration Backup to PLC Shift Cloud' is selected. | ||||||||||
| Enable Table Export via MQTT | enTblExMqtt | 1179660 | bool | i | False | min:False;max:True; | Export tabular data, like flow computer history or Data Logger data via MQTT using the Sparkplug B payload definition | ✓ | ||||||||
| Enable Stream Export via MQTT | enStrmExMqtt | 1179661 | bool | i | False | min:False;max:True; | Export tag values via MQTT using the Sparkplug B payload definition | ✓ | ||||||||
| MQTT Broker 01 | mqttHost01 | 1179662 | string | i | minChars:0;maxChars:128; spaces:False; lettersNumbersOnly:True; | The host name or IP address of the primary MQTT broker. The system will connect to this MQTT broker first | ||||||||||
| MQTT Broker 01 Port | mqttHost01Prt | 1179663 | ui16 | i | 1883 | min:1;max:65535; | The port to connect to for Mqtt Broker 01 | ✓ | ||||||||
| Enable MQTT Broker 02 | enMqttHost02 | 1179664 | bool | i | False | min:False;max:True; | Allow connections to Mqtt Broker 02 when a connection cannot be made to MQTT Broker 01 | ✓ | ||||||||
| MQTT Broker 02 | mqttHost02 | 1179665 | string | i | minChars:0;maxChars:128; spaces:False; lettersNumbersOnly:True; | The host name or IP address of the secondary MQTT broker. The system will connect to this MQTT broker if a connection cannot be made to MQTT Broker 01 and 'Enable MQTT Broker 02' is enabled | ||||||||||
| MQTT Broker 02 Port | mqttHost02Prt | 1179666 | ui16 | i | 1883 | min:1;max:65535; | The port to connect to for Mqtt Broker 02 | ✓ | ||||||||
| Enable MQTT Authentication | enMqttAuth | 1179667 | bool | i | False | min:False;max:True; | Select this option if the MQTT broker requires authentication | ✓ | ||||||||
| MQTT User Name | mqttUserName | 1179668 | string | i | minChars:0;maxChars:64; spaces:False; lettersNumbersOnly:True; | The user name if MQTT authentication is enabled | ||||||||||
| MQTT Password | mqttPassword | 1179669 | string | i | minChars:0;maxChars:64; spaces:False; lettersNumbersOnly:True; | The password if MQTT authentication is enabled | ||||||||||
| MQTT Clean Disconnect | mqttCleanDisconnect | 1179670 | bool | i | False | min:False;max:True; | Whether disconnect cleanly from the MQTT broker. Depennding on the broker configuration, disconnting cleanly may supress publishing a last will and testament message | ✓ | ||||||||
| MQTT Group Name | mqttGroupName | 1179675 | string | i | plc-shift | minChars:4;maxChars:64; spaces:False; lettersNumbersOnly:True; | The 'Group ID' as defined in the Sparkplug B specification. This is high level partition key for SparkplugB. Devices that have the same group name will be grouped together in the host application. | |||||||||
| Primary Application Name | mqttPriApp | 1179676 | string | i | Ignition | minChars:4;maxChars:64; spaces:False; lettersNumbersOnly:True; | The name of the primary application as described in the Sparkplug B manual. The state of this application can optionally be subscribed to. When the primary application goes offline, PLC Shift will disconnect from the broker and reconnect to the next broker, if enabled, or reconnect to the primary broker. Multiple broker connections should be enabled to effectively use this feature. | |||||||||
| Subscribe to Primary Application State | mqttSubPriApp | 1179677 | bool | i | False | min:False;max:True; | Whether to subscribe to the state of the primary application. When the primary application goes offline, PLC Shift will disconnect from the broker and reconnect to the next broker, if enabled, or reconnect to the primary broker. Multiple broker connections should be enabled to effectively use this feature. | ✓ |
Group 'Control'
Contol the core application
This is a control group that has 2 parameters.
| Parameter | Tag Name | ID | Value Type | Tag Value Type | IO Type | Default Value | Limits | Default Units | Allowed Units | Description | Sync Enabled | Sync Default | Export Enabled | Publish MQTT Enabled | Subscribe MQTT Enabled | Show in Manager Enabled |
| Logging Level | logLevel | 8388608 | i32 | io | 0:Verbose | 0:Verbose; 1:Debug; 2:Info; 3:Warning; 4:Error; | The level of detail in device log files, including core logs, PLC driver logs and MQTT logs. Error logs errors only, Warning logs errors and warnings, and so on. Take care when using Debug and Verbose because the logs will be large and potentially filled with irrelvant information | ✓ | ||||||||
| Reset Counters | resetCounters | 8388609 | bool | io | False | min:False;max:True; | Clear the core application performance counters | ✓ |
Group 'Status'
The status of the core application on the device. The core application is responsible for managing application instances
This is a status group that has 33 parameters.
| Parameter | Tag Name | ID | Value Type | Tag Value Type | IO Type | Default Value | Limits | Default Units | Allowed Units | Description | Sync Enabled | Sync Default | Export Enabled | Publish MQTT Enabled | Subscribe MQTT Enabled | Show in Manager Enabled |
| Config Version Major | cfgVerMaj | 5242915 | i32 | o | The major part of the configuration version of the core application. | ✓ | ||||||||||
| Config Version Minor | cfgVerMin | 5242916 | i32 | o | The minor part of the configuration version of the core application. | ✓ | ||||||||||
| Execution Count Today | execCountDy | 5242881 | i32 | o | The number of times that the core application's run loop has been executed today. This is reset every day at midnight based on the remote device's local time setting | ✓ | ||||||||||
| Callback Time Minimum | callBackTimeMin | 5242882 | double | o | 641:milliseconds; | 641:milliseconds; | The minimum time between consecutive executions of the core application in the current hour. This value is reset at the end of every hour | ✓ | ||||||||
| Callback Time Maximum | callBackTimeMax | 5242883 | double | o | 641:milliseconds; | 641:milliseconds; | The maximum time between consecutive executions of the core application in the current hour. This value is reset at the end of every hour | ✓ | ||||||||
| Callback Time Average (Minute) | callBackTimeAvgMn | 5242884 | double | o | 641:milliseconds; | 641:milliseconds; | The average time between consecutive executions of the core application over the last minute. This is a rolling average over the last minute | ✓ | ||||||||
| Callback Time Average (Hour) | callBackTimeAvgHr | 5242885 | double | o | 641:milliseconds; | 641:milliseconds; | The average time between consecutive executions of the core application over the last hour. This is a rolling average over the last hour and is generated from minute averages | ✓ | ||||||||
| Total Execution Time Minimum | ttlExecTimeMin | 5242886 | double | o | 641:milliseconds; | 641:milliseconds; | The minimum amount of time to execute the entire core application in the current hour. This value is reset at the end of every hour | ✓ | ||||||||
| Total Execution Time Maximum | ttlExecTimeMax | 5242887 | double | o | 641:milliseconds; | 641:milliseconds; | The maximum amount of time to execute the entire core application in the current hour. This value is reset at the end of every hour | ✓ | ||||||||
| Total Execution Time Average (Minute) | ttlExecTimeAvgMn | 5242888 | double | o | 641:milliseconds; | 641:milliseconds; | The average time to execute the entire core application over the last minute. This is a rolling average over the last minute | ✓ | ||||||||
| Total Execution Time Average (Hour) | ttlExecTimeAvgHr | 5242889 | double | o | 641:milliseconds; | 641:milliseconds; | The average time to execute the entire core application over the last hour. This is a rolling average over the last hour and is generated from minute averages | ✓ | ||||||||
| Read Time Minimum | readTimeMin | 5242890 | double | o | 641:milliseconds; | 641:milliseconds; | The minimum amount of time to read data from the local database (not the controller database) in the current hour. This value is reset at the end of every hour | ✓ | ||||||||
| Read Time Maximum | readTimeMax | 5242891 | double | o | 641:milliseconds; | 641:milliseconds; | The maximum amount of time to read data from the local database (not the controller database) in in the current hour. This value is reset at the end of every hour | ✓ | ||||||||
| Read Time Average (Minute) | readTimeAvgMn | 5242892 | double | o | 641:milliseconds; | 641:milliseconds; | The average time to read data from the local database (not the controller database) over the last minute. This is a rolling average over the last minute | ✓ | ||||||||
| ReadTime Average (Hour) | readTimeAvgHr | 5242893 | double | o | 641:milliseconds; | 641:milliseconds; | The average time to read data from the local database (not the controller database) over the last hour. This is a rolling average over the last hour and is generated from minute averages | ✓ | ||||||||
| Write Time Minimum | writeTimeMin | 5242894 | double | o | 641:milliseconds; | 641:milliseconds; | The minimum amount of time to write data to the local database (not the controller database) in the current hour. This value is reset at the end of every hour | ✓ | ||||||||
| Write Time Maximum | writeTimeMax | 5242895 | double | o | 641:milliseconds; | 641:milliseconds; | The maximum amount of time to write data to the local database (not the controller database) in in the current hour. This value is reset at the end of every hour | ✓ | ||||||||
| Write Time Average (Minute) | writeTimeAvgMn | 5242896 | double | o | 641:milliseconds; | 641:milliseconds; | The average time to write data to the local database (not the controller database) over the last minute. This is a rolling average over the last minute | ✓ | ||||||||
| Write Time Average (Hour) | writeTimeAvgHr | 5242897 | double | o | 641:milliseconds; | 641:milliseconds; | The average time to write data to the local database (not the controller database) over the last hour. This is a rolling average over the last hour and is generated from minute averages | ✓ | ||||||||
| Apps Execution Time Minimum | appExecTimeMin | 5242898 | double | o | 641:milliseconds; | 641:milliseconds; | The minimum amount of time to execute all applications in the current hour. This value is reset at the end of every hour | ✓ | ||||||||
| Apps Execution Time Maximum | appExecTimeMax | 5242899 | double | o | 641:milliseconds; | 641:milliseconds; | The maximum amount of time to execute all applications in the current hour. This value is reset at the end of every hour | ✓ | ||||||||
| Apps Execution Time Average (Minute) | appExecTimeAvgMn | 5242900 | double | o | 641:milliseconds; | 641:milliseconds; | The average time to execute all applications over the last minute. This is a rolling average over the last minute | ✓ | ||||||||
| Apps Execution Time Average (Hour) | appExecTimeAvgHr | 5242901 | double | o | 641:milliseconds; | 641:milliseconds; | The average time to execute all applications over the last hour. This is a rolling average over the last hour and is generated from minute averages | ✓ | ||||||||
| Controller DB Update Time Minimum | cntrlDbTimeMin | 5242906 | double | o | 641:milliseconds; | 641:milliseconds; | The minimum time to complete one communications update cycle with the controller's tag database. This value is reset at the end of the every hour | ✓ | ||||||||
| Controller DB Update Time Maximum | cntrlDbTimeMax | 5242907 | double | o | 641:milliseconds; | 641:milliseconds; | The maximum time to complete one communications update cycle with the controller's tag database. This value is reset at the end of the every hour | ✓ | ||||||||
| Controller DB Update Time Average (Minute) | cntrlDbTimeAvgMn | 5242908 | double | o | 641:milliseconds; | 641:milliseconds; | The average time to complete one communications update cycle with the controller's tag database over the last minute. This is a rolling average over the last minute | ✓ | ||||||||
| Controller DB Update Time Average (Hour) | cntrlDbTimeAvgHr | 5242909 | double | o | 641:milliseconds; | 641:milliseconds; | The average time to complete one communications update cycle with the controller's tag database over the last hour. This is a rolling average over the last hour and is generated from minute averages | ✓ | ||||||||
| MQTT Cycle Time Minimum | mqttTimeMin | 5242911 | double | o | 641:milliseconds; | 641:milliseconds; | The minimum time to for the MQTT task to complete one cycle. This value is reset at the end of the every hour | ✓ | ||||||||
| MQTT Cycle Time Maximum | mqttTimeMax | 5242912 | double | o | 641:milliseconds; | 641:milliseconds; | The maximum time for the MQTT task to complete one cycle. This value is reset at the end of the every hour | ✓ | ||||||||
| MQTT Cycle Time Average (Minute) | mqttTimeAvgMn | 5242913 | double | o | 641:milliseconds; | 641:milliseconds; | The average time for the MQTT task to complete once cycle over the last minute. This is a rolling average over the last minute | ✓ | ||||||||
| MQTT Cycle Time Average (Hour) | mqttTimeAvgHr | 5242914 | double | o | 641:milliseconds; | 641:milliseconds; | The average time for the MQTT task to complete one cycle over the last hour. This is a rolling average over the last hour and is generated from minute averages | ✓ |