Preferences

Configure UI defaults and widget behavior settings

Preferences control user interface elements that aren’t covered by Dashboard configurations. They define global properties for specific widget types and can be applied at different scopes to customize the experience per robot type.

Unlike most configuration kinds, Preferences is a global config—only one per scope. The only accepted id value is "all".

When to Use

• Hide unused features: Disable teleop for robots that don’t support it
• Quick actions: Add frequently-used actions to the Navigation toolbar
• Multi-map support: Configure which map topics to display for multi-floor navigation

Scope Inheritance

Preferences follow scope inheritance: robot → tag → account. A preference set at the robot level overrides tag-level, which overrides account-level.

# Account-level: default for all robots
scope: account/<accountId>

# Tag-level: override for specific robot types
scope: tag/<accountId>/cleaning-robots

# Robot-level: override for a specific robot
scope: robot/<accountId>/robot-001

Spec Fields

navigationWidget

Configuration for the Navigation widget.

Field	Type	Description
panels	object	Panel visibility. Keys: "teleop", "camera", "gauges". Set to false to hide.
actions	array	Action IDs to show in the Navigation toolbar.
maps	array	ROS map topics available for switching (e.g., /map, /costmap).

Examples

Basic Configuration

kind: Preferences
apiVersion: v0.1
metadata:
  id: "all"
  scope: account/<accountId>
spec:
  navigationWidget:
    panels:
      teleop: true
      camera: true
      gauges: true
    actions:
      - "emergency-stop"
      - "return-to-dock"
    maps:
      - "/map"
      - "/costmap"

Hide Teleop for Non-Teleoperatable Robots

kind: Preferences
apiVersion: v0.1
metadata:
  id: "all"
  scope: tag/<accountId>/autonomous-only
spec:
  navigationWidget:
    panels:
      teleop: false

Cleaning Robots with Custom Actions

kind: Preferences
apiVersion: v0.1
metadata:
  id: "all"
  scope: tag/<accountId>/cleaning-robots
spec:
  navigationWidget:
    panels:
      teleop: false
      camera: true
      gauges: true
    actions:
      - "start-cleaning"
      - "stop-cleaning"
      - "return-to-dock"