Technical information

Programming - Asset Management
68
RMS Enterprise - NetLinx Programmer’s Guide
Each asset parameter value update requires the following information:
Each of the RmsAssetParameterSetValueXXX and RmsAssetParameterEnqueueSetValueXXX functions impose an
update operation of SET_VALUE.
The RmsAssetParameterUpdateValueXXX and RmsAssetParameterEnqueueUpdateValueXXX functions allow the
caller to define which operation to perform.
The following code snippet provides an example of immediately updating an asset parameter value.
// send docked status update to RMS
RmsAssetParameterSetValue(assetClientKey,'touch.panel.docked','true');
Asset Parameter Set Value Functions for Immediate Value Change
The Asset Parameter Set Value functions (for immediate value change) in the RmsApi.axi Include File are described in the
following table:
Asset Parameter Value Updates - Required Information
Asset Key (String)
[REQUIRED]
Parameter Key (String)
[REQUIRED]
Parameter Operation (String)
[REQUIRED]
This is the operation to perform against the current parameter value with the new value provided
in the update call.
A set of the available update operations are listed as constants in the RmsApi.axi Include File:
// RMS Asset Parameter Update Operation
RMS_ASSET_PARAM_UPDATE_OPERATION_SET = 'SET_VALUE';
RMS_ASSET_PARAM_UPDATE_OPERATION_INCREMENT = 'INCREMENT_VALUE';
RMS_ASSET_PARAM_UPDATE_OPERATION_DECREMENT = 'DECREMENT_VALUE';
RMS_ASSET_PARAM_UPDATE_OPERATION_DIVIDE = 'DIVIDE_VALUE';
RMS_ASSET_PARAM_UPDATE_OPERATION_RESET = 'RESET_VALUE';
Parameter Value (String)
[REQUIRED]
This is the value that will be applied to the parameter value using the provided operation.
Asset Parameter Set Value Functions
RmsAssetParameter
SetValueBoolean
Description: This function is used to set a new asset parameter value to the RMS server immediately.
This function will set an asset parameter of data type: BOOLEAN
Arguments:
• CHAR assetClientKey[] - asset client key
• CHAR parameterKey[] - monitored parameter key
• CHAR parameterValue - monitored parameter value
Returns:1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetParameterSetValueBoolean(CHAR assetClientKey[],
CHAR parameterKey[],
CHAR parameterValue)
{
// submit the asset parameter update now
RETURN RmsAssetParameterSetValue(assetClientKey,
parameterKey,
RmsBooleanString(parameterValue));
}