GRID Docs | General Robotics

Python client for GRID Nexus — connect to a robot on the GRID network for direct command dispatch (RemoteRobot) or staged program deployment (RemoteDeployment), with live monitoring of the running graph.

Install

# Preinstalled in every GRID session workspace. For local use, install
# from the GRID package index with your organization's read-only
# credentials (the same pair `grid robot setup` provisions on robots):
export UV_INDEX_GRID_PYPI_USERNAME=<username>
export UV_INDEX_GRID_PYPI_PASSWORD=<token>
uv pip install grid-nexus-client --index grid-pypi=https://pypi.generalrobotics.dev/simple/

Quickstart

from grid_nexus_client import connect

# Direct dispatch: a RemoteRobot whose methods are the robot's capabilities.
robot = connect("<robot-id>")
robot.standUp()
robot.moveByVelocity((0.1, 0.0, 0.0), (0.0, 0.0, 0.0))

The methods a RemoteRobot exposes are the robot’s own — see Robot interface for the catalog. The end-to-end walkthrough is Your first skill.

Classes

Functions

Related topics

grid-cortex-client CortexClient AsyncCortexClient CortexHubClient Overview

⌘I