v0.4.0 - training status as update

Author: dudanov

pyftms/__init__.py

@@ -19,8 +19,6 @@
     SetupEventData,
     SpinDownEvent,
     SpinDownEventData,
-    TrainingStatusEvent,
-    TrainingStatusEventData,
     UpdateEvent,
     UpdateEventData,
     discover_ftms_devices,
@@ -55,11 +53,9 @@
     "UpdateEvent",
     "SetupEvent",
     "ControlEvent",
-    "TrainingStatusEvent",
     "NotFitnessMachineError",
     "SetupEventData",
     "UpdateEventData",
-    "TrainingStatusEventData",
     "MovementDirection",
     "IndoorBikeSimulationParameters",
     "DeviceInfo",

pyftms/client/__init__.py

@@ -17,8 +17,6 @@
     SetupEventData,
     SpinDownEvent,
     SpinDownEventData,
-    TrainingStatusEvent,
-    TrainingStatusEventData,
     UpdateEvent,
     UpdateEventData,
 )
@@ -161,13 +159,11 @@ async def get_client_from_address(
     "UpdateEvent",
     "SetupEvent",
     "ControlEvent",
-    "TrainingStatusEvent",
     "SpinDownEvent",
     "FtmsCallback",
     "SetupEventData",
     "UpdateEventData",
     "SpinDownEventData",
-    "TrainingStatusEventData",
     "MovementDirection",
     "DeviceInfo",
     "SettingRange",

pyftms/client/backends/__init__.py

@@ -10,8 +10,6 @@
     SetupEventData,
     SpinDownEvent,
     SpinDownEventData,
-    TrainingStatusEvent,
-    TrainingStatusEventData,
     UpdateEvent,
     UpdateEventData,
 )
@@ -27,8 +25,6 @@
     "UpdateEvent",
     "SetupEvent",
     "ControlEvent",
-    "TrainingStatusEvent",
     "SpinDownEvent",
     "SpinDownEventData",
-    "TrainingStatusEventData",
 ]

pyftms/client/backends/controller.py

@@ -37,8 +37,8 @@
     SetupEventData,
     SpinDownEvent,
     SpinDownEventData,
-    TrainingStatusEvent,
-    TrainingStatusEventData,
+    UpdateEvent,
+    UpdateEventData,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -254,12 +254,12 @@ def _on_training_status(self, c: BleakGATTCharacteristic, data: bytearray) -> No
         bio = io.BytesIO(data)
         status = TrainingStatusModel._deserialize(bio)
 
-        status_data = TrainingStatusEventData(code=status.code)
+        status_data = UpdateEventData(training_status=status.code)
 
         if TrainingStatusFlags.STRING_PRESENT in status.flags:
             if b := bio.read():
-                status_data["string"] = b.decode(encoding="utf-8")
+                status_data["training_status_string"] = b.decode(encoding="utf-8")
 
-        event = TrainingStatusEvent(event_id="training_status", event_data=status_data)
+        event = UpdateEvent(event_id="update", event_data=status_data)
 
         self._cb(event)

pyftms/client/backends/event.py

@@ -1,7 +1,7 @@
 # Copyright 2024, Sergey Dudanov
 # SPDX-License-Identifier: Apache-2.0
 
-from typing import Callable, Literal, NamedTuple, NotRequired, TypedDict
+from typing import Callable, Literal, NamedTuple, TypedDict
 
 from ...models import (
     IndoorBikeSimulationParameters,
@@ -309,24 +309,14 @@ class UpdateEventData(TypedDict, total=False):
 
     Units: `s`.
     """
-
-
-class TrainingStatusEventData(TypedDict):
-    """`TrainingStatusEvent` data."""
-
-    code: TrainingStatusCode
-    """Training Status Code."""
-    string: NotRequired[str]
-    """Extended string."""
-
-
-class TrainingStatusEvent(NamedTuple):
-    """Training Status Event."""
-
-    event_id: Literal["training_status"]
-    """Always `training_status`."""
-    event_data: TrainingStatusEventData
-    """`TrainingStatusEvent` data."""
+    training_status: TrainingStatusCode
+    """
+    Training Status.
+    """
+    training_status_string: str
+    """
+    Training Status String.
+    """
 
 
 class UpdateEvent(NamedTuple):
@@ -367,9 +357,7 @@ class ControlEvent(NamedTuple):
     """Reason of event."""
 
 
-FtmsEvents = (
-    UpdateEvent | SetupEvent | ControlEvent | TrainingStatusEvent | SpinDownEvent
-)
+FtmsEvents = UpdateEvent | SetupEvent | ControlEvent | SpinDownEvent
 """Tagged union of FTMS events."""
 
 FtmsCallback = Callable[[FtmsEvents], None]

pyftms/client/client.py

@@ -95,11 +95,15 @@ def __init__(
         self._data_updater = DataUpdater(self._data_model, self._on_event)
         self._controller = MachineController(self._on_event)
 
-    @classmethod
     def _get_supported_properties(
-        cls, features: MachineFeatures = MachineFeatures(~0)
+        self, features: MachineFeatures = MachineFeatures(~0)
     ) -> tuple[str, ...]:
-        return cls._data_model._get_features(features)
+        properties = self._data_model._get_features(features)
+
+        if self.training_status is not None:
+            properties.append(c.TRAINING_STATUS)
+
+        return tuple(properties)
 
     async def __aenter__(self):
         await self.connect()
@@ -210,7 +214,7 @@ def available_properties(self) -> tuple[str, ...]:
     @cached_property
     def supported_settings(self) -> tuple[str, ...]:
         """Supported settings."""
-        return ControlModel._get_features(self._m_settings)
+        return tuple(ControlModel._get_features(self._m_settings))
 
     @property
     def supported_ranges(self) -> MappingProxyType[str, SettingRange]:

pyftms/client/const.py

@@ -14,6 +14,7 @@
 FORCE_ON_BELT = "force_on_belt"
 HEART_RATE = "heart_rate"
 INCLINATION = "inclination"
+INDOOR_BIKE_SIMULATION = "indoor_bike_simulation"
 METABOLIC_EQUIVALENT = "metabolic_equivalent"
 MOVEMENT_DIRECTION = "movement_direction"
 PACE_AVERAGE = "pace_average"
@@ -36,7 +37,7 @@
 STROKE_RATE_INSTANT = "stroke_rate_instant"
 TIME_ELAPSED = "time_elapsed"
 TIME_REMAINING = "time_remaining"
-INDOOR_BIKE_SIMULATION = "indoor_bike_simulation"
+TRAINING_STATUS = "training_status"
 
 # TARGET SETTINGS ATTRIBUTES
 

pyftms/client/manager.py

@@ -30,9 +30,6 @@ class PropertiesManager:
     _settings: SetupEventData
     """Properties dictonary"""
 
-    _training_status: TrainingStatusCode
-    """Last Training Status Code"""
-
     def __init__(self, on_ftms_event: FtmsCallback | None = None) -> None:
         self._cb = on_ftms_event
         self._properties = {}
@@ -49,8 +46,6 @@ def _on_event(self, e: FtmsEvents) -> None:
             self._live_properties.update(k for k, v in e.event_data.items() if v)
         elif e.event_id == "setup":
             self._settings |= e.event_data
-        elif e.event_id == "training_status":
-            self._training_status = e.event_data["code"]
 
         return self._cb and self._cb(e)
 
@@ -83,7 +78,7 @@ def settings(self) -> SetupEventData:
 
     @property
     def training_status(self) -> TrainingStatusCode:
-        return self._training_status
+        return self.get_property(c.TRAINING_STATUS)
 
     # REAL-TIME TRAINING DATA
 

pyftms/serializer/model.py

@@ -171,7 +171,7 @@ def _transform(input: dict):
         return result
 
     @classmethod
-    def _get_features(cls, features: int) -> tuple[str, ...]:
+    def _get_features(cls, features: int) -> list[str]:
         result = []
 
         def _get_cls_features(cls):
@@ -194,7 +194,7 @@ def _get_cls_features(cls):
 
         _get_cls_features(cls)
 
-        return tuple(result)
+        return result
 
     def __post_init__(self, *args, **kwargs):
         for field in dc.fields(self):

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyftms"
-version = "0.3.2"
+version = "0.4.0"
 description = "PyFTMS - Python Fitness Machine Service client library."
 authors = ["Sergey V. DUDANOV <sergey.dudanov@gmail.com>"]
 readme = "README.md"