MQTT Topics

From Nottinghack Wiki
Jump to navigation Jump to search

This is the list of MQTT Topics that are use by the various HackSpace Instrumentation projects.

All topics should be prefixed with "nh/"

STATUS

nh/status
All clients should subscribe to the topic and listen for the message "STATUS"
Clients should respond with there name and status.

Three states

  • Restart:
  • Running:
  • Terminated:

ie. "Running: MatrixMQTT"

Include the : and a space before the clients name,

Current list of clients

  • MatrixMQTT
  • Gatekeeper (arduino)
  • nh-irccat
  • nh-irc
  • nh-matrix
  • GateKeeper (process)
  • nh-gk-if
  • nh-irc-misc

The status of all running clients is logged and reported here http://lspace.nottinghack.org.uk/addr_graphs/status.php

Gatekeeper

Topic Description Notes
nh/gk/Unlock
nh/gk/DoorState
nh/gk/Keypad
nh/gk/DoorButton
nh/gk/RFID
nh/gk/LastManState
nh/gk/Status

MatrixMQTT

Topic Description Notes
nh/mb/tx nh-matrix script transmits messages to be displayed
nh/mb/rx confirmation of displayed message is returned to nh-matrix
nh/mb/Status deprecated in MattrixMQTT 004 but still used via nh-matrix

IRC Bot: nh-holly

Living in #nottinghack on freenode, nh-holly is our MQTT to IRC bridge

Topic Description Notes
nh/irc/tx Sends to the default #nottinghack channel
nh/irc/tx/nottinghack Sends to the #nottinghack channel
nh/irc/tx/pm/<nick> Sends a pm to <nick>
nh/irc/rx/nottinghack/<nick> Incoming message from irc #nottinghack channel
nh/irc/rx/pm/<nick> Incoming pm from irc user <nick>

@Holly533MHz: nh-twitter

Twitter to MQTT bridge

Topic Description Notes
nh/twitter/tx
nh/twitter/rx/dm/<screen_name DM to @Holly533Mhz from <Screen_name>
nh/twitter/rx/mention/<screen_name> mention of @Holly533Mhz by <screen_name>
nh/twitter/rx/hs latest tweet from @HSNOTTS includes retweets payload <screen_name>:<text>

Temperature

Readings from DS18B20 1-Wire digital temperature sensors around the space are published every 2.5 minutes.
nh/temp
Message format as follows
address:temp

address Hex string 16 long
temp Float 00.00