Appearance
Integration Guide
This guide is for IT teams and developers who want to pull CoppelBox device data — telemetry, power readings, alerts — into their own systems, or who need to understand the wire protocol a CoppelBox unit speaks.
Scope: this guide covers CoppelBox devices (the ESP32-based units documented in Using Your CoppelBox Unit) on shipped firmware (v1.0.x). It does not cover the legacy Avior device integration, which uses a different protocol.
What's covered
| Page | Contents |
|---|---|
| How Integration Works | The device-to-cloud architecture, what data exists, and your two integration options |
| MQTT API | The broker, the /cbox/... topic structure, and message payload formats |
| Telemetry | Status packets, power data, and how often each is published |
| Alerts | How alerts are raised, their payload structure, and how to consume them |
| Authentication & Access | The credentials model, IoT policy scoping, and rate limits |
| Examples | Concrete sample payloads and a worked subscription flow |
Before you start
CoppelBox devices talk MQTT to AWS IoT Core, and that traffic is what ultimately populates the platform's real-time dashboard. The same field names and payload shapes described here also show up in the platform's GraphQL API (AppSync), so this guide is useful whether you end up subscribing to MQTT directly or consuming the data through the API — see Authentication & Access for which one applies to you.