Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Page Tree
root@self
startDepth1

...

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:

...

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.

gumbandSetOTAFirmware()

Temporarily puts the hardware device into “OTA firmware update mode” for local updates.

Syntax:

void gumbandSetOTAFirmware(void);

...

Gumband Status API

Functions to monitor the status of the Gumband hardware external connections.

gumbandConnected()

Syntax:

uint8_t gumbandConnected(void);

gumbandCloudConnected()

Syntax:

uint8_t gumbandCloudConnected(void);

...

gumbandExhibitConnected()

Syntax:

uint8_t gumbandExhibitConnected(void);

gumbandUSBConnected()

Syntax:

uint8_t gumbandUSBConnected(void);

...

Functions to control specific aspects of the physical Gumband hardware, support for these functions may vary depending on platform.

gumbandWriteUserData()

Syntax:

void gumbandWriteUserData(uint8_t index, uint8_t data);

gumbandReadUserData()

Syntax:

uint8_t gumbandReadUserData(uint8_t index);

...

gumbandLedSetBrightness()

Syntax:

void gumbandLedSetBrightness(uint8_t pwm);

gumbandLedOn()

Syntax:

void gumbandLedOn(void);

gumbandLedOff()

Syntax:

void gumbandLedOff(void);

gumbandLedToggle()

Syntax:

void gumbandLedToggle(void);

gumbandLedOut()

Syntax:

void gumbandLedOut(uint8_t state);

gumbandLedPWM()

Syntax:

void gumbandLedPWM(uint8_t pwm);

gumbandButtonPressed()

Syntax:

uint8_t gumbandButtonPressed(void);