Versions Compared

Key

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

...

Code Block
languagecpp
gumbandSetDescription(motor_speed_prop, "This property controls the speed of the motor.")

gumbandSetHidden()
Status
colourRed
titleUNFINISHED

Set the property as hidden to prevent it from being displayed on the Gumband Cloud dashboard. This has no affect on the Exhibit server.

...

Code Block
languagecpp
gumbandSetHidden(motor_speed_prop); // Hide the motor speed property from the dashboard

gumbandClearHidden()
Status
colourRed
titleUNFINISHED

Set the property as visible to allow it to be shown on the Gumband Cloud dashboard.

...

Code Block
languagecpp
// Create all peripherals and their properties
GumbandProp first_prop = gumbandCreate("My Peripheral", "First", gmbnd_byte);
GumbandProp second_prop = gumbandCreate("My Peripheral", "Second", gmbnd_byte);
...
// Register the peripherals and properties with the broker
gumbandSubscribe();

gumbandPublish()
Status
colourRed
titleUNFINISHED

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

Syntax:

void gumbandPublish();

...

Code Block
languagecpp
GumbandProp my_prop = gumbandCreate("My Peripheral", "My Property", gmbnd_byte);
...
uint8_t data_val = 100;
gumbandPublishByte(my_prop, data_val); // Publish the value of 100 to "My Property"

gumbandPublishByteArray()
Status
colourRed
titleUNFINISHED

Publish an array of bytes to a property of type gmbnd_byte and length >1.

...

Code Block
languagecpp
GumbandProp my_prop = gumbandCreate("My Peripheral", "My Integer", gmbnd_byte);
...
int32_t data_val = -1000;
gumbandPublishInt(my_prop, data_val); // Publish the value of -1000 to "My Integer"

gumbandPublishIntArray()
Status
colourRed
titleUNFINISHED

Publish an array of uint32 to a property of type gmbnd_int32 and length > 1.

...

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 gumbandNotify(const char* text, ...);

...

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:

...