Modbus OMNI Commands

Common Commands

See Device Object Common Commands for commands that are common to all device types.

Commands

CommandDescriptionParameters

Test Communication

When executed, ACM will poll a known OPC item from the device and wait for the response to see if the communication is good.None
Retrieve HistoryRequests the retrieval of history records (for all enabled meters).None
Retrieve meter config during next history pollRetrieves meter configuration data during the next history retrievalNone
Reset ArchiveClears the archive retrieval position so retrieval starts at the oldest record.  Provide the meter number in parameter one, or leave blank for all meters.Archive Number
Move ArchiveMoves the saved archive retrieval position to an older record.  Provide the meter number in parameter one, or leave blank for all meters.  Enter the number of records to move back.

Archive Number

Record Count

Skip ArchiveMoves the saved daily retrieval position forward.  Provide the record count in parameter one, or leave blank for all meters.  Enter the number of records to skip.

Archive Number

Reset Archive

Time SyncCauses 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.None
Request Batch ReportRequest one of the available batch text reports.  Enter the report number (1 = most recent; 8 = oldest) or leave blank for the most recent report.Report Number
Request Prove ReportRequest one of the available prove reports.  Enter the report number (1 = most recent; 8 = oldest) or leave blank for the most recent report.Report Number
Request Daily ReportRequest one of the available daily text reports.  Enter the report number (1 = most recent; 8 = oldest) or leave blank for the most recent report.Report Number
Request Snapshot ReportRequest the snapshot report.None
Request Miscellaneous ReportRequest the miscellaneous report.None
Request Template ReportRequest one of the available template reports.  Enter the value for the desired template (1=Snapshot; 2=Batch; 3=Daily; 4=Prove).Report Number
Request Ethernet Configuration ReportRequest one of the available Ethernet configuration reports.  Enter the value for the desired report (1 - 3).Report Number
Read Custom Packet ConfigurationRe-read the custom packet configuration from the OMNI.None
Read Archive ConfigurationRe-read the archive configuration from the OMNI. Use this command to make ACM read the configuration of one or more OMNI archives. Note that this command is sent automatically if ACM detects that the data size of an archive record does not match the size reported in a previous archive configuration read.None
Reset ReportReset the positions for auto-report collection.None
Read Product Information

Re-read the product names and data from the OMNI.

None
Document Periodic Register

Write the internal register map used for periodic records to the server machine file "C:\ProgramData\AutoSol\CommunicationManager\7\asiMODBUS_OMNI_PERIODIC_REGISTER_DOC.txt"

None
Document Batch Register

Write the internal register map used for batch records to the server machine file "C:\ProgramData\AutoSol\CommunicationManager\7\asiMODBUS_OMNI_BATCH_REGISTER_DOC.txt"

None
Document Prove Register

Write the internal register map used for prove records to the server machine file "C:\ProgramData\AutoSol\CommunicationManager\7\asiMODBUS_OMNI_PROVE_REGISTER_DOC.txt"

None

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.