Page Tree | ||||
---|---|---|---|---|
|
...
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:
...
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);
...
Temporarily puts the hardware device into “OTA firmware update mode” for local updates.
Syntax:
void gumbandSetOTAFirmware(void);
...
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);