Common Parameters Version 1.24
-
Gas Flow version 1.6
Group 'Overall Settings'
Configure overall settings for this application. These settings do not affect the way that the program operates
This is a group that has 8 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 |
| User Configured Name | userConfiguredName | 65537 | string | i | name | minChars:4;maxChars:4; spaces:True; lettersNumbersOnly:False; | Enter an name that identifies this application. The name must be unique acrosss all applications in this device. Take care when changing the name. Matching local applications to applications on the remote device is done via the application name | |||||||||
| User Configured Description | userConfiguredDesc | 65538 | string | i | minChars:0;maxChars:0; spaces:True; lettersNumbersOnly:False; | Enter an optional description for this application | ||||||||||
| Metadata | appMetadata | 65543 | string | i | minChars:0;maxChars:0; 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;" | ||||||||||
| Application Tag Name Prefix | appTagNamePrefix | 65539 | string | i | x_ | minChars:2;maxChars:2; spaces:False; lettersNumbersOnly:True; | Enter an optional prefix for all tags in this this application. This setting makes it clear which tag belongs to which applicaiton when multiple instances of the same application exist | |||||||||
| PLC Tag Name | plcTagName | 65540 | string | i | plcTagName | minChars:3;maxChars:3; spaces:False; lettersNumbersOnly:True; | The Tag Name for the application UDT or DUT. This value is only used when value of the 'Tag DB Protocol' setting is 'EIP' or 'OPC UA' and can be ignored otherwise. This value must be unique | |||||||||
| Disable Tag DB | disableTagDb | 65541 | bool | i | False | min:False; max:True; | Disable communications with the logic controller's tag database. This is useful when setting up the system and tags are not yet available or properly configured in the logic controller. This should not be selected once the app is finally deployed because it will prevent the application from sharing data with the logic controller | ✓ | ||||||||
| License Key | licenseKey | 65542 | string | i | minChars:0;maxChars:0; spaces:False; lettersNumbersOnly:False; | The license key for this application. Each application has a unique license key. When online, use the 'Generate Licence Key Request' feature to request a license key. | ||||||||||
| OPC UA Global Variable List Name | opcUaGvl | 65544 | string | i | GVL | minChars:2;maxChars:2; spaces:False; lettersNumbersOnly:False; | The name of the global variable list that the PLC Tag belongs to. This value is combined with the 'OPC UA Node ID' at the device level and the 'PLC Tag Name' to generate a unique node ID that can be used to communicate with the controller when using OPC UA. |
Group 'Modbus TCP Settings'
Configure Modbus register settings for this application. The settings only need to be configured if the selected 'Database Protocol' at the device level is 'Modbus TCP'
This is a group that has 10 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 Read Base Address Coil | cfgRdBaseAddrCoil | 196609 | i32 | i | 1 | min:0 ;max: 65536; | The coil registers base address for the read value for published configuration parameters. Modbus addresses for the read value for boolean configuration parameters will be assigned sequentially starting at this addresss. Addresses will only be assigned for published parameters | ✓ | ||||||||
| Config Read Base Address Holding | cfgRdBaseAddrHlding | 196610 | i32 | i | 40001 | min:40000 ;max: 465536; | The holding registers base address for the read value for published configuration parameters. Modbus addresses for the read value for non-boolean configuration parameters will be assigned sequentially starting at this addresss. Addresses will only be assigned for published parameters | ✓ | ||||||||
| Config Write Base Address Coil | cfgWrBaseAddrCoil | 196611 | i32 | i | 501 | min:0 ;max: 65536; | The coil registers base address for the write value for published configuration parameters. Modbus addresses for the write value for boolean configuration parameters will be assigned sequentially starting at this addresss. Addresses will only be assigned for published parameters | ✓ | ||||||||
| Config Write Base Address Holding | cfgWrBaseAddrHlding | 196612 | i32 | i | 40501 | min:40000 ;max: 465536; | The holding registers base address for the write value for published configuration parameters. Modbus addresses for the read value for non-boolean configuration parameters will be assigned sequentially starting at this addresss. Addresses will only be assigned for published parameters | ✓ | ||||||||
| Control Base Address Coil | cntrlBaseAddrCoil | 196613 | i32 | i | 1001 | min:0 ;max: 65536; | The coil registers base address for published control parameters. Modbus addresses for boolean control parameters will be assigned sequentially starting at this addresss. Addresses will only be assigned for published parameters | ✓ | ||||||||
| Control Base Address Holding | cntrlBaseAddrHlding | 196614 | i32 | i | 41001 | min:40000 ;max: 465536; | The holding registers base address for published control parameters. Modbus addresses for non-boolean control parameters will be assigned sequentially starting at this addresss. Addresses will only be assigned for published parameters | ✓ | ||||||||
| Status Base Address Coil | statBaseAddrCoil | 196615 | i32 | i | 1501 | min:0 ;max: 65536; | The coil registers base address for published status parameters. Modbus addresses for boolean status parameters will be assigned sequentially starting at this addresss. Addresses will only be assigned for published parameters | ✓ | ||||||||
| Status Base Address Holding | statBaseAddrHlding | 196616 | i32 | i | 41501 | min:40000 ;max: 465536; | The holding registers base address for published status parameters. Modbus addresses for non-boolean status parameters will be assigned sequentially starting at this addresss. Addresses will only be assigned for published parameters | ✓ | ||||||||
| User Defined Base Address Coil | udBaseAddrCoil | 196617 | i32 | i | 2001 | min:1 ;max: 65536; | The coil registers base address for published user defined parameters. Modbus addresses for boolean status parameters will be assigned sequentially starting at this addresss. Addresses will only be assigned for published parameters | ✓ | ||||||||
| User Defined Base Address Holding | udBaseAddrHlding | 196618 | i32 | i | 42001 | min:40000 ;max: 465536; | The holding registers base address for published user defined parameters. Modbus addresses for non-boolean user defined parameters will be assigned sequentially starting at this addresss. Addresses will only be assigned for published parameters | ✓ |
Group 'Export Settings'
Configure data export for this application. Export locations are configured at the device level
This is a configuration group that has 27 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 |
| App Export Name | appExportName | 131090 | string | i | minChars:0;maxChars:0; spaces:False; lettersNumbersOnly:False; | Enter a string value to uniquely identify exported data from this application. This is only required if export is enabled. If this is left empty the User Configured Name will be used instead | ||||||||||
| Export Diagnostic Log | exportDiagLog | 131072 | bool | i | False | min:False; max:True; | Whether to export this application's diagnostic log | ✓ | ||||||||
| Export Configuration Log | exportConfigLog | 131073 | bool | i | False | min:False; max:True; | Whether to export this application's configuration change log | ✓ | ||||||||
| Export Partial Logs | exPartialLog | 131074 | 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. | ✓ | ||||||||
| Export Interval 1 | exIntrvl01 | 131075 | i32 | i | 3600 | min:1 ;max: 10000; | 640:sec; | 640: sec; 642: min; | The export interval for parameters that have the 'Export On Interval 1' option selected. | ✓ | ||||||
| Export Interval 2 | exIntrvl02 | 131077 | i32 | i | 600 | min:1 ;max: 10000; | 640:sec; | 640: sec; 642: min; | The export interval for parameters that have the 'Export On Interval 2' option selected. | ✓ | ||||||
| Publish MQTT Interval 1 | mqIntrvl01 | 131076 | i32 | i | 3600 | min:1 ;max: 10000; | 640:sec; | 640: sec; 642: min; | The publishing interval for parameters that have the 'Publish MQTT Interval 1' option selected. | ✓ | ||||||
| Publish MQTT Interval 2 | mqIntrvl02 | 131078 | i32 | i | 600 | min:1 ;max: 10000; | 640:sec; | 640: sec; 642: min; | The export interval for parameters that have the 'Publish MQTT Interval 2' option selected. | ✓ | ||||||
| Export Deadband 1 | exDeadband01 | 131079 | double | i | 1 | min:0.1 ;max: 1000; | 1:%; | 1: %; | The percentage that a value must change by before it is exported. Applies to parameters that have the 'Export on Change' and 'Deadband 1' options selected. | ✓ | ||||||
| Export Deadband 2 | exDeadband02 | 131080 | double | i | 1 | min:0.1 ;max: 1000; | 1:%; | 1: %; | The percentage that a value must change by before it is exported. Applies to parameters that have the 'Export on Change' and 'Deadband 2' options selected. | ✓ | ||||||
| Publish MQTT Deadband 1 | mqDeadband01 | 131081 | double | i | 1 | min:0.1 ;max: 1000; | 1:%; | 1: %; | The percentage that a value must change by before it is published via MQTT. Applies to parameters that have the 'Publish MQTT on Change' and 'Deadband 1' options selected. | ✓ | ||||||
| Publish MQTT Deadband 2 | mqDeadband02 | 131082 | double | i | 1 | min:0.1 ;max: 1000; | 1:%; | 1: %; | The percentage that a value must change by before it is published via MQTT. Applies to parameters that have the 'Publish MQTT on Change' and 'Deadband 2' options selected. | ✓ | ||||||
| Export Flow Minute History | exportFlMinuteHis | 131088 | bool | i | False | min:False; max:True; | Whether to export the minute flow history to table storage | ✓ | ||||||||
| Export Flow Hourly History | exportFlHourHis | 131086 | bool | i | False | min:False; max:True; | Whether to export the hourly flow history to table storage | ✓ | ||||||||
| Export Flow Daily History | exportFlDayHis | 131085 | bool | i | False | min:False; max:True; | Whether to export the daily flow history to table storage | ✓ | ||||||||
| Export Flow Batch History | exportFlBatchHis | 131087 | bool | i | False | min:False; max:True; | Whether to export the batch flow history to table storage | ✓ | ||||||||
| Export Flow Config History | exportFlConfigHis | 131089 | bool | i | False | min:False; max:True; | Whether to export the configuration history to table storage | ✓ | ||||||||
| Export Flow Events | exportFlEvents | 131083 | bool | i | False | min:False; max:True; | Whether to export the flow computer's event log to table storage | ✓ | ||||||||
| Export Flow Alarms | exportFlAlarms | 131084 | bool | i | False | min:False; max:True; | Whether to export the flow computer's alarm log to table storage | ✓ | ||||||||
| Export Logged Data | exportLoggedData | 131091 | bool | i | False | min:False; max:True; | Whether to export logged data to table storage. This setting applies to all enabled data logs | ✓ | ||||||||
| Generate CFX File | enGenCfx | 131092 | bool | i | False | min:False; max:True; | Whether to generate Flowcal (CFX) files for this app. When enabled, CFX files will be generated automatically when a new daily record is generated. Files will be stored on the remote device in the /var/cfx/ | ✓ | ||||||||
| Export CFX File | enExportCfx | 131093 | bool | i | False | min:False; max:True; | Automatically export generated CFX files to file export locations that are enabled and configured at the device level. | ✓ | ||||||||
| CFX Use Local Time | cfxLocalTime | 131094 | bool | i | False | min:False; max:True; | When selected, timestamps will be written to CFX files in the local time zone of the remote device. When not selected, timestamps will be written to the CFX files in UTC. The CFX file format is not time zone aware, and makes no allowance for daylight savings time, so selecting this option may result in duplicate records when the clock changes. UTC is recommended as it is stable throughout the year. | ✓ | ||||||||
| CFX Meter Number | cfxMeterNumber | 131095 | string | i | minChars:0;maxChars:0; spaces:True; lettersNumbersOnly:False; | The value of this parameter is copied into the 'Meter Number' field in the exported file. CFX files will also be stored on the remote device in a directory with this name. If this field is empty, the 'App Export Name' will be used, and if the 'App Export Name' is empty, the 'User Configured Name' (app name) will be used. | ||||||||||
| CFX Liquid Product Code | cfxLiqProductCode | 131096 | string | i | minChars:0;maxChars:0; spaces:True; lettersNumbersOnly:False; | The value of this parameter is copied into the 'Product Code' field that is used in the 'Liquid Product' table in the exported file. This parameter is not used for gas runs. | ||||||||||
| CFX Host ID | cfxHostId | 131097 | string | i | cfxHostId | minChars:2;maxChars:2; spaces:False; lettersNumbersOnly:True; | The value here will be copied into the 'Host ID' field in generated CFX files. Only ASCII characters are allowed. | |||||||||
| CFX Host Tag | cfxHostTag | 131098 | string | i | cfxHostTag | minChars:2;maxChars:2; spaces:False; lettersNumbersOnly:True; | The value here will be copied into the 'Host Tag' field in generated CFX files. Only ASCII characters are allowed. |
Group 'App Control'
General control settings for the 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 | 12582912 | i32 | io | 4:Error | 0:Verbose; 1:Debug; 2:Info; 3:Warning; 4:Error; | The level of detail in the application's diagnostic log. 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 App Counters | rstAppCntrs | 12582913 | bool | io | False | min:False; max:True; | Clear the application performance counters including execution time and callback time counters | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
Group 'Application Info'
Overall status and information about the application
This is a status group that has 14 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 |
| Execution Count | execCount | 8323072 | ui32 | o | The number of times that the application's main run loop has been executed | ✓ | ✓ | ✓ | ✓ | ✓ | ||||||
| Execution Maximum Time | execTimeMax | 8323073 | float | o | 641:millisec; | 641: millisec; | The maximum time to execute the application's main loop for the last hour. This value is reset at the start of every hour | ✓ | ✓ | ✓ | ✓ | ✓ | ||||
| Execution Minimum Time | execTimeMin | 8323074 | float | o | 641:millisec; | 641: millisec; | The minimum time to execute the application's main loop for the last hour. This value is reset at the start of every hour | ✓ | ✓ | ✓ | ✓ | ✓ | ||||
| Execution Average Time | execTimeAvg | 8323075 | float | o | 641:millisec; | 641: millisec; | The average time to execute the application's main loop for the last hour. This is a rolling average for the last hour based on minute averages | ✓ | ✓ | ✓ | ✓ | ✓ | ||||
| Config Version Major | configVersionMajor | 8323080 | i16 | o | The major part of the configuration version of the application | ✓ | ✓ | ✓ | ✓ | ✓ | ||||||
| Config Version Minor | configVersionMinor | 8323081 | i16 | o | The minor part of the configuration version of the application | ✓ | ✓ | ✓ | ✓ | ✓ | ||||||
| App Version Major | appVersionMajor | 8323082 | i16 | o | The major part of the application's version | ✓ | ✓ | ✓ | ✓ | ✓ | ||||||
| App Version Minor | appVersionMinor | 8323083 | i16 | o | The minor part of the application's version | ✓ | ✓ | ✓ | ✓ | ✓ | ||||||
| Hardware ID | hardwareId | 8323084 | string | o | A unique identifier for the hardware that is automatically generated by the PLC Shift run time | ✓ | ||||||||||
| License State | licenseState | 8323085 | i32 | o | 0:Demo | 0:Demo; 1:Trial; 2:Permanent; 3:Unlicensed; | The license status of the application. 'Demo' means that no license file is installed, but the application will run with all features enabled for 7 days. 'Trial' means that a license with an expiration time is installed. 'Permanent' means that a permanent license is installed and the license will not expire. 'Unlicensed' means that a license is not installed, could not be decoded, or that a demo or trial license has expired. The application will not execute in 'Unlicensed' state. View the application's diagnostic log for more details on the license state. | ✓ | ✓ | ✓ | ✓ | ✓ | ||||
| License Expiry Time (UTC) | licenseExpireTs | 8323086 | ui32 | o | 4:Unix Timestamp; | 4: Unix Timestamp; | The time when the demo or trial license will expire or actually expired. For permanent licenses this will be approximately 1 year in the future, but will keep being pushed out, so expiry will never actually happen. | ✓ | ✓ | ✓ | ✓ | ✓ | ||||
| License Time Left | licenseTimeLeft | 8323087 | double | o | 642:min; | 642: min; 643: hr; 644: day; | The amount of time left before the demo or trial license expires. For permanent license this will be approximately 1 year in the future, but will keep being pushed out, so expiry will never actually happen. | ✓ | ✓ | ✓ | ✓ | ✓ | ||||
| License Features | licenseFeatures | 8323088 | string | o | The features which are available in the installed license. Individual features are separated using a colon. | ✓ | ||||||||||
| MQTT Alias Prefix | mqttAliasPrefix | 8323089 | i32 | o | When using Sparkplug B payloads, every metric (aka tag) has a 64 bit alias that must be unique across the Sparkplug Node, which is a PLC Shift Device. Every parameter in a PLC Shift app has an ID that is unique for the app. If multiple apps of the same type exist on the same device, the parameter ID cannot be used an alias because duplicates will occur. The solution is to prefix each parameter ID with a value that is unique to each app. To calculate a parameter's 64 bit alias, put this value in the most significant 32 bits of a 64 bit integer. Put the parameter ID in the least significant 32 bits. Use the resulting 64 bit value as the alias. | ✓ | ✓ | ✓ | ✓ |