scirodev 0.5.5__tar.gz → 0.5.6__tar.gz

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

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

{scirodev-0.5.5 → scirodev-0.5.6}/pyproject.toml

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

@@ -1,7 +1,8 @@
 """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()``.
+the upstream stubs lack: the ``PeakHub`` class, its ``display.device()``, and the
+``ThisHub`` alias.
 """
 
 from __future__ import annotations
@@ -150,3 +151,32 @@ class PeakHub:
             broadcast_channel: Channel for broadcasting data (0 .. 255).
             observe_channels: Channels to observe.
         """
+
+
+#: The hub this program is running on.
+#:
+#: Every Pybricks firmware compiles in exactly one hub class and exports it
+#: under several names: the generic ``ThisHub``, the hub's own name, and any
+#: aliases. On PeakHub firmware ``ThisHub``, :class:`PeakHub`, ``PrimeHub`` and
+#: ``InventorHub`` are therefore all the *same* class object -- this is resolved
+#: when the firmware is built, not by detecting anything at run time.
+#:
+#: Use it for code that should run unchanged on whichever hub is in front of
+#: you, which is mostly bench and test scripts::
+#:
+#:     from sciro.hubs import ThisHub
+#:
+#:     hub = ThisHub()
+#:     print(hub.imu.heading(), hub.imu.tilt())
+#:
+#: Prefer :class:`PeakHub` when a program is specific to this hub anyway: it
+#: says so, and it reads better than a generic name.
+#:
+#: Note the difference between the REPL and a downloaded program. The REPL is
+#: started with everything auto-imported and with a ready-made ``hub`` instance
+#: already created, so there ``hub.imu.heading()`` just works. A downloaded
+#: program gets neither: it must import what it uses and construct the hub, as
+#: above, and ``print(hub)`` there raises ``NameError``. (In the firmware this
+#: is ``pb_package_pybricks_init(true)`` for the REPL versus ``false`` for
+#: everything else.)
+ThisHub = PeakHub

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

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