Technical information

RMS NetLinx Virtual Device API
143
RMS Enterprise - NetLinx Programmer’s Guide
RMS Asset Registration Commands (Cont.)
Command Description
ASSET.MANUFACTURER-
<asset-client-key>,
<asset-manufacturer-name>
(,<asset-manufacturer-url>)
This command sets the asset manufacturer name and URL properties 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.
The manufacturer URL property is optional.
ASSET.MODEL-
<asset-client-key>,
<asset-model-name>
(,<asset-model-url>)
This command sets the asset model name and URL properties 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.
The model URL property is optional.
ASSET.FIRMWARE-
<asset-client-key>,
<firmware-version>
This command sets the asset firmware version 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.SUBMIT-
<asset-client-key>
This command submits a queued asset registration to the RMS client.
This command should follow either the ASSET.REGISTER.DEV command or the
ASSET.REGISTER command and all asset property set commands. This command will finalize
the asset registration and remove the asset details from the registration queue.
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.EXCLUDE-
<asset-client-key>(,<exclude>)
This command will add the asset to the asset registration exclusion list. If an asset registration
attempt is made after the asset has been added to the exclusion list, the asset registration will be
ignored.
This command must be issued to RMS prior to the asset registration attempt.
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.
• <exclude>: This parameter is optional and if not included the default value assumed is TRUE.
If set to TRUE, then the asset will be added to the asset registration exclusion list.
If set to FALSE the asset will be removed from the exclusion list.