Versions Compared

Key

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

...

An Organization is the highest-level entity within Gumband. This is typically your company, business unit, or specific team name. Within your Organization, you can create any number of Sites to hold Exhibits and Hardware. A Site is generally the physical location where Exhibits are installed, such as different cities, building locations, or floors.

...

Organization, Site, and Exhibit hierarchy

Anchor
_prpeixdf1ajj
_prpeixdf1ajj
Log in to Gumband

...

Gumband is secured using Google Oauth and is extensible to support other third-party providers as necessary. Navigate to

https://app.gumband.com/

in a browser and click the appropriate button to log in. If you have not been added to Gumband, you will see an unauthorized page.

...

Permissions are more granular at the Exhibit level. Users can be given read and write permissions for each status, control, and setting. This is especially useful when wanting to share Exhibit information (such as health or metricsanalytics), but prevent users from accidentally modifying mission-critical settings.

Read more in Platform Roles and Granular Permissions.

...

User permissions page

Anchor
_nzfhk05ksoof
_nzfhk05ksoof
Exhibit UI

Anchor
_afbajmbx9okg
_afbajmbx9okg
Create a New Exhibit

  1. Navigate to the Site under which this Exhibit will exist

  2. Click “Create Exhibit”

  3. Give your Exhibit a name

  4. Optionally enter the MQTT path (usually the computer’s local IP address and MQTT port ie “192.168.1.128:1883”)

  5. Click “Create”

  6. Note the Exhibit ID and token for initializing the SDK

...

View Site Exhibits page

...

Create Exhibit dialog

...

Anchor
_lawi1fq4c64k
_lawi1fq4c64k
Operating Mode

Each exhibit has Some exhibits have an operating mode (on operating or offstandby). This is useful for day-to-day operation, maintenance, and support in turning off screens and disabling interactivity for exhibits. The operating mode status is displayed by the switch first setting on the left of the Exhibit name and connection status:

...

Exhibit on: if the toggle is to the right and orange (blue star)

...

Settings page:

...

  • Operating: if the toggle is to the left and gray (blue star)

There is also a quick indicator in the left sidebar that contains the exhibit list.

  • Exhibit on: the indicator checked and the icon is a green lightning bolt (blue star)

    Screen Shot 2024-08-29 at 5.35.47 PM.pngImage Added
  • Exhibit off: the indicator is a red Standby: if the toggle is unchecked and the icon is an orange crossed-out lighting bolt (blue star)

Gumband also allows specific Controls and Settings to be available depending on the current operating mode; this is defined by the exhibit developer in the Exhibit Manifest. By default, Settings and Controls are only editable when operating mode is disabled — notice in the screenshots below how the “Reload” button is only available when the operating mode is set to off.

Info

Not all exhibits necessarily take advantage of this feature. If a setting or control is disabled in both operating modes, this may be limited by your user permissions for that exhibit.

...

Operating mode off (“Skip Interaction” disabled)

...

Operating mode on (“Reload” disabled)

  • Screen Shot 2024-08-29 at 5.37.21 PM.pngImage Added

Anchor
_epmud1h8hwlb
_epmud1h8hwlb
View Statuses

Statuses are displayed on the “Overview” tab. The list of Statuses is restricted by User Permissions. The “Overview” tab also shows a summary of the Exhibit, including read-only Settings and Hardware information.

Info

Statuses are shown based on the order key for that item in the manifest, falling back to an alpha-numeric comparison of the display keys.

...

Exhibit Overview tab

Statuses can be used to display links to helpful resources, file servers, and email addresses, even a website hosted by the exhibit. Make sure the URL to be shown has the appropriate protocol prefix, such as http:// or https://, ftp://, mailto:, etc.

Statuses can also display multi-line content by using \n, which converts to line-breaks.

Anchor
_pe7nhaji6lpz
_pe7nhaji6lpz
Trigger Controls

Controls can be triggered in real-time from the “Controls” tab. The list of Controls is restricted by User Permissions. Controls can be disabled/enabled based on the Exhibit Operating Mode.

Image Removed

...

...

Anchor
_zgej32isajsb
_zgej32isajsb
Update Settings

...