API Reference (V2.0.0 - Latest)

Owned by Luke Derrick
Last updated: Oct 10, 2024
18 min read

SDK Configuration Options

Here is a list of the configuration options that the SDK constructor takes as parameters.

constructor (token: string, exhibitId: number, manifest: Object, options = {})

token

The exhibit token generated through the Exhibit/Auth tab in the Gumband UI. This is required to authenticate the SDK with Gumband.

exhibitId

The ID of the exhibit in Gumband. This can be found under the Exhibit/Auth tab in the Gumband UI. This is required to authenticate the SDK with Gumband.

manifest

The exhibit manifest. See the Exhibit Manifest Configuration docs for how to structure the manifest object.

options

All of the remaining optional parameters that enables certain features of the Gumband SDK.

contentLocation: string

Including this option tells the SDK to download a copy of each file in the Exhibit/Files tab of the Gumband UI and save them in this location. The SDK will automatically sync these files each time it starts and connects to Gumband, but the files can also be synced manually with the gb.content.sync() function.

endpoint: string

Set to “app” by default. May be set to “custom” if app.gumband.com is not the instance of Gumband to which you’re connecting your exhibit. If set to “custom”, the sdk can connect the “customServerIP” option or 0.0.0.0 if “customServerIP“ is left undefined.

customServerIP: string

If the “endpoint” configuration option is set to “custom”, this option can be set in order to tell the SDK the IP address of the Gumband server to which it is connecting. Set to 0.0.0.0 by default.

version: string

The version of the Gumband Cloud to which the exhibit should connect. Set to “v1” by default.

noInternetConnection: boolean

Tells the SDK that the exhibit is expected to be disconnected from the internet, and should not attempt to authenticate with Gumband.

allowOnlyCloudHardwareIds: boolean

Tells the SDK only to allow messages from hardware associated with the same exhibit as the SDK.

allowedHardwareIds: number[]

A whitelist of hardware IDs. The SDK is only permitted to process messages from hardware on this whitelist. By default, messages from all hardware IDs are permitted.

useLocalMQTTBroker: boolean

Whether a local MQTT broker should be started when the SDK is initialized. This MQTT broker is used to communicate with Gumband Hardware.

MQTTBrokerIP: string

An IP for the user provided MQTT broker. The SDK will attempt to open an MQTT client connection to this IP and the port from the MQTTBrokerPort option.

MQTTBrokerPort: number

This option is the port that the local MQTT broker is exposed on, or the port that the SDK should attempt to connect to if running a third part MQTT broker.

skipOrganizationFileSync: boolean

Set to true by default. Tells the SDK not to download all organization files along with the exhibit files when the “contentLocation” option is provided. Exhibit files are only accessible by the exhibit under the Exhibit/Files tab in the Gumband UI, but organization files are available to all exhibits under the organization and can be seen under each exhibits' Files tab. Organization files are prefixed by “[ORG]” and are managed by the Strapi CMS.

SDK Base Function Library

isReady( )

Returns true if Gumband is connected to the Gumband Cloud and is ready to process requests. Useful when the Gumband SDK is initialized in multiple places since the constructor returns a singleton and it is possible to "miss" the READY event if an event listener is not configured yet.

setManifest(manifestLocation: string): Promise<void>

Use a local manifest to update the exhibit items on the gumband cloud. This function updates the SDK cache of the manifest as well.

manifestLocation

The directory path to the manifest.

gumbandSDK.setManifest('./path/to/manifest.json');

getOperatingMode( ): Promise<boolean>

The Operating Mode feature is deprecated and disabled by default. You can continue to use it, but we plan to replace it with a more functional feature in the future. When the feature is disabled, this method will always resolve false. To enable the OperatingMode feature, call the setOperatingMode method once while the SDK is connected to the Gumband platform.

Get the current operating mode for the exhibit from Gumband.

let operatingMode = await gumbandSDK.getOperatingMode(); console.log(`Operating Mode: ${operatingMode}`); // Operating Mode: true

setOperatingMode(opMode: boolean): Promise<void>

The Operating Mode feature is deprecated and disabled by default. You can continue to use it, but we plan to replace it with a more functional feature in the future. To enable the OperatingMode feature, call the setOperatingMode method once while the SDK is connected to the Gumband platform.

Set the operating mode for the exhibit in Gumband.

opMode

The target operating mode.

getStatus(statusName: string): Promise<string>

Get the value of a status from Gumband.

statusName

The “id” field of the status in the manifest.

setStatus(statusName: string, value: string): Promise<void>

Set the value of a status in Gumband.

statusName

The “id” field of the status in the manifest.

value

The target value to which the status should be set.

getSetting(manifestId: string): Promise<string>

Get the value of a setting from Gumband.

manifestId

The “id” field of the setting in the manifest.

setSetting(settingName: string, value: string): Promise<void>

Set the value of a setting in Gumband.

settingName

The “id” field of the setting in the manifest.

value

The target value to which the setting should be set.

getAllSettings( ): Promise<Map<Setting>>

Get all settings as a map, where the key is the “id” field of each setting in the manifest.

getAllSettingLists( ): Promise<SettingList[ ]>

Get all setting lists in the manifest as an array.

getOnlineHardware( ): Hardware[ ]

Get the list of Gumband Hardware that are currently connected to the SDK.

Exhibit

exhibit.getManifest( ): Promise<Manifest>

Get the full manifest of this exhibit from Gumband.

exhibit.getStrapiContentSetting(id: number): Promise<StrapiContent>

Get an exhibit setting with type StrapiContent.

id

The database ID of the StrapiContent.

Hardware

hardware.setProperty(id: string, topic: string, value: any, options: any): Promise<void>

Set a hardware property to a value.

id

A string of the form ed028e04-41d9-4e77-a5d2-ab4e7346e3a7. This is the hardware ID.

topic

A string of the form property/path, which is the name and path to the property that is having its value set.

value

The new value to which the property will be set.

[options.source]

The source of the property. Can be either “system”, which come on the Gumband Hardware by default, or “app”, which are created in the user firmware. This value will be set to “app” by default.

hardware.getProperty(id: string, topic: string): Promise<any>

Get the value of the given property.

id

A string of the form ed028e04-41d9-4e77-a5d2-ab4e7346e3a7. This is the hardware ID.

topic

A string of the form property/path, which is the name and path to the property that is having its value set.

[options.source]

The source of the property. Can be either “system”, which come on the Gumband Hardware by default, or “app”, which are created in the user firmware. This value will be set to “app” by default.

 

hardware.getRegisteredProperties(id: string): Promise<Property[ ]>

Get all registered properties for a hardware. Will not include values for those properties

id

A string of the form ed028e04-41d9-4e77-a5d2-ab4e7346e3a7. This is the hardware ID.

[options.source]

The source of the property. Can be either “system”, which come on the Gumband Hardware by default, or “app”, which are created in the user firmware. This value will be set to “app” by default.

 

hardware.reboot(id: string): Promise<void>

Triggers a reboot of the hardware matching the given ID.

id

A string of the form ed028e04-41d9-4e77-a5d2-ab4e7346e3a7. This is the hardware ID.

hardware.identify(id: string): Promise<void>

Triggers the hardware matching the given ID to identify itself by flashing its LED.

id

A string of the form ed028e04-41d9-4e77-a5d2-ab4e7346e3a7. This is the hardware ID.

hardware.getExhibitHardware( ): Promise<Response<Hardware[ ]>>

Get all hardware associated with this exhibit in the Gumband UI.

hardware.sendMqttMessage(topic: string, rawPayload): Promise<void>

Sends an MQTT message directly to the hardware with the given topic and rawPayload.

topic

A string of the form {hardwareId}/{prop}, where hardwareId is the ID of the hardware found under the Hardware/Auth tab in the Gumband UI, and prop is the name of the property that is having its value set.

rawPayload

The raw value to be sent directly by the hardware.

hardware.getAllRegisteredHardware(): Promise<Map<Hardware>>

Gets a map of all registered hardware keyed by the hardware id.

 

hardware.getRegisteredHardware(id: string): Promise<Hardware>

Gets a hardware that is registered.

id

A string of the form ed028e04-41d9-4e77-a5d2-ab4e7346e3a7. This is the hardware ID.

 

hardware.getIdFromName(name: string): Promise<string>

Gets a hardware id from the given name.

name

The name of the hardware that the user gave it in the Gumband UI.

 

Content

content.getRemoteFileList( ): Promise<Response<File[ ]>

Get a list of all remote file names. These file names will match the files list under the Exhibit/Files tab in the Gumband UI.

content.getLocalFileList( ): File[ ]

Get a list of all locally saved file names for the exhibit.

content.sync( ): Promise<void>

Sync locally saved files with the list of remote files. This is called whenever the SDK makes a connection to Gumband if local files is enabled.

content.uploadFile(fileStream: ReadStream): Promise<void>

Uploads a file to the list of remote files for the exhibit.

fileStream

A stream of data from a function such as fs.createReadStream("path/to/file").

content.downloadFile(file: string): Promise<void>

Downloads the given file name from the remote list of files for the exhibit in Gumband, and saves it in the contentLocation directory for the locally saved exhibit files. Existing files with the same name will be overwritten.

file

The name of the file.

Event

event.create(eventName: string, data: any): Promise<void>

Creates a reporting event of the given event name, and includes the data object given as an object on the event.

eventName

The name of the reporting event.

data

Any data object to be associated with the event.

Logger

logger.info(message: string): Promise<void>

Logs a message to Gumband as an “info” level log. Logs can be viewed under the Exhibit/Logs tab in the Gumband UI.

message

The message for the log.

logger.debug(message: string): Promise<void>

Logs a message to Gumband as an “debug” level log. Logs can be viewed under the Exhibit/Logs tab in the Gumband UI.

message

The message for the log.

logger.warn(message: string): Promise<void>

Logs a message to Gumband as an “warn” level log. Logs can be viewed under the Exhibit/Logs tab in the Gumband UI.

message

The message for the log.

logger.error(message: string): Promise<void>

Logs a message to Gumband as an “error” level log. Logs can be viewed under the Exhibit/Logs tab in the Gumband UI.

message

The message for the log.

Metrics

metrics.broadcastEventConfigs(manifest: object)

Sends metrics configurations from the manifest to the gumband cloud

metrics.create(eventName: string, data: object)

Creates a metrics event for a given exhibit

metrics.endInteraction(data?: object)

Ends an active interaction for a given exhibit.

metrics.startInteraction(data?: object)

Starts an active interaction for a given exhibit.

metrics.createConcurrent(eventName: string, data: object, interactionId?: string): string

This method is identical to the create method except that it attaches an interactionId to each event, so Gumband can tell the difference between events for different, concurrent interactions. It will return the generated interactionId so it can be attached to future events for this interaction.

metrics.startConcurrentInteraction(data: object, interactionId?: string): string

This method is identical to the startInteraction method except that it generates and attaches an interactionId to each event, so Gumband can tell the difference between events for different, concurrent interactions. It will return the generated interactionId so it can be attached to future events for this interaction.

metrics.endConcurrentInteraction(data: object, interactionId: string): string

This method is identical to the endInteraction method except that it attaches an interactionId to each event, so Gumband can tell the difference between events for different, concurrent interactions.

Notification

notifications.email(message: string): Promise<void>

Sends a custom email notification through Gumband. Custom email notifications can be subscribed to on an individual user basis under the Exhibit/Notifications tab of the Gumband UI.

message

The message for the custom email notification.

Websocket Events

This is a list of the possible websocket events that may be emitted by the SDK; for example:

Sockets.READY

Emitted after the SDK successfully authenticates with Gumband, comes online, and is ready to make requests to Gumband.

Sockets.EXHIBIT_ONLINE

Emitted when the SDK successfully authenticates with Gumband and comes online.

Sockets.EXHIBIT_OFFLINE

Emitted when the SDK losses its websocket connection with Gumband.

Sockets.CONTROL_RECEIVED

Emitted when a control is triggered, usually through the Exhibit/Controls tab in the Gumband UI.

Sockets.SETTING_RECEIVED

Emitted when a setting is changed, usually through the Exhibit/Settings tab in the Gumband UI.

Sockets.SETTING_LIST_RECEIVED

Emitted when a new setting list item is added or deleted, when the setting list items have their order changed, or when a setting within a setting list item is changed. The payload is the new setting list with all of its items.

Sockets.SETTING_LIST_ITEM_DELETED

Emitted when a setting list item is deleted. The payload is the setting list item that was deleted.

Sockets.OP_MODE_RECEIVED

The Operating Mode feature is deprecated and disabled by default. You can continue to use it, but we plan to replace it with a more functional feature in the future. While the feature is disabled, this event will not be emit to your software. To enable the OperatingMode feature, call the setOperatingMode method once while the SDK is connected to the Gumband platform.

Emitted when the Operation Mode is changed, usually through the Exhibit dashboard in the Gumband UI.

Sockets.HARDWARE_CONNECTED

Emitted when a Gumband Hardware connects to the exhibit SDK.

Sockets.HARDWARE_DISCONNECTED

Emitted when a Gumband Hardware disconnects from the exhibit SDK.

Sockets.HARDWARE_SYSTEM_REGISTERED

Emitted after a Gumband Hardware connects to and registers its system info/properties with the exhibit SDK.

Sockets.HARDWARE_APP_REGISTERED

Emitted when a Gumband Hardware connects to and registers its app info/properties with the exhibit SDK.

Sockets.HARDWARE_FULLY_REGISTERED

Emitted when a Gumband Hardware connects to and registers its app and system info/properties with the exhibit SDK.

Sockets.HARDWARE_SYSTEM_PROPERTY_RECEIVED

Emitted when a system property is changed in a Gumband Hardware that is connected to the exhibit.

Sockets.HARDWARE_APP_PROPERTY_RECEIVED

Emitted when an app property is changed in a Gumband Hardware that is connected to the exhibit.

Sockets.HARDWARE_PROPERTY_RECEIVED

Emitted when either a system or app property is changed in a Gumband Hardware that is connected to the exhibit.

Sockets.FILE_UPLOADED

Emitted when a new file has been uploaded to Gumband, usually through the Exhibit/Files tab of the Gumband UI.

Sockets.FILE_DELETED

Emitted when a file is deleted from Gumband, usually through the Exhibit/Files tab of the Gumband UI.

Sockets.ERROR

Emitted when any error is logged to the local logger via Gumband.