...
Priority
It is possible to set an alarm with different priority, below are the different colors that are used on W-AIR handset depending on the priority.
- 1: red
- 2: red
- 3: red
- 4: Yellow
- 5: Yellow
- 6: Yellow
- 7: Green
- 8: Green
- 9: Green
- All other values: Green
Confirmation type
XML child "confirmationtype" (JobDataDef):
- 0: No User confirmation needed
- W-AIR base station sends back a confirmation to a Message server that the message is received on W-AIR base station
- 1: User Received Job confirmation needed
- W-AIR base station sends back a confirmation to a Message server that the message is received on W-AIR base station
- W-AIR base station sends back a confirmation to a Message server that the message is received on W-AIR handset
- 2: User Confirm/ Reject Job confirmation needed
- W-AIR base station sends back a confirmation to a Message server that the message is received on W-AIR base station
- W-AIR base station sends back a confirmation to a Message server that the message is received on W-AIR handset
- W-AIR base station sends back a confirmation to a Message server if the user confirms /rejects the message
Reference number
Substituting an alarm
The reference number is unique number per alarm. When sending an alarm, the reference number always needs to be present, otherwise the message is interpreted as an SMS.
- If an alarm is sent with the same referencenumber as a previous alarm that is NOT yet confirmed/ rejected (confirmationtype 2), the first alarm is deleted and only the new one is saved and displayed on W-AIR handset
- If an alarm is sent with the same referencenumber as a previous alarm that is confirmed/ rejected, then both alarms are displayed
- If an alarm is sent with the same referencenumber as a previous alarm that has confirmationtype 0 or 1, then both alarms are on W-AIR handset
Deleting an alarm
It is possible to delete an alarm that is NOT yet confirmed/ rejected on W-AIR handset.
- Deletion is available for an alarm with confirmationtype 1 and 2
- For deleting an existing alarm, the same reference number should be used and the status should be set to 10
Response handling
For confirmationtype 1 and 2, there is always a response sent to a Message server that W-AIR base station/ handset receives the messages:
- A Message server needs both responses to be sure that the messages are received on W-AIR handset.
- A Message server should not send a new message to the same W-AIR handset before both responses are received
- In case a Message server does not receive the response from W-AIR handset, it should wait a minimum of 10 sec before trying to send a message again to the same W-AIR handset. This is needed so W-AIR base station has enough time to timeout the first messages
When using confirmationtype 0, a Message server doesn't know if the SMS/ alarm is lost from W-AIR base station to W-AIR handset. Here a Message server should always wait 10 sec between each message to the same W-AIR handset
Examples
Below are examples of an alarm sent from a Message server with confirmationtype 2:
| Expand |
|---|
| title | A Message server sends alarm to W-AIR base station |
|---|
|
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<request version="1.0" type="job">
<systemdata>
<name>Micromedia-Alert</name>
<datetime>2017-06-20T09:25:24</datetime>
<timestamp>5948cde4</timestamp>
<status>1</status>
<statusinfo>System running</statusinfo>
</systemdata>
<jobdata>
<alarmnumber>5</alarmnumber>
<referencenumber>5</referencenumber>
<priority>1</priority>
<flash>0</flash>
<rings>0</rings>
<confirmationtype>2</confirmationtype> <messages>
<message1></message1> <message2></message2>
<messageuui>Alarm1 text</messageuui> </messages>
<status>0</status>
<statusinfo/>
</jobdata>
<persondata>
<address>991</address>
<status>0</status>
<statusinfo/>
</persondata> <externalid>mmi5948c09b-5</externalid> </request> |
|
| Expand |
|---|
| title | W-AIR base station responses to a Message server about receiving the alarm |
|---|
|
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<response version="17.6.15.1526" type="job">
<externalid>mmi5948c09b-5</externalid>
<status>1</status>
<systemdata>
<name>SME VoIP</name>
<datetime>2017-06-20 02:25:22</datetime>
<timestamp>5948cde2</timestamp>
<status>1</status>
<statusinfo>System running</statusinfo>
</systemdata>
<senderdata>
<address>991</address>
<name>991</name>
<location>SME VoIP</location>
</senderdata>
</response> |
|
| Expand |
|---|
| title | W-AIR base station responses to a Message server about W-AIR handset receiving the alarm |
|---|
|
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<response version="17.6.15.1526" type="job">
<externalid>mmi5948c09b-5</externalid>
<systemdata>
<name>SME VoIP</name>
<datetime>2017-06-20 02:25:23</datetime>
<timestamp>5948cde3</timestamp>
<status>1</status>
<statusinfo>System running</statusinfo>
</systemdata>
<jobdata>
<priority>1</priority>
<messages>
<message1></message1>
<message2></message2>
<messageuui></messageuui>
</messages>
<status>1</status>
<statusinfo></statusinfo>
</jobdata>
<senderdata>
<address>991</address>
<name>991</name>
<location>SME VoIP</location>
</senderdata>
</response> |
|
| Expand |
|---|
| title | User presses OK and W-AIR base station sends response to a Message server |
|---|
|
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<response version="17.6.15.1526" type="job">
<externalid>mmi5948c09b-5</externalid>
<systemdata>
<name>SME VoIP</name>
<datetime>2017-06-20 02:25:38</datetime>
<timestamp>5948cdf2</timestamp>
<status>1</status>
<statusinfo>System running</statusinfo>
</systemdata>
<jobdata>
<priority>1</priority>
<messages>
<message1></message1>
<message2></message2>
<messageuui></messageuui>
</messages>
<status>4</status>
<statusinfo></statusinfo>
</jobdata>
<senderdata>
<address>991</address>
<name>991</name>
<location>SME VoIP</location>
</senderdata>
</response> |
|
Delete an alarm
| Expand |
|---|
| title | A Message server sends an alarm to W-AIR base station |
|---|
|
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<request version="1.0" type="job">
<systemdata> <name>Micromedia-Alert</name>
<datetime>2017-06-20T09:58:25</datetime>
<timestamp>5948d5a1</timestamp>
<status>1</status>
<statusinfo>System running</statusinfo>
</systemdata>
<jobdata>
<alarmnumber>5</alarmnumber>
<referencenumber>5</referencenumber>
<priority>1</priority>
<flash>0</flash>
<rings>0</rings>
<confirmationtype>2</confirmationtype>
<messages>
<message1></message1>
<message2></message2>
<messageuui>Alarm1 text</messageuui>
</messages>
<status>0</status>
<statusinfo/>
</jobdata>
<persondata>
<address>991</address>
<status>0</status>
<statusinfo/>
</persondata> <externalid>mmi5948c0a6-5</externalid>
</request> |
|
| Expand |
|---|
| title | A Message server requests W-AIR base station to delete the alarm (note that the same reference number is used and status is 10) |
|---|
|
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<request version="1.0" type="job">
<systemdata>
<name>Micromedia-Alert</name>
<datetime>2017-06-20T09:58:25</datetime>
<timestamp>5948d5a1</timestamp>
<status>1</status>
<statusinfo>System running</statusinfo>
</systemdata>
<jobdata>
<alarmnumber>5</alarmnumber>
<referencenumber>5</referencenumber>
<priority>1</priority>
<flash>0</flash>
<rings>0</rings>
<confirmationtype>2</confirmationtype>
<messages>
<message1></message1>
<message2></message2>
<messageuui>Alarm1 text</messageuui>
</messages>
<status>10</status>
<statusinfo/>
</jobdata>
<persondata>
<address>991</address>
<status>0</status>
<statusinfo/>
</persondata> <externalid>mmi5948c0a6-5</externalid>
</request> |
|
Sending alarms
...
from W-AIR base station/ handset to a Message server
W-AIR handset can be configured so it sends an alarm to a Message server for the following cases:
...
In W-AIR network with up to 1000 handsets, it is important to use as little space as possible for the parameters. It is not recommended to store the broadcast for each W-AIR handset as this will fill 32kByte on W-AIR base station. The IPEI number should be used as part of the UUID number together with a selectable value that is the same for all handsets.
Transmit beacon content (32 bytes) | Broadcast data of the transmitted beacon (space reserved 32 bytes):
iBeacon: 26 bytes
AltBeacon: 28 bytes
EddyStone: 20 bytes | |
Sending beacon messages from W-AIR base station/ handset
...