| Table of Contents | ||||
|---|---|---|---|---|
|
...
Example Usage:
gumbandPublish()
TBD on the implementation of this, but the intent is to be a type agnostic way to publish.
Syntax:
void gumbandPublish();
...
void gumbandError(const char* text, ...);
Parameters: | |
|---|---|
text | A text string of the Error message, up to 127 characters allowed. |
… | Variables… |
Example Usage
gumbandNotify()
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. <Link to details for how to subscribe to notifications>
Syntax:
void gumbandEventgumbandNotify(const char* text, uint32_t val););
Parameters: | |
|---|---|
text | A message associated with the notification, up to 127 characters allowed. |
Example Usage:
gumbandEvent()
Send an “Event” to the Cloud. These Events are plotted on a graph and can be viewed in realtime on the dashboard. The data can be viewed either as frequency of named Events over time or Event values over time.
Syntax:
void gumbandEvent(const char* text, uint32_t val);
Parameters: | |
|---|---|
text | A text string name for the Event. Events are grouped by matching name. |
val | An optional value for the event. |
Example Usage:
...
Gumband Configuration API
...
gumbandSetUserFirmwareVer()
This sets the version number for the user firmware. This is separate from the Gumband version and is an optional value that is visible from the overview dashboard on the Cloud server and available to the Exhibit. This can be any integer and allows you to keep track of the current firmware on the device. This must be called before gumbandSubscribe().
Syntax:
void gumbandSetUserFirmwareVer(uint8_t fw);
Parameters: | |
|---|---|
fw | A byte value (0-255) indicating the current firmware version. |
| Note |
|---|
Notes: 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:
...
void gumbandSetCloudServer(const char* addr);
gumbandSetExhibitServer()
Set the IP of the exhibit server, the static_flag variable can be set to the version number for the user firmware. This is separate from the Gumband version and is an optional value that is visible from the overview dashboard on the Cloud server and available to the Exhibit. This can be any integer and allows you to keep track of the current firmware on the device. This must be called before gumbandSubscribe().
Syntax:
void gumbandSetExhibitServer(const char* addr, uint8_t static_flag);
Parameters: | |
|---|---|
addr | A text string of the IP address |
static_flag | A “boolean”, set to 1 to indicate this Exhibit address should override the Exhibit address set by the Cloud server. |
...
Gumband Status API
Functions to monitor the status of the Gumband hardware external connections.
...