Skip to content

Widgets

Jump to bottom
Jared Quinn edited this page Jun 19, 2026 · 11 revisions

Counter

A counter that can count, up or down, increment or decrement, great for tracking scores. image

Configuration

    <widget>
        <id>home_goals</id>
        <type>Counter</type>

        <initial_value>0</initial_value>
        <increments>
                <value>4</value>
                <value>2</value>
                <value>1</value>
        </increments>    
        <min_value>0</min_value>
        <max_value>65535</max_value>
     </widget>

Configuration Values

  • id (string) - Unique ID for this counter.
  • initial_value (integer) - Value to set the timer to when initializing/resetting.
  • increments (list of integer) - list of nodes containing the values for convenience buttons in the UI.
  • min_value (integer) - Minimum value allowed to be set
  • max_value (integer) - Maximum value allowed to be set API Actions
Action Value Type Description
increment integer Increment the counter (default 1)
decrement integer Decrement the counter (default 1)
set integer Set to specific value
set_min integer Set minimum allowed value
set_max integer Set maximum allowed value
reset integer Reset to initial value

Flat JSON Structure

The primary value of the field contains the current value. Additionally:

  • _min will contain the current min allowed value
  • _max will contain the current max allowed value

List

A List is an integer value pointing to an item in a list.

image

Configuration

  <widget>
        <id>period</id>
        <type>List</type>
        <initial_index>0</initial_index>
        <options>
            <option>PRE GAME</option>
            <option>1ST QTR</option>
            <option>1/4</option>
            <option>2ND QTR</option>
            <option>HALFTIME</option>
            <option>3RD QTR</option>
            <option>3/4</option>
            <option>4TH QTR</option>
            <option>FULLTIME</option>
        </options>
    </widget>

Configuration Values

  • id (string) - Unique ID for this counter.
  • initial_index (integer) - Value to set the List to when initializing/resetting.
  • options (list of option nodes) - list of nodes containing the values to display for each index.

API Actions

Action Value Type Description
next Progress to next item
previous Go to previous item
reset Reset to initial value
set index Set List to index value

Flat JSON Structure

The primary value of this widget will contain the value of the currently selected option.

Additionally:

  • _index will contain the current numerical index

Text

A simple text field widget.

Configuration

    <widget>
        <id>description</id>
        <type>Text</type>
        <initial_value>ROUND 1 MATCH 1</initial_value>
    </widget>

Configuration Values

  • initial_value: initial value to set the text to on scoreboard reset.

API Actions

Action Value Type Description
set string Set the value of the widget to the current value string

Flat JSON Structure

The primary value of the field contains the value.

Timer

A timer that counts up and down in seconds and additionally tracks any paused (stoppage time) and the total ticks ticked (paused and running).

image
  • The master is_running value controls if the timer responds to ticks at all.
  • The is_paused state controls if the ticks update the clock or the stoppage (pause) timer.
  • total_time always counts upwards, regardless of the direction of the clock (and therefore so does total_formatted).

Configuration

   
    <widget>
        <id>match_clock</id>
        <type>Timer</type>

        <initial_seconds>0</initial_seconds>
        <is_down>false</is_down>
        <min_value>0</min_value>
        <max_value>1200</max_value>
        <reset_on_start>false</reset_on_start>
        <format>mm:ss</format>
    </widget>

Configuration values

  • id (string) - Unique ID for this timer.
  • initial_seconds (integer) - Value to set the timer to when initializing/resetting.
  • is_down (bool) - True for countdown and false for countup timers
  • min_value (integer) - Lowest value allowed for timer (in seconds)
  • max_value (integer) - Largest value allowed for timer (in seconds)
  • format (string) - Format string to use for formatted times (default: mm:ss)
  • reset_on_start (bool) - Automatically reset the clock when starting

API Actions

Action Value Type Description
set integer Set current time in seconds
set string Set current time from formatted string
set_min integer Set minimum value for timer in seconds
set_max integer Set maximum value for timer in seconds
set_direction string UP or DOWN as a string to set direction
set_initial integer Set initial value (used on reset) for timer in seconds
start Start timer and optionally perform reset if reset_on_start set
stop Stop Timer responding to ticks
toggle Toggle timer start/top state
pause Toggle Pause state of timer
reset Perform reset of timer and set to unpaused, stopped, also clears stoppage time

Flat JSON Structure

The primary value of the field contains the current clock in seconds only.

Additional values provided in the flat data structure are:

  • _formatted_time - Current value formatted with the format string
  • _paused_formatted - Current value of the stoppage clock formatted with the format string.
  • _paused_time - Current value of the stoppage clock in seconds
  • _total_formatted - Current value of the total clock formatted with the format string.
  • _total_time - Current value of the total clock in seconds
  • _paused - Boolean, true if clock is paused
  • _running - Boolean, true if clock is running

Clone this wiki locally