Installation¶
There are two pieces: the Gateway on the robot, and a client to control it (the Robotics Group App, or your own code).
1. Gateway (on the robot)¶
The Gateway runs as an autostart service on the robot's Perception Board. On a robot that was commissioned by URG it is already installed and starts automatically — nothing to do.
To commission a new robot, follow the Deployment Process. In short:
scp gateway_v2.py install.sh booster@<ROBOT-IP>:~/
ssh booster@<ROBOT-IP>
bash ~/install.sh
Requirements on the board (present on a factory robot): Python 3.10+,
websockets, pyyaml, numpy, opencv (cv2), pyrealsense2, the on-board
runtime SDK, and a connected RealSense camera.
2a. Robotics Group App (recommended)¶
The Robotics Group App is a Flutter app for iOS and Android (landscape). It is distributed through TestFlight / an internal Play track and, later, the App Store and Google Play. See the Mobile App guide.
2b. Your own client¶
Any WebSocket client can drive the robot:
pip install websockets
python3 test_client.py <ROBOT-IP>
Continue with the Quickstart or the Gateway API.
Network setup¶
Robot and controlling device must be on the same network. Note the robot's
Perception Board IP at commissioning — that is the address the app connects to,
on port 8765.