Technical information

RMS NetLinx Virtual Device API
149
RMS Enterprise - NetLinx Programmer’s Guide
RMS Asset Parameters Registration & Update Commands (Cont.)
Command Description
ASSET.PARAM- (Cont.) • <parameter-type>: This property is optional and specifies an explicit asset parameter
type. If not provided, the parameter type is assumed to be NONE. The parameter type is
used to designate the parameter to a specific parameter profile and behavior in RMS. For
example, if the parameter should be included in RMS reporting and views for Lamp Hours,
then a parameter type of LAMP_USAGE is applied.
The available parameter types include the following values:
NONE
ASSET_ONLINE
ASSET_POWER
POWER_CONSUMPTION
EMISSIONS
LAMP_USAGE
BATTERY_LEVEL
BATTERY_CHARGING_STATE
RFID_LOCATION
SOURCE_USAGE
SOURCE_STATE
SYSTEM_ONLINE
SYSTEM_POWER
TRANSPORT_STATE
TRANSPORT_USAGE
DISPLAY_USAGE
TEMPERATURE
SECURITY_STATE
LIGHT_LEVEL
SIGNAL_STRENGTH
HVAC_STATE
DIALER_STATE
DOCKING_STATE
• <parameter-value>: This property is optional and specifies an explicit asset parameter
initial value to register with. If not provided, the parameter value remains null.
• <parameter-units>: This property is optional and specifies a units decorator for the asset
parameter. This is used as a suffix string when the RMS user interface displays the
parameter value.
• <parameter-allow-reset>: This property is optional and specifies if the asset parameter
value can be RESET at runtime in the RMS user interface. If not specified, this property is
assumed to be FALSE.
• <parameter-reset-value>: This property is optional and specifies the asset parameter
reset value applied to the parameter when a user RESETS the parameter at runtime in the
RMS user interface. This argument should be defined if <parameter-allow-reset> is set to
"true".
• <parameter-min-value>: This property is optional and if included specifies a minimum
acceptable parameter value. This property should only be used with numeric data types.
• <parameter-max-value>: This property is optional and if included specifies a maximum
acceptable parameter value. This property should only be used with numeric data types.
• <parameter-enumeration>: This property is optional and specifies a pipe delimited series
of enumeration values. This property should only be used with the enumeration data type.
• <parameter-track-changes>: This property is optional and specifies if the RMS server
should maintain a historical record of parameter value changes. If not defined, this
property has a default value of 'false'.
For a detailed listing if the parameter arguments, please see the ASSET.PARAM registration
command.