Technical information

RMS NetLinx Virtual Device API
152
RMS Enterprise - NetLinx Programmer’s Guide
RMS Asset Control Methods - Command API
RMS Asset Control Methods Event Notification Commands
RMS Asset Control Methods Query Commands
RMS Asset Control Method Registration Commands
RMS Asset Control Methods Event Notification Commands
String Description
ASSET.METHOD.EXECUTE-
<asset-client-key>,
<method-key>,
[,<method-argument-value>]*
This event notification command is issued by the RMS when an instruction is received from the
RMS server to execute a control method.
RMS Asset Control Methods Query Commands
Command Description / Response Commands
?ASSET.METHOD-
<asset-client-key>
This command is used to query for all asset control method records for a specific asset from the RMS
server.
• <asset-client-key>: The asset client key of the asset you wish to query must be included. This asset client
key is typically the D:P:S string in NetLinx systems.
An ASSET.METHOD.RECORD.COUNT command string followed by a series of
ASSET.METHOD.RECORD commands will be returned in response to this query.
First a total count is returned.
ASSET.METHOD.RECORD.COUNT-<record-count>
If the record count is greater than zero, then a series of the following command responses will be sent:
ASSET.METHOD.RECORD-<asset-client-key>,
<record-index>,
<record-count>,
<method-key>,
<method-name>,
<method-description>
?ASSET.METHOD-
<asset-client-key,
<method-key>
This command is used to query for a specific asset control method from the RMS server.
• <asset-client-key>: The asset client key of the asset you wish to query must be included. This asset client
key is typically the D:P:S string in NetLinx systems.
• <method-key>: This field is the asset control method key string used to uniquely identify the control
method scoped to this asset.
ASSET.METHOD-<asset-client-key>,
<method-key>,
<method-name>,
<method-description>
RMS Asset Control Method Registration Commands
Command Description
ASSET.METHOD-<asset-client-key>,
<method-key>,<method-name>,
(,<method-description>)
This command is used to en-queue an asset control method for a specific asset in
RMS. If the asset control method does not exist on the RMS server, a new record is
created, if the control method already exists, then no changes are applied.
• <asset-client-key>: The asset client key of the asset you wish to create the asset
control method. This asset client key is typically the D:P:S string in NetLinx
systems.
• <method-key>: This field is the asset control method key string used to uniquely
identify the control method scoped to this asset.
• <method-name>: This field is the asset control method displayed name.
• <method-description>: This property is OPTIONAL and allows the program to
provide an asset control method textual description.