Technical information

Programming - Asset Management
106
RMS Enterprise - NetLinx Programmer’s Guide
Excluding Default Asset Parameters
If the RMS Client and SDK register an asset parameter by default that you don't want exposed in your system, you can define an
exclusion by calling the following method before the asset registration takes place. The suggested place to put this exclude call
would be immediately after the vdvRMS virtual device comes online.
RmsAssetParameterExclude
RmsAssetParameter
Exclude
Description: This function is used to exclude a specific asset monitored parameter from being registered
to the specified asset client key.
Arguments:
• CHAR assetClientKey[] - asset client key
• CHAR parameterKey[] - monitored parameter key
Returns: 1 if call was successful; 0 if call was unsuccessful
Syntax:
DEFINE_FUNCTION CHAR RmsAssetParameterExclude(CHAR assetClientKey[],
CHAR parameterKey[])
{
STACK_VAR CHAR rmsCommand[RMS_MAX_CMD_LEN];
// ensure an asset client key has been provided
IF(assetClientKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetParameterExclude> :: missing asset client
key';
RETURN FALSE;
}
// ensure a parameter key has been provided
IF(parameterKey == '')
{
SEND_STRING 0, '>>>> RMS API ERROR <RmsAssetParameterExclude> :: missing parameter
key';
RETURN FALSE;
}
// submit the asset exclusion now
rmsCommand = RmsPackCmdHeader('ASSET.PARAM.EXCLUDE');
rmsCommand = RmsPackCmdParam(rmsCommand,assetClientKey);
rmsCommand = RmsPackCmdParam(rmsCommand,parameterKey);
rmsCommand = RmsPackCmdParam(rmsCommand,'true'); // force exclusion
SEND_COMMAND
vdvRMS, rmsCommand;
RETURN TRUE;
}