Technical information

Programming - Asset Management
70
RMS Enterprise - NetLinx Programmer’s Guide
Asset Parameter Set Value Functions (Cont.)
RmsAssetParameter
SetValue
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: STRING
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 RmsAssetParameterSetValue(CHAR assetClientKey[],
CHAR parameterKey[],
CHAR parameterValue[])
{
// submit the asset parameter update now
RETURN RmsAssetParameterUpdateValue(assetClientKey,
parameterKey,
RMS_ASSET_PARAM_UPDATE_OPERATION_SET,
parameterValue);
}
RmsAssetParameter
UpdateValue
Description: This function is used to update an asset parameter value to the RMS server immediately.
Arguments:
• CHAR assetClientKey[] - asset client key
• CHAR parameterKey[] - monitored parameter key
• CHAR parameterOperation[] - update operation
• CHAR parameterValue[] - update parameter value
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetParameterUpdateValue(CHAR assetClientKey[],
CHAR parameterKey[],
CHAR parameterOperation[],
CHAR parameterValue[])
{
STACK_VAR CHAR rmsCommand[RMS_MAX_CMD_LEN];
// ensure RMS is ONLINE, REGISTERED, and ready for ASSET registration
IF(![vdvRMS,RMS_CHANNEL_ASSETS_REGISTER])
{
RETURN FALSE;
}
// ensure an asset client key has been provided
IF(assetClientKey == '')
{
SEND_STRING 0, "'>>>> RMS API ERROR <RmsAssetParameterUpdateValue> :: missing asset client key for
parameter: ',parameterKey";
RETURN FALSE;
}
// ensure a parameter key has been provided
IF(parameterKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetParameterUpdateValue> :: missing parameter key';
RETURN FALSE;
}
// if an operation was not provided, then apply the SET operation
IF(parameterOperation == '')
{
parameterOperation = RMS_ASSET_PARAM_UPDATE_OPERATION_SET;
}
// submit the asset parameter update now
rmsCommand = RmsPackCmdHeader('ASSET.PARAM.UPDATE');
rmsCommand = RmsPackCmdParam(rmsCommand,assetClientKey);
rmsCommand = RmsPackCmdParam(rmsCommand,parameterKey);
rmsCommand = RmsPackCmdParam(rmsCommand,parameterOperation);
rmsCommand = RmsPackCmdParam(rmsCommand,parameterValue);
rmsCommand = RmsPackCmdParam(rmsCommand,'true'); // SUBMIT-NOW = TRUE
SEND_COMMAND vdvRMS, rmsCommand;
RETURN TRUE;
}