Hex Repeater Commands
Overview
The command tab allows certain commands to be executed within ACM. This alleviates the need to use an OPC Client for commonly used commands.
The list of commands for the Hex Repeater protocol is directly dependent on the template used; however, there are some common commands that appear in the majority of the templates. Note that since commands can vary within different template objects, the ‘Send Multiple Commands’ option works slightly differently with Hex Repeater devices. Instead of selecting the Hex Repeater protocol to see a list of available commands, a list of templates currently in use is provided in the selection list. This allows ACM to present a known set of commands from that template. Any commands defined by the template can be executed against any or all of the devices that use the template. This also means that if more than one template is in use by the Hex Repeater devices in the ACM configuration, it will take more than one ‘Send Multiple Commands’ sequence to send a command to every device.
Common Commands
See Device Object Common Commands for commands that are common to all device types.
Commands
| Command | Description | Parameters |
|---|---|---|
Test Communication | When executed, ACM will poll the device with a request for its current time and wait for the response to see if the communication is good. This command is not dependent on the selected template – it is available for all Hex Repeater devices. | None |
| Time Sync | Causes a comparison of the date and time in the device to the host date and time. Once compared, the configured rules of the selected time sync object will be applied - including time zone and daylight saving options. Note that if the Time Sync type is set to ‘Always’ instead of ‘Range’, then no comparison is made between the current RTU time and the system time. The system time, with time zone and/or daylight saving options, will be applied to the RTU. This command is not dependent on the selected template – it is available for all Hex Repeater devices. | None |
Template Dependent Commands
| Command | Description | Parameters |
|---|---|---|
Action - LostAllData | Executes the "Lost Database Flag" action sequence, which typically writes any stored configuration data back to the device to restore its configuration. | None |
| Action - PowerFail | Executes the “Power Fail Flag” action sequence. | None |
| Change Log Pointer - AuditLog_1 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Change Log Pointer - AuditLog_2 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Change Log Pointer - AuditLog_3 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Change Log Pointer - AuditLog_4 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Change Log Pointer - ChangeLog_1 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Change Log Pointer - ChangeLog_2 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Change Log Pointer - ChangeLog_3 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Change Log Pointer - ChangeLog_4 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Change Log Pointer - DailyProductionLog_1 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Change Log Pointer - EventLog_1 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Change Log Pointer - EventLog_2 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Change Log Pointer - EventLog_3 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Change Log Pointer - EventLog_4 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Change Log Pointer - ProductionCycleLog_1 | Sets the log pointer to a specific timestamp. Provide the timestamp value to use when issuing the reset command in parameter one. | Timestamp |
| Log Upload - AuditLog_1 | Retrieves available and uncollected log records. | None |
| Log Upload - AuditLog_2 | Retrieves available and uncollected log records. | None |
| Log Upload - AuditLog_3 | Retrieves available and uncollected log records. | None |
| Log Upload - AuditLog_4 | Retrieves available and uncollected log records. | None |
| Log Upload - ChangeLog_1 | Retrieves available and uncollected log records. | None |
| Log Upload - ChangeLog_2 | Retrieves available and uncollected log records. | None |
| Log Upload - ChangeLog_3 | Retrieves available and uncollected log records. | None |
| Log Upload - ChangeLog_4 | Retrieves available and uncollected log records. | None |
| Log Upload - DailyProductionLog_1 | Retrieves available and uncollected log records. | None |
| Log Upload - EventLog_1 | Retrieves available and uncollected log records. | None |
| Log Upload - EventLog_2 | Retrieves available and uncollected log records. | None |
| Log Upload - EventLog_3 | Retrieves available and uncollected log records. | None |
| Log Upload - EventLog_4 | Retrieves available and uncollected log records. | None |
| Log Upload - ProductionCycleLog_1 | Retrieves available and uncollected log records. | None |
| Upload - ActionParameters_Read | Uploads configuration data. Enter the Instance Id to use when executing the command in parameter one: 1, 2, 3, 4, 5, 6, 7, 8. Instance numbers may differ based on the selected template. | Instance Id |
| Upload - AnalogCalibration_Read | Uploads configuration data. Enter the Instance Id to use when executing the command in parameter one: 1, 2, 3, 4, 5, 6, 7, 8. Instance numbers may differ based on the selected template. | Instance Id |
| Upload - EGMAnalogIndexes_Read | Uploads configuration data. Enter the Instance Id to use when executing the command in parameter one: 1, 2, 3, 4, 5, 6, 7, 8. Instance numbers may differ based on the selected template. | Instance Id |
| Upload - EGMBaseParameters_Read | Uploads configuration data. Enter the Instance Id to use when executing the command in parameter one: 1, 2, 3, 4, 5, 6, 7, 8. Instance numbers may differ based on the selected template. | Instance Id |
| Upload - EGMComponentParameters_Read | Uploads configuration data. Enter the Instance Id to use when executing the command in parameter one: 1, 2, 3, 4, 5, 6, 7, 8. Instance numbers may differ based on the selected template. | Instance Id |
| Upload - EGMConversionFactors_Read | Uploads configuration data. Enter the Instance Id to use when executing the command in parameter one: 1, 2, 3, 4, 5, 6, 7, 8. Instance numbers may differ based on the selected template. | Instance Id |
| Upload - EGMCprimeFlowFactors_Read | Uploads configuration data. Enter the Instance Id to use when executing the command in parameter one: 1, 2, 3, 4, 5, 6, 7, 8. Instance numbers may differ based on the selected template. | Instance Id |
| Upload - EGMMeterInfo_Read | Uploads configuration data. Enter the Instance Id to use when executing the command in parameter one: 1, 2, 3, 4, 5, 6, 7, 8. Instance numbers may differ based on the selected template. | Instance Id |
| Upload - EGMTimeOfLastChange_Read | Uploads configuration data. Enter the Instance Id to use when executing the command in parameter one: 1, 2, 3, 4, 5, 6, 7, 8. Instance numbers may differ based on the selected template. | Instance Id |
| Upload - MVTConfiguration_Read | Uploads configuration data. Enter the Instance Id to use when executing the command in parameter one: 1, 2, 3, 4, 5, 6, 7, 8. Instance numbers may differ based on the selected template. | Instance Id |
| Upload - TankLevelShutdownParameters_Read | Uploads configuration data. Enter the Instance Id to use when executing the command in parameter one: 1, 2, 3, 4, 5, 6, 7, 8. Instance numbers may differ based on the selected template. | Instance Id |
| Upload - WSCMiscellaneousParameters_Read | Uploads configuration data. Enter the Instance Id to use when executing the command in parameter one: 1, 2, 3, 4, 5, 6, 7, 8. Instance numbers may differ based on the selected template. | Instance Id |
| Upload - WSCParameters_Read | Uploads configuration data. Enter the Instance Id to use when executing the command in parameter one: 1, 2, 3, 4, 5, 6, 7, 8. Instance numbers may differ based on the selected template. | Instance Id |
For assistance, please submit a ticket via our Support Portal, email autosol.support@autosoln.com or call 281.286.6017 to speak to a support team member.