Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Gumband Exhibits

What is an Exhibit?

The Gumband platform is centered around building and maintaining Exhibits, interactive experiences built with a combination of software and hardware components.

Specifically, an Exhibit contains a computer that runs software to orchestrate the user experience. This software is typically a full stack web app with output to one or more screens, but could also just be backend code to control electromechanical I/O.

The following diagrams demonstrate a few ways to build an Exhibit. In each case, the Exhibit developer leverages a Gumband SDK to communicate with the platform and enable various features.

Example exhibit comprised of a computer and multiple Bundles

(Gumband-native microcontrollers) to control external hardware

Example exhibit comprised of a computer and

an Arduino to control external hardware

Example exhibit comprised of a Raspberry Pi

controlling external hardware directly

Exhibit Statuses, Controls, and Settings

Statuses, Controls, and Settings are properties of an Exhibit and can be manipulated by the Exhibit SDK and/or through the Gumband web UI. These items are automatically updated in real time between the Exhibit and Gumband.

Statuses

Statuses are one-way values that are set from the Exhibit SDK and displayed on the web UI. They are used to surface relevant un-editable properties of an Exhibit.

Examples:

  • Exhibit IP address

  • Last interaction time or result

  • Exhibit state

  • Serial connection status

Controls

Controls are one-way triggers that are fired from the web UI and received in the Exhibit SDK. They are used to execute local code or start some Exhibit functionality.

Examples:

  • Reload a user interface

  • Reset an internal counter

  • Trigger an animation

  • Run a test sequence

Settings

Settings are key-value pairs that can be updated from either the web UI or Exhibit SDK. They are used to control behavior of the exhibit, both digitally and physically.

Examples:

  • Third-party API URL (string)

  • Dev, stage, or production endpoint (dropdown)

  • Interactive mode (toggle)

  • Color scheme (hex color)

  • Inactivity timeout duration (number)

The following diagram shows a simplified view of how Gumband Statuses, Controls, and Settings travel between an Exhibit and the web UI.

Exhibit Manifest

The Exhibit manifest is a JSON file that defines relevant Exhibit information for Gumband, including Statuses, Controls, and Settings. When the Exhibit SDK is initialized, it automatically uploads the manifest and Gumband synchronizes the Exhibit with this list of capabilities.

Exhibit SDK Sidecar

A sidecar application is available that allows projects that use other languages / technologies (Python, C, TouchDesigner, etc) to leverage Gumband functionality. This sidecar runs alongside the main application and the two communicate via Redis or websockets.

Monitoring Exhibit Operating Systems

For Exhibits that have already been developed and cannot integrate the Exhibit SDK, a custom approach using PM2 (https://pm2.keymetrics.io/ ) or Docker (https://www.docker.com/ ) and the Exhibit SDK can be used. This allows for monitoring and high level control (On/Off) for the Exhibit’s computer and running processes.

  • No labels