Deprecated โ Consolidated into PLAT-0004 on 2026-05-02 per ADR-0047. This source file is retained as a reference; the canonical content is in PLAT-0004.
ADR-0024: Region-Based Node Naming Scheme¶
Date: 2026-04-06 Status: Accepted
Context¶
The original node naming scheme used cae as a prefix derived from "CanEast"
-- the public alias for the platform. As the platform grows to potentially span
multiple physical sites (home, family locations, remote sites), the prefix
needed to encode geographic region and site number, not just a brand alias.
The public documentation uses site1 as a sanitized alias -- no geographic
information is exposed externally.
Decision¶
Internal naming pattern¶
{region}{site}{type}{n}
| Segment | Meaning | Examples |
|---|---|---|
| region | Geographic region code | cae, caw, cac |
| site | Site number within region | 1, 2, 3 |
| type | Device type | node, mqtt, fw, jmp, ot |
| n | Sequential device number | 1, 2, 3 |
Region codes¶
| Code | Region | Notes |
|---|---|---|
| cae | Canada East | Primary site -- Montreal area |
| caw | Canada West | Future -- Vancouver area |
| cac | Canada Central | Future -- Ontario/Prairies |
Site numbering per region¶
| Site | Location |
|---|---|
| cae1 | Primary home |
| cae2 | Family site (future) |
| cae3 | Cottage (future) |
| caw1 | Vancouver site (future) |
Public alias¶
All public-facing documentation uses site1 as a sanitized alias.
No region codes, site numbers, or geographic references are exposed externally.
sanitize.py and sanitize-devices.py enforce this on every pipeline run.
OT sensor pattern¶
{region}{site}ot{zone}esp{n}
| Zone | Location |
|---|---|
| ot-zone | Basement |
| ot-zone | Main floor / garage |
| ot-zone | Outdoor |
| ot-zone | Rack monitoring |
Example: caneast-site1-ot1-snr01 -- Canada East, site 1, basement zone, ESP32 node 1
Consequences¶
- Naming is forward-compatible with multi-site expansion
- Public docs never reveal internal site topology
- New sites require a new region/site code -- document in reference/naming.md
- OT-0001 (sensor naming convention) remains valid -- this ADR extends it
Related ADRs¶
- ADR-0008: CanEast public naming convention
- OT-0001: OT sensor naming convention