Versions Compared

Key

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

...

  • Online Mode - authenticate, connect, and manage hardware using the Gumband Dashboard and ServiceCloud.

  • Offline Mode - connect and manage hardware directly in the SDK, no authentication through the Gumband ServicesCloud.

More information about authentication scenarios, including caching the authentication whitelist, see SDK Hardware Authentication Scenarios

...

Note: Gumband hardware connects to the Gumband Services Cloud and to the Gumband SDK using GBTT, the Gumband MQTT Hardware Service.

...

Expand
titleSteps to connect hardware via the Gumband Dashboard

Online mode is all done using in the Gumband DashboardCloud!

Set the Exhibit MQTT IP address

Note: This step is a current limitation of the SDK not registering the IP address where the hardware should connect to, and is planned to be removed in the future.

In the “Hardware” tab for the exhibit, enter the IP address and MQTT port the hardware should connect to. This is typically the IP of the computer running the SDK application, with the default port being 1883.

Enter this information in the format:
<SDK Computer IP>:<SDK GBTT Port> ie. 192.168.1.100:1883

Info

Whenever Anytime associated hardware connects to the cloud / Gumband ServiceCloud, it is provided this IP to be able to connect to the Exhibit SDK. Any changes to this setting will immediately be sent to any online hardware. Any offline hardware will be sent the IP the next time it comes online.

Associate the Hardware with the Exhibit SDK

Insert excerpt
Hardware UI
Hardware UI
nameHWUI Connect to exhibit
nopaneltrue

...

Expand
titleSteps to connect hardware manually

For instances where you want to bypass hardware authentication and management through Gumband ServicesCloud. This could include an on-site installation where there is flakey or non-existent cloud access.

Whitelist the Hardware ID in the SDK

Code Block
languagejs
const { Gumband, Sockets } = require('@deeplocal/gumband-node-sdk');

const EXHIBIT_ID = '40';
const EXHIBIT_TOKEN = 'a45ne3...';

const gb = new Gumband(
    EXHIBIT_TOKEN,
    EXHIBIT_ID,
    './manifest.json',
    {
      gbttEnabled: true, // Enable the hardware MQTT broker
      gbttPort: 1883, // (Optional) port for the MQTT broker, defaults to 1883
      noInternetConnection: true, // SDK needs to run in offline mode to use Hardware ID whitelist
      noInternetHardwareIds: [] // Array of offline hardware IDs
    }
);

gb.on(Sockets.READY, async () => {
    console.log('Gumband Ready!');
});

Configure the Exhibit Application IP on the Hardware

The hardware needs to know the IP of the computer running the SDK application so it knows where to connect to. We’ll configure the hardware to use this IP using the serial configuration interface, and disable the cloud/ Gumband Service Cloud from being able to change it.

Description

Command

Set Exhibit Server to Static

write static_exhibit true

Set Exhibit Server

write exhibit_server XX.XX.XX.XX:1883

...

See SDK Events for more information about these events and the available data in the payloads.

Hardware online/offline event

...