scirodev 0.1.0__tar.gz → 0.3.0__tar.gz

{scirodev-0.1.0/scirodev.egg-info → scirodev-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scirodev
-Version: 0.1.0
+Version: 0.3.0
 Summary: PeakHub / sciro extensions to Pybricks: typed API stubs (sciro.*) and hub tooling on top of pybricksdev
 Author: Thomas Schank
 License: MIT
@@ -41,10 +41,13 @@ Then your IDE/type checker knows these, which the upstream `pybricks` stubs don'
 ```python
 from sciro.parameters import Port          # Port.A .. Port.H (PeakHub has 8 ports)
 from sciro.iodevices import PUMPDevice     # generic PUMP device access
-from sciro.floorpro import FloorPro        # LP-FloorPro convenience class
+from sciro.pump import FloorPro        # PUMP devices (LP-FloorPro, ...)
+from sciro.hubs import PeakHub             # hub class incl. display.device()
 
+hub = PeakHub()
 fp = FloorPro(Port.G)
 cog_dark, cog_bright, brightness, darkness, mask, calibrating = fp.line.read()
+hub.display.device(fp, brightness=50)      # mirror the sensor's LED strip on the 5x5
 ```
 
 On the hub these modules are frozen into the PeakHub firmware:

{scirodev-0.1.0 → scirodev-0.3.0}/README.md

@@ -21,10 +21,13 @@ Then your IDE/type checker knows these, which the upstream `pybricks` stubs don'
 ```python
 from sciro.parameters import Port          # Port.A .. Port.H (PeakHub has 8 ports)
 from sciro.iodevices import PUMPDevice     # generic PUMP device access
-from sciro.floorpro import FloorPro        # LP-FloorPro convenience class
+from sciro.pump import FloorPro        # PUMP devices (LP-FloorPro, ...)
+from sciro.hubs import PeakHub             # hub class incl. display.device()
 
+hub = PeakHub()
 fp = FloorPro(Port.G)
 cog_dark, cog_bright, brightness, darkness, mask, calibrating = fp.line.read()
+hub.display.device(fp, brightness=50)      # mirror the sensor's LED strip on the 5x5
 ```
 
 On the hub these modules are frozen into the PeakHub firmware:

{scirodev-0.1.0 → scirodev-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "scirodev"
-version = "0.1.0"
+version = "0.3.0"
 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.1.0 → scirodev-0.3.0}/sciro/__init__.py

@@ -2,5 +2,5 @@
 
 These are typing stubs (like the `pybricks` package): the real modules are frozen
 into the PeakHub firmware. Import from `sciro.parameters`, `sciro.iodevices` and
-`sciro.floorpro`.
+`sciro.pump`.
 """

{scirodev-0.1.0 → scirodev-0.3.0}/sciro/_common.py

@@ -17,6 +17,8 @@ if TYPE_CHECKING:
     _RGBC = Tuple[int, int, int, int, int]
     _Euler = Tuple[float, float, float, int]
     _StateData = Tuple[bytes, bytes]
+    _RGB = Tuple[int, int, int]
+    _Pixels = Tuple[_RGB, ...]
 
     class MaybeAwaitableLine(_Line, Awaitable[_Line]): ...
 
@@ -29,3 +31,5 @@ if TYPE_CHECKING:
     class MaybeAwaitableEuler(_Euler, Awaitable[_Euler]): ...
 
     class MaybeAwaitableStateData(_StateData, Awaitable[_StateData]): ...
+
+    class MaybeAwaitablePixels(_Pixels, Awaitable[_Pixels]): ...

scirodev-0.3.0/sciro/floorpro.py

@@ -0,0 +1,13 @@
+"""sciro.floorpro -- deprecated alias of :mod:`sciro.pump` (where the FloorPro
+class lives now). Kept so older programs keep type-checking.
+"""
+
+from .pump import (  # noqa: F401  (re-exports)
+    IMU as IMU,
+    ColorSensor as ColorSensor,
+    FloorPro as FloorPro,
+    IRCalib as IRCalib,
+    IRRaw as IRRaw,
+    Line as Line,
+    Pixels as Pixels,
+)

scirodev-0.3.0/sciro/hubs.py

@@ -0,0 +1,76 @@
+"""sciro.hubs -- the PeakHub.
+
+On the hub this module re-exports ``pybricks.hubs`` unchanged; the stub adds what
+the upstream stubs lack: the ``PeakHub`` class and its ``display.device()``.
+"""
+
+from __future__ import annotations
+
+from typing import Any, Optional, Protocol, Tuple
+
+from pybricks import _common
+from pybricks.hubs import PrimeHub as PrimeHub  # noqa: F401  (re-export)
+from pybricks.parameters import Axis as _Axis
+from pybricks.parameters import Button as _Button
+
+from .iodevices import PUMPDevice
+
+
+class DisplaySource(Protocol):
+    """Anything :meth:`LightMatrix.device` can show: an object whose
+    ``_display_source()`` returns ``(PUMPDevice, stream id, map)``.
+    """
+
+    def _display_source(self) -> Tuple[PUMPDevice, int, Tuple[Optional[int], ...]]: ...
+
+
+class LightMatrix(_common.LightMatrix):
+    """The PeakHub's 5x5 RGB matrix: everything ``pybricks`` offers, plus a
+    background mirror of a PUMP device's display stream.
+    """
+
+    def device(self, device: DisplaySource, brightness: int = 100) -> None:
+        """device(device, brightness=100)
+
+        Shows the device's own display (e.g. the LP-FloorPro's LED strip) on
+        the matrix, updated in the background at the device's rate until
+        :meth:`off` or any other drawing call. The device stops streaming when
+        the program ends.
+
+        Arguments:
+            device (FloorPro): The device to mirror (any ``sciro.pump`` device with a display stream).
+            brightness (Number, %): Brightness of the mirrored pixels, 0 .. 1000.
+                Above 100 the picture is amplified (clipping at full), since
+                the matrix is far dimmer than a sensor's own LED strip.
+        """
+
+
+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()
+    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 = _common.System()
+    ble = _common.BLE()
+
+    def __init__(
+        self,
+        top_side: Any = _Axis.Z,
+        front_side: Any = _Axis.X,
+        broadcast_channel: int = 0,
+        observe_channels: Any = (),
+    ):
+        """PeakHub(top_side=Axis.Z, front_side=Axis.X, broadcast_channel=0, observe_channels=[])
+
+        Arguments:
+            top_side (Axis): The axis that passes through the *top side* of the hub.
+            front_side (Axis): The axis that passes through the *front side* of the hub.
+            broadcast_channel: Channel for broadcasting data (0 .. 255).
+            observe_channels: Channels to observe.
+        """

{scirodev-0.1.0 → scirodev-0.3.0}/sciro/iodevices.py

@@ -21,7 +21,7 @@ class PUMPDevice:
     """Generic access to a PUMP device (Power UART Multiplex Protocol) on a
     PeakHub port. Streams are addressed by id (1..N); state and data are raw
     ``bytes`` decoded by the user or a convenience class such as
-    :class:`sciro.floorpro.FloorPro`. Spec: ``PUMP-Protocol.md``.
+    :class:`sciro.pump.FloorPro`. Spec: ``PUMP-Protocol.md``.
     """
 
     OFF: int = 0

scirodev-0.1.0/sciro/floorpro.py → scirodev-0.3.0/sciro/pump.py

@@ -1,4 +1,6 @@
-"""sciro.floorpro -- the LP-FloorPro line sensor over PUMP (PeakHub).
+"""sciro.pump -- PUMP devices on the PeakHub, the PUMP counterpart of
+``pybricks.pupdevices``: the generic :class:`PUMPDevice` plus one class per
+device (currently the LP-FloorPro line sensor).
 
 Stub for the frozen module of the same name. Every reading method returns the
 value directly, or an awaitable under multitasking.
@@ -16,10 +18,12 @@ if TYPE_CHECKING:
         MaybeAwaitableInts,
         MaybeAwaitableIRCalib,
         MaybeAwaitableLine,
+        MaybeAwaitablePixels,
         MaybeAwaitableRGBC,
     )
 
-from .iodevices import PUMPDevice, StreamInfo
+from .iodevices import PUMPDevice as PUMPDevice  # noqa: F401  (re-export)
+from .iodevices import StreamInfo
 from .parameters import Port as _Port
 
 
@@ -75,6 +79,20 @@ class IRCalib(_Stream):
         """oneshot() -> Tuple  -- request the table once and return it."""
 
 
+class Pixels(_Stream):
+    """The sensor's own LED strip picture, rendered on the device at full scale:
+    18 ``(r, g, b)`` triplets = IR channels 0..14, EXT1, EXT2, battery. Off by
+    default. A PeakHub mirrors it on its 5x5 matrix with
+    :meth:`sciro.hubs.LightMatrix.device`.
+    """
+
+    def read(self) -> MaybeAwaitablePixels:
+        """read() -> Tuple[Tuple[int, int, int], ...]  -- 18 RGB triplets, 0 .. 255."""
+
+    def oneshot(self) -> MaybeAwaitablePixels:
+        """oneshot() -> Tuple  -- request one frame and return it."""
+
+
 class ColorSensor(_Stream):
     """TCS3400 on an extension port: raw R, G, B, C at device resolution.
 
@@ -126,6 +144,8 @@ class FloorPro:
     line: Line
     ir_raw: IRRaw
     ir_calib: IRCalib
+    pixels: Pixels
+    """The strip picture stream; ``None`` with firmware that lacks it."""
 
     def __init__(self, port: _Port):
         """FloorPro(port)
@@ -146,3 +166,6 @@ class FloorPro:
 
     def streams(self) -> Tuple[StreamInfo, ...]:
         """streams() -> Tuple  -- the enumerated streams ``(id, url, ext_port, state_len)``."""
+
+    def _display_source(self) -> Tuple[PUMPDevice, int, Tuple[Optional[int], ...]]:
+        """(device, stream id, matrix map) consumed by ``hub.display.device()``."""

{scirodev-0.1.0 → scirodev-0.3.0/scirodev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scirodev
-Version: 0.1.0
+Version: 0.3.0
 Summary: PeakHub / sciro extensions to Pybricks: typed API stubs (sciro.*) and hub tooling on top of pybricksdev
 Author: Thomas Schank
 License: MIT
@@ -41,10 +41,13 @@ Then your IDE/type checker knows these, which the upstream `pybricks` stubs don'
 ```python
 from sciro.parameters import Port          # Port.A .. Port.H (PeakHub has 8 ports)
 from sciro.iodevices import PUMPDevice     # generic PUMP device access
-from sciro.floorpro import FloorPro        # LP-FloorPro convenience class
+from sciro.pump import FloorPro        # PUMP devices (LP-FloorPro, ...)
+from sciro.hubs import PeakHub             # hub class incl. display.device()
 
+hub = PeakHub()
 fp = FloorPro(Port.G)
 cog_dark, cog_bright, brightness, darkness, mask, calibrating = fp.line.read()
+hub.display.device(fp, brightness=50)      # mirror the sensor's LED strip on the 5x5
 ```
 
 On the hub these modules are frozen into the PeakHub firmware:

{scirodev-0.1.0 → scirodev-0.3.0}/scirodev.egg-info/SOURCES.txt

@@ -4,8 +4,10 @@ pyproject.toml
 sciro/__init__.py
 sciro/_common.py
 sciro/floorpro.py
+sciro/hubs.py
 sciro/iodevices.py
 sciro/parameters.py
+sciro/pump.py
 sciro/py.typed
 scirodev/__init__.py
 scirodev/cli.py