Add client support for alternative arming modes (#53)

Author: nickw444

nessclient/__init__.py

@@ -1,6 +1,6 @@
 from .client import Client
-from .alarm import ArmingState
+from .alarm import ArmingState, ArmingMode
 from .event import BaseEvent
 
-__all__ = ["Client", "ArmingState", "BaseEvent"]
+__all__ = ["Client", "ArmingState", "ArmingMode", "BaseEvent"]
 __version__ = "0.0.0-dev"

nessclient/alarm.py

@@ -15,20 +15,29 @@ class ArmingState(Enum):
     TRIGGERED = "TRIGGERED"
 
 
+class ArmingMode(Enum):
+    ARMED_AWAY = "ARMED_AWAY"
+    ARMED_HOME = "ARMED_HOME"
+    ARMED_DAY = "ARMED_DAY"
+    ARMED_NIGHT = "ARMED_NIGHT"
+    ARMED_VACATION = "ARMED_VACATION"
+    ARMED_HIGHEST = "ARMED_HIGHEST"
+
+
 class Alarm:
     """
     In-memory representation of the state of the alarm the client is connected
     to.
     """
 
-    ARM_EVENTS = [
-        SystemStatusEvent.EventType.ARMED_AWAY,
-        SystemStatusEvent.EventType.ARMED_HOME,
-        SystemStatusEvent.EventType.ARMED_DAY,
-        SystemStatusEvent.EventType.ARMED_NIGHT,
-        SystemStatusEvent.EventType.ARMED_VACATION,
-        SystemStatusEvent.EventType.ARMED_HIGHEST,
-    ]
+    ARM_EVENTS_MAP = {
+        SystemStatusEvent.EventType.ARMED_AWAY: ArmingMode.ARMED_AWAY,
+        SystemStatusEvent.EventType.ARMED_HOME: ArmingMode.ARMED_HOME,
+        SystemStatusEvent.EventType.ARMED_DAY: ArmingMode.ARMED_DAY,
+        SystemStatusEvent.EventType.ARMED_NIGHT: ArmingMode.ARMED_NIGHT,
+        SystemStatusEvent.EventType.ARMED_VACATION: ArmingMode.ARMED_VACATION,
+        SystemStatusEvent.EventType.ARMED_HIGHEST: ArmingMode.ARMED_HIGHEST,
+    }
 
     @dataclass
     class Zone:
@@ -39,7 +48,11 @@ def __init__(self, infer_arming_state: bool = False) -> None:
         self.arming_state: ArmingState = ArmingState.UNKNOWN
         self.zones: List[Alarm.Zone] = [Alarm.Zone(triggered=None) for _ in range(16)]
 
-        self._on_state_change: Optional[Callable[["ArmingState"], None]] = None
+        self._arming_mode: ArmingMode | None = None
+
+        self._on_state_change: Optional[
+            Callable[[ArmingState, ArmingMode | None], None]
+        ] = None
         self._on_zone_change: Optional[Callable[[int, bool], None]] = None
 
     def handle_event(self, event: BaseEvent) -> None:
@@ -121,18 +134,20 @@ def _handle_system_status_event(self, event: SystemStatusEvent) -> None:
             # state to armed
             if self.arming_state == ArmingState.EXIT_DELAY:
                 return self._update_arming_state(ArmingState.ARMED)
-        elif event.type in Alarm.ARM_EVENTS:
+        elif event.type in Alarm.ARM_EVENTS_MAP.keys():
+            self._arming_mode = Alarm.ARM_EVENTS_MAP[event.type]
             return self._update_arming_state(ArmingState.ARMING)
         elif event.type == SystemStatusEvent.EventType.DISARMED:
+            self._arming_mode = None  # Restore arming mode on disarmed.
             return self._update_arming_state(ArmingState.DISARMED)
         elif event.type == SystemStatusEvent.EventType.ARMING_DELAYED:
             pass
 
-    def _update_arming_state(self, state: "ArmingState") -> None:
+    def _update_arming_state(self, state: ArmingState) -> None:
         if self.arming_state != state:
             self.arming_state = state
             if self._on_state_change is not None:
-                self._on_state_change(state)
+                self._on_state_change(state, self._arming_mode)
 
     def _update_zone(self, zone_id: int, state: bool) -> None:
         zone = self.zones[zone_id - 1]
@@ -141,7 +156,9 @@ def _update_zone(self, zone_id: int, state: bool) -> None:
             if self._on_zone_change is not None:
                 self._on_zone_change(zone_id, state)
 
-    def on_state_change(self, f: Callable[[ArmingState], None]) -> None:
+    def on_state_change(
+        self, f: Callable[[ArmingState, ArmingMode | None], None]
+    ) -> None:
         self._on_state_change = f
 
     def on_zone_change(self, f: Callable[[int, bool], None]) -> None:

nessclient/cli/events.py

@@ -2,7 +2,7 @@
 import click
 
 from ..client import Client
-from ..alarm import ArmingState
+from ..alarm import ArmingState, ArmingMode
 from ..event import BaseEvent
 from .server import DEFAULT_PORT
 
@@ -25,11 +25,11 @@ def events(
 
     @client.on_zone_change
     def on_zone_change(zone: int, triggered: bool) -> None:
-        print("Zone {} changed to {}".format(zone, triggered))
+        print(f"Zone {zone} changed to {triggered}")
 
     @client.on_state_change
-    def on_state_change(state: ArmingState) -> None:
-        print("Alarm state changed to {}".format(state))
+    def on_state_change(state: ArmingState, arming_mode: ArmingMode | None) -> None:
+        print(f"Alarm state changed to {state} (mode: {arming_mode})")
 
     @client.on_event_received
     def on_event_received(event: BaseEvent) -> None:

nessclient/client.py

@@ -6,7 +6,7 @@
 
 from justbackoff import Backoff
 
-from .alarm import ArmingState, Alarm
+from .alarm import ArmingState, Alarm, ArmingMode
 from .connection import Connection, IP232Connection
 from .event import BaseEvent
 from .packet import CommandType, Packet
@@ -167,8 +167,8 @@ async def close(self) -> None:
         await self._connection.close()
 
     def on_state_change(
-        self, f: Callable[[ArmingState], None]
-    ) -> Callable[[ArmingState], None]:
+        self, f: Callable[[ArmingState, ArmingMode | None], None]
+    ) -> Callable[[ArmingState, ArmingMode | None], None]:
         self.alarm.on_state_change(f)
         return f
 

nessclient_tests/test_alarm.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from nessclient.alarm import Alarm, ArmingState
+from nessclient.alarm import Alarm, ArmingState, ArmingMode
 from nessclient.event import ArmingUpdate, ZoneUpdate, SystemStatusEvent
 
 
@@ -119,14 +119,27 @@ def test_handle_event_arming_update_infer_arming_state_unknown_empty():
 
 
 def test_handle_event_arming_update_callback(alarm):
+    # emit a SystemStatusEvent for an arming mode to test that it is emitted
+    # during EXIT_DELAY state change.
+    alarm.handle_event(
+        SystemStatusEvent(
+            address=None,
+            timestamp=None,
+            type=SystemStatusEvent.EventType.ARMED_AWAY,
+            area=0,
+            zone=1,
+        )
+    )
+
     cb = Mock()
     alarm.on_state_change(cb)
+
     event = ArmingUpdate(
         status=[ArmingUpdate.ArmingStatus.AREA_1_ARMED], address=None, timestamp=None
     )
     alarm.handle_event(event)
     assert cb.call_count == 1
-    assert cb.call_args[0] == (ArmingState.EXIT_DELAY,)
+    assert cb.call_args[0] == (ArmingState.EXIT_DELAY, ArmingMode.ARMED_AWAY)
 
 
 def test_handle_event_system_status_unsealed_zone(alarm):
@@ -297,7 +310,7 @@ def test_handle_event_system_status_exit_delay_end_from_armed(alarm):
 
 
 def test_handle_event_system_status_arm_events(alarm):
-    for event_type in Alarm.ARM_EVENTS:
+    for event_type in Alarm.ARM_EVENTS_MAP.keys():
         alarm.arming_state = ArmingState.DISARMED
         event = SystemStatusEvent(
             address=None, timestamp=None, type=event_type, area=0, zone=1