Getting Started with Orbit Plugin Development | Support

Orbit is GQA’s plugin framework for extending Helix with project-specific functionality. Plugins can decode CAN data, provide dashboard readers and writers, automate actions, store configuration, and add custom interface elements.

Helix 2 Plus compatibility

Helix 2 Plus currently supports browser-targeted Orbit plugins written in JavaScript, TypeScript, or Python.

The Orbit development tools also recognize a Node.js backend target, but that target is not currently supported on Helix 2 Plus. Plugins intended for the device must use:

{
  "target": "browser"
}

Install the Orbit CLI

Node.js 20 or later is required.

npm install --global @gothenburg-quantum-analytics/orbit-cli

Confirm the installation:

orbit --version

Create a plugin

Run the interactive project generator:

orbit init can-byte-viewer

Select the JavaScript runtime and browser target when prompted.

A project can also be created without prompts:

orbit init can-byte-viewer --runtime js --target browser --id com.example.can-byte-viewer --author "Example Engineering" --description "Displays values decoded from CAN payloads" --yes

Install its dependencies:

cd can-byte-viewer
npm install

The generated project contains:

manifest.json — Plugin identity, permissions, and capabilities
src/index.ts — Plugin entry point
src/ui — Host-rendered interface components
package.json — Dependencies and build scripts
dist — Generated build output

The manifest ID must use reverse-domain notation, such as com.example.can-byte-viewer. Keep "target": "browser" for Helix 2 Plus compatibility.