Some Omni network modules are configured for UDP, in which case PC Access
falls back to the v1 wire protocol (OmniLinkMessage outer = 0x10, inner
StartChar 0x5A, typed Request*Status opcodes) instead of v2's TCP path
(OmniLink2Message + StartChar 0x21 + parameterised RequestProperties).
This adds a parallel implementation rather than overloading the v2 path.
omni_pca/v1/
connection.py UDP-only OmniConnectionV1; reuses crypto + handshake,
routes post-handshake messages through OmniLinkMessage
(0x10) wrapping v1 inner format. Adds iter_streaming
for the lock-step UploadNames/Acknowledge/EOD pattern.
messages.py Block parsers for the typed v1 status replies (zone,
unit, thermostat, aux), v1 SystemStatus, and NameData
(handles both one-byte and two-byte NameNumber forms).
client.py OmniClientV1: read API (get_system_information,
get_*_status), discovery (iter_names + list_*_names),
write API (execute_command, execute_security_command,
turn_unit_*, set_unit_level, bypass/restore_zone,
execute_button, set_thermostat_*). acknowledge_alerts
is a no-op (v1 has no equivalent opcode).
Discovery uses bare UploadNames; panel streams every defined name across
all types in a fixed order with per-record Acknowledge. Verified against
firmware 2.12 — pulled 16 zones, 44 units, 16 buttons, 8 codes,
2 thermostats, 8 messages in one stream.
src/omni_pca/message.py
Fix flipped START_CHAR_V1_* constants. enuOmniLinkMessageFormat says
Addressable=0x41 and NonAddressable=0x5A; our names had them swapped.
Wire bytes were unchanged, so existing tests kept passing — but
encode_v1() with no serial_address now correctly emits 0x5A, which
is what UDP needs.
tests/
test_v1_messages.py 22 cases; payloads are real wire captures
from a firmware-2.12 panel via probe_v1_recon.
test_v1_client_commands.py 20 cases; payload-packing for the Command
and ExecuteSecurityCommand opcodes,
including BE u16 parameter2 and the
digit-by-digit security code form.
dev/
probe_v1.py Phase-1 smoke: handshake + RequestSystemInformation.
probe_v1_recon.py Raw opcode dump for protocol reconnaissance.
probe_v1_stream.py Streaming UploadNames flow exploration.
probe_v1_client.py Full read-path smoke test via OmniClientV1.
probe_v1_write.py Live no-op execute_command round-trip.
.gitignore: ignore dev/.omni_key (probe scripts read controller key from
this file as one fallback option).
Discovery on firmware 2.12: Request*ExtendedStatus opcodes (63/65/69)
NAK on this firmware — only the basic Request*Status opcodes are
implemented, so OmniClientV1 uses those (3 bytes/unit, 7 bytes/tstat,
4 bytes/aux records). HA still gets enough signal for polling; full
properties discovery uses streaming UploadNames instead.
Test totals: 387 passed, 1 skipped (existing fixture skip).
94 lines
3.6 KiB
Python
94 lines
3.6 KiB
Python
#!/usr/bin/env python3
|
|
"""Phase-2c live write smoke test: round-trip a no-op unit command.
|
|
|
|
Reads the current state of one unit, sends a command that should yield
|
|
the same observable result, then re-reads to confirm. Proves that
|
|
:meth:`OmniClientV1.execute_command` actually flows through the v1
|
|
Command opcode against the real panel without changing anything visible.
|
|
|
|
Run:
|
|
cd /home/kdm/home-auto/omni-pca
|
|
uv run python dev/probe_v1_write.py [--index N]
|
|
|
|
Default target is unit #4 ('STAIRS' per current panel config).
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import argparse
|
|
import asyncio
|
|
import logging
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
sys.path.insert(0, str(Path(__file__).parent))
|
|
from probe_v1 import _load_key # type: ignore # noqa: E402
|
|
|
|
from omni_pca.v1 import OmniClientV1
|
|
|
|
|
|
async def amain(args: argparse.Namespace) -> int:
|
|
key = _load_key(args.key)
|
|
print(f"[write probe] target {args.host}:{args.port} unit #{args.index}\n")
|
|
|
|
async with OmniClientV1(
|
|
host=args.host, port=args.port, controller_key=key, timeout=4.0
|
|
) as c:
|
|
before = (await c.get_unit_status(args.index, args.index))[args.index]
|
|
print(f"BEFORE: state=0x{before.state:02x} "
|
|
f"brightness={before.brightness!r} "
|
|
f"time_remaining={before.time_remaining_secs}s")
|
|
|
|
# Pick the safest no-op command for the unit's current state:
|
|
# - state == 0 → send UNIT_OFF (already off, panel acks)
|
|
# - state == 1 → send UNIT_ON (already on, panel acks)
|
|
# - 100 <= state <= 200 → set_unit_level(percent) at the current level
|
|
# - otherwise (scene/dim/etc.) → fall back to UNIT_ON which is harmless
|
|
if before.state == 0:
|
|
print("ACTION: turn_unit_off (already off, expecting Ack)")
|
|
await c.turn_unit_off(args.index)
|
|
elif before.state == 1:
|
|
print("ACTION: turn_unit_on (already on, expecting Ack)")
|
|
await c.turn_unit_on(args.index)
|
|
elif 100 <= before.state <= 200:
|
|
level = before.state - 100
|
|
print(f"ACTION: set_unit_level({level}%) (already at this level)")
|
|
await c.set_unit_level(args.index, level)
|
|
else:
|
|
print(f"ACTION: turn_unit_on (state=0x{before.state:02x} is exotic; safe ack expected)")
|
|
await c.turn_unit_on(args.index)
|
|
|
|
# Give the panel ~250ms to settle if it does pulse anything.
|
|
await asyncio.sleep(0.25)
|
|
|
|
after = (await c.get_unit_status(args.index, args.index))[args.index]
|
|
print(f"AFTER: state=0x{after.state:02x} "
|
|
f"brightness={after.brightness!r} "
|
|
f"time_remaining={after.time_remaining_secs}s")
|
|
|
|
if after.state == before.state:
|
|
print("\n✓ panel acked the Command, state unchanged — wire path verified")
|
|
else:
|
|
print(f"\n⚠ state changed (0x{before.state:02x} → 0x{after.state:02x}). "
|
|
"Probably harmless but worth investigating.")
|
|
return 0
|
|
|
|
|
|
def main() -> int:
|
|
parser = argparse.ArgumentParser(description=__doc__)
|
|
parser.add_argument("--host", default="192.168.1.9")
|
|
parser.add_argument("--port", type=int, default=4369)
|
|
parser.add_argument("--key", help="32 hex chars; overrides env/.omni_key")
|
|
parser.add_argument("--index", type=int, default=4)
|
|
parser.add_argument("--debug", action="store_true")
|
|
args = parser.parse_args()
|
|
logging.basicConfig(
|
|
level=logging.DEBUG if args.debug else logging.WARNING,
|
|
format="%(asctime)s %(levelname)s %(name)s: %(message)s",
|
|
)
|
|
return asyncio.run(amain(args))
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|