...
| Table of Contents |
|---|
...
|
...
|
...
Online reference coming soon.
...
Online reference coming soon.
...
|
| Anchor | ||||
|---|---|---|---|---|
|
A Gumband communication instance (only one can exist per device). Functions for this class are listed below:
...
GumbandConnection MyGumband;
| Anchor | ||||
|---|---|---|---|---|
|
Initiates the Gumband connection.
...
MyGumband.begin();
MyGumband.begin(1);
| Anchor | ||||
|---|---|---|---|---|
|
Sets the Hardware ID of the Gumband Hardware. This is a unique identifier generated by the Gumband UI. Each separate registered Gumband Hardware device receives its own ID. This ID is required to link Hardware to a specific Exhibit in the Gumband UI.
...
void id(const char* id);
Example Usage:
MyGumband.id(16);
MyGumband.id(“16”);
| Anchor | ||||
|---|---|---|---|---|
|
Set the Gumband master control server username. This must match the username created for this device within the Gumband UI.
...
MyGumband.username(“MarlonBando”);
| Anchor | ||||
|---|---|---|---|---|
|
Set the Gumband master control server password. This must match the password created for this device within the Gumband UI.
...
MyGumband.password(“P455W0RD!”);
| Anchor | ||||
|---|---|---|---|---|
|
Returns ‘1’ if the Hardware has a valid network connection.
...
if(MyGumband.connected() == 1) { //Connected to Network }
| Anchor | ||||
|---|---|---|---|---|
|
Returns ‘1’ if the Hardware has a valid master server connection.
...
if(MyGumband.connectedMaster() == 1) { //Connected to Master }
| Anchor | ||||
|---|---|---|---|---|
|
Returns ‘1’ if the Hardware has a valid Exhibit server connection.
...
if(MyGumband.connectedExhibit() == 1) { //Connected to Exhibit }
| Anchor | ||||
|---|---|---|---|---|
|
Publish a text message to the ‘event’ log.
...
MyGumband.event(“An event has occurred!”);
| Anchor | ||||
|---|---|---|---|---|
|
Publish a text message to the ‘error’ log.
...
MyGumband.error(“An error has occurred!”);
| Anchor | ||||
|---|---|---|---|---|
|
Publish a text message to the ‘debug’ log.
...
MyGumband.debug(“Something routine has occurred!”);
| Anchor | ||||
|---|---|---|---|---|
|
Print data to the Hardware USB serial port.
...
MyGumband.print(“Hello World!”);
MyGumband.print(25);
| Anchor | ||||
|---|---|---|---|---|
|
An instance of a Gumband property or endpoint. An individual instance must exist for every Gumband property in the Exhibit.
...
GumbandProperty MyProperty;
| Anchor | ||||
|---|---|---|---|---|
|
This function creates a named property within a named peripheral container and registers it with the Gumband server so we can publish or subscribe to it. A Gumband instance must first exist before this function will succeed.
...
MyProperty.begin(“PeripheralName”, “PropertyName”, gmbnd_button);
| Anchor | ||||
|---|---|---|---|---|
|
Publish data to the property endpoint.
...
MyProperty.publish(values, 5); //values[5] = {3,5,8,1,0}Anchor
Bundles support an AT command set over a serial interface.
...
Empty test command, Bundle will respond with “OK” if successfully receiving AT commands.
...
Change or initialise Gumband settings.
Syntax:
AT+GBSET=<HardwareId>,<Firmware>
Example Usage:
AT+GBSET=7,10
...
Set the Gumband Master server authorization credentials.
Syntax:
AT+GBAUTH=<Username>,<Password>
Example Usage:
AT+GBAUTH=”MarlonBando”,”P455W0RD!”
...
Create a Publish or Subscribe Property
Syntax:
AT+GBCREATE=<Pub/Sub>,<Peripheral>,<Property>,<Type>
Example Usage:
AT+GBCREATE=Pub,”Front Panel”,Button,gmbnd_button
AT+GBCREATE=Sub,”Front Panel”,LED,gmbnd_led
...
Publish to a Property
Syntax:
AT+GBPUB=<Peripheral>,<Property>,<Data>
Example Usage:
AT+GBDEBUG=”Motor Enabled”
...
Publish an Error message.
Syntax:
AT+GBERROR=<Text>
Example Usage:
AT+GBERROR=”Motor Stall Detected!”
...
Publish a Debug message.
Syntax:
AT+GBDEBUG=<Text>
Example Usage:
AT+GBDEBUG=”Motor Enabled”
...
Publish an Event message.
Syntax:
AT+GBEVENT=<Text>
Example Usage:
AT+GBEVENT=”A user pushed the start button”
...
Data from a subscribed property, this command is sent from the device and cannot be written to.
Syntax:
+GBSUB=<Peripheral>,<Property>,<Data>
Example Usage:
AT+GBSUB=”Front Panel”,LED,0x00F0
...
Property Type
...
Size
...
Description
...
gmbnd_button
...
1 byte
...
Momentary Button -
0 = Release
1 = Press
2 = Toggle/Moment
...
gmbnd_switch
...
1 bool (byte)
...
Toggle Switch -
0 = Off
1 = On
...
gmbnd_encoder
...
4 bytes
...
32-bit number
...
gmbnd_relay
...
1 bool (byte)
...
Relay -
0 = Off
1 = On
...
gmbnd_pwm
...
4 bytes
...
PWM Duty Cycle
...
gmbnd_led
...
2 bytes
...
Brightness
...
gmbnd_motor_position
...
4 bytes
...
gmbnd_motor_speed
...
4 bytes
...
gmbnd_motor_accel
...
4 bytes
...
gmbnd_step_motor
...
4 bytes
...
gmbnd_addr_led
...
7 bytes
...
IARGBW
I = Index (16bit)
A = alpha/brightness
RGBW = Color Bytes
...
gmbnd_byte
...
1 byte
...
Generic 8 bit number
...
gmbnd_int32
...
4 bytes
...