Documentation
On this page
Choose the task you want to complete. Current setup needs an operator, a Mac gateway and a configured gadget. Phone-only setup is planned, not available today.
Use a configured gadget
- Ask the operator to confirm the gadget and gateway are ready.
- Connect your Grok Bot and complete OAuth sign-in.
- Ask Grok Bot to list gadgets, show text or read the button events.
- If a step fails, use the troubleshooting lookup.
The owner verified Mac and iPhone calls. See current support before you choose another platform.
Build a gadget
| Starting point | Guide |
|---|---|
| No hardware | First success with the simulator |
| The tested ESP32-S3 and OLED | Parts and wiring, then repeat the setup |
| A Linux application | Linux SDK |
Use the ESP32 SDK for board examples and reusable firmware code. Use the gateway for device routing and Grok Bot tools. Home Assistant operators can use the read-only probe.
Reference
- Glossary: shared terms.
- Repository and device map: component responsibilities.
- Hosting: the current connection and its limits.
- Gateway protocol: tool and transport references.
Status and roadmap
Project status lists releases and support. The roadmap separates completed work, planned phases and owner decisions.
Verification and contribution
How we verify explains the evidence levels. The daily record contains the latest owner observations and logs. Report a repeat test in #185. For code or documentation work, read Contributing.