Skip to main content

​
NexusClient

Inherits from: object Dynamic client that mirrors the remote robot’s interface. Provides fast WebSocket communication with immediate disconnect detection. Best suited for safety-critical robotics applications and real-time control.

​
init

NexusClient.__init__(robot_ip: str, port: int = 4774) -> None
Initialize NexusClient to connect to remote robot.
​
Arguments
​
robot_ip (str)
str
required
IP address of the robot
​
port (int)
int
Port number (default 4774)
​
Returns
​
returns
None
​
Raises
​
ConnectionError
If connection fails or times out

​
is_connected

NexusClient.is_connected() -> bool
Check if client is connected to robot.
​
Returns
​
bool
bool
True if WebSocket connection is active

​
disconnect

NexusClient.disconnect() -> None
Disconnect from robot. Closes the WebSocket connection and cleans up resources.
​
Returns
​
returns
None