Technical information

Programming - Asset Management
47
RMS Enterprise - NetLinx Programmer’s Guide
Programming - Asset Management
Asset Monitoring Modules
All RMS asset monitoring modules in the RMS SDK implement the RmsMonitorCommon.axi Include File.
The RmsMonitorCommon.axi Include File implements the underlying basic requirements and workflow required for asset
management. Usage of this Include File simplifies the implementation requirements inside each asset monitoring module and
abstracts most of the more complicated RMS logic allowing the monitoring module to focus solely on its own asset monitoring and
management implementation without knowledge of other assets or other RMS events.
The RmsMonitorCommon.axi Include File provides the appropriate callback methods on the asset monitoring modules at the
appropriate times when information is needed by RMS or when asset related information is evented from RMS.
RmsMonitorCommon.axi will invoke these following callback methods that must be implemented in each asset monitoring
module:
RegisterAssets - see Registering Assets on page 47
RegisterAssetParameters - see Registering Asset Parameters on page 54
SynchronizeAssetParameters - see Synchronizing Asset Parameter Values on page 74
ResetAssetParameterValue
RegisterAssetMetadata - see Registering Asset Metadata Properties on page 75
SynchronizeAssetMetadata - see Synchronizing Asset Metadata Properties on page 84
RegisterAssetControlMethods - see Registering Asset Control Methods on page 91
ExecuteAssetControlMethod - see Executing Asset Control Functions on page 105
SystemPowerChanged
SystemModeChanged
Registering Assets
The following callback method will be invoked in each asset monitoring module when it is time to perform the Asset registration
with RMS:
(***********************************************************)
(* Name: RegisterAsset *)
(* Args: RmsAsset asset data object to be registered . *)
(* *)
(* Desc: This is a callback method that is invoked by *)
(* RMS to notify this module that it is time to *)
(* register this asset. *)
(* *)
(* This method should not be invoked/called *)
(* by any user implementation code. *)
(***********************************************************)
DEFINE_FUNCTION RegisterAsset(RmsAsset asset)
{
}
The RmsApi Include File (which is already included by each asset monitoring module) provides a few asset registration methods to
use:
RmsAssetRegister (see page 50)
RmsAssetRegisterAmxDevice (see page 51)
RmsAssetRegisterDuetDevice (see page 52)
RmsAssetRegistrationSubmit (see page 53)
Each asset registration uses the following information.