Installation¶
There are two pieces: the Gateway on the robot, and a client to control it (the Robotics Group App, or your own code).
For IT, technicians and integration partners
Technical reference for IT departments, URG technicians and trained partners. It is not written as operating instructions for end users.
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 <SERVICE-USER>@<ROBOT-IP>:~/
ssh <SERVICE-USER>@<ROBOT-IP>
bash ~/install.sh
Requirements on the board (present on a factory robot): Python 3.10+,
websockets, pyyaml, numpy, opencv (cv2), the Python bindings of the depth
camera, the on-board runtime SDK, and a connected depth camera.
<SERVICE-USER> is the service account of the Perception Board; its name is not
published on this site.
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.