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. |
+