The Gumband SDK: Getting Started

Welcome to the Gumband SDK Getting Started docs! These will give you all of the basic tools you need to integrate Gumband into your project with the Gumband SDK, but how Gumband can best contribute to your specific exhibit will probably be unique. These docs are broken up into three sections: a detailed tutorial, a quick start guide, and an API reference doc. Each successive section assumes a greater familiarity with NodeJS (the environment upon which the Gumband SDK is built) and Gumband in general, but they can be read in any order. If one section feels too advanced, try an earlier one; the tutorial should be accessible even to absolute beginners.

Tutorial: Digital Signage and Game

In this section, you’ll build a simple example app that demonstrates how to:

• Use statuses as health checks for your exhibits.

• Use controls to trigger one-time events.

• Use settings to add configurations.

• Send logs to Gumband to assist in debugging.

• Send reporting events to Gumband to capture user interactions.

• Send email notifications when maintenance is required.

• Integrate with Gumband Hardware

  • Listen for events from the Hardware

  • Write properties to the Hardware

This tutorial is an electron app that doubles as a digital signage and a video game. If you’d prefer to skip to the end and simply look through the code of the completed Tutorial, you can find that here.

Quick Start

An overview of all the features Gumband provides through the SDK and how these features can contribute more reliable health monitoring, content configuration, and measurement of user interaction for your exhibit. Intended for someone who is familiar with NodeJS and exhibit development, but is new to Gumband.

API Reference

An API document of all functions available in the Gumband SDK and all websocket events that can be emitted from the Gumband SDK.