Hardware UI

To create credentials for your hardware device, you’ll need to login to app.gumband.com and have developer-level or manager-level permission.

1. Navigate to a Site under which this hardware will exist.

Sites > [Project Site] > Hardware

2. Click “Create Hardware”.

Open

The ‘Create Hardware’ button located in the top-right corner of the hardware page. It might look like a '+' on a mobile device or in a small window.

3. Enter a descriptive name for the hardware device and press “Create”.

Note: this is visible to everyone in the organization so include your name or initials or project name as applicable, for example “Thomas Test” or instead of simply “Test”.

Open

4. Note the Hardware ID and Token

The software will automatically generate a unique hardware ID and authentication token to use on the hardware. Make note of this token or copy it to your clipboard; you’ll need to give it to the hardware to configure it.

Note: if you lose this authentication token, you can create a new one anytime from the ‘Auth’ tab on the dashboard.

Users can view and test Hardware Peripherals under the “Peripherals” tab. Peripherals are only interactive when the debug mode is On to prevent interrupting live usage of the Exhibit. Debug mode can be toggled through the switch on the left of the Hardware device name. Usually, the debug mode will be off in production and on during development and testing. Doing this optimizes latency for local Exhibits and reduces load on the Gumband infrastructure.

When the debug mode is On, all peripheral values such as encoder information and button clicks are sent and updated in real-time in this view. When the debug mode is Off, all peripheral values are greyed-out so they are no longer interactive.

The properties on this page are grouped by their parent property and then sorted by the order determined during registration, which usually is the order they were created in the user code.

See how properties are registered for more information.

Similar to an Exhibit, Hardware logs can be viewed under the “Logs” tab. This view will contain all logs sent by the Hardware device in real-time and will also allow the user to filter the logs by date or event type.

Similar to Exhibits, Hardware reports can be viewed under the “Reports” tab. These reports can aggregate on any developer-defined such as the number of times a button was pressed or the CPU booted.

This can alternatively be done from the Exhibit SDK’s Hardware Tab.

1. Navigate to the hardware you want to add.

Sites > [Project Site] > [Hardware] > Overview

2. In the “Overview” tab, click “Connect to Exhibit”.

3. Choose the Exhibit SDK to connect to.

A modal will pop up and display all available Exhibits within the same organization.

The hardware is set to connect to an Exhibit SDK if the Exhibit name is displayed in the “Overview” tab.