reachy-mini 1.0.0__py3-none-any.whl

reachy_mini/io/__init__.py

@@ -0,0 +1 @@
+"""IO module."""

reachy_mini/io/abstract.py

@@ -0,0 +1,70 @@
+"""Base classes for server and client implementations.
+
+These abstract classes define the interface for server and client components
+in the Reachy Mini project. They provide methods for starting and stopping
+the server, handling commands, and managing client connections.
+"""
+
+from abc import ABC, abstractmethod
+from threading import Event
+from uuid import UUID
+
+from reachy_mini.io.protocol import AnyTaskRequest
+
+
+class AbstractServer(ABC):
+    """Base class for server implementations."""
+
+    @abstractmethod
+    def start(self) -> None:
+        """Start the server."""
+        pass
+
+    @abstractmethod
+    def stop(self) -> None:
+        """Stop the server."""
+        pass
+
+    @abstractmethod
+    def command_received_event(self) -> Event:
+        """Wait for a new command and return it."""
+        pass
+
+
+class AbstractClient(ABC):
+    """Base class for client implementations."""
+
+    @abstractmethod
+    def wait_for_connection(self) -> None:
+        """Wait for the client to connect to the server."""
+        pass
+
+    @abstractmethod
+    def is_connected(self) -> bool:
+        """Check if the client is connected to the server."""
+        pass
+
+    @abstractmethod
+    def disconnect(self) -> None:
+        """Disconnect the client from the server."""
+        pass
+
+    @abstractmethod
+    def send_command(self, command: str) -> None:
+        """Send a command to the server."""
+        pass
+
+    @abstractmethod
+    def get_current_joints(self) -> tuple[list[float], list[float]]:
+        """Get the current joint positions."""
+        pass
+
+    @abstractmethod
+    def send_task_request(self, task_req: AnyTaskRequest) -> UUID:
+        """Send a task request to the server and return a unique task identifier."""
+        pass
+
+    @abstractmethod
+    def wait_for_task_completion(self, task_uid: UUID, timeout: float = 5.0) -> None:
+        """Wait for the specified task to complete."""
+        pass

reachy_mini/io/protocol.py

@@ -0,0 +1,44 @@
+"""Protocol definitions for Reachy Mini client/server communication."""
+
+from datetime import datetime
+from uuid import UUID
+
+from pydantic import BaseModel
+
+from reachy_mini.utils.interpolation import InterpolationTechnique
+
+
+class GotoTaskRequest(BaseModel):
+    """Class to represent a goto target task."""
+
+    head: list[float] | None  # 4x4 flatten pose matrix
+    antennas: list[float] | None  # [right_angle, left_angle] (in rads)
+    duration: float
+    method: InterpolationTechnique
+    body_yaw: float | None
+
+
+class PlayMoveTaskRequest(BaseModel):
+    """Class to represent a play move task."""
+
+    move_name: str
+
+
+AnyTaskRequest = GotoTaskRequest | PlayMoveTaskRequest
+
+
+class TaskRequest(BaseModel):
+    """Class to represent any task request."""
+
+    uuid: UUID
+    req: AnyTaskRequest
+    timestamp: datetime
+
+
+class TaskProgress(BaseModel):
+    """Class to represent task progress."""
+
+    uuid: UUID
+    finished: bool = False
+    error: str | None = None
+    timestamp: datetime

reachy_mini/io/zenoh_client.py

@@ -0,0 +1,258 @@
+"""Zenoh client for Reachy Mini.
+
+This module implements a Zenoh client that allows communication with the Reachy Mini
+robot. It subscribes to joint positions updates and allows sending commands to the robot.
+"""
+
+import json
+import threading
+import time
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any, Dict, List, Optional
+from uuid import UUID, uuid4
+
+import numpy as np
+import numpy.typing as npt
+import zenoh
+
+from reachy_mini.io.abstract import AbstractClient
+from reachy_mini.io.protocol import AnyTaskRequest, TaskProgress, TaskRequest
+
+
+class ZenohClient(AbstractClient):
+    """Zenoh client for Reachy Mini."""
+
+    def __init__(self, localhost_only: bool = True):
+        """Initialize the Zenoh client."""
+        if localhost_only:
+            c = zenoh.Config.from_json5(
+                json.dumps(
+                    {
+                        "connect": {
+                            "endpoints": {
+                                "peer": ["tcp/localhost:7447"],
+                                "router": [],
+                            },
+                        },
+                    }
+                )
+            )
+        else:
+            c = zenoh.Config()
+
+        self.joint_position_received = threading.Event()
+        self.head_pose_received = threading.Event()
+        self.status_received = threading.Event()
+
+        self.session = zenoh.open(c)
+        self.cmd_pub = self.session.declare_publisher("reachy_mini/command")
+
+        self.joint_sub = self.session.declare_subscriber(
+            "reachy_mini/joint_positions",
+            self._handle_joint_positions,
+        )
+
+        self.pose_sub = self.session.declare_subscriber(
+            "reachy_mini/head_pose",
+            self._handle_head_pose,
+        )
+
+        self.recording_sub = self.session.declare_subscriber(
+            "reachy_mini/recorded_data",
+            self._handle_recorded_data,
+        )
+
+        self.status_sub = self.session.declare_subscriber(
+            "reachy_mini/daemon_status",
+            self._handle_status,
+        )
+
+        self._last_head_joint_positions = None
+        self._last_antennas_joint_positions = None
+        self._last_head_pose: Optional[npt.NDArray[np.float64]] = None
+        self._recorded_data: Optional[
+            List[Dict[str, float | List[float] | List[List[float]]]]
+        ] = None
+        self._recorded_data_ready = threading.Event()
+        self._is_alive = False
+        self._last_status: Dict[str, Any] = {}  # contains a DaemonStatus
+
+        self.tasks: dict[UUID, TaskState] = {}
+        self.task_request_pub = self.session.declare_publisher("reachy_mini/task")
+        self.task_progress_sub = self.session.declare_subscriber(
+            "reachy_mini/task_progress",
+            self._handle_task_progress,
+        )
+
+    def wait_for_connection(self, timeout: float = 5.0) -> None:
+        """Wait for the client to connect to the server.
+
+        Args:
+            timeout (float): Maximum time to wait for the connection in seconds.
+
+        Raises:
+            TimeoutError: If the connection is not established within the timeout period.
+
+        """
+        start = time.time()
+        while not self.joint_position_received.wait(
+            timeout=1.0
+        ) or not self.head_pose_received.wait(timeout=1.0):
+            if time.time() - start > timeout:
+                self.disconnect()
+                raise TimeoutError(
+                    "Timeout while waiting for connection with the server."
+                )
+            print("Waiting for connection with the server...")
+
+        self._is_alive = True
+        self._check_alive_evt = threading.Event()
+        threading.Thread(target=self.check_alive, daemon=True).start()
+
+    def check_alive(self) -> None:
+        """Periodically check if the client is still connected to the server."""
+        while True:
+            self._is_alive = self.is_connected()
+            self._check_alive_evt.set()
+            time.sleep(1.0)
+
+    def is_connected(self) -> bool:
+        """Check if the client is connected to the server."""
+        self.joint_position_received.clear()
+        self.head_pose_received.clear()
+        return self.joint_position_received.wait(
+            timeout=1.0
+        ) and self.head_pose_received.wait(timeout=1.0)
+
+    def disconnect(self) -> None:
+        """Disconnect the client from the server."""
+        self.session.close()  # type: ignore[no-untyped-call]
+
+    def send_command(self, command: str) -> None:
+        """Send a command to the server."""
+        if not self._is_alive:
+            raise ConnectionError("Lost connection with the server.")
+
+        self.cmd_pub.put(command.encode("utf-8"))
+
+    def _handle_joint_positions(self, sample: zenoh.Sample) -> None:
+        """Handle incoming joint positions."""
+        if sample.payload:
+            positions = json.loads(sample.payload.to_string())
+            self._last_head_joint_positions = positions.get("head_joint_positions")
+            self._last_antennas_joint_positions = positions.get(
+                "antennas_joint_positions"
+            )
+            self.joint_position_received.set()
+
+    def _handle_recorded_data(self, sample: zenoh.Sample) -> None:
+        """Handle incoming recorded data."""
+        print("Received recorded data.")
+        if sample.payload:
+            data = json.loads(sample.payload.to_string())
+            self._recorded_data = data
+            self._recorded_data_ready.set()
+        if self._recorded_data is not None:
+            print(f"Recorded data: {len(self._recorded_data)} frames received.")
+
+    def _handle_status(self, sample: zenoh.Sample) -> None:
+        """Handle incoming status updates."""
+        if sample.payload:
+            status = json.loads(sample.payload.to_string())
+            self._last_status = status
+            self.status_received.set()
+
+    def get_current_joints(self) -> tuple[list[float], list[float]]:
+        """Get the current joint positions."""
+        assert (
+            self._last_head_joint_positions is not None
+            and self._last_antennas_joint_positions is not None
+        ), "No joint positions received yet. Wait for the client to connect."
+        return (
+            self._last_head_joint_positions.copy(),
+            self._last_antennas_joint_positions.copy(),
+        )
+
+    def wait_for_recorded_data(self, timeout: float = 5.0) -> bool:
+        """Block until the daemon publishes the frames (or timeout)."""
+        return self._recorded_data_ready.wait(timeout)
+
+    def get_recorded_data(
+        self, wait: bool = True, timeout: float = 5.0
+    ) -> Optional[List[Dict[str, float | List[float] | List[List[float]]]]]:
+        """Return the cached recording, optionally blocking until it arrives.
+
+        Raises `TimeoutError` if nothing shows up in time.
+        """
+        if wait and not self._recorded_data_ready.wait(timeout):
+            raise TimeoutError("Recording not received in time.")
+        self._recorded_data_ready.clear()  # ready for next run
+        if self._recorded_data is not None:
+            return self._recorded_data.copy()
+        return None
+
+    def get_status(self, wait: bool = True, timeout: float = 5.0) -> Dict[str, Any]:
+        """Get the last received status. Returns DaemonStatus as a dict."""
+        if wait and not self.status_received.wait(timeout):
+            raise TimeoutError("Status not received in time.")
+        self.status_received.clear()  # ready for next run
+        return self._last_status
+
+    def _handle_head_pose(self, sample: zenoh.Sample) -> None:
+        """Handle incoming head pose."""
+        if sample.payload:
+            pose = json.loads(sample.payload.to_string())
+            self._last_head_pose = np.array(pose.get("head_pose")).reshape(4, 4)
+            self.head_pose_received.set()
+
+    def get_current_head_pose(self) -> npt.NDArray[np.float64]:
+        """Get the current head pose."""
+        assert self._last_head_pose is not None, "No head pose received yet."
+        return self._last_head_pose.copy()
+
+    def send_task_request(self, task_req: AnyTaskRequest) -> UUID:
+        """Send a task request to the server."""
+        if not self._is_alive:
+            raise ConnectionError("Lost connection with the server.")
+
+        task = TaskRequest(uuid=uuid4(), req=task_req, timestamp=datetime.now())
+
+        self.tasks[task.uuid] = TaskState(event=threading.Event(), error=None)
+
+        self.task_request_pub.put(task.model_dump_json())
+
+        return task.uuid
+
+    def wait_for_task_completion(self, task_uid: UUID, timeout: float = 5.0) -> None:
+        """Wait for the specified task to complete."""
+        if task_uid not in self.tasks:
+            raise ValueError("Task not found.")
+
+        self.tasks[task_uid].event.wait(timeout)
+
+        if not self.tasks[task_uid].event.is_set():
+            raise TimeoutError("Task did not complete in time.")
+        if self.tasks[task_uid].error is not None:
+            raise Exception(f"Task failed with error: {self.tasks[task_uid].error}")
+
+        del self.tasks[task_uid]
+
+    def _handle_task_progress(self, sample: zenoh.Sample) -> None:
+        if sample.payload:
+            progress = TaskProgress.model_validate_json(sample.payload.to_string())
+            assert progress.uuid in self.tasks, "Unknown task UUID."
+
+            if progress.error:
+                self.tasks[progress.uuid].error = progress.error
+
+            if progress.finished:
+                self.tasks[progress.uuid].event.set()
+
+
+@dataclass
+class TaskState:
+    """Represents the state of a task."""
+
+    event: threading.Event
+    error: str | None

reachy_mini/io/zenoh_server.py

@@ -0,0 +1,183 @@
+"""Zenoh server for Reachy Mini.
+
+This module implements a Zenoh server that allows communication with the Reachy Mini
+robot. It handles commands for joint positions and torque settings, and publishes joint positions updates.
+
+It uses the Zenoh protocol for efficient data exchange and can be configured to run
+either on localhost only or to accept connections from other hosts.
+"""
+
+import asyncio
+import json
+import threading
+from datetime import datetime
+
+import numpy as np
+import zenoh
+
+from reachy_mini.daemon.backend.abstract import Backend, MotorControlMode
+from reachy_mini.io.abstract import AbstractServer
+from reachy_mini.io.protocol import (
+    GotoTaskRequest,
+    PlayMoveTaskRequest,
+    TaskProgress,
+    TaskRequest,
+)
+
+
+class ZenohServer(AbstractServer):
+    """Zenoh server for Reachy Mini."""
+
+    def __init__(self, backend: Backend, localhost_only: bool = True):
+        """Initialize the Zenoh server."""
+        self.localhost_only = localhost_only
+        self.backend = backend
+
+        self._lock = threading.Lock()
+        self._cmd_event = threading.Event()
+
+    def start(self) -> None:
+        """Start the Zenoh server."""
+        if self.localhost_only:
+            c = zenoh.Config.from_json5(
+                json.dumps(
+                    {
+                        "listen": {
+                            "endpoints": ["tcp/localhost:7447"],
+                        },
+                        "scouting": {
+                            "multicast": {
+                                "enabled": False,
+                            },
+                            "gossip": {
+                                "enabled": False,
+                            },
+                        },
+                        "connect": {
+                            "endpoints": [
+                                "tcp/localhost:7447",
+                            ],
+                        },
+                    }
+                )
+            )
+        else:
+            c = zenoh.Config()
+
+        self.session = zenoh.open(c)
+        self.sub = self.session.declare_subscriber(
+            "reachy_mini/command",
+            self._handle_command,
+        )
+        self.pub = self.session.declare_publisher("reachy_mini/joint_positions")
+        self.pub_record = self.session.declare_publisher("reachy_mini/recorded_data")
+        self.backend.set_joint_positions_publisher(self.pub)
+        self.backend.set_recording_publisher(self.pub_record)
+
+        self.pub_pose = self.session.declare_publisher("reachy_mini/head_pose")
+        self.backend.set_pose_publisher(self.pub_pose)
+
+        self.task_req_sub = self.session.declare_subscriber(
+            "reachy_mini/task",
+            self._handle_task_request,
+        )
+        self.task_progress_pub = self.session.declare_publisher(
+            "reachy_mini/task_progress"
+        )
+
+        self.pub_status = self.session.declare_publisher("reachy_mini/daemon_status")
+
+    def stop(self) -> None:
+        """Stop the Zenoh server."""
+        self.session.close()  # type: ignore[no-untyped-call]
+
+    def command_received_event(self) -> threading.Event:
+        """Wait for a new command and return it."""
+        return self._cmd_event
+
+    def _handle_command(self, sample: zenoh.Sample) -> None:
+        data = sample.payload.to_string()
+        command = json.loads(data)
+        with self._lock:
+            if "torque" in command:
+                if command["torque"]:
+                    self.backend.set_motor_control_mode(MotorControlMode.Enabled)
+                else:
+                    self.backend.set_motor_control_mode(MotorControlMode.Disabled)
+            if "head_joint_positions" in command:
+                self.backend.set_target_head_joint_positions(
+                    np.array(command["head_joint_positions"])
+                )
+            if "head_pose" in command:
+                self.backend.set_target_head_pose(
+                    np.array(command["head_pose"]).reshape(4, 4)
+                )
+            if "body_yaw" in command:
+                self.backend.set_target_body_yaw(command["body_yaw"])
+            if "antennas_joint_positions" in command:
+                self.backend.set_target_antenna_joint_positions(
+                    np.array(command["antennas_joint_positions"]),
+                )
+            if "gravity_compensation" in command:
+                try:
+                    if command["gravity_compensation"]:
+                        self.backend.set_motor_control_mode(
+                            MotorControlMode.GravityCompensation
+                        )
+                    else:
+                        self.backend.set_motor_control_mode(MotorControlMode.Enabled)
+
+                except ValueError as e:
+                    print(e)
+            if "automatic_body_yaw" in command:
+                self.backend.set_automatic_body_yaw(command["automatic_body_yaw"])
+
+            if "set_target_record" in command:
+                self.backend.append_record(command["set_target_record"])
+
+            if "start_recording" in command:
+                self.backend.start_recording()
+            if "stop_recording" in command:
+                self.backend.stop_recording()
+        self._cmd_event.set()
+
+    def _handle_task_request(self, sample: zenoh.Sample) -> None:
+        task_req = TaskRequest.model_validate_json(sample.payload.to_string())
+
+        if isinstance(task_req.req, GotoTaskRequest):
+            req = task_req.req
+
+            def task() -> None:
+                asyncio.run(
+                    self.backend.goto_target(
+                        head=np.array(req.head).reshape(4, 4) if req.head else None,
+                        antennas=np.array(req.antennas) if req.antennas else None,
+                        duration=req.duration,
+                        method=req.method,
+                        body_yaw=req.body_yaw,
+                    )
+                )
+        elif isinstance(task_req.req, PlayMoveTaskRequest):
+
+            def task() -> None:
+                print("PLAY MOVE")
+
+        else:
+            assert False, f"Unknown task request type {task_req.req.__class__.__name__}"
+
+        def wrapped_task() -> None:
+            error = None
+            try:
+                task()
+            except Exception as e:
+                error = str(e)
+
+            progress = TaskProgress(
+                uuid=task_req.uuid,
+                finished=True,
+                error=error,
+                timestamp=datetime.now(),
+            )
+            self.task_progress_pub.put(progress.model_dump_json())
+
+        threading.Thread(target=wrapped_task).start()

reachy_mini/kinematics/__init__.py

@@ -0,0 +1,68 @@
+"""Try to import kinematics engines, and provide mockup classes if they are not available."""
+
+from typing import Annotated
+
+import numpy as np
+import numpy.typing as npt
+
+try:
+    from reachy_mini.kinematics.nn_kinematics import NNKinematics  # noqa: F401
+except ImportError:
+
+    class MockupNNKinematics:
+        """Mockup class for NNKinematics."""
+
+        def __init__(self, *args, **kwargs) -> None:  # type: ignore[no-untyped-def]
+            """Raise ImportError when trying to instantiate the class."""
+            raise ImportError(
+                "NNKinematics could not be imported. Make sure you run pip install reachy_mini[nn_kinematics]."
+            )
+
+        def ik(self, *args, **kwargs) -> Annotated[npt.NDArray[np.float64], (7,)]:  # type: ignore[no-untyped-def]
+            """Mockup method for ik."""
+            raise ImportError(
+                "NNKinematics could not be imported. Make sure you run pip install reachy_mini[nn_kinematics]."
+            )
+
+        def fk(self, *args, **kwargs) -> Annotated[npt.NDArray[np.float64], (4, 4)]:  # type: ignore[no-untyped-def]
+            """Mockup method for fk."""
+            raise ImportError(
+                "NNKinematics could not be imported. Make sure you run pip install reachy_mini[nn_kinematics]."
+            )
+
+    NNKinematics = MockupNNKinematics  # type: ignore[assignment, misc]
+
+try:
+    from reachy_mini.kinematics.placo_kinematics import PlacoKinematics  # noqa: F401
+except ImportError:
+
+    class MockupPlacoKinematics:
+        """Mockup class for PlacoKinematics."""
+
+        def __init__(self, *args, **kwargs) -> None:  # type: ignore[no-untyped-def]
+            """Raise ImportError when trying to instantiate the class."""
+            raise ImportError(
+                "PlacoKinematics could not be imported. Make sure you run pip install reachy_mini[placo_kinematics]."
+            )
+
+        def ik(self, *args, **kwargs) -> Annotated[npt.NDArray[np.float64], (7,)]:  # type: ignore[no-untyped-def]
+            """Mockup method for ik."""
+            raise ImportError(
+                "PlacoKinematics could not be imported. Make sure you run pip install reachy_mini[placo_kinematics]."
+            )
+
+        def fk(self, *args, **kwargs) -> Annotated[npt.NDArray[np.float64], (4, 4)]:  # type: ignore[no-untyped-def]
+            """Mockup method for fk."""
+            raise ImportError(
+                "PlacoKinematics could not be imported. Make sure you run pip install reachy_mini[placo_kinematics]."
+            )
+
+    PlacoKinematics = MockupPlacoKinematics  # type: ignore[assignment, misc]
+
+
+from reachy_mini.kinematics.analytical_kinematics import (  # noqa: F401
+    AnalyticalKinematics,
+)
+
+AnyKinematics = NNKinematics | PlacoKinematics | AnalyticalKinematics
+__all__ = ["NNKinematics", "PlacoKinematics", "AnalyticalKinematics"]