Documentation Heron

Get Started

Installation, initial setup, and first-time configuration. From unboxing to a live dashboard in six steps.

Stuck? Email northsline@protonmail.com - a real reply, from a person.

What's in the box

Step 1 - Plug it into your computer

Connect Heron to your computer with the USB cable. Use Chrome or Edge - Safari and Firefox do not support the WebSerial API that setup requires. The screen on the device shows "Setup." That is what you want.

Step 2 - Open the setup page

Open the setup page in Chrome or Edge. The address is on the card that came with your Heron. Click "Connect Heron" and pick your device from the list.

Your browser verifies the device is genuine using a cryptographic check that runs entirely on your computer. Nothing is sent to any server.

Step 3 - Give Heron your Wi-Fi

Pick your home Wi-Fi from the list. Type the password. Heron connects and restarts.

Step 4 - Point your router at Heron

Heron needs your router to send it DNS traffic. The setup page shows you how - it is different for every router brand. You log into your router (the address is on the setup page), change one setting, done. Takes about two minutes.

Step 5 - Unplug, plug into the wall

Unplug Heron from your computer. Plug it into any USB wall adapter. It connects to your Wi-Fi on its own.

Step 6 - Open the dashboard

Go to heron.local in any browser. Any device on your Wi-Fi works. You will see your network traffic - live.

What you need

What happens during setup

Setup is a one-time operation. Your browser talks to Heron over USB, verifies the device's identity cryptographically, writes your Wi-Fi credentials to the device, and shows you how to point your router's DNS at it. No network call is made during this process - verification uses a public key embedded in the setup page itself.

After setup, you never need the USB cable or the setup page again unless you change your Wi-Fi network.

Next