Documentation

This page is honest about what exists: a getting-started path through the dashboard, a full API reference, and the source for everything else.

Try it now -- no hardware required

Getting Started

Create an account

Create a flock

A flock groups pigeons under one owner — think of it as a project or a fleet.

Create a pigeon

Creating a pigeon mints its Ed25519 keypair and returns a one-time device token — this is the only time the token is ever shown. Copy it before dismissing the dialog.

Provision the device

Bake the pigeon's endpoint and token into your device build (see the pigeon library below). HTTPS, WebSocket, and CoAP (DTLS/UDP or TLS/TCP, PSK-authenticated) are all live — pick whichever transport fits the hardware.

Connect and confirm

Once the device reports in, its shadow, telemetry, and logs (if wired up) start showing on the pigeon's detail page in the dashboard — and any alerts you define start evaluating against it.

Create an Account Read the API Reference

Reference & Source

API Reference

Every dashboard and device route, request/response shapes, and auth models — generated straight from the maintained doc in the repo.

pidgeiot

The platform itself — dovecote (edge router), fancier (this dashboard), and capsules (shared wire types).

pigeon

The Zephyr device library: shadow fetch/report, telemetry, dictionary log upload, and the FOTA client.

pigeon-examples

Board-level sample applications built on the pigeon library — bring-up references for real hardware targets.

Support

PidgeIoT is built and run by one engineer, so here is the honest version: you will get a considered reply from the person who wrote the code, and it will usually take a day, not a minute.

support@pidgeiot.com

Email for anything already broken, plus billing and account questions. Expect a reply within two business days.

Status page

Live availability of the API, authentication and dashboard, plus any incident we are working on. Check here first.

Contact form

Sales questions, feature requests, and anything with enough detail to be worth structuring. It reaches the same inbox.

Issues and discussion

Bugs in the open-source device library or the platform itself are best raised where the code lives.

What to include

A report with these five things can usually be answered on the first reply instead of the third:

The email address on your account.
The flock and pigeon involved, by id.
What you expected to happen, and what happened instead.
When it happened, in UTC, and whether it is still happening.
The transport the device uses: HTTPS, WebSocket, or CoAP.

Never send a device token, a pre-shared key, or any other credential. Nothing we need to diagnose a problem requires one, and a token pasted into an email should be treated as compromised and rotated.