===== SmartSpace =====

SmartSpace is a project to enhance the space with Internet of Things type of devices and services.

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 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]]

==== Operations ====

=== Sources ===

The SmartSpace repository is hosted on GitHub:

[[https://github.com/vhs/SmartSpace]]

Access via #vhs-it-ops on Slack

=== Use ===

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:

Controlled:
^ Type ^ Topic Naming ^ Purpose ^ Read Access ^ Write Access ^
| Config | / config / //device// | Push configurations to devices | VHS Restricted | VHS Restricted |
| Devices | / devices / //device// / //key// | Push/update specific device settings or values | VHS Restricted | VHS Restricted |
| Events | / events / //category// / //name// | Topic for single event reporting | Public | VHS Restricted |
| Status | / status / //category// / //key// | Topic for general status reporting. | Public | VHS Restricted |
| Projects | / projects / //project// / //key// / | Topic for project specific things | Public | Project Restricted |
| Tests | / test / //anything// | Topic for testing | Public | Public |

Special categories:
  * //services//
  * //space//

=== Examples ===
  * SIP monitor reports its status to /status/services/sip-to-mqtt and incoming calls to /events/phone/ring