Sending Messages
The Appliance Events and Alerts cluster server resides on the appliance (for example, a washing machine) and the cluster client resides on a controlling device (normally a remote control unit).
Messages can be sent between the client and the server in the following ways:
Alerts that are active on the appliance can be requested by the client by sending a ‘Get Alerts’ message to the server (which replies with a ‘Get Alerts Response’ message).
Alerts that are active on the appliance can be sent unsolicited from the server to the client in an ‘Alerts Notification’ message.
The server can notify the client of an appliance event by sending an unsolicited ‘Event Notification’ message to the client
Sending the above messages is described in the sub-sections below.
‘Get Alerts’ Messages from Client to Server
The application on the cluster client can request the alerts that are currently active on the appliance by sending a ‘Get Alerts’ message to the server - this message is sent by calling the function eCLD_AEAAGetAlertsSend(). This function returns immediately and the requested alerts are later returned in an E_CLD_APPLIANCE_EVENTS_AND_ALERTS_CMD_GET_ALERTS event, which is generated when a response arrives from the server (Appliance Events and Alerts events are described in Section 47.4).
Note: The cluster server handles the ‘Get Alerts’ message automatically and returns the requested alerts in a ‘Get Alerts Response’ message to the client.
The appliance alerts from the message payload are contained in the above event - for details of this payload and the alert information, refer to Section 47.8.2. Up to 15 alerts can be reported in a single response.
Parent topic:Sending Messages
‘Alerts Notification’ Messages from Server to Client
The cluster server on the appliance can send unsolicited alert notifications to the client in ‘Alerts Notification’ messages. The application on the server can send a message of this kind by calling either of the following functions:
eCLD_AEAAAlertsNotificationSend()
eCLD_AEAAGetAlertsResponseORAlertsNotificationSend()
Note: The latter function is also used internally by the cluster server to send a ‘Get Alerts Response’ message - see Section 47.3.1.
The appliance status information from the ‘Alerts Notification’ message is reported to the application on the cluster client through the event E_CLD_APPLIANCE_EVENTS_AND_ALERTS_CMD_ALERTS_NOTIFICATION, which is generated when the notification arrives from the server (Appliance Events and Alerts events are described in Section 47.4). The appliance alerts from the message payload are contained in the above event - for details of this payload and the alert information, refer to Section 47.8.2. Up to 15 alerts can be reported in a single notification.
Parent topic:Sending Messages
‘Event Notification’ Messages from Server to Client
The cluster server on the appliance can send unsolicited event notifications to the client in ‘Event Notification’ messages, where each message reports a single appliance event (for example, oven has reached its target temperature). A message of this kind can be sent by the application on the server by calling the function eCLD_AEAAEventNotificationSend().
The appliance event information from the ‘Event Notification’ message is reported to the application on the cluster client through the event E_CLD_APPLIANCE_EVENTS_AND_ALERTS_CMD_ALERTS_NOTIFICATION, which is generated when the notification arrives from the server (Appliance Events and Alerts events are described in Section 47.4). The appliance event from the message payload is contained in the above client event - for details of this payload and the embedded appliance event information, refer to Section 47.8.3.
Parent topic:Sending Messages
Parent topic:Appliance Events and Alerts Cluster