beacon

beacon

An offline-first NMEA 2000 gateway for moving vessel data between CAN, USB-CAN, HTTP, WebSocket, TCP, MQTT, capture files, and marine gateways. Beacon adds CEL filtering, durable per-route buffering, replay, live diagnostics, and one REST API without requiring a cloud service.

Start here

A real Beacon instance routing live NMEA 2000 traffic. Sources, connector routes, sinks, state, throughput, and pending delivery stay visible in one view.

The quickest local preview needs no CAN hardware. Start Beacon, then open http://localhost:2112:

git clone https://github.com/open-ships/beacon.git
cd beacon
go run ./cmd/beacon \
  --db beacon.db \
  --admin-address 127.0.0.1:2112 \
  --data-address 127.0.0.1:8080

This route requires Go 1.25.2 or newer. Prefer a container? The published image provides the same no-hardware preview:

mkdir -p data
docker run --rm \
  -p 127.0.0.1:2112:2112 \
  -p 127.0.0.1:8080:8080 \
  -v "$(pwd)/data:/data" \
  ghcr.io/open-ships/beacon:latest

Once it is running:

• Dashboard: localhost:2112
• Onboard manual: localhost:2112/docs
• MCP agent reference: localhost:2112/mcp/info
• Interactive API reference: localhost:2112/api/docs
• Health: localhost:2112/health

The UI starts empty on purpose. Add a source, a sink, and a connector route from the dashboard, or import one of the tested configs in examples/. Every change is validated, persisted to SQLite, and applied immediately; there is no separate configuration file to maintain and no restart step.

See traffic without hardware

On Linux, a virtual CAN interface gives you a complete local route in a few commands. Stop the preview above if it is still running, install can-utils, then run:

sudo modprobe vcan
sudo ip link add dev vcan0 type vcan
sudo ip link set vcan0 up

go run ./cmd/beacon \
  --db beacon-vcan.db \
  --seed examples/vcan-dev.json

In another terminal, connect the SSE consumer first:

curl -N http://localhost:8080/events

Then inject a frame from a third terminal:

cansend vcan0 18FF0001#0102030405060708

You now have a real route from vcan0 through Beacon's durable connector buffer to an SSE client. The source, route, counters, and sink state appear on the dashboard within a couple of seconds.

[!NOTE] --seed is applied only when the selected database has no configuration. Reusing a populated database safely keeps its current routes.

Why Beacon

• Offline by design. The UI, manual, API reference, PGN catalog, storage, and runtime all work with no internet connection.
• A legible routing model. Every message moves through an explicit source → connector route → sink topology.
• Independent durability. Each connector route owns its own SQLite-backed buffer, checkpoint, limits, counters, and delivery boundary.
• Controlled bridging. Choose semantic re-origination, transparent wire-preserving forwarding, or observe-only inspection per route.
• NMEA 2000 depth. Beacon keeps raw bytes and wire values while adding PGN metadata, decoded fields, physical units, ingress provenance, stable Device NAMEs, device inventory, and commissioning reports.
• Built for integration. The UI is a thin layer over a typed REST API with an embedded OpenAPI 3.1 reference, RFC 7807 errors, health, and Prometheus metrics.
• Hot configuration. Valid writes are persisted and reconciled against the running graph in the same request; only affected components restart.

The model

source ──▶ connector route ──▶ sink
            │        │
            │        └─ delivery checkpoint + replay retention
            ├─ CEL filters
            ├─ bridge mode
            └─ durable SQLite buffer

A source reads NMEA 2000 messages onto Beacon. A sink makes messages available somewhere else. A connector route is the only component that moves data: it names exactly one source and one sink and owns the policy and delivery state between them. Sources and sinks can be shared by any number of routes, making fan-out and fan-in explicit rather than implicit.

Supported endpoints

Bridge modes

transparent mode currently requires a SocketCAN sink, rejects a source and sink on the same interface, and blocks address-claim and network-management PGNs unless forward_management is explicitly enabled.

Filtering with CEL

Filters are Common Expression Language expressions evaluated against the canonical msg envelope. A route's expressions use AND semantics; use || inside one expression for OR.

msg.pgn in [127250, 129025, 129026, 129029]
msg.priority <= 3
has(msg.device_name) && msg.device_name == 123456789

The connector editor validates filters as you type and provides completions for envelope fields, PGNs, decoded payload fields, and CEL helpers. The API exposes the same compiler without persisting a route:

curl -X POST http://localhost:2112/api/v1/filters/validate \
  -H 'Content-Type: application/json' \
  -d '{"filters":["msg.pgn == 127250","msg.priority <= 3"]}'

See the filter cookbook for payload examples, null handling, physical values, and reusable policies.

Delivery, buffering, and replay

Beacon decouples source throughput from sink availability. After filtering, a message is written to the connector route's SQLite buffer; that route advances its own checkpoint only when it reaches the sink's declared delivery boundary. A slow or disconnected sink does not block another route using the same source.

Each route can bound retained data with any combination of max_messages, max_age, and max_bytes. With no limits set, max_messages defaults to 100,000. Metrics distinguish pending delivery after the checkpoint from retained history that has already been acknowledged but remains replayable.

SSE clients resume with Last-Event-ID; SSE and WebSocket clients can also use ?after=<connector>:<sequence>. A sink shared by multiple routes accepts a comma-separated cursor such as ?after=nav:104,engine:57. TCP and MQTT are live-only.

Confirmed writes use retry with bounded exponential backoff and at-least-once semantics. An envelope that cannot be encoded for semantic CAN delivery is counted as skipped and checkpointed so an unknown PGN cannot wedge a route. Transparent SocketCAN delivery preserves that unknown PGN losslessly.

For the precise retention, pruning, replay, retry, and file-rotation contract, read Concepts and ADR 0001.

The envelope

MQTT, SSE, WebSocket, TCP, and NDJSON consumers receive exactly three top-level keys:

{
  "payload": {
    "info": {
      "timestamp": "2026-07-25T12:00:00Z",
      "receivedAt": "2026-07-25T12:00:00Z",
      "adapterId": "socketcan:can0",
      "networkId": "can0",
      "direction": "received",
      "priority": 2,
      "pgn": 127250,
      "sourceId": 12,
      "targetId": null
    },
    "heading": 15708
  },
  "metadata": {
    "id": 42,
    "connector": "heading",
    "observed_at": "2026-07-25T12:00:00Z",
    "ingress": "can0",
    "pgn_name": "Vessel Heading",
    "decode": {"status": "decoded", "complete": true}
  },
  "raw": "XC9///////8="
}

payload is the verbatim JSON representation of the decoded open-ships/n2k Go struct, including every exported MessageInfo field such as receive time, transport timing, adapter, network, and direction. A consumer that knows the PGN can unmarshal payload directly into the corresponding pgn type. The raw-tick values are unchanged.

metadata holds only what Beacon adds: queue and connector identity, ingress provenance, stable Device NAME, catalog/decode details, and physical values.

raw is the assembled CAN payload as base64 bytes. It is top-level data, not metadata.

Unknown PGNs still move through HTTP, TCP, MQTT, file, observe, and transparent routes. Their payload is the complete pgn.UnknownPGN JSON and their original bytes remain available at top-level raw. See ADR 0004 for the compatibility rationale and Concepts for the complete field contract.

Configuration

The entire desired state is one JSON document:

{
  "sources": [
    {
      "id": "can0",
      "name": "Engine room bus",
      "type": "socketcan",
      "enabled": true,
      "interface": "can0"
    }
  ],
  "sinks": [
    {
      "id": "events",
      "name": "Browser feed",
      "type": "http_sse",
      "enabled": true,
      "path": "/events"
    }
  ],
  "connectors": [
    {
      "id": "navigation",
      "name": "Navigation data",
      "source_id": "can0",
      "sink_id": "events",
      "mode": "semantic",
      "filters": ["msg.pgn in [127250, 129025, 129026, 129029]"],
      "buffer": {"max_messages": 100000},
      "enabled": true
    }
  ]
}

Use it in whichever workflow fits:

# Seed an empty database at boot
beacon --db beacon.db --seed examples/navigation.json

# Replace or merge config on a running Beacon
curl -X POST 'http://localhost:2112/api/v1/config/import?mode=replace' \
  -H 'Content-Type: application/json' \
  --data-binary @examples/navigation.json

curl -X POST 'http://localhost:2112/api/v1/config/import?mode=merge' \
  -H 'Content-Type: application/json' \
  --data-binary @examples/engine-room.json

# Export a running Beacon
curl http://localhost:2112/api/v1/config/export > beacon-config.json

Entity-level CRUD is available at /api/v1/{sources,sinks,connectors}/{id}. Deleting a source or sink still in use returns 409; structural and CEL errors return an RFC 7807 422 without changing the running configuration.

The CLI also provides offline beacon export and beacon import commands. Do not use them against a database held open by a running Beacon; use the live HTTP endpoints instead. Full examples and caveats are in examples/README.md.

API and operational surfaces

Beacon runs separate admin and data servers so a sink configuration cannot take away the control surface used to repair it.

An MCP client can connect without a cloud relay or companion process:

{
  "mcpServers": {
    "beacon": {"url": "http://127.0.0.1:2112/mcp"}
  }
}

The MCP server exposes tools to read the complete configuration, create or update sources, sinks, and connector routes, delete each entity type, and read health, delivery metrics, or per-source PGN traffic metrics. It uses the same validation, SQLite persistence, and hot reconciliation as the UI and REST API. The server, tool schemas, and reference page are all embedded in the Beacon binary; no internet connection, remote schema, CDN, or hosted MCP service is required.

Each source overview groups traffic by source address and PGN, including PGNs Beacon cannot decode. It reports learned frequency and jitter, gaps and bursts, last-seen age, addressing and decode outcomes, traffic share and estimated CAN load, payload lengths, decoded-field quantiles/availability/rate-of-change, and bounded raw-wire fingerprints, entropy, byte ranges, and change masks. Approved baselines make missing streams, frequency drift, payload/decode changes, address moves, and out-of-range values visible after a restart. The scrape-safe subset is exported as beacon_source_pgn_* at /metrics; raw payloads and fingerprint identifiers stay in the UI/MCP response to avoid unbounded Prometheus labels.

Every source and sink overview also has a stopped-by-default stream inspector. Start captures future source-received or sink-sent messages without consuming connector queues or blocking routing; Stop freezes the current browser-local capture. An optional CEL expression beside Start filters the server-side preview using the same msg fields as connector filters and can be changed while streaming without clearing captured rows. Clicking a JSON key or value shows a usable CEL expression for that field. The inspector switches between the verbatim decoded n2k JSON and assembled CAN payload bytes in hexadecimal, with exactly one message per line in either view. Captures can be copied, exported as n2k JSONL, or exported as one hexadecimal CAN payload per line, preserving message boundaries. The captured counter tracks the entire browser session even though only its latest 200 messages remain available for display, copy, and export.

The admin API also exposes the complete PGN and field catalog, best-effort CAN/USB hardware discovery, stable Device NAME inventory, commissioning baselines, and a machine-readable commissioning report.

Beacon does not currently provide built-in authentication or TLS. Bind the admin server to loopback for local use, or place it behind the access controls appropriate for the vessel network.

Running in production

Prebuilt archives for Linux, macOS, and Windows on amd64 and arm64 are published on GitHub Releases. Physical SocketCAN operation requires Linux; the other builds remain useful for USB-CAN, remote streams, development, and administration.

For a Linux host with a configured CAN interface, the repository Compose file uses host networking so the container can see that interface:

docker compose up

Or run the published image with persistent storage:

docker run --rm --network host \
  -v "$(pwd)/data:/data" \
  ghcr.io/open-ships/beacon:latest \
  --db /data/beacon.db

Host networking exposes host network interfaces but not USB device nodes. Pass the appropriate serial device explicitly when using USB-CAN in a container. The onboard CAN setup guide covers real and virtual interfaces, permissions, bitrate, Docker, and troubleshooting.

Architecture

Beacon is a single static Go binary with embedded UI/docs assets and a SQLite database. Configuration follows one write path whether it begins in the UI, REST API, seed file, or offline import:

UI / REST / import
        │
        ▼
 validate structure + compile CEL
        │
        ▼
 persist desired config in SQLite
        │
        ▼
 supervisor reconciles changed runtimes

source runtime ─▶ filter ─▶ connector queue ─▶ delivery policy ─▶ sink runtime
                         └──── metrics / replay / checkpoint ────┘

Important design invariants:

• One persistent appliance NAME is reused across restarts and independently connected bus endpoints.
• Raw wire values remain canonical; physical values and catalog metadata are additive.
• Every connector route declares one bridge mode and one delivery class.
• Pending delivery and retained replay history are reported separately.
• The admin and data listeners fail independently.
• All configuration mutations pass through validation, persistence, and reconciliation in that order.

The vocabulary in CONTEXT.md is the shared domain model. Design decisions are recorded in docs/adr/, including delivery boundaries, appliance identity, bridge modes, and canonical wire values.

Project layout

cmd/beacon/       CLI entrypoint: serve, export, import
internal/
  app/            composition root and HTTP servers
  api/            typed REST API and embedded OpenAPI reference
  bus/            shared N2K clients per physical endpoint
  config/         validate → persist → reconcile write path
  connector/      subscribe → filter → queue → deliver route runtime
  filter/         CEL environment, compile, and evaluation
  identity/       persistent N2K appliance identity
  inventory/      Device NAME history and commissioning baseline
  model/          sources, sinks, connector routes, validation
  msg/            canonical NMEA 2000 envelope
  queue/          SQLite-backed per-route buffer and checkpoints
  sink/           CAN, HTTP, TCP, MQTT, file, and gateway delivery
  source/         CAN, HTTP, MQTT, file, and gateway ingestion
  stats/          live route counters
  supervisor/     desired-state runtime reconciliation
  ui/             embedded htmx UI and onboard manual
examples/         validated, importable starter configurations
tests/browser/    Playwright end-to-end tests

Development

Common tasks use just:

just build          # local static binary
just test           # all Go tests
just test-race      # full suite with the race detector
just test-browser   # Playwright end-to-end tests
just fmt            # gofmt
just vet            # go vet
just lint           # golangci-lint
just secure         # govulncheck + gosec
just docker-build   # local container image

The direct path has no task-runner dependency:

go test ./...
go build ./cmd/beacon

Browser tests start an isolated in-memory Beacon automatically:

npm ci
npx playwright install chromium
npm test

Before changing a domain boundary, read CONTEXT.md and the relevant ADR. Before changing an endpoint or configuration shape, update the API/UI tests and keep the files in examples/ valid; CI validates them through the same code path used by real configuration writes.

Issues and pull requests are welcome. The most useful contributions preserve offline operation, wire fidelity, explicit delivery semantics, and the source → connector route → sink model.

License

Beacon is available under the Apache License 2.0.