Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleTable of Contents
Table of Contents
minLevel1
maxLevel4

...

Initialize a Gumband property that can be used to send and receive data to and from the online dashboard or an exhibit. Every property must be initialized using gubmandCreate() before calling any gumbandSet function that applies to that property.

Info

A property does not get created on the remote server until gumbandSubscribe() is called.

Syntax:

GumbandProp gumbandCreate(const char peripheral, const char property, gmbnd_type_t type)

...

gumbandPublish()
Status
colourYellow
titleUNFINISHED

TBD on the implementation of this, but the intent is to be a type agnostic way to publish.

Syntax:

void gumbandPublish();

...

Functions to send informational messages to the Gumband Cloud dashboard.

Insert excerpt
Hardware Logging & Events
Hardware Logging & Events
nameLog limit
nopaneltrue

gumbandDebug()

https://deeplocal.atlassian.net/wiki/spaces/GS/pages/52822092/Logging+Events#Debug-Logs
Syntax:

void gumbandDebug(const char* text, ...);

...

Code Block
languagecpp
uint8_t test_data = 100;
gumbandDebug("Sending data value of %d...", test_data);

gumbandError()

https://deeplocal.atlassian.net/wiki/spaces/GS/pages/52822092/Logging+Events#Error-Logs
Syntax:

void gumbandError(const char* text, ...);

...

Code Block
languagecpp
const char* error_string = "Example Error";
gumbandError("Warning! Encountered an error with message: %s", error_string);

gumbandNotify()

https://deeplocal.atlassian.net/wiki/spaces/GS/pages/52822092/Logging+Events#Notify

Send a notification message to the Cloud. Anyone who is subscribed to notification messages for this hardware will immediately receive an email notification with the message.

...

Code Block
languagecpp
gumbandNotify("Hello Gumband! I am a notification in your e-mail that something happened.");

gumbandEvent()

https://deeplocal.atlassian.net/wiki/spaces/GS/pages/52822092/Logging+Events#Event-Logs

Send an “Event” to the Cloud. These Events are plotted on a graph and can be viewed in real time on the dashboard. The data can be viewed either as frequency of named Events over time or Event values over time.

...

Code Block
languagecpp
#define FW_VERSION 53
gumbandSetUserFirmwareVer(FW_VERSION);

Note

In most cases it is not recommended to use any of the following 4 functions to configure the hardware, these changes should be made via the configuration interface (link)

gumbandSetAuthToken()

Syntax:

...