pybricks.hubs.MoveHub: Enable imu orientation.

pybricks · Nov 13, 2023 · 81cb194 · 81cb194
1 parent f470f1c
commit 81cb194
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/doc/main/hubs/movehub.rst b/doc/main/hubs/movehub.rst
@@ -25,6 +25,8 @@ Move Hub
 
     .. automethod:: pybricks.hubs::MoveHub.imu.up
 
+    .. automethod:: pybricks.hubs::TechnicHub.imu.tilt
+
     .. automethod:: pybricks.hubs::MoveHub.imu.acceleration
 
         .. versionchanged:: 3.2

diff --git a/doc/main/parameters/axis.rst b/doc/main/parameters/axis.rst
@@ -5,3 +5,6 @@ Axis
 
 .. autoclass:: pybricks.parameters.Axis
     :no-members:
+
+On Move Hub, doing math with these vectors is not supported. The axes can still
+be used to set up the hub orientation.
diff --git a/src/pybricks/hubs.py b/src/pybricks/hubs.py
@@ -46,9 +46,13 @@ class MoveHub:
     def __init__(
         self, broadcast_channel: int = 0, observe_channels: Sequence[int] = []
     ):
-        """MoveHub(broadcast_channel=0, observe_channels=[])
+        """MoveHub(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:
                 A value from 0 to 255 indicating which channel ``hub.ble.broadcast()``
                 will use. Default is channel 0.