steamloop 1.1.0__tar.gz → 1.2.1__tar.gz

{steamloop-1.1.0 → steamloop-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: steamloop
-Version: 1.1.0
+Version: 1.2.1
 Summary: Local control for choochoo based thermostats
 Author-email: "J. Nick Koston" <nick@koston.org>
 License-Expression: Apache-2.0
@@ -68,7 +68,7 @@ pip install steamloop
 
 ### Pairing
 
-Put the thermostat in pairing mode (Menu > Settings > Remote Access > Pair New Device), then:
+Put the thermostat in pairing mode (Menu > Settings > Network > Advanced Setup > Remote Connection > Pair), then:
 
 ```bash
 steamloop 192.168.1.100 --pair
@@ -82,6 +82,12 @@ This saves a pairing file in the current directory with the secret key.
 steamloop 192.168.1.100
 ```
 
+If already paired, you can pass the secret key directly to skip the pairing file:
+
+```bash
+steamloop 192.168.1.100 --key YOUR_SECRET_KEY
+```
+
 Interactive commands: `status`, `heat <temp>`, `cool <temp>`, `mode <off|auto|cool|heat>`, `fan <auto|on|circulate>`, `eheat <on|off>`, `help`.
 
 ## Library Usage

{steamloop-1.1.0 → steamloop-1.2.1}/README.md

@@ -44,7 +44,7 @@ pip install steamloop
 
 ### Pairing
 
-Put the thermostat in pairing mode (Menu > Settings > Remote Access > Pair New Device), then:
+Put the thermostat in pairing mode (Menu > Settings > Network > Advanced Setup > Remote Connection > Pair), then:
 
 ```bash
 steamloop 192.168.1.100 --pair
@@ -58,6 +58,12 @@ This saves a pairing file in the current directory with the secret key.
 steamloop 192.168.1.100
 ```
 
+If already paired, you can pass the secret key directly to skip the pairing file:
+
+```bash
+steamloop 192.168.1.100 --key YOUR_SECRET_KEY
+```
+
 Interactive commands: `status`, `heat <temp>`, `cool <temp>`, `mode <off|auto|cool|heat>`, `fan <auto|on|circulate>`, `eheat <on|off>`, `help`.
 
 ## Library Usage

{steamloop-1.1.0 → steamloop-1.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ requires = [ "setuptools>=77.0.3" ]
 
 [project]
 name = "steamloop"
-version = "1.1.0"
+version = "1.2.1"
 description = "Local control for choochoo based thermostats"
 readme = "README.md"
 license = "Apache-2.0"

{steamloop-1.1.0 → steamloop-1.2.1}/src/steamloop/__init__.py

@@ -1,6 +1,6 @@
 """Local control for thermostat devices over mTLS."""
 
-__version__ = "1.1.0"
+__version__ = "1.2.1"
 
 from .connection import ThermostatConnection, load_pairing, save_pairing
 from .const import DEFAULT_PORT, FanMode, HoldType, ZoneMode

{steamloop-1.1.0 → steamloop-1.2.1}/src/steamloop/cli.py

@@ -19,8 +19,8 @@ if TYPE_CHECKING:
 
 _LOGGER = logging.getLogger(__name__)
 
-_EHEAT_LABELS = {"": "N/A", "1": "On", "2": "Off"}
-_ACTIVE_LABELS = {"": "N/A", "1": "Inactive", "2": "Active"}
+_EHEAT_LABELS = {"": "N/A", "0": "Off", "1": "On"}
+_ACTIVE_LABELS = {"": "N/A", "0": "Inactive", "1": "Idle", "2": "Active"}
 
 _HOLD_MAP: dict[str, HoldType] = {
     "manual": HoldType.MANUAL,
@@ -225,22 +225,30 @@ async def _do_pair(ip: str, port: int) -> None:
     await _do_monitor(ip, port)
 
 
-async def _do_monitor(ip: str, port: int) -> None:
+async def _do_monitor(ip: str, port: int, secret_key: str | None = None) -> None:
     """Run monitoring mode with interactive command loop."""
-    pairing = await load_pairing(ip)
-    if not pairing:
-        print("No pairing found. Run with --pair first.")
-        return
-
-    print("\n=== MONITORING MODE ===")
-    print(f"Using saved pairing for {ip}")
+    if secret_key is not None:
+        print("\n=== MONITORING MODE ===")
+        print(f"Using provided secret key for {ip}")
+        device_type = "automation"
+        device_id = "module"
+    else:
+        pairing = await load_pairing(ip)
+        if not pairing:
+            print("No pairing found. Run with --pair or --key first.")
+            return
+        print("\n=== MONITORING MODE ===")
+        print(f"Using saved pairing for {ip}")
+        secret_key = pairing["secret_key"]
+        device_type = pairing.get("device_type", "automation")
+        device_id = pairing.get("device_id", "module")
 
     conn = ThermostatConnection(
         ip,
         port,
-        secret_key=pairing["secret_key"],
-        device_type=pairing.get("device_type", "automation"),
-        device_id=pairing.get("device_id", "module"),
+        secret_key=secret_key,
+        device_type=device_type,
+        device_id=device_id,
     )
 
     def on_event(msg: dict[str, Any]) -> None:
@@ -295,6 +303,9 @@ def main() -> None:
         help=f"Port (default: {DEFAULT_PORT})",
     )
     parser.add_argument("--pair", action="store_true", help="Enter pairing mode")
+    parser.add_argument(
+        "--key", help="Secret key from a previous pairing (skip pairing file lookup)"
+    )
     parser.add_argument("--debug", action="store_true", help="Enable debug logging")
     args = parser.parse_args()
 
@@ -308,4 +319,4 @@ def main() -> None:
     if args.pair:
         asyncio.run(_do_pair(args.ip, args.port))
     else:
-        asyncio.run(_do_monitor(args.ip, args.port))
+        asyncio.run(_do_monitor(args.ip, args.port, secret_key=args.key))

{steamloop-1.1.0 → steamloop-1.2.1}/src/steamloop/connection.py

@@ -23,6 +23,7 @@ from .const import (
     CONNECT_TIMEOUT,
     DEFAULT_PORT,
     HEARTBEAT_INTERVAL,
+    INITIAL_STATE_TIMEOUT,
     PAIRING_TIMEOUT,
     RECONNECT_DELAY,
     RECONNECT_MAX,
@@ -486,6 +487,10 @@ class ThermostatConnection:
         """
         Authenticate with the thermostat.
 
+        After receiving the login response, waits for the initial burst
+        of state events (zone discovery, temperatures, etc.) to arrive
+        before returning. This ensures ``state`` is fully populated.
+
         Returns:
             LoginResponse on success.
 
@@ -507,6 +512,7 @@ class ThermostatConnection:
             )
             loop = asyncio.get_running_loop()
             deadline = loop.time() + RESPONSE_TIMEOUT
+            login_resp: LoginResponse | None = None
             while (remaining := deadline - loop.time()) > 0:
                 try:
                     msg = await asyncio.wait_for(queue.get(), timeout=remaining)
@@ -516,19 +522,30 @@ class ThermostatConnection:
                     continue
                 resp = msg["Response"]
                 if "LoginResponse" in resp:
-                    login_resp: LoginResponse = resp["LoginResponse"]
+                    login_resp = resp["LoginResponse"]
                     if login_resp.get("status") == "1":
                         _LOGGER.info("Authenticated successfully")
-                        return login_resp
+                        break
                     raise AuthenticationError(f"Authentication failed: {login_resp}")
                 if "Error" in resp:
                     err: ErrorResponse = resp["Error"]
                     raise AuthenticationError(
                         f"Error {err.get('error_type')}: {err.get('description')}"
                     )
+            if login_resp is None:
+                raise AuthenticationError("No login response received")
+            # Drain the initial state burst — the thermostat sends zone
+            # discovery events right after the login response.  Keep
+            # reading until the stream goes quiet so that callers see a
+            # fully-populated ``state`` when login() returns.
+            while True:
+                try:
+                    await asyncio.wait_for(queue.get(), timeout=INITIAL_STATE_TIMEOUT)
+                except TimeoutError:
+                    break
+            return login_resp
         finally:
             self._message_queue = None
-        raise AuthenticationError("No login response received")
 
     async def pair(self) -> SetSecretKeyRequest:
         """

{steamloop-1.1.0 → steamloop-1.2.1}/src/steamloop/const.py

@@ -43,6 +43,7 @@ HEARTBEAT_INTERVAL = 55  # seconds (thermostat expects every 60s)
 CONNECT_TIMEOUT = 10
 PAIRING_TIMEOUT = 120
 RESPONSE_TIMEOUT = 10
+INITIAL_STATE_TIMEOUT = 1  # seconds to wait for initial state after login
 RECONNECT_DELAY = 5  # initial delay before first reconnect attempt
 RECONNECT_MAX = 300  # max delay between reconnect attempts (5 minutes)
 BACKOFF_FACTOR = 2  # multiply delay by this on each failure

{steamloop-1.1.0 → steamloop-1.2.1}/src/steamloop.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: steamloop
-Version: 1.1.0
+Version: 1.2.1
 Summary: Local control for choochoo based thermostats
 Author-email: "J. Nick Koston" <nick@koston.org>
 License-Expression: Apache-2.0
@@ -68,7 +68,7 @@ pip install steamloop
 
 ### Pairing
 
-Put the thermostat in pairing mode (Menu > Settings > Remote Access > Pair New Device), then:
+Put the thermostat in pairing mode (Menu > Settings > Network > Advanced Setup > Remote Connection > Pair), then:
 
 ```bash
 steamloop 192.168.1.100 --pair
@@ -82,6 +82,12 @@ This saves a pairing file in the current directory with the secret key.
 steamloop 192.168.1.100
 ```
 
+If already paired, you can pass the secret key directly to skip the pairing file:
+
+```bash
+steamloop 192.168.1.100 --key YOUR_SECRET_KEY
+```
+
 Interactive commands: `status`, `heat <temp>`, `cool <temp>`, `mode <off|auto|cool|heat>`, `fan <auto|on|circulate>`, `eheat <on|off>`, `help`.
 
 ## Library Usage

{steamloop-1.1.0 → steamloop-1.2.1}/tests/test_cli.py

@@ -542,7 +542,7 @@ def test_main_pair_mode() -> None:
         patch(
             "steamloop.cli.argparse.ArgumentParser.parse_args",
             return_value=MagicMock(
-                ip="192.168.1.100", port=7878, pair=True, debug=False
+                ip="192.168.1.100", port=7878, pair=True, key=None, debug=False
             ),
         ),
         patch(
@@ -561,16 +561,37 @@ def test_main_monitor_mode() -> None:
         patch(
             "steamloop.cli.argparse.ArgumentParser.parse_args",
             return_value=MagicMock(
-                ip="192.168.1.100", port=7878, pair=False, debug=False
+                ip="192.168.1.100", port=7878, pair=False, key=None, debug=False
             ),
         ),
         patch(
             "steamloop.cli._do_monitor",
             new_callable=lambda: MagicMock(return_value=sentinel),
+        ) as mock_monitor,
+        patch("steamloop.cli.asyncio.run") as mock_run,
+    ):
+        main()
+    mock_monitor.assert_called_once_with("192.168.1.100", 7878, secret_key=None)
+    mock_run.assert_called_once_with(sentinel)
+
+
+def test_main_monitor_with_key() -> None:
+    sentinel = object()
+    with (
+        patch(
+            "steamloop.cli.argparse.ArgumentParser.parse_args",
+            return_value=MagicMock(
+                ip="192.168.1.100", port=7878, pair=False, key="my-key", debug=False
+            ),
         ),
+        patch(
+            "steamloop.cli._do_monitor",
+            new_callable=lambda: MagicMock(return_value=sentinel),
+        ) as mock_monitor,
         patch("steamloop.cli.asyncio.run") as mock_run,
     ):
         main()
+    mock_monitor.assert_called_once_with("192.168.1.100", 7878, secret_key="my-key")
     mock_run.assert_called_once_with(sentinel)
 
 
@@ -579,7 +600,7 @@ def test_main_debug_mode() -> None:
         patch(
             "steamloop.cli.argparse.ArgumentParser.parse_args",
             return_value=MagicMock(
-                ip="192.168.1.100", port=7878, pair=False, debug=True
+                ip="192.168.1.100", port=7878, pair=False, key=None, debug=True
             ),
         ),
         patch(
@@ -594,3 +615,44 @@ def test_main_debug_mode() -> None:
 
     mock_logging.assert_called_once()
     assert mock_logging.call_args[1]["level"] == logging.DEBUG
+
+
+async def test_do_monitor_with_key_skips_pairing_file(
+    capsys: pytest.CaptureFixture[str],
+) -> None:
+    """When secret_key is provided, pairing file is not loaded."""
+    mock_conn = MagicMock()
+    mock_conn.connected = True
+    mock_conn.state = ThermostatState()
+    mock_conn.add_event_callback = MagicMock(return_value=lambda: None)
+
+    async def _mock_aenter(self: Any) -> MagicMock:
+        return mock_conn
+
+    mock_conn.__aenter__ = _mock_aenter
+    mock_conn.__aexit__ = AsyncMock(return_value=False)
+
+    with (
+        patch(
+            "steamloop.cli.load_pairing",
+            new_callable=AsyncMock,
+        ) as mock_load,
+        patch(
+            "steamloop.cli.ThermostatConnection",
+            return_value=mock_conn,
+        ) as mock_cls,
+        patch("steamloop.cli.sys.stdin") as mock_stdin,
+    ):
+        mock_stdin.readline.side_effect = KeyboardInterrupt
+        await _do_monitor("192.168.1.100", 7878, secret_key="my-key")
+
+    mock_load.assert_not_called()
+    mock_cls.assert_called_once_with(
+        "192.168.1.100",
+        7878,
+        secret_key="my-key",
+        device_type="automation",
+        device_id="module",
+    )
+    captured = capsys.readouterr()
+    assert "provided secret key" in captured.out

{steamloop-1.1.0 → steamloop-1.2.1}/tests/test_connection.py

@@ -349,7 +349,8 @@ async def test_login_success(connection: ThermostatConnection) -> None:
     asyncio.get_event_loop().call_soon(lambda: connection._on_message(resp))
     # Need a small delay for the queue to process
     task = asyncio.create_task(_feed_response(connection, resp))
-    result = await connection.login()
+    with patch("steamloop.connection.INITIAL_STATE_TIMEOUT", 0.05):
+        result = await connection.login()
     assert result["status"] == "1"
     await task
 
@@ -375,6 +376,7 @@ async def test_login_error_response(
 async def test_login_timeout(connection: ThermostatConnection) -> None:
     with (
         patch("steamloop.connection.RESPONSE_TIMEOUT", 0.05),
+        patch("steamloop.connection.INITIAL_STATE_TIMEOUT", 0.01),
         pytest.raises(AuthenticationError, match="No login response"),
     ):
         await connection.login()
@@ -700,11 +702,44 @@ async def test_login_skips_non_response(
         connection._on_message({"Response": {"LoginResponse": {"status": "1"}}})
 
     task = asyncio.create_task(_feed())
-    result = await connection.login()
+    with patch("steamloop.connection.INITIAL_STATE_TIMEOUT", 0.05):
+        result = await connection.login()
     assert result["status"] == "1"
     await task
 
 
+async def test_login_drains_initial_state(
+    connection: ThermostatConnection,
+) -> None:
+    """Login waits for the initial state burst after LoginResponse."""
+
+    async def _feed() -> None:
+        await asyncio.sleep(0.01)
+        connection._on_message({"Response": {"LoginResponse": {"status": "1"}}})
+        # Thermostat sends initial state burst after login response
+        await asyncio.sleep(0.01)
+        connection._on_message({"Event": {"ZoneAdded": {"zone_id": "1"}}})
+        connection._on_message(
+            {"Event": {"ZoneNameUpdated": {"zone_id": "1", "zone_name": "Main"}}}
+        )
+        await asyncio.sleep(0.01)
+        connection._on_message({"Event": {"ZoneAdded": {"zone_id": "2"}}})
+        connection._on_message(
+            {"Event": {"ZoneNameUpdated": {"zone_id": "2", "zone_name": "Upstairs"}}}
+        )
+
+    task = asyncio.create_task(_feed())
+    with patch("steamloop.connection.INITIAL_STATE_TIMEOUT", 0.15):
+        result = await connection.login()
+    assert result["status"] == "1"
+    # Both zones should be fully populated by the time login returns
+    assert "1" in connection.state.zones
+    assert "2" in connection.state.zones
+    assert connection.state.zones["1"].name == "Main"
+    assert connection.state.zones["2"].name == "Upstairs"
+    await task
+
+
 # ---------------------------------------------------------------------------
 # SSLCertVerificationError
 # ---------------------------------------------------------------------------