RQ

Overview

Redqueen is a way to pass messages between all the iot devices we have at the shop in a way that is documented and expected.

Network Setup

We currently have two mqtt brokers setup, one that is local to the shop and is wide open for anything to send/receive. The other broker is located on our remote webserver and is exposed publicly with SSL and a username/password, meaning you will need to ask an Admin for access. All messages are mirrored between the brokers.

 Local only             Available from outside
--------------         --------------------------
| iot server |  <----> | remote.makerslocal.org |
--------------         --------------------------

Messages

Messages will be send in 1st person. As in "I (door) changed my status to open.". This is different than "Hey you, door....OPEN!".

MQTT Info

Local Host

• dns: iot
• ip: 10.56.0.18
• port: default, 1883
• user/pass: Not needed

Remote Host

• host: 256.makerslocal.org
• port: 35801
• user/pass: Ask admin for access

Messages

IRC

rqirc will send out a message for thing like '!string'.

example: !alert I cut my finger off
/ml256/irc/makerslocal/command/alert {"command":"alert", "channel":"#makerslocal", "user":"jimshoe", "message":"I cut my finger off"}
example: !shopstatus
/ml256/irc/gen/command/alert {"command":"alert", "channel":"##gen", "user":"tylercrumpton", "message":""}

History

This is the documentation for the current version of RedQueen. RedQueen is a documented way to pass messages between devices inside and outside the shop. We have gone through a few versions.

• RQ/v1 - Initial ideas
• RQ/v2 - Tyler's initial python bot, which is doing all the messages passing
• RQ/v3 - Our attempt to use Couchdb to do all the message passing.
• RQ/v4 - This page