Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
AMLNotificationTop
AMLNotificationTop

Panel
titleBGColor#F0F0F0
titleValid for N670 / N870 / N870E but not supported by N610. Software 2.52 or higher is needed.

The system can inform the Alarm (MQTT) server in case of:

  • DECT Manager and or DECT Base - Push notification
    • Single DECT base up/down
    • Single DECT manager up/down
  • DECT Manager and or DECT Base - Status information
    • Status of DECT base stations up/down
    • Status of DECT managers up/down
  • DECT Handset - Push notification
    • In/out of charger
    • Battery level
  1. DECT Manager and or DECT Base - Push notification
  2. How to subscribe for notifications
  3. How to request the current DM and base status
  4. DECT Handset - Push notification in/out of charger
  5. Documentation
Background Color
color#F0F0F0

Anchor
AMLNotificationPushDECT
AMLNotificationPushDECT
1. DECT Manager and or DECT Base - Push notification

Scroll to top


By default, the system will notify the Alarm server if an DECT Manager and/or DECT base is down after 9 minutes outage. This value can be changed via auto-provisioning.


Code Block
languagexml
titleExample of xml file which changes DropoutNotificationTimeout to 60 seconds.
<?xml version="1.0" encoding="UTF-8"?>
<provisioning version="1.1" productID="e2">
   <nvm>
      <param name="AmlGlobal.0.DropoutNotificationTimeout" value="60"/>
   </nvm>
</provisioning>
Code Block
languagexml
titleTo disable functionality DropoutNotificationTimeout needs to be set to value 0.
<?xml version="1.0" encoding="UTF-8"?>
<provisioning version="1.1" productID="e2">
   <nvm>
      <param name="AmlGlobal.0.DropoutNotificationTimeout" value="0"/>
   </nvm>
</provisioning>



Background Color
color#F0F0F0

Anchor
AMLNotificationSubscribe
AMLNotificationSubscribe
2. How to subscribe for notifications

Scroll to top


If you want to receive this information, the alarm server need to subscribe to the MQTT topic.


Example of subscription for any notification.

Code Block
mosquitto_sub -v -t '#' -u "as1" -P "as1" --psk-identity as1 --psk password -p 8884 -h ip_address


Example of subscription for notification regarding status of base stations

Code Block
mosquitto_sub -v -t 'xxl/as-agent/system/as-agent/noti/bsStatus' -u "as1" -P "as1" --psk-identity as1 --psk password -p 8884 -h ip_address


Example of subscription for notification regarding status of dect managers

Code Block
mosquitto_sub -v -t 'xxl/as-agent/system/as-agent/noti/dmStatus' -u "as1" -P "as1" --psk-identity as1 --psk password -p 8884 -h ip_address


Example of subscription for notification regarding the handset status

Code Block
// Example for "ANY" handset
mosquitto_sub -v -t '+/+/as/hs/noti/hs_status' -u "as1" -P "as1" --psk-identity as1 --psk password -p 8884 -h ip_address

// Example for a specific handset
mosquitto_sub -v -t '<dm_id>/<sip_id>/as/hs/noti/hs_status' -u "as1" -P "as1" --psk-identity as1 --psk password -p 8884 -h ip_address


Where:

-u user needs to be added to external client list (webui settings/online-services/application-servers)

--psk is external client password

-p is psk port

-h is ip address of the device

If the AML server subscribes on the required topic, the system will answer with the status

PlantUML Macro
@startuml
!pragma teoz true
participant "Base 589ec60d90ca" as bs1
participant "Base 7c2f80c6e5c2" as bs2
participant "Base 7c2f80f68993" as bs3
box Nx70
participant "MQTT" as mqtt
end box
participant "AML server" as aml

== Example: Subscribe to base station status ==

aml -> mqtt: MQTT subscribe xxl/as-agent/system/as-agent/noti/bsStatus
mqtt -> aml: "{"payload":[{"id":"589ec60d90ca","name":"Office","status":"up"},{"id":"7c2f80c6e5c2","name":"LocalBS","status":"up"},{"id":"7c2f80f68993","name":"Reception","status":"up"}]}"


@enduml



Background Color
color#F0F0F0

Anchor
AMLNotificationCurrentstatus
AMLNotificationCurrentstatus
3. How to request the current DM and Base station status

Scroll to top

With each (new) subscribe or re-subscribe to the above MQTT topic ("Any"), the system will respond with the actual status of the DECT managers and Base stations.

Code Block
titleExample for payload response
"{"payload":[{"id":"589ec60d90ca","name":"","status":"down"},{"id":"7c2f80c6e5c2","name":"","status":"up"},{"id":"589ec60d8c73","name":"","status":"down"}]}"



Background Color
color#F0F0F0

Anchor
AMLNotificationHSstatus
AMLNotificationHSstatus
4. DECT Handset - Push notification in/out of charger

Scroll to top

Power status information contains the following elements:

"charger":

Contains info about status about in charger ("in") or out of charger ("off").

"battery_level":

Contains battery charge level in percent (valid values are 0 to 64 hexadecimal), Value 7f indicates that battery charge level is not available for some reason.

For this feature you need:

  • DECT system software version 2.53 or higher
  • S700H / R700H / SL800H with software release 12 or higher

How to enable this feature:

  1. First you need to enable this feature per handset, this is done via the following MQTT command.
    Below an example to activate this feature for handset "1013"

    Code Block
    mosquitto_pub -t 'as1/hs_status/sip_id/1013/req/hs_status' -m '{"msgId": "hs_status_1013","params": {"sip_id":"1013","hs_status":{"power_status":"on"}}}' 
  2. If operation was successful, response will be sent with current status:

    Code Block
    dm1/1013/as1/hs_status/res/hs_status {"msgId":"hs_status_1013","payload":{"hs_status":{"power_status":"on"},"sip_id":"1013"}} 


  3. If HS does not support sending power status, proper reject reason will be sent:

    Code Block
    dm1/1013/as1/hs_status/res/hs_status {"msgId":"hs_status_1013","payload":{"hs_status":{"rej_reason":"feature_not_supported"},"sip_id":"1013"}} 
  4. To activate power status notifications, the user needs to power cycle the HS (turn it off and on again) or wait up to 3 hours for next automatic location registration.

  5. After successful activation of power status, notifications will be sent when:
    1. HS is put in/out of charger
    2. After location registration (e.g. when HS roams into given DM, when attaching HS after system bootup, automatically every 3 hours)

  6. It will contain status of charging and current battery level (in hex value), e.g.:

    Code Block
    dm1/1013/as/hs/noti/hs_status {"msgId":"hs_status_1013","payload":{"power_status":{"battery_level":"5a","charger":"off"},"sip_id":"1013"}}



Background Color
color#F0F0F0

Anchor
AMLNotificationDocumentation
AMLNotificationDocumentation
5. Documentation

Scroll to top

Alarming, Messaging and Location

Describes the AML functionality FAQ - Alarm, Messaging and Location 


AML installation procedure

How to install/configure the Cordless system to be used in an AML environment. FAQ - AML installation procedure