Difference between revisions of "MQTT Topics"

From Nottinghack Wiki
Jump to navigation Jump to search
m
Line 4: Line 4:
  
 
==STATUS==
 
==STATUS==
nh/Status
+
nh/status
  
 
All clients should subscribe to the topic and listen for the message "STATUS"
 
All clients should subscribe to the topic and listen for the message "STATUS"
  
Clients should respond with there name and "Running" status.  
+
Clients should respond with there name and status.  
  
ie. "MatrixMQTT Running"
+
Three states
 +
* Restart:
 +
* Running:
 +
* Terminated:
  
Clients may also report there "Restart" and termination "Terminated"
+
ie. "Running: MatrixMQTT"
  
The status of all running clients is logged and reported here...
+
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]]==
 
==[[Gatekeeper]]==

Revision as of 12:55, 17 December 2011

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/mb/rx
nh/mb/Status


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