Documentation
Choose what you want to do. A prepared gadget needs a label and an operator’s relay. The project hosts no relay.
On this page
Use a gadget
Start with phone setup, then claim the gadget in Grok Bot. Ask the builder for its label and relay address.
| Your task | Start here |
|---|---|
| Join your home Wi-Fi | Set up your gadget with your phone |
| Connect Grok Bot and claim ownership | Claim your gadget |
| Give someone access | Share a gadget |
| Change the owner | Hand a gadget to someone |
| Receive firmware updates | Keep your gadget up to date |
| Fix a problem | Troubleshooting |
Your relay account owns the gadget. You can give another account use or view access and revoke it later. A reset keeps ownership. A pending transfer needs the owner’s removal or a 7-day wait without refusal.
Two people tested claims, sharing and hand-over with their own iPhones, one relay and one OLED kit. The owner also observed an Android claim and display command on that kit. The 7-day timer has software tests only. See current support for releases and limits.
Build a gadget
| Starting point | Guide |
|---|---|
| Your own relay and a batch of gadgets | Ship a gadget in one afternoon |
| No hardware | First success with the simulator |
| The tested ESP32-S3 and OLED | Build and repeat the kit |
| A Linux application | Linux SDK |
| A gadget ready for someone else | Factory-provision and label it |
| New firmware for your gadgets | Sign and ship an update |
| A gadget to distribute | Distribution responsibilities and firmware licences |
Use the ESP32 SDK for board examples and reusable firmware code. Home Assistant operators can use the read-only probe.
Run a relay
Hosting explains who runs the gateway and how gadgets reach it. Start with Ship a gadget in one afternoon for a new relay and a gadget batch. Use Run the gateway away from your Mac for the detailed relay procedure. Only relay operators send firmware updates, with the CLI. Grok Bot has no update tool.
| Operator task | Guide |
|---|---|
| See requests and account use | Track usage |
| Grant account allowances and check receipts | Credits on your relay |
The connection guide covers the earlier Mac gateway route.
Explore or contribute
- Project status: releases, evidence and open gates.
- Roadmap: completed work and planned phases.
- Glossary: shared terms.
- Architecture: component responsibilities.
- How we verify: evidence levels.
- Contributing: find an issue and prepare a change.
Report your first run
| What you repeated | Report here |
|---|---|
| The owner-tested OLED kit | Independent tester report #185 |
| Your own relay and gadget batch | Outside builder report #269 |
Include the guide step, component versions, expected result and what you observed. Remove tokens and household details before sharing logs.