Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sequence

Source

Message

Destination

1

Gumband Hardware

Subscribe Authenticate

Exhibit Server

2

Exhibit Server

Authenticate request

Gumband Hardware

3

Gumband Hardware

Authenticate token

Exhibit Server

4

Exhibit Server

Authenticate response true

Gumband Hardware

5

Gumband Hardware

Subscribe all peripheral topics

Exhibit Server

6

Gumband Hardware

Heartbeat (Every 16s)

Exhibit Server


...

SYNC Messages

Status
colourRed
titleDePrecated
- See “info” topic, “register” command

Gumband needs some way to make sure its knowledge of peripheral properties are up to date if the Gumband server or MQTT go down at any point and publication messages are missed. In these cases, a SYNC request will be made to each out of date board as soon as the server comes back up. 

...

Command

Text

Description

host

xxx.xxx.xxx.xxx:xxxx

Exhibit server host IP and Port

reboot

-

Reboot the Gumband Hardware

sleep

-

TBD

register

-

Request the hardware to register with the Cloud Server (current functionality of the “sync” topic)

get

-

Request the hardware to publish all of it’s current property values

firmware

-

Enter Device Firmware Update (DFU) mode on Gumband Hardware using the existing Cloud MQTT socket 

firmware_socket

-

Enter Device Firmware Update (DFU) mode on Gumband Hardware using a dedicated TCP socket on port 23 (this only works if that port is not already connected)

control

true/false

Set to true to enable debug mode whereby peripheral control messages can be sent from the Cloud

identify

-

Blink the on board LED to identify this hardware device

error

(see below table)

Allows Gumband server to send error codes to the hardware

...