Technical information

The RMS Enterprise SDK (v4)
21
RMS Enterprise - NetLinx Programmer’s Guide
It is important to note that by default RMS does not implement System Power or System Modes. They must be enabled in the
RmsControlSystemMonitor module and the user program must implement the necessary behavior and logic when these events are
triggered. The RMS SDK provides the infrastructure for routing these notifications, but does not provide a default usage
implementation.
For more details on how to implement System Power or System Modes, please see the Implementing System Power section on
page 113 and the Implementing System Modes section on page 114.
Functions defined in RmsSystemEventHandler.axi
The following table describes the Functions defined in RmsSystemEventHandler.axi:
RmsSystemEventHandler.axi - Functions
RmsEventSystemPowerChangeRequest Description: RMS system power change request notification.
• This callback method is invoked by the 'RmsEventListener’ Include File to notify
this program when a system power state change has been requested.
• This method should not be invoked/called by any user implementation code.
Arguments:
• powerOn - boolean bit TRUE|FALSE for system power state
Syntax:
DEFINE_FUNCTION RmsEventSystemPowerChangeRequest(CHAR powerOn)
{
//
// (RMS SYSTEM POWER CHANGE REQUEST NOTIFICATION)
//
IF(powerOn)
{
// system power ON request received
}
ELSE
{
// system power OFF request received
}
}
RmsEventSystemPowerChanged Description: RMS system power change notification.
• This callback method is invoked by the 'RmsEventListener.axi' Include File to
notify this program when the system power state has changed.
• This method should not be invoked/called by any user implementation code.
Arguments:
• powerOn - boolean bit TRUE|FALSE for system power state
Syntax:
DEFINE_FUNCTION RmsEventSystemPowerChanged(CHAR powerOn)
{
//
// (RMS SYSTEM POWER CHANGE NOTIFICATION)
//
// upon receiving the system power change notification from
// the RMS client the user code should implement the necessary
// code logic to power the 'SYSTEM' ON or OFF
//
SEND_STRING 0, '**************************************';
IF(powerOn)
{
SEND_STRING 0, ' SYSTEM POWER [ON] ';
}
ELSE
{
SEND_STRING 0, ' SYSTEM POWER [OFF] ';
}
SEND_STRING 0, '**************************************';
#WARN 'Implement your SYSTEM POWER [ON/OFF] logic here!'
}