Technical information

RMS NetLinx Virtual Device API
154
RMS Enterprise - NetLinx Programmer’s Guide
RMS Asset Control Method Registration Commands (Cont.)
Command Description
ASSET.METHOD.ARGUMENT.LEVEL-
<asset-client-key>,<method-key>,
<argument-ordinal>,<argument-name>,
(,<argument-description>)
(,<argument-default-value>)
(,<argument-minimum-value>)
(,<argument-maximum-value>)
(,<argument-step-value>)
This command will add an asset control method argument of type "LEVEL" to a
control method currently staged in the control method registration queue.
ASSET.METHOD.ARGUMENT.ENUM-
<asset-client-key>,<method-key>,
<argument-ordinal>,<argument-name>,
(,<argument-description>)
(,<argument-default-value>)
(,<argument-enumeration-value>)
This command will add an asset control method argument of type "ENUM" to a
control method currently staged in the control method registration queue.
• <argument-enumeration-value>: This optional argument defines a set of
enumeration values.
This is a pipe "|" delimited string where each enumeration value is separated by
pipe "|" characters.
ASSET.METHOD.UPDATE-
<asset-client-key>,<method-key>,
<method-name>,(,<method-description>)
This command can update an asset's control method name and description
properties on the RMS server.
ASSET.METHOD.SUBMIT-
<asset-client-key>
This command will submit all pending queued asset control method records for the
specified asset that are currently staged for registration.
Asset control method records are en-queued and staged using the
"ASSET.METHOD" command.
ASSET.METHOD.CLEAR-
<asset-client-key>
This command will remove all pending queued asset control method records for the
specified asset that are currently staged for registration.
ASSET.METHOD.REMOVE-
<asset-client-key>,<method-key>
This command will remove a single pending queued asset control method record for
the specified asset that is currently staged for registration.
ASSET.METHOD.DELETE-
<asset-client-key>,<method-key>
This command will delete an asset control method from the RMS server.
The following response command will be returned based on the success of the delete
operation:
ASSET.METHOD.DELETE-<asset-client-key>,
<method-key>,
<success>
• <success>: This argument will be a true|false value indicating the success of the
delete operation.
ASSET.METHOD.EXECUTE-
<asset-client-key>,<method-key>
[,<argument-value>]*
This command is used to manually execute a RMS asset control method. A listing of
required argument values should be included in this command instruction.
ASSET.METHOD.EXCLUDE-
<asset-client-key>,<method-key>
(,<exclude>)
This command will add the asset control method to the asset control method registra-
tion exclusion list.
If an asset control method registration attempt is made after the asset control method
has been added to the exclusion list, the asset control methods registration will be
ignored.
This command must be issued to RMS prior to the asset control method registration
attempt.
• <exclude>: This parameter is optional and if not included the default value assumed
is TRUE. If set to TRUE, then the control methods will be added to the asset control
method exclusion list. If set to FALSE the asset will be removed from the exclusion
list.