Install pages: Gitea-release URLs while PyPI publish is pending

quickstart:
  - 'pip install omni-pca' -> pip install from git+https at the v2026.5.10 tag
  - uvx --from form documented for no-install runs
  - note callout that PyPI publish is pending and what to switch to once it lands

install-in-home-assistant:
  - Common errors table: replace generic 'check internet' fix with a
    concrete pre-install command using the release wheel URL
  - Known gaps: same wheel install command shown inline with HA-OS hint

Build clean, 23 pages.
This commit is contained in:
Ryan Malloy 2026-05-10 17:55:00 -06:00
parent 9855211cd0
commit 0525895dbe
2 changed files with 31 additions and 10 deletions

View File

@ -123,7 +123,7 @@ Optional polish:
| *Failed to connect* | TCP refused or timed out | See [no entities](#the-integration-loads-but-no-entities-appear). | | *Failed to connect* | TCP refused or timed out | See [no entities](#the-integration-loads-but-no-entities-appear). |
| *Invalid authentication* | ControllerKey wrong or panel rejected the secure handshake | Double-check the 32 hex chars, no spaces, lowercase or uppercase both fine. Re-extract via [find ControllerKey](/how-to/find-controller-key/). | | *Invalid authentication* | ControllerKey wrong or panel rejected the secure handshake | Double-check the 32 hex chars, no spaces, lowercase or uppercase both fine. Re-extract via [find ControllerKey](/how-to/find-controller-key/). |
| *Already configured* | You added the same `host:port` twice | Remove the existing entry first; HA enforces unique-per-host. | | *Already configured* | You added the same `host:port` twice | Remove the existing entry first; HA enforces unique-per-host. |
| *Unable to install requirement omni-pca==2026.5.10* | HA can't reach PyPI to install the wire-protocol library | Check internet connectivity from HA. If on a restricted network, pre-install the wheel manually (see project README). | | *Unable to install requirement omni-pca==2026.5.10* | HA can't fetch the wire-protocol library | Until PyPI publish lands, pre-install the wheel into HA's Python with `pip install https://git.supported.systems/warehack.ing/omni-pca/releases/download/v2026.5.10/omni_pca-2026.5.10-py3-none-any.whl`, then restart HA. |
## The integration loads but no entities appear ## The integration loads but no entities appear
@ -170,8 +170,16 @@ No restart needed.
custom-repository workflow above (or path B) until then. custom-repository workflow above (or path B) until then.
- The library `omni-pca` is **not yet on PyPI**. HA's - The library `omni-pca` is **not yet on PyPI**. HA's
`manifest.json` requires `omni-pca==2026.5.10`; that resolves once `manifest.json` requires `omni-pca==2026.5.10`; that resolves once
publish lands. Until then, install the wheel manually. publish lands. Until then, manually pre-install the wheel into HA's
Python:
```bash
pip install https://git.supported.systems/warehack.ing/omni-pca/releases/download/v2026.5.10/omni_pca-2026.5.10-py3-none-any.whl
```
HA OS users: drop into the SSH/Web add-on shell or use the *Advanced
SSH & Web Terminal* add-on first.
- Live-panel validation against a real Omni Pro II is in progress. - Live-panel validation against a real Omni Pro II is in progress.
Mock-panel coverage is comprehensive (351 tests), but a real-world Mock-panel coverage is comprehensive (351 tests), but a real-world
bug-bash hasn't happened yet. Report anything weird via GitHub bug-bash hasn't happened yet. Report anything weird as a Gitea issue
issues with a [diagnostics download](#verify-it-loaded). with a [diagnostics download](#verify-it-loaded).

View File

@ -15,19 +15,32 @@ the encrypted `.pca` blob. No panel hardware required — the file already
contains everything you need. contains everything you need.
```bash ```bash
pip install omni-pca # omni-pca isn't on PyPI yet — install from the Gitea release:
# or, no install: pip install "omni-pca @ git+https://git.supported.systems/warehack.ing/omni-pca.git@v2026.5.10"
uvx omni-pca decode-pca '/path/to/Your.pca' --field controller_key
omni-pca decode-pca '/path/to/Your.pca' --field controller_key
```
Or, with no permanent install:
```bash
uvx --from "git+https://git.supported.systems/warehack.ing/omni-pca.git@v2026.5.10" \
omni-pca decode-pca '/path/to/Your.pca' --field controller_key
``` ```
Other useful fields: Other useful fields:
```bash ```bash
uvx omni-pca decode-pca '/path/to/Your.pca' --field host omni-pca decode-pca '/path/to/Your.pca' --field host
uvx omni-pca decode-pca '/path/to/Your.pca' --field port omni-pca decode-pca '/path/to/Your.pca' --field port
uvx omni-pca decode-pca '/path/to/Your.pca' --include-pii # full dump, with account info omni-pca decode-pca '/path/to/Your.pca' --include-pii # full dump, with account info
``` ```
:::note[PyPI publish is pending]
Once `omni-pca` lands on PyPI the install collapses to `pip install omni-pca`
or `uvx omni-pca ...`. Until then, the git-URL form above is the way.
:::
:::caution[The decrypted `.pca` plaintext contains PII] :::caution[The decrypted `.pca` plaintext contains PII]
Account name, address, phone number, and (commonly) factory-default user Account name, address, phone number, and (commonly) factory-default user
codes all live in the file in plaintext after decryption. The CLI redacts codes all live in the file in plaintext after decryption. The CLI redacts