scirodev 0.5.3__tar.gz → 0.5.5__tar.gz

{scirodev-0.5.3/scirodev.egg-info → scirodev-0.5.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scirodev
-Version: 0.5.3
+Version: 0.5.5
 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.3 → scirodev-0.5.5}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "scirodev"
-version = "0.5.3"
+version = "0.5.5"
 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.3 → scirodev-0.5.5}/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.3 → scirodev-0.5.5}/sciro/robotics.py

@@ -73,6 +73,76 @@ class DriveBase(_DriveBase):
         upstream meaning: continue at the drive speed.
         """
 
+    def turn(  # type: ignore[override]
+        self,
+        angle: Number,
+        then: Stop = Stop.HOLD,
+        wait: bool = True,
+        absolute: bool = False,
+        turn_rate: Optional[Number] = None,
+    ) -> MaybeAwaitable:
+        """turn(angle, then=Stop.HOLD, wait=True, absolute=False, turn_rate=None)
+
+        Turns in place, as in Pybricks, with one PeakHub extension:
+
+        ``turn_rate``: turn rate in deg/s for this move only; ``None`` uses the
+        ``turn_rate`` setting, which is left untouched either way.
+
+        ``absolute=True`` turns *to* the given heading rather than *by* it,
+        taking the nearest whole-turn equivalent, so the correction is always
+        within +/-180 degrees (the same rule as ``straight(heading=)``).
+        """
+
+    def curve(
+        self,
+        radius: Number,
+        angle: Number,
+        then: Stop = Stop.HOLD,
+        wait: bool = True,
+        speed: Optional[Number] = None,
+        exit_speed: Number = 0,
+    ) -> MaybeAwaitable:
+        """curve(radius, angle, then=Stop.HOLD, wait=True, speed=None, exit_speed=0)
+
+        Drives an arc of ``angle`` degrees along a circle of ``radius`` mm.
+        Upstream dropped this method in favour of :meth:`arc`, but the firmware
+        still has it, so it is declared here to keep it usable without a type
+        error. ``arc()`` takes the same extensions and is preferred in new code.
+
+        ``speed``: drive speed in mm/s along the arc for this move only. The
+        matching turn rate is derived from it, so the linear speed is what
+        governs the duration; ``None`` uses the ``straight_speed`` and
+        ``turn_rate`` settings.
+
+        ``exit_speed``: speed in mm/s the robot has when it reaches the end of
+        the arc. The *turn rate is brought to zero* at that point, so the robot
+        leaves on the tangent and keeps driving straight at ``exit_speed``
+        until the next command. This makes a curve-to-straight handover smooth;
+        without it a continuing move keeps rotating at the arc's turn rate and
+        the next command has to cancel that rotation. The price is that the
+        last fraction of the path is slightly flatter than a true arc. Implies
+        ``then=Stop.NONE``; any other explicit ``then`` raises ``ValueError``.
+        """
+
+    def arc(  # type: ignore[override]
+        self,
+        radius: Number,
+        angle: Optional[Number] = None,
+        distance: Optional[Number] = None,
+        then: Stop = Stop.HOLD,
+        wait: bool = True,
+        speed: Optional[Number] = None,
+        exit_speed: Number = 0,
+    ) -> MaybeAwaitable:
+        """arc(radius, angle=None, distance=None, then=Stop.HOLD, wait=True, speed=None, exit_speed=0)
+
+        Drives an arc, as in Pybricks, with the same two PeakHub extensions as
+        :meth:`curve`: ``speed`` in mm/s for this move only (the turn rate is
+        derived from it), and ``exit_speed``, which ends the arc at that speed
+        with the turn rate at zero so the robot exits on the tangent and keeps
+        driving straight. ``exit_speed`` implies ``then=Stop.NONE``.
+        """
+
     def heading_target(self, angle: Optional[Number] = None) -> Optional[float]:
         """heading_target(angle) / heading_target() -> float
 

{scirodev-0.5.3 → scirodev-0.5.5/scirodev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scirodev
-Version: 0.5.3
+Version: 0.5.5
 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.3 → scirodev-0.5.5}/scirodev.egg-info/requires.txt

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