Serial Configuration Interface

Owned by Thomas Driscoll
Last updated: Mar 17, 2023 by Devon Gardner
2 min read

The hardware has a USB-C port which supports a USB-CDC serial interface to allow for debugging and configuration of the hardware and powering the device. A USB connection is not required if these features are not needed. See Opening Up a Serial Port for easy ways to interact with the device.

Structure

<command> <password> <topic> <data>

  • Password field is only required if the USB password is enabled

  • Topic and Data fields are command specific

  • All commands and topics are lowercase

  • Command is terminated by a CR or NL characters (Return or New Line)

 

Commands <command>

Description

Explanation

write

Write a device setting (see device settings table)

read

Read a device setting (see device settings table)

mqtt

Emulate an MQTT command if usb_mqtt is enabled (see MQTT hardware interface documentation)

help

Returns command help text

ver

Returns the Gumband Firmware Version

restart

Restart the Gumband device

dfu

Restart into the bootloader (device firmware update)

 

Device Settings <topic> <data>

Command

Topic 

Data

read

mac

read device MAC

read/write

net

static or dhcp or offline

read/write

ip

XXX.XXX.XXX.XXX - Writeable only if net is set to static

read/write

gw

Set default gateway

read/write

subnet

Set subnet mask

read/write

dns

Set preferred dns ip (set to 0.0.0.0:0 to use DHCP assigned)

read/write

cloud_server

Set cloud server IP (or address) and port XXX.XXX.XXX.XXX:XXXX

read/write

exhibit_server

Set exhibit server IP and port XXX.XXX.XXX.XXX:XXXX

read/write

cloud_tls_enable

Enable cloud server encryption: true or false

read/write

static_exhibit

true Use locally saved exhibit server instead of cloud assigned server
false Use cloud assigned exhibit server 

write

auth_token

Set device authentication token - generated in the Gumband dashboard when adding new hardware

read/write

hardware_id

Set device hardware ID - generated in the Gumband dashboard when adding new hardware

write

data

Write user data location 32 single byte locations available<start_addr>:<byte>

OR

<byte0>,<byte1>,<byte2> .…

read

data

<start_address>

write

usb_pass

Set USB password - 6 to 16 characters, set to 0 to ignore

read/write

usb_mqtt

true Enable MQTT over USB
false Disable MQTT over USB

When MQTT over USB is enabled: Any valid MQTT topic with corresponding data is supported

Â