Technical information

RMS NetLinx Virtual Device API
148
RMS Enterprise - NetLinx Programmer’s Guide
RMS Asset Parameters Registration & Update Commands
RMS Asset Parameters Query Commands (Cont.)
Command Description
?ASSET.PARAM-
<asset-client-key,
<parameter-key>
This command is used to query for a specific asset parameter from the RMS server.
Arguments:
<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.
<parameter-key>: This field is the asset parameter key string used to uniquely identify the asset parameter
scoped to this asset.
ASSET.PARAM-<asset-client-key>,
<parameter-key>,
<parameter-name>,
<parameter-description>,
<parameter-data-type>,
<parameter-type>,
<parameter-value>,
<parameter-units>,
<parameter-allow-reset>,
<parameter-reset-value>,
<parameter-min-value>,
<parameter-max-value>,
<parameter-enumeration>,
<parameter-track-changes>,
<parameter-is-stock>
For a detailed listing of the parameter arguments, see the ASSET.PARAM registration command (below).
If the parameter contains any defined thresholds, then a series of threshold commands will be additionally
sent:
ASSET.PARAM.THRESHOLD-<asset-client-key>,
<parameter-key>,
<threshold-record-index>,
<threshold-record-count>,
<threshold-name>,
<enabled>,
<status-type-key>,
<comparison-operator>,
<threshold-value>,
<notify-on-trip>,
<notify-on-restore>,
<delayed>,
<delay-interval>
RMS Asset Parameters Registration & Update Commands
Command Description
ASSET.PARAM-<asset-client-key>,
<parameter-key>,
<parameter-name>
(,<parameter-description>)
(,<parameter-data-type>)
(,<parameter-type>)
(,<parameter-value>)
(,<parameter-units>)
(,<parameter-allow-reset>)
(,<parameter-reset-value>)
(,<parameter-min-value>)
(,<parameter-max-value>)
(,<parameter-enumeration>)
(,<parameter-track-changes>)
(,<parameter-bargraph-key>)
(,<parameter-is-stock>)
This command is used to en-queue an asset parameter for a specific asset in RMS. If the
asset parameter does not exist on the RMS server, a new record is created, if the parameter
already exists, then no changes are applied.
Arguments:
• <asset-client-key>: The asset client key of the asset you wish to create the asset
parameter. This asset client key is typically the D:P:S string in NetLinx systems.
• <parameter-key>: This field is the asset parameter key string used to uniquely identify the
parameter scoped to this asset.
• <parameter-name>: This field is the asset parameter displayed name.
• <parameter-description>: This property is optional and allows the program to provide an
asset parameter textual description.
• <parameter-data-type>: This property is optional and specifies an explicit asset
parameter data type. If not provided, the data type is assumed to be STRING.
The available parameter data type values include the following:
NUMBER
STRING
ENUMERATION
LEVEL
BOOLEAN
DECIMAL