HALO · v0.1.0

HALO

Mesh telemetry and node control.

OVERVIEW
HALO overview

HALO turns commodity ARM hardware into self-organizing HaLow mesh networks with built-in monitoring, automation, and remote control.

GET STARTED
Getting started

Flash a HALO image, bring up a gateway, join the first node, and reach HALO Portal — the path from bare hardware to a running mesh.

CONCEPTS
Architecture

HALO's control plane, mesh manager, and node agent — the brain and neuron model, gateway and node roles, and the canonical device model.

CONCEPTS
Networking

HALO's two-layer encrypted mesh — 802.11ah HaLow radio, batman-adv Layer 2 underlay, and an auto-keyed WireGuard overlay.

SUBSYSTEMS
HALO Portal

HALO Portal is the web admin UI — a React single-page app served on the gateway for monitoring, control, and configuration of the mesh.

SUBSYSTEMS
HALO Flows

HALO Flows is the event pipeline engine — a visual builder chaining triggers, conditions, and actions to automate responses to mesh and sensor events.

SUBSYSTEMS
Field diagnostics

HALO Field is a mobile-first diagnostics UI served on remote nodes — connect a phone to a node hotspot for instant mesh, signal, and GPS health.

SUBSYSTEMS
IO and sensors

Plug-and-play I2C sensors, TOML board definitions, and the IO page — HALO auto-detects hardware and reports telemetry without recompiling.

SUBSYSTEMS
External systems

Agent-less monitoring of third-party systems — Proxmox, Synology, UniFi, HTTP, and ping — polled by the gateway and usable as flow data sources.

REFERENCE
haloctl CLI

haloctl is the command-line tool for HALO nodes — status, health checks, hardware detection, sensor reads, and node provisioning.

REFERENCE
Gateway API

The HALO gateway REST API — JWT auth, node onboarding, telemetry, mesh topology, flows, and external systems, with interactive Swagger docs.

OPERATIONS
Configuration and operations

Build, deploy, and operate HALO — cross-compilation, binary push deploys, systemd service management, and device file locations.