Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

...

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

Example Usage:

Code Block
languagecpp
GumbandProp motor_start = gumbandCreate("Motor", "Spin", gmbnd_bool);
GumbandProp motor_speed = gumbandCreate("Motor", "Speed", gmbnd_int32);

...

int8_t gumbandSetReadCallback(GumbandProp handle, callback_func read_callback);

Example Usage:

Code Block
languagecpp
GumbandProp motor_start = gumbandCreate("Motor", "Spin", gmbnd_bool);

void motorStartCallback(uint16_t length, void* data) {
  // Do something
}

gumbandSetWriteCallback()

...

Example Usage:

gumbandPublish()

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

Syntax:

void gumbandPublish();

...

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:

...