Hardware UI

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

2. Click “Create Hardware”

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

4. Note the Hardware ID and token for initializing the Hardware library

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.

Run a Report

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.

Connect to an Exhibit

1. In most cases, Hardware will eventually connect to an Exhibit and start interfacing with it. To do so, head over to the “Overview” tab and click “Connect to Exhibit”.

2. A modal will pop up and display all available Exhibits within the same organization. Choose the Exhibit to connect to.

3. The hardware has successfully connected to the Exhibit if the Exhibit name is displayed in the “Overview” tab.