Properties

Gumband Properties are a way to control data to and from the hardware system using the Gumband Library. The most common way to interact with Properties is through the Gumband Dashboard or through a connection to an application using a Gumband SDK.

System vs. App (Custom) Properties

Properties are split into two categories, System and App.

• System
  • Control underlying systems specific to the version of the Gumband Library for the hardware you are using.
  • Examples: Reboot, Identify, App Status, Runtime
• App
  • Custom properties created by a Developer using the Gumband Library.
  • These are what you will be creating as a developer

Groups

Groups are a way to organize properties and function similar to folders. Property groups are designated by / in the "property path". Properties must have a unique property path, so using groups can be a good way to organize properties if they share the same name or if you need a more complex property structure.

For Example:

Let's say we had an alarm clock we wanted to represent using Gumband Properties. Let's create the Properties:

Time, Alarming, Snooze, Stop Alarm, Alarm 1/Time, Alarm 1/Active Days of the Week, Alarm 1/Active,Alarm 2/Time, Alarm 2/Active Days of the Week, Alarm 2/Active, Config/Time/24 Hour,

There are multiple properties with the name "Time", but the full property path with the groups creates unique values that can be displayed on the Gumband Dashboard. If we think of it as a folder structure it looks something like this (with the properties bolded):

• Time
• Alarming
• Snooze
• Stop Alarm
• Alarm 1
  • Time
  • Active Days of the Week
  • Active
• Alarm 2
  • Time
  • Active Days of the Week
  • Active
• Config
  • Time
    • 24 Hour

Types

All Gumband Properties have a type. The type is part of defining a Gumband Property and determines what type of data that property can store. The current Gumband Data types are:

• Bool
  • True or False
• Trigger
  • Dataless signal (A button)
• Byte
  • 8 bit unsigned integer value e.g 255
• Int
  • 32 bit signed integer value e.g -20000
• Float
  • Double precision floating point value e.g. 48.5
• Color
  • RGBW/RGBA representation e.g. { red: 106, green: 173, blue: 233, alpha: 255 } or 0x6aade9ff
• Text
  • A string value e.g "Hello"

Permissions

Properties can have a combination of Read and Write permissions. The permissions are from the perspective of an external source interacting with the hardware (Gumband Dashboard or Gumband SDK application). The hardware can modify its own property values as well as publish property values freely regardless of the set permissions.

• Read
  • The device will respond with the property value if the property is requested from an external source.
• Write
  • The device will allow the property to be set from an external source

note

It is possible for a property can have neither Read nor Write permissions. This means that the hardware device can publish property values, but the value can not be requested from an external source and cannot be written to from an external source.

For example: A property that sends a signal out, but does not have any state tracking itself, so it's not useful to query the value.