Skip to content

Getting started

Jump to bottom
Elliot edited this page Jul 28, 2026 · 1 revision

Getting Started

This guide helps a new user, contributor, or hardware evaluator choose a safe starting point. VTOC Agent is not a generic binary for every ESP32 board: a release is installable only for the exact board profile and revision named in its release evidence.

flowchart TD
  A[Start] --> B{What are you trying to do?}
  B --> C[Install a reviewed release]
  B --> D[Build for the initial Heltec board]
  B --> E[Evaluate another ESP32-class board]
  C --> F[Read release notes, checksum, and recovery evidence]
  D --> G[Follow Board Bring-up]
  E --> H[Create a board profile and evidence pull request]
  F --> I[Owner selects the serial port in the browser flasher]
  G --> J[Build and verify normal plus recovery images]
  H --> J
Loading

Install a reviewed release

  1. Confirm that the release identifies your exact board and revision.
  2. Read its release notes, image checksum, recovery instructions, and recorded physical-board verification.
  3. Use a supported Chromium-based browser over HTTPS to open the flasher.
  4. Connect only the board you intend to update, then choose its serial port yourself when the browser asks.
  5. Do not continue if the flasher cannot show a complete, verified manifest.
  6. After installation, verify the expected serial output and retain the recovery path before enabling any optional integration.

The current foundation release is intentionally non-flashable. It exists to make the release, evidence, and recovery contracts visible before a first physical-board release is published.

Build from source

Use a clean clone and the repository's pinned build environment. Keep local network details, credentials, device identifiers, and personal configuration out of source control and release artifacts. A source build is not a public release until it has the board evidence and recovery record described in the Release Process.

Evaluate a new board

Start at Hardware Support. Do not flash an existing Heltec image simply because another board uses an ESP32-family chip. Pin mappings, flash layout, reset behavior, display wiring, radio wiring, power circuitry, and available memory can differ in safety-critical ways.

Clone this wiki locally