From 2d35379614c34b468c185f3f2d2c678114fd38cd Mon Sep 17 00:00:00 2001 From: Nicolas Klier Date: Sat, 14 Nov 2020 17:31:43 +0100 Subject: [PATCH] --- Notification.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 Notification.md diff --git a/Notification.md b/Notification.md new file mode 100644 index 0000000..4f58af2 --- /dev/null +++ b/Notification.md @@ -0,0 +1,16 @@ +# Notifications +Notifications are sent over MQTT/AMQT to all devices that have subscribed to a specific topic. + +## Get notifications +All traffic goes over the default topic `amq.topic` but you have to subscribe with a routing key which is equal to your user ID. If your routing key does not match with your own user ID, access will be denied. +## Events + + +| Event name | Values | Description | +| -------- | -------- | -------- | +| beat | Beat interface | A new beat is available. | +| phone_alive | Phone interface | Phone is now available and is sending data. | +| phone_dead | Phone interface | Phone is now offline and will stop sending any data. | +| phone_register | Phone interface | A phone tries to register and has to be confirmed by the user. | +| panic | Phone interface | A phone triggered the panic feature which will be broadcast to every user. | +