Skip to content

PROTOCOL.md

Latest commit

 

History

History
50 lines (40 loc) · 2.02 KB

PROTOCOL.md

File metadata and controls

50 lines (40 loc) · 2.02 KB

Room Outbox protocol

An effective protocol for MQTT messages sent by connected props for Escape Room.

Connected props for Escape Room exchange data and messages with a MQTT broker.

Room Outbox protocol is a minimal implementation to structure messages sent by connected props.

However props may use MQTT topics in any way, for example Teletext Props publishes its displayed text as a retained message in a dedicated MQTT topic.

Outbox

Room Outbox protocol defines messages sent in props outbox, which is a MQTT topic structured like this:

Room/Name of the room/Props/Name of the props/outbox

For example:

Room/My room/Props/Raspberry Teletext/outbox

Inbox

The props also subscribes to its dedicated inbox topic to listen to command such as actuators:

Room/Name of the room/Props/Name of the props/inbox

For example:

Room/My room/Props/Raspberry Teletext/inbox

Protocol for outbox

The protocol has been defined to be human readable (so debugging Escape Room is easy) and simple to parse (so low-end MCU can parse it quickly, such as Arduino):

  • CONNECTED is sent when the props is connected to the MQTT broker
  • DISCONNECTED is set as the MQTT will for the outbox topic
  • DATA var1=value1 var2=value2 to report sensors or challenge state
  • REQU command to send a request to another props
  • PROG command to send a program request to the Escape Game controller (Room software)
  • DONE command to report command has been received and done
  • OMIT command to report unsupported command has been received
  • OVER command to report an Escape Game challenge has been complete
  • MESG any interesting stuff to report

Author

Faure Systems (Oct 9th, 2019)