Rename the movement properties

Author: sebromero

examples/movement.py

@@ -11,10 +11,11 @@
 movement = ModulinoMovement()
 
 while True:
-    acc = movement.accelerometer
-    gyro = movement.gyro
+    acc = movement.acceleration
+    gyro = movement.angular_velocity
 
-    print(f"🏃 Accelerometer: x:{acc.x:>8.3f} y:{acc.y:>8.3f} z:{acc.z:>8.3f}")
-    print(f"🌐 Gyroscope:     x:{gyro.x:>8.3f} y:{gyro.y:>8.3f} z:{gyro.z:>8.3f}")
+    print(f"🏃 Acceleration: x:{acc.x:>8.3f} y:{acc.y:>8.3f} z:{acc.z:>8.3f}")
+    print(f"💪 Acceleration Magnitude: {movement.acceleration_magnitude:>8.3f} g")
+    print(f"🌐 Angular Velocity: x:{gyro.x:>8.3f} y:{gyro.y:>8.3f} z:{gyro.z:>8.3f}")
     print("")
     sleep_ms(100)

src/modulino/movement.py

@@ -27,7 +27,7 @@ def __init__(self, i2c_bus = None, address: int | None = None) -> None:
         self.sensor = LSM6DSOX(self.i2c_bus, address=self.address)
 
     @property
-    def accelerometer(self) -> MovementValues:
+    def acceleration(self) -> MovementValues:
         """
         Returns:
             MovementValues: The acceleration values in the x, y, and z axes.
@@ -38,7 +38,17 @@ def accelerometer(self) -> MovementValues:
         return MovementValues(sensor_values[0], sensor_values[1], sensor_values[2])
 
     @property
-    def gyro(self) -> MovementValues:
+    def acceleration_magnitude(self) -> float:
+        """
+        Returns:
+            float: The magnitude of the acceleration vector in g.
+                   When the Modulino is at rest (on planet earth), this value should be approximately 1.0g due to gravity.
+        """
+        x, y, z = self.accelerometer
+        return (x**2 + y**2 + z**2) ** 0.5
+
+    @property
+    def angular_velocity(self) -> MovementValues:
         """
         Returns:
             MovementValues: The gyroscope values in the x, y, and z axes.