Technical information

RMS NetLinx Virtual Device API
151
RMS Enterprise - NetLinx Programmer’s Guide
RMS Asset Parameters Registration & Update Commands (Cont.)
Command Description
ASSET.PARAM.UPDATE-
<asset-client-key>,
<parameter-key>,
<parameter-operation>,
<parameter-value>
(,<submit-now>)
This command will perform an update of the asset parameter value with the RMS server.
The asset parameter should already be registered prior to issuing this command.
Arguments:
• <parameter-operation>: The parameter update operation argument specifies how the
RMS server will apply the <parameter-value>. The following list of operations are
available:
SET_VALUE
INCREMENT_VALUE
DECREMENT_VALUE
MULTIPLY_VALUE
DIVIDE_VALUE
RESET_VALUE
• (<submit-now>): This optional argument can be set to a value of true|false indicating if
this single parameter value update should be sent to the RMS server immediately.
If not provided, the argument is assumed to be a value of 'false'.
If this argument is omitted or set to a value of 'false', then the parameter update will be en-
queued waiting for a final 'ASSET.PARAM.UPDATE.SUBMIT' command to submit all of the
pending updates at once.
If this argument is set to a value of 'true', then this single parameter update will be
immediately forwarded to the RMS server.
A value of 'true' will not submit any pending parameter updates that are presently in queue.
ASSET.PARAM.UPDATE.SUBMIT-
<asset-client-key>
This command will submit all pending queued asset parameter update records for the
specified asset that are currently staged for updating. Asset parameter update records are
en-queued and staged using the "ASSET.PARAM.UPDATE" command.
ASSET.PARAM.UPDATE.CLEAR-
<asset-client-key>
This command will remove all pending queued asset parameter update records for the
specified asset that are currently staged for updating.
ASSET.PARAM.UPDATE.REMOVE-
<asset-client-key>,
<parameter-key>
This command will remove a single pending queued asset parameter update record for the
specified asset that is currently staged for update.
ASSET.PARAM.EXCLUDE-
<asset-client-key>,
<parameter-key>(,<exclude>)
This command will add the asset parameter to the asset parameter registration exclusion
list. If an asset parameter registration attempt is made after the asset parameter has been
added to the exclusion list, the asset parameter registration will be ignored.
This command must be issued to RMS prior to the asset parameter registration attempt.
Arguments:
• <exclude>: This parameter is optional and if not included the default value assumed is
TRUE.
If set to TRUE, then the asset parameter will be added to the asset parameter method
exclusion list.
If set to FALSE the asset will be removed from the exclusion list.