Skip to main content

Connection

AuroraClient.get_instance()

Python
AuroraClient.get_instance(
domain_id: int,
participant_qos=None,
robot_name: str | None = None,
namespace: str | None = None,
is_ros_compatible: bool | None = None
) -> AuroraClient

Creates or returns the singleton AuroraClient instance. Multiple calls within the same process return the same object.

ParameterTypeDescription
domain_idintDDS domain ID — must match the robot's infra.yaml (default 123)
participant_qosDDS participant QoS; pass None to use defaults
robot_namestrRobot model: "gr1", "gr2", "gr3", "gr3mini", "krabby", "fouriern1", "dr1"
namespacestr | NoneDDS topic namespace; None for auto-detection
is_ros_compatiblebool | NoneEnable ROS-compatible DDS topic naming

Returns: AuroraClient instance. Raises DDSInitError on failure.

Example

Python
from fourier_aurora_client import AuroraClient

client = AuroraClient.get_instance(domain_id=123, robot_name="gr3")

close()

Python
client.close()

Closes the DDS interface and releases all resources. Call this before the program exits.

Example

Python
client = AuroraClient.get_instance(domain_id=123, robot_name="gr3")

# ... perform operations ...

client.close()