Documentation Index
Fetch the complete documentation index at: https://docs.generalrobotics.dev/llms.txt
Use this file to discover all available pages before exploring further.
HTTPClient
Inherits from: object
Direct HTTP client for robot communication.
Provides simple REST API access to robot endpoints. Best suited for
web applications, scripts, and IoT devices requiring lightweight
HTTP-based robot control.
init
HTTPClient.__init__(robot_ip: str, port: int = 4774, enable_heartbeat: bool = True, heartbeat_interval: float = 3.0) -> None
Initialize HTTP client.
Port number (default 4774)
Enable automatic heartbeat monitoring for safety
heartbeat_interval (float)
Heartbeat interval in seconds (default 3.0)
If requests library is not installed
is_connected
HTTPClient.is_connected() -> bool
Check if HTTP client can connect.
True if client can successfully connect to the robot
disconnect
HTTPClient.disconnect() -> None
Disconnect HTTP client and stop heartbeat monitoring.
Stops the heartbeat monitoring thread and cleans up resources.