Technical information

RMS NetLinx Virtual Device API
141
RMS Enterprise - NetLinx Programmer’s Guide
RMS Asset Registration Commands (Cont.)
Command Description
ASSET.REGISTER-
<asset-name>,
<asset-client-key>
(,<asset-type-key>)
(,<asset-global-key>)
This command is used to register a non-NetLinx-based asset with the RMS system. If a device
or asset does not have an associated NetLinx DPS, then this call should be used to register the
asset.
This command will queue the asset for registration. Additional asset properties can be set using
the asset command set provided in this section.
When ready to submit the asset registration, use the ASSET.SUBMIT command.
Arguments:
• <asset-name>: This argument should contain a friendly name for the asset. This name can be
later changed by the user in the RMS system.
• <asset-client-key>: This argument is required. The value for this field represents an asset
identifier that is unique on this client system (does not have to be globally unique). Any naming
or numbering system can be used as long as the identifier is unique for each asset on the
client system and is persisted across system/device reboots & firmware upgrades.
• <asset-type-key>: This argument is optional but it is recommended to set this to an
appropriate asset type key. The asset types are listed in the RMS web user interface under the
Settings menu. Please note, this field must contain the asset type key, not the asset type
name. (For Duet devices, the asset type key is the same as the device interface.)
• <asset-global-key>: This argument is optional and should only set if the asset contains some
unique identifier that can be assured to be globally unique across all assets in all RMS
locations. Properties such as a MAC address which are globally unique could be used. Please
note that an asset serial number by itself is not guaranteed to be unique across multiple
vendors. Thus if attempting to use a serial number it may need to be prefixed with some
additional scoping information such as manufacturer & model. If an asset is registered with a
global key, the RMS system can detect if the asset gets relocated to a different location
anywhere in the RMS system.
ASSET.DESCRIPTION-
<asset-client-key>,
<description>
This command sets the asset description property on an asset that has been queued for
registration. The asset client key must be provided to perform the set on the specific asset.
If the ASSET.REGISTER.DEV command was used to register a NetLinx-based device and no
explicit asset client key was specified, then the asset client key will be the DPS string.
Arguments:
• <asset-client-key>: This argument is required. The value for this field represents an asset
identifier that is unique on this client system (does not have to be globally unique). Any naming
or numbering system can be used as long as the identifier is unique for each asset on the
client system and is persisted across system/device reboots & firmware upgrades.
ASSET.NAME-
<asset-client-key>,
<asset-name>
This command sets the asset name property on an asset that has been queued for registration.
The asset client key must be provided to perform the set on the specific asset.
If the ASSET.REGISTER.DEV command was used to register a NetLinx-based device and no
explicit asset client key was specified, then the asset client key will be the DPS string.
Arguments:
• <asset-client-key>: This argument is required. The value for this field represents an asset
identifier that is unique on this client system (does not have to be globally unique). Any naming
or numbering system can be used as long as the identifier is unique for each asset on the
client system and is persisted across system/device reboots & firmware upgrades.
• <asset-name>: This argument should contain a friendly name for the asset. This name can be
later changed by the user in the RMS system.