scirodev 0.5.2__tar.gz → 0.5.4__tar.gz

{scirodev-0.5.2/scirodev.egg-info → scirodev-0.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scirodev
-Version: 0.5.2
+Version: 0.5.4
 Summary: PeakHub / sciro extensions to Pybricks: typed API stubs (sciro.*) and hub tooling on top of pybricksdev
 Author: Thomas Schank
 License: MIT
@@ -15,7 +15,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pybricksdev>=2.3
-Requires-Dist: pybricks>=3.6
+Requires-Dist: pybricks>=4
 Provides-Extra: docs
 Requires-Dist: sphinx>=8; extra == "docs"
 Requires-Dist: furo; extra == "docs"

{scirodev-0.5.2 → scirodev-0.5.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "scirodev"
-version = "0.5.2"
+version = "0.5.4"
 description = "PeakHub / sciro extensions to Pybricks: typed API stubs (sciro.*) and hub tooling on top of pybricksdev"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -21,7 +21,7 @@ dependencies = [
     # Tooling: connecting to hubs (incl. PeakHub over BLE), running/downloading programs.
     "pybricksdev>=2.3",
     # The upstream API stubs we build on (pybricks.parameters, pybricks._common, ...).
-    "pybricks>=3.6",
+    "pybricks>=4",
 ]
 
 [project.optional-dependencies]

{scirodev-0.5.2 → scirodev-0.5.4}/sciro/hubs.py

@@ -45,6 +45,15 @@ class LightMatrix(_common.LightMatrix):
         """
 
 
+    def on(self, brightness: int = 100) -> None:
+        """on(brightness=100)
+
+        Turns all pixels on at ``brightness`` percent (0 .. 100), stopping a
+        running :meth:`device` mirror or animation. Declared here because the
+        firmware has it while the published ``pybricks`` stubs do not.
+        """
+
+
 class System(_common.System):
     """The PeakHub's system object: everything ``pybricks`` offers, plus the
     board identity.
@@ -72,20 +81,59 @@ class System(_common.System):
         "program_start_type"}`` in one call.
         """
 
+    def name(self) -> str:
+        """name() -> str
+
+        The hub name, as advertised over Bluetooth.
+        """
+
+    def reset_reason(self) -> int:
+        """reset_reason() -> int
+
+        Why the hub last reset: ``0`` power-on or unknown, ``1`` software
+        reset, ``2`` watchdog.
+        """
+
+    def low_power(self) -> None:
+        """low_power()
+
+        Ends the program and drops the hub into its wakeable low-power mode
+        (device supply off, motors coasting, panel dimmed) instead of powering
+        off; a short button press wakes it back to the idle menu. PeakHub only.
+        """
+
+
+class Battery(_common.Battery):
+    """The PeakHub's battery, with the two readings the published ``pybricks``
+    stubs lack."""
+
+    def type(self) -> str:
+        """type() -> str
+
+        The battery chemistry the hub was built for: ``"Li-ion"``,
+        ``"Alkaline"`` or ``"Unknown"``.
+        """
+
+    def temperature(self) -> int:
+        """temperature() -> int
+
+        The battery pack temperature, in milli-degrees Celsius.
+        """
+
 
 class PeakHub:
     """LEGO-compatible hub by Sciurus Robotics: 8 ports, 5x5 RGB matrix, IMU."""
 
     # Class attributes for documentation/typing only; the firmware creates
     # them as instance attributes in __init__.
-    battery = _common.Battery()
+    # No charger and no ble: the firmware's hub type exposes neither (the
+    # PeakHub's Bluetooth is a console/protocol transport, not a user API).
+    battery = Battery()
     buttons = _common.Keypad([_Button.LEFT, _Button.RIGHT, _Button.CENTER, _Button.BLUETOOTH])
-    charger = _common.Charger()
     display = LightMatrix(5, 5)
     imu = _common.IMU()
     speaker = _common.Speaker()
     system = System()
-    ble = _common.BLE()
 
     def __init__(
         self,

{scirodev-0.5.2 → scirodev-0.5.4}/sciro/robotics.py

@@ -73,6 +73,21 @@ class DriveBase(_DriveBase):
         upstream meaning: continue at the drive speed.
         """
 
+    def curve(
+        self,
+        radius: Number,
+        angle: Number,
+        then: Stop = Stop.HOLD,
+        wait: bool = True,
+    ) -> MaybeAwaitable:
+        """curve(radius, angle, then=Stop.HOLD, wait=True)
+
+        Drives an arc of ``angle`` degrees along a circle of ``radius`` mm.
+        The firmware still has this method, but the ``pybricks`` stubs dropped
+        it in favor of :meth:`arc`, so it is declared here to keep it usable
+        without a type error. Prefer ``arc()`` in new code.
+        """
+
     def heading_target(self, angle: Optional[Number] = None) -> Optional[float]:
         """heading_target(angle) / heading_target() -> float
 

{scirodev-0.5.2 → scirodev-0.5.4}/sciro/tools.py

@@ -4,7 +4,56 @@ helpers. EXPERIMENTAL: the API may still change between releases.
 
 from __future__ import annotations
 
-from typing import Awaitable, Callable, Iterable, Iterator, Optional, Sequence, Tuple
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Awaitable,
+    Callable,
+    Iterable,
+    Iterator,
+    Optional,
+    Sequence,
+    Tuple,
+)
+
+if TYPE_CHECKING:
+    from pybricks._common import MaybeAwaitableTuple
+else:
+    # Upstream defines this only for type checkers; runtime importers of the
+    # stubs (the docs build) need a value. Annotations are strings here
+    # (from __future__ import annotations), so a placeholder suffices.
+    MaybeAwaitableTuple = None
+
+
+def multitask(*coroutines: Awaitable[Any], race: bool = False) -> MaybeAwaitableTuple:
+    """multitask(coroutine1, coroutine2, ..., race=False) -> Tuple
+
+    ``pybricks.tools.multitask`` (the same function on the hub), typed to
+    accept any awaitable.
+
+    The upstream stub asks for ``Coroutine``, which every *maybe-awaitable*
+    hub method fails to satisfy for a type checker: ``motor.run_angle(...)``,
+    ``db.straight(...)`` or ``sensor.read()`` are declared as awaitables, not
+    as coroutines, because they return a plain value when called outside
+    ``run_task``. Importing ``multitask`` (and :func:`run_task`) from
+    ``sciro.tools`` instead of ``pybricks.tools`` removes those warnings::
+
+        from sciro.tools import multitask, run_task
+
+        async def main():
+            await multitask(db.straight(500), log.record(db.state), race=True)
+
+        run_task(main())
+    """
+
+
+def run_task(coroutine: Optional[Awaitable[Any]] = None) -> Optional[bool]:
+    """run_task(coroutine) -> bool | None
+
+    ``pybricks.tools.run_task`` (the same function on the hub), typed to
+    accept any awaitable; see :func:`multitask`. Without an argument it
+    returns whether the run loop is active.
+    """
 
 
 class RingBuffer:

{scirodev-0.5.2 → scirodev-0.5.4/scirodev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scirodev
-Version: 0.5.2
+Version: 0.5.4
 Summary: PeakHub / sciro extensions to Pybricks: typed API stubs (sciro.*) and hub tooling on top of pybricksdev
 Author: Thomas Schank
 License: MIT
@@ -15,7 +15,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pybricksdev>=2.3
-Requires-Dist: pybricks>=3.6
+Requires-Dist: pybricks>=4
 Provides-Extra: docs
 Requires-Dist: sphinx>=8; extra == "docs"
 Requires-Dist: furo; extra == "docs"

{scirodev-0.5.2 → scirodev-0.5.4}/scirodev.egg-info/requires.txt

@@ -1,5 +1,5 @@
 pybricksdev>=2.3
-pybricks>=3.6
+pybricks>=4
 
 [docs]
 sphinx>=8