scirodev 0.3.1__tar.gz → 0.4.1__tar.gz

{scirodev-0.3.1 → scirodev-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scirodev
-Version: 0.3.1
+Version: 0.4.1
 Summary: PeakHub / sciro extensions to Pybricks: typed API stubs (sciro.*) and hub tooling on top of pybricksdev
 Author: Thomas Schank
 License: MIT

{scirodev-0.3.1 → scirodev-0.4.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "scirodev"
-version = "0.3.1"
+version = "0.4.1"
 description = "PeakHub / sciro extensions to Pybricks: typed API stubs (sciro.*) and hub tooling on top of pybricksdev"
 readme = "README.md"
 requires-python = ">=3.10"

{scirodev-0.3.1 → scirodev-0.4.1}/sciro/_common.py

@@ -18,6 +18,7 @@ if TYPE_CHECKING:
     _Euler = Tuple[float, float, float, int]
     _StateData = Tuple[bytes, bytes]
     _RGB = Tuple[int, int, int]
+    _Calibration = Tuple[Tuple[int, int, int, int], Tuple[int, int, int, int], Tuple[int, int, int], bool, bool, int]
     _Pixels = Tuple[_RGB, ...]
 
     class MaybeAwaitableLine(_Line, Awaitable[_Line]): ...
@@ -33,3 +34,9 @@ if TYPE_CHECKING:
     class MaybeAwaitableStateData(_StateData, Awaitable[_StateData]): ...
 
     class MaybeAwaitablePixels(_Pixels, Awaitable[_Pixels]): ...
+
+    class MaybeAwaitableRGB8(_RGB, Awaitable[_RGB]): ...
+
+    class MaybeAwaitableCalibration(_Calibration, Awaitable[_Calibration]): ...
+
+    class MaybeAwaitableStr(str, Awaitable[str]): ...

{scirodev-0.3.1 → scirodev-0.4.1}/sciro/floorpro.py

@@ -4,6 +4,7 @@ class lives now). Kept so older programs keep type-checking.
 
 from .pump import (  # noqa: F401  (re-exports)
     IMU as IMU,
+    Gyro as Gyro,
     ColorSensor as ColorSensor,
     FloorPro as FloorPro,
     IRCalib as IRCalib,

{scirodev-0.3.1 → scirodev-0.4.1}/sciro/hubs.py

@@ -45,6 +45,34 @@ class LightMatrix(_common.LightMatrix):
         """
 
 
+class System(_common.System):
+    """The PeakHub's system object: everything ``pybricks`` offers, plus the
+    board identity.
+    """
+
+    def device_id(self) -> str:
+        """device_id() -> str
+
+        The full factory unique ID of the hub's MCU as a 24-character uppercase
+        hex string. Stable per physical hub.
+        """
+
+    def short_id(self) -> str:
+        """short_id() -> str
+
+        The hub's 8-character short ID (Crockford base32, derived from the
+        device ID): the same value the boot console prints and the device
+        inventory uses.
+        """
+
+    def info(self) -> dict:
+        """info() -> dict
+
+        ``{"name", "device_id", "short_id", "reset_reason", "program_id",
+        "program_start_type"}`` in one call.
+        """
+
+
 class PeakHub:
     """LEGO-compatible hub by Sciurus Robotics: 8 ports, 5x5 RGB matrix, IMU."""
 
@@ -56,7 +84,7 @@ class PeakHub:
     display = LightMatrix(5, 5)
     imu = _common.IMU()
     speaker = _common.Speaker()
-    system = _common.System()
+    system = System()
     ble = _common.BLE()
 
     def __init__(

{scirodev-0.3.1 → scirodev-0.4.1}/sciro/pump.py

@@ -19,6 +19,9 @@ if TYPE_CHECKING:
         MaybeAwaitableIRCalib,
         MaybeAwaitableLine,
         MaybeAwaitablePixels,
+        MaybeAwaitableRGB8,
+        MaybeAwaitableCalibration,
+        MaybeAwaitableStr,
         MaybeAwaitableRGBC,
     )
 
@@ -122,12 +125,48 @@ class ColorSensor(_Stream):
     def read(self) -> MaybeAwaitableRGBC:
         """read() -> Tuple[int, int, int, int, int]  -- raw (red, green, blue, clear, status) at device resolution."""
 
+    def calibrated(self) -> MaybeAwaitableRGB8:
+        """calibrated() -> Tuple[int, int, int]
+
+        Red, green, blue 0 .. 255 as the device itself shows them: stretched
+        over the calibrated range when a valid calibration applies, scaled to
+        full scale otherwise.
+        """
+
     def hsv(self) -> MaybeAwaitableColor:
         """hsv() -> Color
 
         Hue (0 .. 359), saturation (0 .. 100) and value (0 .. 100) of the
-        surface, as a ``Color``. Standard HSV of the raw reading; value is
-        relative to the full scale of the current integration time.
+        surface, as a ``Color``: standard HSV of the calibrated colour when a
+        valid calibration applies, of the raw reading otherwise.
+        """
+
+    def calibration_status(self) -> MaybeAwaitableStr:
+        """calibration_status() -> str
+
+        ``"none"`` (nothing stored), ``"weak"`` (stored but not applicable:
+        incomplete, or LED / gain / integration differ from the calibration
+        profile), ``"ok"`` (applied), or ``"calibrating"``.
+        """
+
+    def calibrate(self, enable: bool = True) -> MaybeAwaitable:
+        """calibrate(enable=True)
+
+        Start or stop the range calibration on the device. While it runs, move
+        the sensor over the darkest and brightest surfaces (or elements) it
+        will see; stopping stores the table on the sensor, bound to the LED,
+        gain and integration time in force. Changing those meanwhile aborts it.
+        """
+
+    def clear_calibration(self) -> MaybeAwaitable:
+        """clear_calibration()  -- drop the stored calibration (back to full-scale colour)."""
+
+    def calibration(self) -> MaybeAwaitableCalibration:
+        """calibration() -> Tuple
+
+        The stored table: ``(min, max, (led, gain, atime), valid, applicable,
+        visited_mask)`` with ``min``/``max`` tuples of four counts (red, green,
+        blue, clear). Fetched from the device on demand.
         """
 
     def color(self) -> MaybeAwaitableColor:
@@ -153,24 +192,24 @@ class ColorSensor(_Stream):
         """set_integration(atime)  -- TCS3400 ATIME register 0 .. 255: (256 - atime) * 2.78 ms."""
 
 
-class IMU(_Stream):
-    """BNO086 IMU on an extension port of a PUMP device: roll, pitch, yaw in degrees.
+class Gyro(_Stream):
+    """Gyro (BNO086) on an extension port of a PUMP device: roll, pitch, yaw in degrees.
 
-    ``IMU(port, ext_port)`` opens it directly; :meth:`FloorPro.imu` returns the
-    same class. The heading offset lives on the hub: :meth:`reset_heading` makes
-    the current yaw read as the given angle.
+    ``Gyro(port, ext_port)`` opens it directly; :meth:`FloorPro.gyro` returns the
+    same class (``IMU`` is an alias). The heading offset lives on the hub:
+    :meth:`reset_heading` makes the current yaw read as the given angle.
     """
 
     ext_port: int
 
     def __init__(self, port: Union[_Port, PUMPDevice], ext_port: int = 2):
-        """IMU(port, ext_port=ExtPort.EXT2)
+        """Gyro(port, ext_port=ExtPort.EXT2)
 
         Arguments:
-            port (Port): Hub port of the PUMP device carrying the IMU (or the
+            port (Port): Hub port of the PUMP device carrying the gyro (or the
                 opened ``PUMPDevice`` itself).
-            ext_port (ExtPort): Extension port the IMU is plugged into. Raises
-                ``OSError`` if there is no IMU there.
+            ext_port (ExtPort): Extension port the gyro is plugged into. Raises
+                ``OSError`` if there is no gyro there.
         """
 
     def read(self) -> MaybeAwaitableEuler:
@@ -183,6 +222,10 @@ class IMU(_Stream):
         """reset_heading(angle=0)  -- make the current heading read as ``angle``."""
 
 
+IMU = Gyro
+"""Alias of :class:`Gyro`."""
+
+
 class FloorPro:
     """LP-FloorPro connected to a PeakHub port, speaking PUMP."""
 
@@ -210,8 +253,11 @@ class FloorPro:
         The TCS3400 on extension port 1 or 2; raises ``OSError`` if none.
         """
 
-    def imu(self, ext_port: int = 2) -> IMU:
-        """imu(ext_port=2) -> IMU  -- the BNO086 on extension port 1 or 2; raises ``OSError`` if none."""
+    def gyro(self, ext_port: int = 2) -> Gyro:
+        """gyro(ext_port=2) -> Gyro  -- the gyro on extension port 1 or 2; raises ``OSError`` if none."""
+
+    def imu(self, ext_port: int = 2) -> Gyro:
+        """imu(ext_port=2) -> Gyro  -- alias of :meth:`gyro`."""
 
     def streams(self) -> Tuple[StreamInfo, ...]:
         """streams() -> Tuple  -- the enumerated streams ``(id, url, ext_port, state_len)``."""

{scirodev-0.3.1 → scirodev-0.4.1}/scirodev.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scirodev
-Version: 0.3.1
+Version: 0.4.1
 Summary: PeakHub / sciro extensions to Pybricks: typed API stubs (sciro.*) and hub tooling on top of pybricksdev
 Author: Thomas Schank
 License: MIT