Technical information

RMS Duet Module Properties
117
RMS Enterprise - NetLinx Programmer’s Guide
RMS Duet Module Properties
Overview
When a Duet device is registered with RMS, RMS can look at RMS specific Duet module properties for overriding device specific
information. These properties allow a programmer to override the default implementation and specify device specific unique
information.
If not provided, RMS will use a fallback mechanism to determine the most appropriate values. These fallback properties are also
listed below. Use the PROPERTY command for each Duet module to set any of these desired properties.
After device registration RMS will update all these properties with the current applied values so you can query any of these named
properties to obtain their current values.
If you provide specific concrete information such as asset model and manufacturer in
the initial asset registration call, then the RMS SDK will use that information and not
look at the corresponding Duet module properties.
RMS Duet Module Properties
RMS-Type
(Required)
This property is required for RMS to register the Duet device with the RMS server. The only accept-
able value for this property at this time is 'Asset'.
SEND_COMMAND vdvDuetModule, "'PROPERTY-RMS-Type,Asset'"
There is no fallback for this property; it is required for use with RMS.
(This property is automatically set by each RMS monitoring module.)
RMS-Asset-Name This property will define the asset's friendly name used when registering this asset with the RMS
server. This property will not override an asset name that was explicitly provided in a RMS Duet
Asset registration call.
If not provided, the fallback default Duet module property of 'Device-Name' will be used to
determine the asset name.
RMS-Asset-Description This property will define the asset's descriptive text used when registering this asset with the RMS
server. This property will not override an asset description that was explicitly provided in a RMS
Duet Asset registration call.
If not provided, the fallback default Duet module property of 'Device-Description' will be used
to determine the asset description.
RMS-Asset-Client-Key This property will define the asset's system unique client key identifier string. This identifier string
must be unique in scope on the NetLinx master.
If not provided, the fallback value is constructed using the D:P:S address of the physical (real)
device. Example: "5001:16:0"
It is not recommended to override this property unless you know specifically what you are doing
in some advanced programming scenario.
RMS-Asset-Global-Key This property will define the asset's globally unique key identifier string. This identifier string much
be unique in scope of the entire RMS system including all locations, and all device manufacturers.
Values such as MAC addresses may be used for this property, but values like serial numbers may
not be unique across all manufacturer devices.
If not provided, no fallback value will be used. This property is optional and is not required.
It is not recommended to override this property unless you know specifically what you are doing
in some advanced programming scenario.
RMS-Asset-Make This property will define the asset's manufacturer name used when registering this asset with the
RMS server. This property will not override an asset manufacturer name that was explicitly provided
in a RMS Duet Asset registration call.
If not provided, the fallback default Duet module property of 'Device-Make' will be used to deter-
mine the asset manufacturer name.