Technical information

ManualsBrandsAMX ManualsComputer equipmentRMS

151

152

153

154

155

156

157

158

159

160

RMS NetLinx Virtual Device API

140

RMS Enterprise - NetLinx Programmer’s Guide

RMS Asset Registration Commands

Command Description

ASSET.REGISTER.DEV-

<D:P:S>,

<asset-name>,

(,<asset-client-key>)

(,<asset-type-key>)

(,<asset-global-key>)

This command is used to register a NetLinx-based device asset with the RMS system. If the

device uses a 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:

• <D:P:S>: The DPS string should be provided here in the format: Device:Port:System.

• <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 optional and typically not set for a NetLinx-device based

asset registration. This key represents an asset identifier that is unique on this client system

(does not have to be globally unique). If not provided, the DPS string is used as the client key.

This asset client key is typically the D:P:S string in NetLinx systems.

• (<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 be 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 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.REGISTER.AMX.DEV-

<D:P:S>,

(,<asset-name>)

(,<asset-client-key>)

(,<asset-type-key>)

(,<asset-global-key>)

This command is used to register an AMX manufactured NetLinx-based device asset with the

RMS system. If the device uses a NetLinx DPS and is manufactured by AMX, then this call

should be used to register the asset. This command will queue the asset for registration.

This command will pre-populate all available asset fields with information obtained from the

NetLinx device info query.

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:

• <D:P:S>: The DPS string should be provided here in the format: Device:Port:System.

• <asset-name>: This argument is optional but it is recommended to provide an explicit

identifying friendly name appropriate for the asset. This argument should contain a friendly

name for the asset. This name can be later changed by the user in the RMS system.