Rainforest Automation
,
Inc
.
RAVEn™
XML API Manual
18
Message Feature
The Message Feature provides the commands and notifications for managing messages routed
through the smart meters.
Key commands and notifications include:
•
Message notifications when a smart meter receives a message
•
Message confirmation by the User
1. Command: GET_MESSAGE
Send the GET_MESSAGE command to have the
RAVEn
™ get the current text message. The
RAVEn
™ will send a
MessageCluster
notification in response.
<Command>
<Name>get_message</Name>
[<MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId>]
[<Refresh>{text}</Refresh>]
</Command>
Element
Range
Description
MeterMacId
0xFFFFFFFFFFFFFFFF;
Optional if only one meter
Unique MAC Address of meter
Refresh
Y | N; Optional
Y: Get current message from meter
N: Get message from
RAVEn
™ cache
(default)
2. Notify:
MessageCluster
MessageCluster
notifications provide the current text message from the meter. If a confirmation
is required, the ConfirmationRequired flag is set. If the user has already confirmed the message,
then the Confirmed flag is set to Y. The ID is the reference to a particular message. The
message text is HTML escape encoded.
<MessageCluster>
<DeviceMacId>0xFFFFFFFFFFFFFFFF</DeviceMacId>
<MeterMacId>0xFFFFFFFFFFFFFFFF</MeterMacId>
<TimeStamp>0xFFFFFFFF</TimeStamp>
<Id>0xFFFFFFFF</Id>
<Text>{string}</Text>
<ConfirmationRequired>{enumeration}</ConfirmationRequired>
<Confirmed>{enumeration}</Confirmed>
<Queue>{enumeration}</Queue>
</MessageCluster>
