MQTT Topics

From Nottinghack Wiki
Revision as of 22:15, 19 December 2011 by Lwk (talk | contribs) (→‎MatrixMQTT)
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 depreciated in MattrixMQTT but still used via nh-matrix

IRC Bot: nh-holly

Topic Description Notes
nh/irc/tx
nh/irc/rx

Twitter Bot: @Holly533MHz

Topic Description Notes
nh/twitter/tx
nh/twitter/rx/dm
nh/twitter/rx/mention