Orbit SDK

TypeScript SDK for authoring Orbit plugins, including CAN APIs, host-rendered UI helpers, automotive protocol utilities, checksums, statistics, and timing utilities.

What is an Orbit plugin?

An Orbit plugin is a packaged extension that adds CAN processing, dashboard data sources and controls, automation, storage, or host-rendered UI to a GQA product. Helix 2 Plus currently supports browser-targeted Orbit plugins; Node.js backend plugins are not yet supported on the device.

Installation

npm install @gothenburg-quantum-analytics/orbit-sdk

Browser plugin

import { definePlugin } from '@gothenburg-quantum-analytics/orbit-sdk';

definePlugin({
  init(ctx) {
    ctx.log.info('Plugin initialized');
  },
});

Backend plugins should import from @gothenburg-quantum-analytics/orbit-sdk/backend. Additional entry points include dbc, isotp, j1939, obd2, uds, checksum, stats, and timing.

Documentation

See Getting Started with Orbit Plugin Development for the Helix 2 Plus development workflow.

License

MIT