Technical information

ManualsBrandsAMX ManualsComputer equipmentRMS

Programming - Asset Management

RMS Enterprise - NetLinx Programmer’s Guide

Each asset parameter requires the following information:

Asset Parameters - Required & Optional Information

Key (String)

[REQUIRED]

This is a unique identifier for this asset parameter. This ID string must be uniquely scoped for

this asset. Parameter value updates and reset notifications will use this key identifier when

operating on this parameter.

Name (String)

[REQUIRED]

Friendly name for this asset parameter.

Description (String)

[OPTIONAL]

Descriptive text for this asset parameter.

Data Type (String)

[REQUIRED]

Data type for this asset parameter's value.

The following parameter data types are supported for RMS asset parameters:

• Enumeration - list of choices

• Decimal - floating point number

• Level - number with fixed upper and lower bounds

• Number

•String

• Boolean

A set of constants are defined for the available data types in the RmsApi.axi Include File.

// RMS Asset Parameter Data Types

RMS_ASSET_PARAM_DATA_TYPE_NUMBER = 'NUMBER';

RMS_ASSET_PARAM_DATA_TYPE_STRING = 'STRING';

RMS_ASSET_PARAM_DATA_TYPE_ENUMERATION = 'ENUMERATION';

RMS_ASSET_PARAM_DATA_TYPE_LEVEL = 'LEVEL';

RMS_ASSET_PARAM_DATA_TYPE_BOOLEAN = 'BOOLEAN';

RMS_ASSET_PARAM_DATA_TYPE_DECIMAL = 'DECIMAL';

Reporting Type (String)

[OPTIONAL]

Reporting type for this asset parameter's value. This type is only applied to parameters that

have a special meaning in the RMS reporting system.

A set of constants are defined for the available reporting types in the RmsApi.axi Include File:

// RMS Asset Parameter (Reporting) Types

RMS_ASSET_PARAM_TYPE_NONE = 'NONE';

RMS_ASSET_PARAM_TYPE_ASSET_ONLINE = 'ASSET_ONLINE';

RMS_ASSET_PARAM_TYPE_ASSET_POWER = 'ASSET_POWER';

RMS_ASSET_PARAM_TYPE_POWER_CONSUMPTION = 'POWER_CONSUMPTION';

RMS_ASSET_PARAM_TYPE_ENVIONMENTAL_EMISSIONS = 'EMISSIONS';

RMS_ASSET_PARAM_TYPE_LAMP_USAGE = 'LAMP_USAGE';

RMS_ASSET_PARAM_TYPE_BATTERY_LEVEL = 'BATTERY_LEVEL';

RMS_ASSET_PARAM_TYPE_BATTERY_CHARGING_STATE = 'BATTERY_CHARGING_STATE';

RMS_ASSET_PARAM_TYPE_RFID_LOCATION = 'RFID_LOCATION';

RMS_ASSET_PARAM_TYPE_SOURCE_USAGE = 'SOURCE_USAGE';

RMS_ASSET_PARAM_TYPE_SOURCE_STATE = 'SOURCE_STATE'

RMS_ASSET_PARAM_TYPE_SYSTEM_ONLINE = 'SYSTEM_ONLINE';

RMS_ASSET_PARAM_TYPE_SYSTEM_POWER = 'SYSTEM_POWER';

RMS_ASSET_PARAM_TYPE_TRANSPORT_STATE = 'TRANSPORT_STATE';

RMS_ASSET_PARAM_TYPE_TRANSPORT_USAGE = 'TRANSPORT_USAGE';

RMS_ASSET_PARAM_TYPE_DISPLAY_USAGE = 'DISPLAY_USAGE';

RMS_ASSET_PARAM_TYPE_TEMPERATURE = 'TEMPERATURE';

RMS_ASSET_PARAM_TYPE_SECURITY_STATE = 'SECURITY_STATE';

RMS_ASSET_PARAM_TYPE_LIGHT_LEVEL = 'LIGHT_LEVEL';

RMS_ASSET_PARAM_TYPE_SIGNAL_STRENGTH = 'SIGNAL_STRENGTH';

RMS_ASSET_PARAM_TYPE_HVAC_STATE = 'HVAC_STATE';

RMS_ASSET_PARAM_TYPE_DIALER_STATE = 'DIALER_STATE';

RMS_ASSET_PARAM_TYPE_DOCKING_STATE = 'DOCKING_STATE';

Initial Value (String)

[OPTIONAL]

The current parameter value (if known) should be set at the initial value when the parameter

gets register in the RMS system.

Units (String)

[OPTIONAL]

If the parameter value should have a unit descriptor following the value in the user interface,

then provide the unit descriptor here.

Allow Reset (Boolean)

[REQUIRED]

If this parameter attribute is set to TRUE, then the asset parameter RESET option will be

available in the RMS web user interface.

Users can reset the value from the RMS web pages and a notification will be delivered to the

asset monitoring module to notify it of the reset value.

Reset Value (String)

[OPTIONAL]

If Allow Reset is enabled, the a default reset value should be provided.

When users that perform a RESET from the RMS web user interface this reset value will be

applied as the current value for the asset parameter.