Skip to content

OrbitDeck Docs

Pass operations documentation

OrbitDeck helps you track passes, tune radios, run APRS, and pick the right screen for the job.

Start here to get OrbitDeck running, pick the right screen, and learn the basics before you dig deeper.

Get started with Quick Start Follow the First Hour walkthrough Jump to Common Tasks

What This Docs Site Covers

Platforms

Use these docs for macOS, Raspberry Pi, and lite mode on smaller hardware.

Docs site

The published docs are at chipsncode.com/OrbitDeck.

API docs

A running OrbitDeck instance shows the live API schema at /docs.

More help

Install, troubleshooting, runtime data, and API links are below.

Get Running

Quick Start

The fastest way to get OrbitDeck running.

  • Set up a local run
  • Open the main routes
  • Check that the app is working

First Hour

A guided first run from launch to pass tracking.

  • Choose the right screen
  • Set the basics
  • Get ready for a pass

Install / Build / Run

Use this for full install steps, packaged releases, and build details.

  • macOS DMG notes
  • Raspberry Pi package flow
  • Source-run commands

Use OrbitDeck

/ Main tracking view

Use the main screen to watch active and upcoming passes and see tuning guidance.

Read about the screens

/lite Lite mode

Use the smaller mobile-friendly screen on Pi Zero-class hardware, phones, or low-power remote setups.

Read about lite mode

/radio Radio validation

Use the radio screen to test CI-V, manual tuning, or uplink and downlink pairs.

Read about the screens

/aprs APRS operations

Use the APRS screen for setup, status checks, and send tools in terrestrial or satellite mode.

See common tasks

/settings Station setup

Use settings for location, timezone, pass preferences, radio setup, APRS setup, and debug overrides.

Read about the screens

Understand the System

Core Concepts

Simple explanations of passes, guidance, APRS, and the main screens.

Platforms

What works on macOS, Raspberry Pi, and Pi Zero-class hardware.

Frequency Guidance

How OrbitDeck chooses tune-now and tune-next recommendations.

Glossary

Quick definitions for radio and satellite terms.

Reference and Troubleshooting

HTTP API

Read the current route map and request shapes used by the UI and API tools.

Settings Reference

See the settings model for location, pass filters, radio, APRS, and overrides.

Troubleshooting

Use this when launch, APRS, radio control, or route behavior is not doing what you expect.

Runtime Data

Find state files, caches, snapshots, and writable locations.

Docs Contributing Guide

Use this if you want to work on the docs.