A SiteWalk describes a series of tasks that define autonomous robot operation. It contains SiteElements and SiteDocks together with other parameters that define autonomous operation.
This example program is the introductory programming example for the Orbit client, which uses the Orbit web API. It demonstrates how to initialize the Orbit client, authenticate with an API token, and finally export SiteWalk archives from Orbit.
A SiteWalk archive contains a compressed filepath to an Autowalk .walk folder that contains edge_snapshots, waypoint_snapshots, missions, and a graph.
Please begin with the Quickstart Guide to get your Python programming environment set up properly. Then, specifically for this example, look at the Orbit API Docs. For a complete list of resources and their methods, see the Orbit API Reference.
See the requirements.txt file for a list of python dependencies which can be installed with pip using the command:
python3 -m pip install -r requirements.txt
To run the example for local development and testing, run the following command with verify set to False. When set to False, requests will skip server's TLS certificate verifications which will make your application vulnerable. For production software, we recommend you set verify to True or a path to CA bundle.
python3 export_site_walk_archive.py --hostname ORBIT_IP --verify False
The above command prompts you to provide the API token obtained from the Orbit admin settings page. Alternatively, you can set the environment variable BOSDYN_ORBIT_CLIENT_API_TOKEN to the API token obtained from Orbit admin settings page.