URLs: github -> git.supported.systems/warehack.ing/{omni-pca,omni-pca-docs}
astro.config.mjs editLink baseUrl + GitHub social link README.md all references src/content/docs/changelog.md release tag URL src/content/docs/reference/library-api.md 'see github' note src/content/docs/reference/protocol.mdx opcodes.py source link src/content/docs/tutorials/dev-stack.md git clone command src/content/docs/how-to/install-in-home-assistant.md HACS custom-repo URL + manual git clone Build: 23 pages clean.
This commit is contained in:
parent
0c245b0af5
commit
9855211cd0
@ -1,6 +1,6 @@
|
|||||||
# hai-omni-docs
|
# hai-omni-docs
|
||||||
|
|
||||||
Documentation site for [`omni-pca`](https://github.com/rsp2k/omni-pca) — a
|
Documentation site for [`omni-pca`](https://git.supported.systems/warehack.ing/omni-pca) — a
|
||||||
reverse-engineered Python library and Home Assistant integration for HAI/Leviton
|
reverse-engineered Python library and Home Assistant integration for HAI/Leviton
|
||||||
Omni Pro II home automation panels. Built with Astro + Starlight, organised
|
Omni Pro II home automation panels. Built with Astro + Starlight, organised
|
||||||
around the Diátaxis framework.
|
around the Diátaxis framework.
|
||||||
@ -51,4 +51,4 @@ src/
|
|||||||
|
|
||||||
## Source project
|
## Source project
|
||||||
|
|
||||||
- Library + integration: <https://github.com/rsp2k/omni-pca>
|
- Library + integration: <https://git.supported.systems/warehack.ing/omni-pca>
|
||||||
|
|||||||
@ -28,12 +28,12 @@ export default defineConfig({
|
|||||||
{
|
{
|
||||||
icon: 'github',
|
icon: 'github',
|
||||||
label: 'GitHub',
|
label: 'GitHub',
|
||||||
href: 'https://github.com/rsp2k/omni-pca',
|
href: 'https://git.supported.systems/warehack.ing/omni-pca',
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
editLink: {
|
editLink: {
|
||||||
// Placeholder — update once the docs repo lives somewhere on GitHub.
|
// Placeholder — update once the docs repo lives somewhere on GitHub.
|
||||||
baseUrl: 'https://github.com/rsp2k/hai-omni-docs/edit/main/',
|
baseUrl: 'https://git.supported.systems/warehack.ing/omni-pca-docs/edit/main/',
|
||||||
},
|
},
|
||||||
lastUpdated: true,
|
lastUpdated: true,
|
||||||
pagination: true,
|
pagination: true,
|
||||||
|
|||||||
@ -196,4 +196,4 @@ panel's network module is currently off.
|
|||||||
install the wheel manually or pip-install from a Git URL.
|
install the wheel manually or pip-install from a Git URL.
|
||||||
- **HACS submission**: pending live-panel validation.
|
- **HACS submission**: pending live-panel validation.
|
||||||
|
|
||||||
[2026.5.10]: https://github.com/rsp2k/omni-pca/releases/tag/v2026.5.10
|
[2026.5.10]: https://git.supported.systems/warehack.ing/omni-pca/releases/tag/v2026.5.10
|
||||||
|
|||||||
@ -39,7 +39,7 @@ Until HACS publication, use Path B or add the project as a HACS *custom
|
|||||||
repository*:
|
repository*:
|
||||||
|
|
||||||
1. **HACS → Integrations → ⋮ → Custom repositories**
|
1. **HACS → Integrations → ⋮ → Custom repositories**
|
||||||
2. URL: `https://github.com/rsp2k/omni-pca`, category *Integration*.
|
2. URL: `https://git.supported.systems/warehack.ing/omni-pca`, category *Integration*.
|
||||||
3. Click **Add**, then download as in steps 1–3 above.
|
3. Click **Add**, then download as in steps 1–3 above.
|
||||||
|
|
||||||
## Path B — manual copy
|
## Path B — manual copy
|
||||||
@ -50,7 +50,7 @@ Works on any HA install (Container, Supervised, Core, OS):
|
|||||||
cd /path/to/your/homeassistant/config/ # the dir with configuration.yaml
|
cd /path/to/your/homeassistant/config/ # the dir with configuration.yaml
|
||||||
mkdir -p custom_components
|
mkdir -p custom_components
|
||||||
cd custom_components
|
cd custom_components
|
||||||
git clone https://github.com/rsp2k/omni-pca tmp-omni
|
git clone https://git.supported.systems/warehack.ing/omni-pca tmp-omni
|
||||||
cp -r tmp-omni/custom_components/omni_pca .
|
cp -r tmp-omni/custom_components/omni_pca .
|
||||||
rm -rf tmp-omni
|
rm -rf tmp-omni
|
||||||
```
|
```
|
||||||
|
|||||||
@ -139,7 +139,7 @@ security (`SECURITY_OFF`..`SECURITY_ARMING_NIGHT_DELAYED`), energy
|
|||||||
(`SHOW_MESSAGE_WITH_BEEP`..`EMAIL_MESSAGE`), scenes/misc
|
(`SHOW_MESSAGE_WITH_BEEP`..`EMAIL_MESSAGE`), scenes/misc
|
||||||
(`SCENE_OFF`..`STOP`), audio (`AUDIO_ZONE`..`AUDIO_KEY_PRESS`).
|
(`SCENE_OFF`..`STOP`), audio (`AUDIO_ZONE`..`AUDIO_KEY_PRESS`).
|
||||||
|
|
||||||
Source: [`omni_pca/commands.py`](https://github.com/rsp2k/omni-pca/blob/main/src/omni_pca/commands.py).
|
Source: [`omni_pca/commands.py`](https://git.supported.systems/warehack.ing/omni-pca/blob/main/src/omni_pca/commands.py).
|
||||||
|
|
||||||
Companion types:
|
Companion types:
|
||||||
|
|
||||||
@ -224,4 +224,4 @@ The package ships a `omni-pca` console script:
|
|||||||
---
|
---
|
||||||
|
|
||||||
For full details, the source has type hints and docstrings everywhere; see
|
For full details, the source has type hints and docstrings everywhere; see
|
||||||
[github.com/rsp2k/omni-pca](https://github.com/rsp2k/omni-pca).
|
[git.supported.systems/warehack.ing/omni-pca](https://git.supported.systems/warehack.ing/omni-pca).
|
||||||
|
|||||||
@ -189,7 +189,7 @@ TCP — the panel would accept it but no production deployment uses it.
|
|||||||
|
|
||||||
The inner Message format is documented at the top of this page (start
|
The inner Message format is documented at the top of this page (start
|
||||||
byte, length, opcode, data, CRC-16/MODBUS). The opcode tables for v1 and
|
byte, length, opcode, data, CRC-16/MODBUS). The opcode tables for v1 and
|
||||||
v2 live in [`omni_pca.opcodes`](https://github.com/rsp2k/omni-pca/blob/main/src/omni_pca/opcodes.py)
|
v2 live in [`omni_pca.opcodes`](https://git.supported.systems/warehack.ing/omni-pca/blob/main/src/omni_pca/opcodes.py)
|
||||||
— too long to reproduce here.
|
— too long to reproduce here.
|
||||||
|
|
||||||
### v2 `Login` (inner opcode 42) — *defined but unused on TCP*
|
### v2 `Login` (inner opcode 42) — *defined but unused on TCP*
|
||||||
|
|||||||
@ -17,7 +17,7 @@ change the library.
|
|||||||
- ~500 MB of free disk for the HA + builder images.
|
- ~500 MB of free disk for the HA + builder images.
|
||||||
- Port 8123 free on localhost.
|
- Port 8123 free on localhost.
|
||||||
- The `omni-pca` source repo cloned locally
|
- The `omni-pca` source repo cloned locally
|
||||||
(`git clone https://github.com/rsp2k/omni-pca`).
|
(`git clone https://git.supported.systems/warehack.ing/omni-pca`).
|
||||||
|
|
||||||
## Step 1 — boot the stack
|
## Step 1 — boot the stack
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user