Technical information

Programming - Asset Management
91
RMS Enterprise - NetLinx Programmer’s Guide
Registering Asset Control Methods
The following callback method will be invoked in each asset monitoring module when it is time to perform the asset control
method registration with RMS.
(***********************************************************)
(* Name: RegisterAssetControlMethods *)
(* Args: -none- *)
(* *)
(* Desc: This is a callback method that is invoked by *)
(* RMS to notify this module that it is time to *)
(* register this asset's control methods with RMS. *)
(* *)
(* This method should not be invoked/called *)
(* by any user implementation code. *)
(***********************************************************)
DEFINE_FUNCTION RegisterAssetControlMethods ()
{
}
The RmsApi.axi Include File (which is already included by each asset monitoring module) provides the following wrapper
functions for registering asset control methods and asset control method arguments with RMS:
RmsAssetControlMethodEnqueue (see page 93)
RmsAssetControlMethodArgumentString (see page 94)
RmsAssetControlMethodArgumentBoolean (see page 95)
RmsAssetControlMethodArgumentNumber (see page 96)
RmsAssetControlMethodArgumentNumberEx (see page 97)
RmsAssetControlMethodArgumentDecimal (see page 98)
RmsAssetControlMethodArgumentLevel (see page 99)
RmsAssetControlMethodArgumentEnum (see page 100)
RmsAssetControlMethodArgumentEnumEx (see page 101)
RmsAssetControlMethodArgumentEnqueue (see page 102)
RmsAssetControlMethodsSubmit (see page 103)
RmsAssetControlMethodDelete (see page 104)
Each asset control method requires the following information:
Each asset control method argument requires the following information:
Asset Control Methods - Required Information
Key (String) This is a unique identifier for this asset control method. This ID string must be uniquely scoped for this asset.
Control method execution request will use this key identifier when operating on this control method.
Name (String) Friendly name for this asset control method.
Description (String) Descriptive help text for this asset control method.
Asset Control Method Arguments - Required Information
Ordinal (Integer) Argument order position for this asset control method argument in the control method. When control
methods are executed, the arguments returned will be order by this ordinal index.
Name (String) Friendly name for this asset control method argument.
Description (String) Descriptive help text for this asset control method argument.
Data Type (String) The following control method argument data types are supported for RMS asset control methods:
String, Boolean, Number, Decimal, Level, Enumeration.
A set of constants are defined for the available data types in the RmsApi.axi Include File.
// RMS Control Method Argument Data Types
RMS_METHOD_ARGUMENT_TYPE_NUMBER = 'NUMBER';
RMS_METHOD_ARGUMENT_TYPE_STRING = 'STRING';
RMS_METHOD_ARGUMENT_TYPE_ENUMERATION = 'ENUMERATION';
RMS_METHOD_ARGUMENT_TYPE_LEVEL = 'LEVEL';
RMS_METHOD_ARGUMENT_TYPE_BOOLEAN = 'BOOLEAN';
RMS_METHOD_ARGUMENT_TYPE_DECIMAL = 'DECIMAL';