Skip to main content

Boston Dynamics API client code and interfaces

Project description

bosdyn-client

The bosdyn-client wheel contains client interfaces for interacting with the Boston Dynamics Spot API. The client interfaces implement the Remote Procedure Calls (RPCs) defined in the bosdyn-api wheel.

Main Classes

The main classes contained in this wheel are Sdk and Robot.

  • Sdk: Class for settings typically common to a single developer and/or robot fleet.
  • Robot: Class for settings common to one user's access to one robot. This is the main point of access to all client functionality.

For example, to list the robot image sources using the Image client, simply create an Sdk object, create a Robot object, authenticate, create the client and call the corresponding method, as shown below. It is that simple!

>>> import bosdyn.client
>>> sdk = bosdyn.client.create_standard_sdk('image_capture')
>>> robot = sdk.create_robot(hostname)
>>> robot.authenticate(username, password)
>>> image_client = robot.ensure_client(ImageClient.default_service_name)
>>> image_sources = image_client.list_image_sources()

Clients that trigger robot movement also need to set up the TimeSync, Lease and E-Stop clients. Our examples repository contains many tutorials on how to use the clients included in this wheel.

Command-line Support

Some of the clients included in this wheel can also be accessed directly from the command-line.

python3 -m bosdyn.client hostname -h
usage: bosdyn.client [-h] [-v] [--username USERNAME] [--password PASSWORD]
                     hostname
                     {dir,payload,fault,id,license,log-status,state,log,data,time-sync,lease,become-estop,estop,image,local_grid,acquire,self-ip,power,keepalive}
                     ...

Command-line interface for interacting with robot services.
...

For example, to list the robot image sources from the command-line:

$ python3 -m bosdyn.client hostname image list-sources
back_depth                     (240x424)
back_depth_in_visual_frame     (480x640)
back_fisheye_image             (480x640)
frontleft_depth                (240x424)
frontleft_depth_in_visual_frame (480x640)
frontleft_fisheye_image        (480x640)
frontright_depth               (240x424)
frontright_depth_in_visual_frame (480x640)
frontright_fisheye_image       (480x640)
left_depth                     (240x424)
left_depth_in_visual_frame     (480x640)
left_fisheye_image             (480x640)
right_depth                    (240x424)
right_depth_in_visual_frame    (480x640)
right_fisheye_image            (480x640)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

bosdyn_client-5.0.0-py3-none-any.whl (289.8 kB view details)

Uploaded Python 3

File details

Details for the file bosdyn_client-5.0.0-py3-none-any.whl.

File metadata

  • Download URL: bosdyn_client-5.0.0-py3-none-any.whl
  • Upload date:
  • Size: 289.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.12

File hashes

Hashes for bosdyn_client-5.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc67e6a4d0a8ef465754a586b2f583088cfa633d5948fd1a673570f860d0a00d
MD5 a8facb6b49afdc6744cde59894f82d11
BLAKE2b-256 2d69fee933962be73e7ae03ecd1e3aacfa8b7ede5bee2bb5e48c79094fb07e1d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page