Repository navigation
Home
Nick Berardi edited this page Jul 19, 2026
·
9 revisions
Protocol reference for the scrypted-aprilaire Scrypted plugin.
Binary TCP protocol for Aprilaire / AprilAire Wi‑Fi thermostats used in home automation integrations.
| Page | Topics |
|---|---|
| Overview & Provisioning | Models, transport, provisioning, design rules |
| Packet Frame | Frame layout, sequence numbers, CRC, payload header |
| Actions & Transactions | Write, Read, COS, NACK, examples |
| Temperature Encoding | Packed Celsius byte format |
| Temperature Conversion Table | °C ↔ °F conversion pairs |
| NACK Codes | Error status codes and retry policy |
| Best Practices | Connect-time sync checklist |
| Attribute Table | Domains and attribute numbers |
| Guide Errata | Known defects in the source guide and how the wiki handles them |
| Page | Domain | Byte |
|---|---|---|
| Setup | Setup | 0x01 |
| Control | Control | 0x02 |
| Scheduling | Scheduling | 0x03 |
| Alerts | Alerts | 0x04 |
| Sensors | Sensors | 0x05 |
| Lockout | Lockout | 0x06 |
| Status | Status | 0x07 |
| Identification | Identification | 0x08 |
| Messaging & Display | Messaging / Display |
0x09 / 0x0A
|
| Page | Notes |
|---|---|
| Codebase Mapping | Protocol → src/ files and coverage |
| Implementation Backlog | Ranked open work items |
- Packet layout is the same across thermostat models; unsupported fields are ignored based on equipment capabilities.
- Additional model IDs and alternate ports used in the field are documented under Codebase Mapping.
Protocol reference for scrypted-aprilaire · Validate codecs with npm test