Differences

This shows you the differences between two versions of the page.

--- infrastructure:smartspace [2019/04/06 22:59] – created tyisi
+++ infrastructure:smartspace [2019/04/08 20:32] – tyisi
@@ Line 3: / Line 3: @@
 SmartSpace is a project to enhance the space with Internet of Things type of devices and services.
-SmartSpace consists of three parts:
+SmartSpace consists of three components:
   * SpaceBus, a Mosquitto-based MQTT broker service that will allow users/devices/services to pass messages. SpaceBus features a controlled part for protected use (such as phone notifications) and an open part for general use
-  * SmartSpace services, a variety of services that can connect to the SpaceBus, including Node-Red, Grafana, Influxdb, SIP monitoring and URL monitoring
+  * SmartSpace services, a variety of services that can connect to the SpaceBus, including Sergeant, Node-Red, Grafana, Influxdb, SIP monitoring and URL monitoring
   * SmartSpace devices, devices around the space that either act as consumers or publishers on the SpaceBus. Example: visual phone notification aids or automatic sign control based on [[hacks:isvhsopen]]
@@ Line 21: / Line 21: @@
 While this is under development, ask in #vhs-it-ops
+==== SpaceBus ====
+=== Use ===
+For now, read only access is available on spacebus.vanhack.ca on port 1883
+=== Topics ===
+SpaceBus uses the following patterns/naming conventions:
+^ Type ^ Topic Naming ^ Purpose ^
+| Config | / config / //device// | Push configurations to devices |
+| Devices | / devices / //device// / //key// | Push/update specific device settings or values |
+| Events | / events / //category// / //name// | Topic for single event reporting |
+| Status | / status / //category// / //key// | Topic for general status reporting. |
+Special categories:
+  * //services//
+  * //space//
+=== Examples ===
+  * SIP monitor reports its status to /status/services/sip-to-mqtt and incoming calls to /events/phone/ring