scirodev 0.3.1__tar.gz → 0.4.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scirodev
-Version: 0.3.1
+Version: 0.4.0
 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.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "scirodev"
-version = "0.3.1"
+version = "0.4.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.3.1 → scirodev-0.4.0}/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.0}/sciro/pump.py

@@ -153,24 +153,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 +183,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 +214,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.0}/scirodev.egg-info/PKG-INFO

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