hacs: switch canonical URLs to github.com/rsp2k/omni-pca + add validation CI
- manifest.json documentation/issue_tracker → GitHub (where HACS users land) - README install instructions → `pip install omni-pca` (now on PyPI) - pyproject.toml URLs → Repository / Issues / Changelog / Documentation - custom_components README → HACS default-catalog install flow - .github/workflows/validate.yml: hacs/action + hassfest on push/PR/weekly Library remains importable from PyPI; integration tracks the same release tag.
This commit is contained in:
parent
116591be90
commit
16655da34c
26
.github/workflows/validate.yml
vendored
Normal file
26
.github/workflows/validate.yml
vendored
Normal file
@ -0,0 +1,26 @@
|
||||
name: Validate
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
schedule:
|
||||
- cron: "0 4 * * 1" # weekly Monday 04:00 UTC
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
hacs:
|
||||
name: HACS validation
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: hacs/action@main
|
||||
with:
|
||||
category: integration
|
||||
|
||||
hassfest:
|
||||
name: Hassfest
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: home-assistant/actions/hassfest@master
|
||||
@ -82,4 +82,4 @@ First release. Working library + Home Assistant custom component, validated end-
|
||||
- **PyPI publish**: `omni-pca` not yet on PyPI; HA `manifest.json` requirements line will only resolve once it is. For now users either install the wheel manually or pip-install from a Git URL.
|
||||
- **HACS submission**: pending live-panel validation.
|
||||
|
||||
[2026.5.10]: https://git.supported.systems/warehack.ing/omni-pca/releases/tag/v2026.5.10
|
||||
[2026.5.10]: https://github.com/rsp2k/omni-pca/releases/tag/v2026.5.10
|
||||
|
||||
16
README.md
16
README.md
@ -4,7 +4,7 @@ Async Python client for HAI/Leviton Omni-Link II home automation panels — Omni
|
||||
|
||||
Includes a Home Assistant custom component (`custom_components/omni_pca/`).
|
||||
|
||||
**Project home:** <https://git.supported.systems/warehack.ing/omni-pca>
|
||||
**Project home:** <https://github.com/rsp2k/omni-pca>
|
||||
**Documentation:** <https://hai-omni-pro-ii.warehack.ing/>
|
||||
|
||||
## Status
|
||||
@ -18,20 +18,14 @@ The full byte-level protocol spec lives at <https://hai-omni-pro-ii.warehack.ing
|
||||
|
||||
## Install
|
||||
|
||||
The library isn't on PyPI yet (pending), so install directly from the Gitea release:
|
||||
|
||||
```bash
|
||||
# Pinned to a specific release (recommended)
|
||||
pip install "omni-pca @ git+https://git.supported.systems/warehack.ing/omni-pca.git@v2026.5.10"
|
||||
|
||||
# Or the wheel from the release page
|
||||
pip install https://git.supported.systems/warehack.ing/omni-pca/releases/download/v2026.5.10/omni_pca-2026.5.10-py3-none-any.whl
|
||||
pip install omni-pca
|
||||
|
||||
# Or with uv
|
||||
uv add "omni-pca @ git+https://git.supported.systems/warehack.ing/omni-pca.git@v2026.5.10"
|
||||
uv add omni-pca
|
||||
```
|
||||
|
||||
Once published to PyPI, the canonical install will be `pip install omni-pca`.
|
||||
For Home Assistant users, install the integration through HACS — see the [HA install how-to](https://hai-omni-pro-ii.warehack.ing/how-to/install-in-home-assistant/).
|
||||
|
||||
## Quick start (library)
|
||||
|
||||
@ -79,7 +73,7 @@ The HA integration picks the right client automatically based on the **Transport
|
||||
cd /path/to/your/homeassistant/config/
|
||||
mkdir -p custom_components
|
||||
cd custom_components
|
||||
git clone https://git.supported.systems/warehack.ing/omni-pca tmp-omni
|
||||
git clone https://github.com/rsp2k/omni-pca tmp-omni
|
||||
cp -r tmp-omni/custom_components/omni_pca .
|
||||
rm -rf tmp-omni
|
||||
```
|
||||
|
||||
@ -6,16 +6,18 @@ 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://git.supported.systems/warehack.ing/omni-pca) Python library; the library
|
||||
[`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)
|
||||
### HACS
|
||||
|
||||
1. HACS → Integrations → custom repository → add
|
||||
`https://git.supported.systems/warehack.ing/omni-pca`, category **Integration**.
|
||||
2. Install **HAI / Leviton Omni Panel**, then restart Home Assistant.
|
||||
1. HACS → Integrations → search **HAI / Leviton Omni Panel**.
|
||||
2. Install, then restart Home Assistant.
|
||||
|
||||
(If not yet in the HACS default catalog: HACS → Integrations → custom
|
||||
repository → add `https://github.com/rsp2k/omni-pca`, category **Integration**.)
|
||||
|
||||
### Manual
|
||||
|
||||
@ -121,6 +123,6 @@ hashed) — useful for bug reports.
|
||||
- **No entities for X**: only objects with a name configured on the panel
|
||||
are discovered. PC Access's "Names" page is where they live.
|
||||
|
||||
See the [parent README](https://git.supported.systems/warehack.ing/omni-pca) for protocol /
|
||||
See the [parent README](https://github.com/rsp2k/omni-pca) for protocol /
|
||||
library details. Detailed reverse-engineering notes are in
|
||||
[`docs/JOURNEY.md`](https://git.supported.systems/warehack.ing/omni-pca/blob/main/docs/JOURNEY.md).
|
||||
[`docs/JOURNEY.md`](https://github.com/rsp2k/omni-pca/blob/main/docs/JOURNEY.md).
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
"dependencies": [],
|
||||
"codeowners": ["@rsp2k"],
|
||||
"requirements": ["omni-pca==2026.5.11"],
|
||||
"documentation": "https://git.supported.systems/warehack.ing/omni-pca",
|
||||
"issue_tracker": "https://git.supported.systems/warehack.ing/omni-pca/issues",
|
||||
"documentation": "https://github.com/rsp2k/omni-pca",
|
||||
"issue_tracker": "https://github.com/rsp2k/omni-pca/issues",
|
||||
"integration_type": "hub"
|
||||
}
|
||||
|
||||
@ -34,7 +34,10 @@ engine = ["astral>=2.2,<3"]
|
||||
omni-pca = "omni_pca.__main__:main"
|
||||
|
||||
[project.urls]
|
||||
Repository = "https://git.supported.systems/warehack.ing/omni-pca"
|
||||
Repository = "https://github.com/rsp2k/omni-pca"
|
||||
Issues = "https://github.com/rsp2k/omni-pca/issues"
|
||||
Changelog = "https://github.com/rsp2k/omni-pca/blob/main/CHANGELOG.md"
|
||||
Documentation = "https://hai-omni-pro-ii.warehack.ing/"
|
||||
|
||||
[build-system]
|
||||
requires = ["uv_build>=0.11.8,<0.12.0"]
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user