ble.pybricks: use IntFlag for Status

This data is received as bit flags from the hub, so it makes sense to
use IntFlag so we can benefit from extras that come with that type.

Author: dlech

pybricksdev/ble/pybricks.py

@@ -16,7 +16,7 @@
 version can be used to determine the capabilities of the device.
 """
 
-from enum import IntEnum
+from enum import IntEnum, IntFlag
 from struct import unpack
 from typing import Literal, Tuple
 
@@ -72,65 +72,57 @@ class Event(IntEnum):
     """
 
 
-class Status(IntEnum):
-    """Hub status indicators.
+class StatusFlag(IntFlag):
+    """Hub status indicators."""
 
-    Use the :attr:`flag` property to get the value as a bit flag.
-    """
-
-    BATTERY_LOW_VOLTAGE_WARNING = 0
+    BATTERY_LOW_VOLTAGE_WARNING = 1 << 0
     """Battery voltage is low.
 
     .. availability:: Since Pybricks protocol v1.0.0.
     """
 
-    BATTERY_LOW_VOLTAGE_SHUTDOWN = 1
+    BATTERY_LOW_VOLTAGE_SHUTDOWN = 1 << 1
     """Battery voltage is critically low.
 
     .. availability:: Since Pybricks protocol v1.0.0.
     """
 
-    BATTERY_HIGH_CURRENT = 2
+    BATTERY_HIGH_CURRENT = 1 << 2
     """Battery current is too high.
 
     .. availability:: Since Pybricks protocol v1.0.0.
     """
 
-    BLE_ADVERTISING = 3
+    BLE_ADVERTISING = 1 << 3
     """Bluetooth Low Energy is advertising/discoverable.
 
     .. availability:: Since Pybricks protocol v1.0.0.
     """
 
-    BLE_LOW_SIGNAL = 4
+    BLE_LOW_SIGNAL = 1 << 4
     """Bluetooth Low Energy has low signal.
 
     .. availability:: Since Pybricks protocol v1.0.0.
     """
 
-    POWER_BUTTON_PRESSED = 5
+    POWER_BUTTON_PRESSED = 1 << 5
     """Power button is currently pressed.
 
     .. availability:: Since Pybricks protocol v1.0.0.
     """
 
-    USER_PROGRAM_RUNNING = 6
+    USER_PROGRAM_RUNNING = 1 << 6
     """User program is currently running.
 
     .. availability:: Since Pybricks protocol v1.0.0.
     """
 
-    SHUTDOWN = 7
+    SHUTDOWN = 1 << 7
     """Hub shutdown was requested.
 
     .. availability:: Since Pybricks protocol v1.1.0.
     """
 
-    @property
-    def flag(self) -> int:
-        """Gets the value of the enum as a bit flag."""
-        return 1 << self.value
-
 
 # The Pybricks Protocol version also implies certain other services and
 # and characteristics are present.

pybricksdev/connections.py

@@ -24,7 +24,7 @@
     SW_REV_UUID,
     PNP_ID_UUID,
     Event,
-    Status,
+    StatusFlag,
     unpack_pnp_id,
 )
 from .compile import compile_file
@@ -247,7 +247,7 @@ def pybricks_service_handler(self, _: int, data: bytes) -> None:
         if data[0] == Event.STATUS_REPORT:
             # decode the payload
             (flags,) = struct.unpack("<I", data[1:])
-            program_running_now = bool(flags & Status.USER_PROGRAM_RUNNING.flag)
+            program_running_now = bool(flags & StatusFlag.USER_PROGRAM_RUNNING)
 
             # If we are currently downloading a program, we must ignore user
             # program running state changes, otherwise the checksum will be

tests/ble/test_pybrick.py

@@ -4,7 +4,6 @@
     PYBRICKS_CONTROL_UUID,
     PYBRICKS_SERVICE_UUID,
     SW_REV_UUID,
-    Status,
 )
 
 
@@ -16,16 +15,6 @@ def test_pybricks_control_characteristic_uuid():
     assert PYBRICKS_CONTROL_UUID == "c5f50002-8280-46da-89f4-6d8051e4aeef"
 
 
-def test_status_flags():
-    assert Status.BATTERY_LOW_VOLTAGE_WARNING.flag == 0x1
-    assert Status.BATTERY_LOW_VOLTAGE_SHUTDOWN.flag == 0x2
-    assert Status.BATTERY_HIGH_CURRENT.flag == 0x4
-    assert Status.BLE_ADVERTISING.flag == 0x8
-    assert Status.BLE_LOW_SIGNAL.flag == 0x10
-    assert Status.POWER_BUTTON_PRESSED.flag == 0x20
-    assert Status.USER_PROGRAM_RUNNING.flag == 0x40
-
-
 def test_device_information_service_uuid():
     assert DI_SERVICE_UUID == "0000180a-0000-1000-8000-00805f9b34fb"