Ryan Malloy
2e439364bd
custom_components/omni_pca/ — drop-in HA integration: - manifest.json (HA 2026.x, iot_class=local_push, requires omni-pca lib) - config_flow.py — host/port/controller_key with auth + reauth steps, parse_controller_key() extracted as pure testable function - coordinator.py — OmniDataUpdateCoordinator with long-lived OmniClient, unsolicited push wiring, ConfigEntryAuthFailed on bad key, reconnect on err - binary_sensor.py — one entity per named zone, zone_type -> device_class map (OPENING/MOTION/SMOKE/etc), is_on derived from ZoneProperties.status - const.py, strings.json, translations/en.json, README.md - hacs.json at root for HACS distribution tests: 97 pass + 2 skip (HA harness not installed; importorskip in test_ha_imports.py). 12 cases for parse_controller_key validation. Ruff clean across src/ tests/ custom_components/. Status of HA component itself NOT validated against a running HA — needs that next.
68 lines
2.3 KiB
Markdown
68 lines
2.3 KiB
Markdown
# HAI / Leviton Omni Panel — Home Assistant Integration
|
|
|
|
Native HA integration that talks Omni-Link II directly to your **Omni Pro II
|
|
/ Omni IIe / Omni LTe / Lumina** controller over TCP. No middleware — HA
|
|
opens an encrypted session straight to the panel and listens for unsolicited
|
|
push messages.
|
|
|
|
This integration is the HA-facing wrapper around the
|
|
[`omni-pca`](https://github.com/rsp2k/omni-pca) Python library; the library
|
|
handles the wire protocol, this component surfaces it as HA entities.
|
|
|
|
## Install
|
|
|
|
### HACS (recommended once published)
|
|
|
|
1. HACS → Integrations → custom repository → add
|
|
`https://github.com/rsp2k/omni-pca`, category **Integration**.
|
|
2. Install **HAI / Leviton Omni Panel**, then restart Home Assistant.
|
|
|
|
### Manual
|
|
|
|
Copy the `custom_components/omni_pca/` directory into your HA
|
|
`config/custom_components/` directory and restart HA.
|
|
|
|
## Configure
|
|
|
|
1. **Settings → Devices & Services → Add Integration** → search for
|
|
*HAI/Leviton Omni Panel*.
|
|
2. Enter:
|
|
- **Host** — IP or hostname of the panel (e.g. `192.168.1.50`)
|
|
- **Port** — defaults to `4369` (HAI's reserved port)
|
|
- **Controller Key** — 32 hex characters, the panel's NVRAM key
|
|
3. Save. The panel's model and firmware appear as a single device, with one
|
|
`binary_sensor` per defined zone.
|
|
|
|
### Where do I get the Controller Key?
|
|
|
|
If you have a `.pca` configuration export from PC Access, the included CLI
|
|
extracts the key for you:
|
|
|
|
```bash
|
|
uvx omni-pca decode-pca '/path/to/My House.pca' --field controller_key
|
|
```
|
|
|
|
Otherwise, find it in PC Access under the panel's **Setup → Misc → Network**
|
|
page (HAI labels it "Encryption Key 1").
|
|
|
|
## What you get
|
|
|
|
- One **device** per panel — model + firmware reported in the UI.
|
|
- One **`binary_sensor`** per defined zone, named from the panel's own
|
|
zone-name field. `OPENING` device class for door/window contacts,
|
|
`MOTION` for interior PIRs, `SMOKE` for fire zones, etc., chosen by zone
|
|
type when the panel reports one.
|
|
- **Push updates**: zone state changes propagate within a single round-trip
|
|
thanks to unsolicited-message subscription. The 30-second poll is just a
|
|
safety net.
|
|
|
|
## Roadmap
|
|
|
|
- Areas → `alarm_control_panel` entities
|
|
- Units → `light` / `switch` entities
|
|
- Thermostats → `climate`
|
|
- Aux sensors → `sensor`
|
|
|
|
See the [parent README](https://github.com/rsp2k/omni-pca) for protocol /
|
|
library details.
|