CINXE.COM

<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Recording — Spot 4.1.0 documentation</title> <link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../../../../../_static/style.css" type="text/css" /> <link rel="shortcut icon" href="../../../../../_static/bd-favicon.png"/> <link rel="canonical" href="https://dev.bostondynamics.com/python/bosdyn-client/src/bosdyn/client/recording.html" />  <script src="../../../../../_static/jquery.js"></script> <script src="../../../../../_static/_sphinx_javascript_frameworks_compat.js"></script> <script data-url_root="../../../../../" id="documentation_options" src="../../../../../_static/documentation_options.js"></script> <script src="../../../../../_static/doctools.js"></script> <script src="../../../../../_static/sphinx_highlight.js"></script> <script src="../../../../../_static/js/theme.js"></script> <link rel="index" title="Index" href="../../../../../genindex.html" /> <link rel="search" title="Search" href="../../../../../search.html" /> <link rel="next" title="Robot Command" href="robot_command.html" /> <link rel="prev" title="Ray Cast" href="ray_cast.html" />  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-7602095-5"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-7602095-5'); </script>X-Content-Type-Options: nosniff<script type="text/javascript" src="//script.crazyegg.com/pages/scripts/0096/9626.js" async="async"></script></head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href='/readme'> <img src="../../../../../_static/bd-official-white.png" class="logo" alt="Logo"/> </a> <div class="version"> 4.1.0 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <ul class="current"> <li class="toctree-l1"><a class='reference internal' href='/docs/concepts/readme'>Concepts</a><ul> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/about_spot'>About Spot</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/orbit/about_orbit'>About Orbit (formerly Scout)</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/orbit/orbit_api'>Orbit API</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/networking'>Networking</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/base_services'>Base services</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/geometry_and_frames'>Geometry and Frames</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/robot_services'>Robot services</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/estop_service'>E-Stop</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/keepalive_service'>KeepAlive (BETA)</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/lease_service'>Lease</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/developing_api_services'>Developing API Services</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/service_customization'>Service Customization</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/faults'>Faults</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/autonomy/readme'>Autonomy services</a><ul> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/graphnav_tech_summary'>Autonomy Technical Summary</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/autonomous_navigation_code_examples'>Autonomous navigation code examples</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/components_of_autonomous_navigation'>Components of autonomous navigation</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/docking'>Docking</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/typical_autonomous_navigation_use_case'>Typical autonomous navigation use case</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/autonomous_navigation_services'>Autonomous navigation services</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/graphnav_service'>GraphNav service</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/graphnav_map_structure'>GraphNav map structure</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/graphnav_area_callbacks'>GraphNav area callbacks</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/initialization'>Initialization</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/localization'>Localization</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/graphnav_and_robot_locomotion'>GraphNav and robot locomotion</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/missions_service'>Missions service</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/autowalk_service'>Autowalk service</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/network_compute_bridge'>Network compute bridge</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/auto_return'>AutoReturn service</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/directed_exploration'>Directed Exploration</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/autonomy/gps'>GPS</a></li> </ul> </li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/choreography/readme'>Choreography</a><ul> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/choreography/choreography_service'>Choreography Service</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/choreography/move_reference'>Move Reference Guide</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/choreography/custom_gait'>CustomGait Reference</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/choreography/choreographer_setup'>Choreographer Setup</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/choreography/choreographer'>Choreographer Overview</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/choreography/robot_controls_in_choreographer'>Robot Connections in Choreographer</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/choreography/animations_in_choreographer'>Animations in Choreography</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/choreography/animation_file_specification'>Animation File Format</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/choreography/choreography_in_tablet'>Tablet Choreography Mode</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/choreography/choreography_in_autowalk'>Choreography Actions in Autowalk</a></li> </ul> </li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/joint_control/readme'>Joint Control API</a><ul> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/joint_control/supplemental_data'>Supplemental Robot Information</a><ul> <li class="toctree-l4"><a class='reference internal' href='/docs/concepts/joint_control/knee_torque_limits'>Knee Torque Limits</a></li> </ul> </li> </ul> </li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/arm/readme'>Spot Arm</a><ul> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/arm/arm_specification'>Arm and Gripper Specification</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/arm/arm_concepts'>Concepts</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/arm/arm_services'>Services</a></li> </ul> </li> <li class="toctree-l2"><a class='reference internal' href='/docs/concepts/data'>Spot Data</a><ul> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/data_acquisition_overview'>Data Acquisition Overview</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/data_acquisition_output'>Data Acquisition Output</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/writing_services_for_data_acquisition'>Integrate Payloads with the API</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/data_buffer_overview'>Data Buffer Overview</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/bddf'>BDDF File Format</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/concepts/data_acquisition_thermal_raw'>Thermal Raw Data Format</a></li> </ul> </li> </ul> </li> <li class="toctree-l1 current"><a class='reference internal' href='/docs/python/readme'>Python</a><ul class="current"> <li class="toctree-l2"><a class='reference internal' href='/docs/python/quickstart'>Quickstart</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/python/understanding_spot_programming'>Understanding Spot Programming</a></li> <li class="toctree-l2"><a class='reference internal' href='/python/examples/readme'>Examples</a><ul> <li class="toctree-l3"><a class='reference internal' href='/python/examples/docs/basic_service_examples'>Basic Service Examples</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/examples/hello_spot/readme'>Hello Spot</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/directory/readme'>Directory</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/get_robot_state/readme'>Get Robot State</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/get_robot_state_async/readme'>Get Robot State Async</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/get_image/readme'>Get Image</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/get_world_objects/readme'>Get World Objects</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/get_mission_state/readme'>Get Mission State</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/estop/readme'>E-Stop</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/time_sync/readme'>Time Sync</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/comms_test/readme'>Comms Test</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/disable_ir_emission/readme'>IR Enable/Disable</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/reset_safety_stop/readme'>Reset Safety Stop</a></li> </ul> </li> <li class="toctree-l3"><a class='reference internal' href='/python/examples/docs/robot_behavior_examples'>Robot Behavior and Commands Examples</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/examples/stance/readme'>Stance</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/frame_trajectory_command/readme'>Frame Trajectory</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/spot_light/readme'>Spot Light</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/upload_choreographed_sequence/readme'>Upload Choreographed Sequence</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/xbox_controller/readme'>Xbox Controller</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/wasd/readme'>WASD</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/docking/readme'>Docking</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/animation_recorder/readme'>Animation Recorder</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/auto_return/readme'>Auto Return</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/fan_command/readme'>Fan Commands</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_wasd/readme'>ARM WASD</a></li> </ul> </li> <li class="toctree-l3"><a class='reference internal' href='/python/examples/docs/arm_examples'>Arm Command Examples</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_simple/readme'>Simple Arm Motion</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_stow_unstow/readme'>Stow/unstow Arm</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_freeze/readme'>Arm Freeze</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_and_mobility_command/readme'>Arm and Mobility Command</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_with_body_follow/readme'>Arm Command with Body Following</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_constrained_manipulation/readme'>Arm Constrained Manipulation</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_trajectory/readme'>Arm Trajectory</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_trajectory/readme#long-trajectory'>Long Trajectory</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_joint_move/readme'>Arm Joint Move Command</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_force_control/readme'>Arm Force Control Command</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_grasp/readme'>Arm Grasp Command</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_grasp_carry_overrides/readme'>Arm Grasp and Carry Overrides</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_gaze/readme'>Arm Gaze Command</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_surface_contact/readme'>Arm Command with Surface Contact</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_door/readme'>Arm Door Opening Command</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_walk_to_object/readme'>Walk to And Pick Up Object</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_gcode/readme'>Writing Gcode</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/gripper_camera_params/readme'>Gripper Camera Parameters</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_impedance_control/readme'>Arm Impedance Control</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/inverse_kinematics/readme'>Inverse Kinematics</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/arm_wasd/readme'>Arm WASD</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/joint_control/readme'>Wiggle Arm</a></li> </ul> </li> <li class="toctree-l3"><a class='reference internal' href='/python/examples/docs/payloads_examples'>Payloads and Registration Examples</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/examples/payloads/readme'>Payloads</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/self_registration/readme'>Self Registration</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/service_faults/readme'>Faults</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/velodyne_client/readme'>Velodyne</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/core_io_gpio/readme'>CORE I/O GPIO</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/metrics_over_coreio/readme'>Overview</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/metrics_over_coreio/readme#usage'>Usage</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/metrics_over_coreio/readme#components'>Components</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/metrics_over_coreio/readme#recommended-debugging'>Recommended debugging</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/extensions/readme'>Extensions</a></li> </ul> </li> <li class="toctree-l3"><a class='reference internal' href='/python/examples/docs/perception_world_objects_examples'>Perception and World Objects Examples</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/examples/get_image/readme'>Get Image</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/get_world_objects/readme'>Get World Objects</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/world_object_with_image_coordinates/readme'>World Object With Image Coordinates</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/world_object_mutations/readme'>World Object Mutations</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/visualizer/readme'>Visualizer</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/ricoh_theta/readme'>Ricoh Theta</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/gripper_camera_params/readme'>Gripper Camera Parameters</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/spot_cam/readme'>Spot CAM Services</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/spot_cam/readme#spot-cam-video-core-io-extension-example'>Spot Cam Video Core IO Extension Example</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/stitch_front_images/readme'>Stitch Front Images</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/get_depth_plus_visual_image/readme'>Project Depth Data on Visual Images</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/service_customization/custom_parameter_image_server/readme'>Custom Parameter Image Server</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/fiducial_follow/readme'>Fiducial Follow</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/spot_tensorflow_detector/readme'>Tensorflow Detector</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/service_customization/custom_parameter_ncb_worker/readme'>Custom Parameter Tensorflow Detector</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/network_compute_bridge/readme'>Machine Learning with the Network Compute Bridge</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/network_compute_bridge/fire_extinguisher_server/readme'>Fire Extinguisher Detector with the Network Compute Bridge</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/ray_cast/readme'>Ray Cast</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/user_nogo_regions/readme'>No-Go Regions</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/gps_service/readme'>GPS</a></li> </ul> </li> <li class="toctree-l3"><a class='reference internal' href='/python/examples/docs/logging_examples'>Logging Examples</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/examples/bddf_download/readme'>BDDF Download</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/data_buffer/readme'>Data Buffer</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/data_service/readme'>Data Service</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/logging/readme'>Logging</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/log_status/readme'>Log Status</a></li> </ul> </li> <li class="toctree-l3"><a class='reference internal' href='/python/examples/docs/data_acquisition_examples'>Data Acquisition Examples</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/examples/data_acquisition_service/readme'>Data Acquisition Service</a><ul> <li class="toctree-l5"><a class='reference internal' href='/python/examples/data_acquisition_service/signals_coreio_modem_plugin/readme'>Modem Signals</a></li> </ul> </li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/service_faults/readme'>Faults</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/ricoh_theta/readme'>Ricoh Theta</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/service_customization/custom_parameter_image_server/readme'>Custom Parameter Image Service</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/service_customization/custom_parameters_data_acquisition/readme'>Custom Parameter Data Acquisition Plugin</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/get_image/readme'>Test Image Service Implementation with Get Image</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/post_docking_callbacks/readme'>Post Docking Callbacks</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/cloud_upload/readme'>Cloud Upload</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/comms_mapping/readme'>Comms image service</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/comms_mapping/readme#how-to-use'>How to use</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/data_acquisition_service/signals_coreio_modem_plugin/readme'>CoreIO Modem Signals Plugin</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/tester_programs/readme'>Tester Programs</a></li> </ul> </li> <li class="toctree-l3"><a class='reference internal' href='/python/examples/docs/autonomy_and_missions_examples'>Autonomy and Missions Examples</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/examples/graph_nav_anchoring_optimization/readme'>Graph Nav Anchoring Optimization</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/graph_nav_command_line/readme'>GraphNav and Recording Service Command Line Interfaces</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/graph_nav_command_line/readme#example-programs'>Example Programs</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/graph_nav_extract_point_cloud/readme'>Graph Nav Extract Point Cloud</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/graph_nav_view_map/readme'>Graph Nav View Map</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/graph_nav_view_gps/readme'>Graph Nav View GPS Data</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/get_mission_state/readme'>Get Mission State</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/remote_mission_service/readme'>Remote Mission Service</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/mission_question_answerer/readme'>Mission Question Answerer</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/mission_recorder/readme'>Mission Recorder</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/replay_mission/readme'>Replay Mission</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/post_docking_callbacks/readme'>Post Docking Callbacks</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/area_callback/readme'>Area Callbacks</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/edit_autowalk/readme'>Edit Autowalk</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/record_autowalk/readme'>Record Autowalk</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/extract_images_from_walk/readme'>Extract Images from Autowalk</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/network_request_callback/readme'>Network Request Callback</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/network_request_callback/readme#id1'>Network Request Callback</a></li> </ul> </li> <li class="toctree-l3"><a class='reference internal' href='/python/examples/docs/joint_control_examples'>Joint Control API Examples</a></li> <li class="toctree-l3"><a class='reference internal' href='/python/examples/docs/orbit'>Orbit</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/examples/orbit/hello_orbit/readme'>Hello Orbit</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/orbit/export_run_archives/readme'>Export Run Archives</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/orbit/export_site_walk_archives/readme'>Export Sitewalk Archives</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/orbit/anomalies/readme'>Anomalies</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/orbit/schedule_mission/readme'>Schedule Mission</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/orbit/runs_response/readme'>Runs Response</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/orbit/send_robot_back_to_dock/readme'>Return to Dock</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/orbit/toggle_mission_based_on_weather/readme'>Mission Toggle</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/orbit/webhook/readme'>Webhook</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/orbit/backups/readme'>Backups</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/orbit/webhook_integration/readme'>Webhook Integrations</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/examples/orbit/webhook_integration/readme#example-overview'>Example Overview</a></li> </ul> </li> </ul> </li> <li class="toctree-l2 current"><a class='reference internal' href='/python/readme'>Python Reference Guide</a><ul class="current"> <li class="toctree-l3 current"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/readme'>Client</a><ul class="current"> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/area_callback'>Area Callback</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/area_callback_region_handler_base'>Area Callback Region Handler</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/area_callback_service_runner'>Area Callback Service Runner</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/area_callback_service_servicer'>Area Callback Servicer</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/area_callback_service_utils'>Area Callback Service Utils</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/arm_surface_contact'>Arm Surface Contact</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/async_tasks'>Async Tasks</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/auth'>Auth</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/auto_return'>Auto Return</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/autowalk'>Autowalk</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/bddf'>BDDF</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/bddf_download'>BDDF Download</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/channel'>Channel</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/command_line'>Command</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/common'>Common</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/data_acquisition'>Data Acquisition</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/data_acquisition_helpers'>Data Acquisition Helpers</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/data_acquisition_plugin'>Data Acquisition Plugin</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/data_acquisition_plugin_service'>Data Acquisition Plugin Service</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/data_acquisition_store'>Data Acquisition Store</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/data_buffer'>Data Buffer</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/data_chunk'>Data Chunk</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/data_service'>Data Service</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/directory_registration'>Directory Registration</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/directory'>Directory</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/docking'>Docking</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/door'>Door</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/estop'>E-Stop</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/exceptions'>Exceptions</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/fault'>Fault</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/frame_helpers'>Frame Helpers</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/graph_nav'>Graph Nav</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/gripper_camera_param'>Gripper Camera Params</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/gps/readme'>GPS</a><ul> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/gps/aggregator_client'>Aggregator Client</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/gps/gps_listener'>GPS Listener</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/gps/nmeaparser'>NMEA Parser</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/gps/registration_client'>Registration Client</a></li> </ul> </li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/image'>Image</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/image_service_helpers'>Image Service Helpers</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/inverse_kinematics'>Inverse Kinematics</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/ir_enable_disable'>IR Enable/Disable</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/keepalive'>Keep Alive</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/lease'>Lease</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/lease_resource_hierarchy'>Lease Resource Hierarchy</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/lease_validator'>Lease Validator</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/license'>License</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/local_grid'>Local Grid</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/log_status'>Log Status</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/math_helpers'>Math Helpers</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/manipulation_api_client'>Manipulation API</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/map_processing'>Map Processing</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/metrics_logging'>Metrics Logging</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/network_compute_bridge_client'>Network Compute Bridge</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/payload_registration'>Payload Registration</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/payload'>Payload</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/point_cloud'>Point Cloud</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/power'>Power</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/processors'>Processors</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/ray_cast'>Ray casting</a></li> <li class="toctree-l4 current"><a class="current reference internal" href="#">Recording</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/robot_command'>Robot Command</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/robot_id'>Robot ID</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/robot'>Robot</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/robot_state'>Robot State</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/sdk'>SDK</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/server_util'>Server Util</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/service_customization_helpers'>Service Customization Helpers</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/signals_helpers'>Signals Helpers</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/spot_cam/readme'>Spot CAM</a><ul> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/spot_cam/audio'>Audio</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/spot_cam/compositor'>Compositor</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/spot_cam/health'>Health</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/spot_cam/lighting'>Lighting</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/spot_cam/lights_helper'>Lights Helper</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/spot_cam/media_log'>Media Log</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/spot_cam/network'>Network</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/spot_cam/power'>Power</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/spot_cam/ptz'>PTZ</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/spot_cam/streamquality'>Stream Quality</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/spot_cam/version'>Version</a></li> </ul> </li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/spot_check'>Spot Check</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/time_sync'>Time Sync</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/token_cache'>Token Cache</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/token_manager'>Token Manager</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/units_helpers'>Units Helpers</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/util'>Util</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/world_object'>World Object</a></li> </ul> </li> <li class="toctree-l3"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/readme'>Core</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/readme'>BDDF</a><ul> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/base_data_reader'>Base Data Reader</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/block_writer'>Block Writer</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/bosdyn'>BDDF Conventions</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/common'>Common</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/data_reader'>Data Reader</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/data_writer'>Data Writer</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/file_indexer'>File Indexer</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/grpc_proto_reader'>GRPC Proto Reader</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/grpc_reader'>GRPC Reader</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/grpc_service_reader'>GRPC Service Reader</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/grpc_service_writer'>GRPC Service Writer</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/message_reader'>Message Reader</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/pod_series_reader'>POD Series Reader</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/pod_series_writer'>POD Series Writer</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/protobuf_channel_reader'>Protobuf Channel Reader</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/protobuf_reader'>Protobuf Reader</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/protobuf_series_writer'>Protobuf Series Writer</a></li> <li class="toctree-l5"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/bddf/stream_data_reader'>Stream Data Reader</a></li> </ul> </li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/geometry'>Geometry</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/util'>Util</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-core/src/bosdyn/deprecated'>Deprecated</a></li> </ul> </li> <li class="toctree-l3"><a class='reference internal' href='/python/bosdyn-mission/src/bosdyn/mission/readme'>Mission</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-mission/src/bosdyn/mission/client'>Client</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-mission/src/bosdyn/mission/constants'>Constants</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-mission/src/bosdyn/mission/exceptions'>Exceptions</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-mission/src/bosdyn/mission/remote_client'>Remote Client</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-mission/src/bosdyn/mission/server_util'>Server Util</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-mission/src/bosdyn/mission/util'>Util</a></li> </ul> </li> <li class="toctree-l3"><a class='reference internal' href='/python/bosdyn-choreography-client/src/bosdyn/choreography/client/readme'>Choreography</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-choreography-client/src/bosdyn/choreography/client/choreography'>Choreography</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-choreography-client/src/bosdyn/choreography/client/animation_file_to_proto'>Animation File to Proto</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-choreography-client/src/bosdyn/choreography/client/animation_file_conversion_helpers'>Animation File to Proto Helpers</a></li> </ul> </li> <li class="toctree-l3"><a class='reference internal' href='/python/bosdyn-orbit/src/bosdyn/orbit/readme'>Orbit (formerly Scout)</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-orbit/src/bosdyn/orbit/client'>Client</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-orbit/src/bosdyn/orbit/utils'>Utils</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-orbit/src/bosdyn/orbit/exceptions'>Exceptions</a></li> </ul> </li> <li class="toctree-l3"><a class='reference internal' href='/python/bosdyn-scout/src/bosdyn/scout/readme'>Scout (deprecated)</a><ul> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-scout/src/bosdyn/scout/client'>Client</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-scout/src/bosdyn/scout/utils'>Utils</a></li> <li class="toctree-l4"><a class='reference internal' href='/python/bosdyn-scout/src/bosdyn/scout/exceptions'>Exceptions</a></li> </ul> </li> </ul> </li> <li class="toctree-l2"><a class='reference internal' href='/docs/python/fetch_tutorial/fetch1'>Fetch Tutorial</a><ul> <li class="toctree-l3"><a class='reference internal' href='/docs/python/fetch_tutorial/fetch2'>Part 2: Training the Model</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/python/fetch_tutorial/fetch3'>Part 3: Evaluating the Model</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/python/fetch_tutorial/fetch4'>Part 4: Autonomous Pick Up</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/python/fetch_tutorial/fetch5'>Part 5: Detecting People and Playing Fetch</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/python/fetch_tutorial/fetch6'>Part 6: Running the model on Core IO</a></li> </ul> </li> <li class="toctree-l2"><a class='reference internal' href='/docs/python/daq_tutorial/daq1'>Data Collection Tutorial</a><ul> <li class="toctree-l3"><a class='reference internal' href='/docs/python/daq_tutorial/daq2'>Part 2: Capturing images</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/python/daq_tutorial/daq3'>Part 3: Capturing other data</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/python/daq_tutorial/daq4'>Part 4: Deploying to the CORE I/O</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/python/daq_tutorial/daq5'>Part 5: Collecting data</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/python/daq_tutorial/daq6'>Part 6: Processing collected data</a></li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class='reference internal' href='/docs/payload/readme'>Payloads</a><ul> <li class="toctree-l2"><a class='reference internal' href='/docs/payload/payload_configuration_requirements'>Payload configuration requirements</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/payload/mechanical_interfaces'>Mechanical interfaces</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/payload/robot_mounting_rails'>Robot mounting rails</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/payload/guidelines_for_robust_payload_design'>Guidelines for robust payload design</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/payload/robot_electrical_interface'>Robot electrical interface</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/payload/coreio_documentation'>CORE I/O Documentation</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/payload/coreio_openvpn_extension'>CORE I/O OpenVPN Extension</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/payload/configuring_payload_software'>Configuring payload software</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/payload/docker_containers'>Dockerize payload software</a></li> <li class="toctree-l2"><a class='reference internal' href='/docs/payload/spot_core_documentation'>Pre-3.2 Spot CORE Documentation</a><ul> <li class="toctree-l3"><a class='reference internal' href='/docs/payload/spot_core_portainer'>Configuring Docker containers in SpotCORE</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/payload/spot_core_cockpit'>Spot CORE system management tool: Cockpit</a></li> <li class="toctree-l3"><a class='reference internal' href='/docs/payload/spot_core_vnc'>Spot CORE VNC</a></li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class='reference internal' href='/docs/protos/readme'>API Protocol</a><ul> <li class="toctree-l2"><a class='reference internal' href='/docs/protos/style_guide'>Style Guide</a></li> <li class="toctree-l2"><a class='reference internal' href='/protos/bosdyn/api/readme'>Proto Reference Guide</a><ul> <li class="toctree-l3"><a class='reference internal' href='/protos/bosdyn/api/proto_reference'>Protos</a></li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class='reference internal' href='/docs/release_notes'>Release Notes</a></li> <li class="toctree-l1"><a class="reference external" href="https://github.com/boston-dynamics/spot-sdk">SDK Repository</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href='/readme'>Spot</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a aria-label='Home' class='icon icon-home' href='/readme'></a></li> <li class="breadcrumb-item"><a href='/docs/python/readme'>Python Library</a></li> <li class="breadcrumb-item"><a href='/python/readme'>Boston Dynamics Python Reference Guide</a></li> <li class="breadcrumb-item"><a href='/python/bosdyn-client/src/bosdyn/client/readme'>Python Client</a></li> <li class="breadcrumb-item active">Recording</li> <li class="wy-breadcrumbs-aside"> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="module-bosdyn.client.recording"> <h1>Recording<a class="headerlink" href="#module-bosdyn.client.recording" title="Permalink to this heading"></a></h1> For clients to use the graph nav recording service <dl class="py class"> <dt class="sig sig-object py" id="bosdyn.client.recording.WaypointRegion"> class bosdyn.client.recording.WaypointRegion(value)<a class='reference internal' href='/_modules/bosdyn/client/recording#WaypointRegion'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.WaypointRegion" title="Permalink to this definition"></a></dt> <dd>Bases: <code class="xref py py-class docutils literal notranslate">Enum</code> Helper enum to describe the localization region type for a waypoint. <dl class="py attribute"> <dt class="sig sig-object py" id="bosdyn.client.recording.WaypointRegion.DEFAULT_REGION"> DEFAULT_REGION = 1<a class="headerlink" href="#bosdyn.client.recording.WaypointRegion.DEFAULT_REGION" title="Permalink to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="bosdyn.client.recording.WaypointRegion.EMPTY_REGION"> EMPTY_REGION = 2<a class="headerlink" href="#bosdyn.client.recording.WaypointRegion.EMPTY_REGION" title="Permalink to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="bosdyn.client.recording.WaypointRegion.CIRCLE_REGION"> CIRCLE_REGION = 3<a class="headerlink" href="#bosdyn.client.recording.WaypointRegion.CIRCLE_REGION" title="Permalink to this definition"></a></dt> <dd></dd></dl> </dd></dl> <dl class="py class"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient"> class bosdyn.client.recording.GraphNavRecordingServiceClient<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient" title="Permalink to this definition"></a></dt> <dd>Bases: <a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/common#bosdyn.client.common.BaseClient' title='bosdyn.client.common.BaseClient'><code class="xref py py-class docutils literal notranslate">BaseClient</code></a> Client for the GraphNav recording service. <dl class="py attribute"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.default_service_name"> default_service_name = 'recording-service'<a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.default_service_name" title="Permalink to this definition"></a></dt> <dd></dd></dl> <dl class="py attribute"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.service_type"> service_type = 'bosdyn.api.graph_nav.GraphNavRecordingService'<a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.service_type" title="Permalink to this definition"></a></dt> <dd></dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.start_recording"> start_recording(lease=None, recording_environment=None, require_fiducials=None, **kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.start_recording'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.start_recording" title="Permalink to this definition"></a></dt> <dd>Start the recording service to create/update a map. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>lease – Leases to show ownership of necessary resources. Will use the client’s leases by default.</li> <li>recording_environment – RecordingEnvironment protobuf to be used for the initial waypoint created at start.</li> <li>require_fiducials – Boolean to show whether a fiducial is needed to start the recording.</li> </ul> </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">The status of the start recording request. </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.start_recording_full"> start_recording_full(lease=None, recording_environment=None, require_fiducials=None, **kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.start_recording_full'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.start_recording_full" title="Permalink to this definition"></a></dt> <dd>Same as start_recording() but returns a full response </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.start_recording_async"> start_recording_async(lease=None, recording_environment=None, require_fiducials=None, **kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.start_recording_async'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.start_recording_async" title="Permalink to this definition"></a></dt> <dd>Async version of start_recording(). </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.start_recording_full_async"> start_recording_full_async(lease=None, recording_environment=None, require_fiducials=None, **kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.start_recording_full_async'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.start_recording_full_async" title="Permalink to this definition"></a></dt> <dd>Async version of start_recording_full(). </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.stop_recording"> stop_recording(lease=None, **kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.stop_recording'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.stop_recording" title="Permalink to this definition"></a></dt> <dd>Stop the recording service. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd">lease – Leases to show ownership of necessary resources. Will use the client’s leases by default. </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">The status of the start recording request. </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.stop_recording_async"> stop_recording_async(lease=None, **kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.stop_recording_async'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.stop_recording_async" title="Permalink to this definition"></a></dt> <dd>Async version of stop_recording(). </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.get_record_status"> get_record_status(**kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.get_record_status'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.get_record_status" title="Permalink to this definition"></a></dt> <dd>Get the status of the recording service. <dl class="field-list simple"> <dt class="field-odd">Returns:</dt> <dd class="field-odd">The record service status, which indicates the current persistent environment and if it’s recording a map. </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.get_record_status_async"> get_record_status_async(**kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.get_record_status_async'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.get_record_status_async" title="Permalink to this definition"></a></dt> <dd>Async version of get_record_status(). </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.set_recording_environment"> set_recording_environment(lease=None, recording_environment=None, **kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.set_recording_environment'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.set_recording_environment" title="Permalink to this definition"></a></dt> <dd>Set the persistent recording environment. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>lease – Leases to show ownership of necessary resources. Will use the client’s leases by default.</li> <li>recording_environment – RecordingEnvironment protobuf to be set as the persistent environment.</li> </ul> </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">Nothing unless an error occurs. </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.set_recording_environment_async"> set_recording_environment_async(lease=None, recording_environment=None, **kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.set_recording_environment_async'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.set_recording_environment_async" title="Permalink to this definition"></a></dt> <dd>Async version of set_recording_environment(). </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.create_waypoint"> create_waypoint(lease=None, waypoint_name=None, recording_environment=None, **kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.create_waypoint'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.create_waypoint" title="Permalink to this definition"></a></dt> <dd>Create a waypoint in the map at the current robot state. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>lease – Leases to show ownership of necessary resources. Will use the client’s leases by default.</li> <li>waypoint_name – Human readable string for the waypoint name.</li> <li>recording_environment – RecordingEnvironment protobuf to be used for the waypoint (will overwrite and merge with any persistent env).</li> </ul> </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">The response, which includes the created waypoint and any associated edges created. </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.create_waypoint_async"> create_waypoint_async(lease=None, waypoint_name=None, recording_environment=None, **kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.create_waypoint_async'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.create_waypoint_async" title="Permalink to this definition"></a></dt> <dd>Async version of create_waypoint(). </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.create_edge"> create_edge(lease=None, edge=None, **kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.create_edge'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.create_edge" title="Permalink to this definition"></a></dt> <dd>Create an edge in the map between two existing waypoints. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>lease – Leases to show ownership of necessary resources. Will use the client’s leases by default.</li> <li>edge – An edge protobuf, which must include valid from/to waypoint id’s and a from_T_to transform.</li> </ul> </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">The response status. </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.create_edge_async"> create_edge_async(lease=None, edge=None, **kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.create_edge_async'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.create_edge_async" title="Permalink to this definition"></a></dt> <dd>Async version of create_edge(). </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.make_recording_environment"> static make_recording_environment(name=None, waypoint_env=None, edge_env=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.make_recording_environment'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.make_recording_environment" title="Permalink to this definition"></a></dt> <dd>Construct a complete recording environment from the waypoint and edge environments. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>name – A string name prefix which will prefix waypoint names (human-readable).</li> <li>waypoint_env – Waypoint.Annotations protobuf which includes information for the waypoint environment.</li> <li>edge_env – Edge.Annotations protobuf which includes information for the edge environment.</li> </ul> </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">The API RecordingEnvironment protobuf message. </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.make_waypoint_environment"> static make_waypoint_environment(name=None, region=WaypointRegion.DEFAULT_REGION, dist_2d=None, client_metadata=None, **kwargs)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.make_waypoint_environment'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.make_waypoint_environment" title="Permalink to this definition"></a></dt> <dd>Create a waypoint environment. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>name – A string name for the waypoint (human-readable).</li> <li>region – A WaypointRegion enum representing the region in which we are localizing in. This can be either a default region, an empty region (don’t localize to this waypoint), or a circular region.</li> <li>dist_2d – If the region is circular, then this is set as a distance (meters) representing the number of meters away we can be from the waypoint before scan matching.</li> <li>client_metadata – Info about the client which will be stored in the waypoints.</li> </ul> </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">The API Waypoint.Annotations protobuf message. </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.make_client_metadata"> static make_client_metadata(session_name=None, client_username=None, client_software_version=None, client_id=None, client_type=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.make_client_metadata'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.make_client_metadata" title="Permalink to this definition"></a></dt> <dd>Creates client metadata for recording. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>session_name – User-provided name for this recording “session”. For example, the user may start and stop recording at various times and assign a name to a region that is being recorded. Usually, this will just be the map name.</li> <li>client_username – If the application recording the map has a special user name, this is the name of that user.</li> <li>client_software_version – Version string of any client software that generated this object.</li> <li>client_id – Identifier of any client software that generated this object</li> <li>client_type – Special tag for the client software which created this object. For example, “Tablet”, “Scout”, “Python SDK”, etc.</li> </ul> </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.make_edge_environment"> static make_edge_environment(vel_limit=None, direction_constraint=4, require_alignment=False, ground_mu_hint=0.8, grated_floor=False)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.make_edge_environment'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.make_edge_environment" title="Permalink to this definition"></a></dt> <dd>Create an edge environment. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>vel_limit – A SE2VelocityLimit to use while traversing the edge. Note this is not a target speed, just a max/min.</li> <li>direction_constraint – A direction constraints on the robot’s orientation when traversing the edge.</li> <li>require_alignment – Boolean where if true, the robot must be aligned with the edge in yaw before traversing it.</li> <li>ground_mu_hint – Terrain coefficient of friction user hint. Suggested values lie between [.4, .8].</li> <li>grated_floor – Boolean where if true, the edge crosses over grated metal.</li> </ul> </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">The API Edge.Annotations protobuf message. </dd> </dl> </dd></dl> <dl class="py method"> <dt class="sig sig-object py" id="bosdyn.client.recording.GraphNavRecordingServiceClient.make_edge"> static make_edge(from_waypoint_id, to_waypoint_id, from_tform_to, edge_environment=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#GraphNavRecordingServiceClient.make_edge'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.GraphNavRecordingServiceClient.make_edge" title="Permalink to this definition"></a></dt> <dd>Create an edge between two waypoint ids. <dl class="field-list simple"> <dt class="field-odd">Parameters:</dt> <dd class="field-odd"><ul class="simple"> <li>from_waypoint_id – A waypoint string id for the from waypoint.</li> <li>to_waypoint_id – A waypoint string id for the to waypoint.</li> <li>from_tform_to – An SE3Pose representing the transform of from_waypoint to to_waypoint.</li> <li>edge_environment – Any edge environment to be associated with the created edge.</li> </ul> </dd> <dt class="field-even">Returns:</dt> <dd class="field-even">The API Edge protobuf message. </dd> </dl> </dd></dl> </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.RecordingServiceResponseError"> exception bosdyn.client.recording.RecordingServiceResponseError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#RecordingServiceResponseError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.RecordingServiceResponseError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class='reference internal' href='/python/bosdyn-client/src/bosdyn/client/exceptions#bosdyn.client.exceptions.ResponseError' title='bosdyn.client.exceptions.ResponseError'><code class="xref py py-class docutils literal notranslate">ResponseError</code></a> General class of errors for the GraphNav Recording Service. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.CouldNotCreateWaypointError"> exception bosdyn.client.recording.CouldNotCreateWaypointError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#CouldNotCreateWaypointError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.CouldNotCreateWaypointError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> Service could not create a waypoint. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.NotRecordingError"> exception bosdyn.client.recording.NotRecordingError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#NotRecordingError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.NotRecordingError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> The recording service has not been started. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.UnknownWaypointError"> exception bosdyn.client.recording.UnknownWaypointError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#UnknownWaypointError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.UnknownWaypointError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> The edge requested has a waypoint id that is unknown. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.EdgeExistsError"> exception bosdyn.client.recording.EdgeExistsError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#EdgeExistsError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.EdgeExistsError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> The edge requested with the given ID already exists in the map. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.EdgeMissingTransformError"> exception bosdyn.client.recording.EdgeMissingTransformError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#EdgeMissingTransformError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.EdgeMissingTransformError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> The edge requested is missing the from_T_to transform in the edge. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.NotLocalizedToEndError"> exception bosdyn.client.recording.NotLocalizedToEndError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#NotLocalizedToEndError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.NotLocalizedToEndError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> Stop recording failed to localize to the last created waypoint. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.FollowingRouteError"> exception bosdyn.client.recording.FollowingRouteError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#FollowingRouteError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.FollowingRouteError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> Cannot start recording while the robot is already following a route. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.NotLocalizedToExistingMapError"> exception bosdyn.client.recording.NotLocalizedToExistingMapError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#NotLocalizedToExistingMapError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.NotLocalizedToExistingMapError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> The robot is not localized to the existing map and cannot start recording. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.TooFarFromExistingMapError"> exception bosdyn.client.recording.TooFarFromExistingMapError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#TooFarFromExistingMapError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.TooFarFromExistingMapError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> The robot is too far from the existing map and cannot start recording. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.RemoteCloudFailureNotInDirectoryError"> exception bosdyn.client.recording.RemoteCloudFailureNotInDirectoryError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#RemoteCloudFailureNotInDirectoryError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.RemoteCloudFailureNotInDirectoryError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> Failed to start recording because a remote point cloud (e.g. a LIDAR) is not registered to the service directory. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.RemoteCloudFailureNoDataError"> exception bosdyn.client.recording.RemoteCloudFailureNoDataError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#RemoteCloudFailureNoDataError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.RemoteCloudFailureNoDataError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> Failed to start recording because a remote point cloud (e.g. a LIDAR) is not delivering data. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.NotReadyYetError"> exception bosdyn.client.recording.NotReadyYetError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#NotReadyYetError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.NotReadyYetError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> The service is processing the map at its current position. Try again in 1-2 seconds. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.MapTooLargeLicenseError"> exception bosdyn.client.recording.MapTooLargeLicenseError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#MapTooLargeLicenseError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.MapTooLargeLicenseError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> Map exceeds the size allowed by the license. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.MissingFiducialsError"> exception bosdyn.client.recording.MissingFiducialsError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#MissingFiducialsError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.MissingFiducialsError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> One or more required fiducials were not detected. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.FiducialPoseError"> exception bosdyn.client.recording.FiducialPoseError(response, error_message=None)<a class='reference internal' href='/_modules/bosdyn/client/recording#FiducialPoseError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.FiducialPoseError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> The pose of one or more required fiducials could not be determined accurately. </dd></dl> <dl class="py exception"> <dt class="sig sig-object py" id="bosdyn.client.recording.RobotImpairedError"> exception bosdyn.client.recording.RobotImpairedError(response, error_message)<a class='reference internal' href='/_modules/bosdyn/client/recording#RobotImpairedError'>[source]</a><a class="headerlink" href="#bosdyn.client.recording.RobotImpairedError" title="Permalink to this definition"></a></dt> <dd>Bases: <a class="reference internal" href="#bosdyn.client.recording.RecordingServiceResponseError" title="bosdyn.client.recording.RecordingServiceResponseError"><code class="xref py py-class docutils literal notranslate">RecordingServiceResponseError</code></a> Failed to start recording because the robot is impaired. </dd></dl> </section> </div> </div> <footer> <hr/> <div role="contentinfo"> © Copyright 2024 Boston Dynamics. All rights reserved. <a href="https://www.bostondynamics.com/privacy-policy">Privacy Policy</a> | <a href="https://www.bostondynamics.com/terms">Terms of Use</a> </div> </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(false); }); </script>  <script async src="https://www.googletagmanager.com/gtag/js?id=UA-XXXXXXX-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-XXXXXXX-1', { 'anonymize_ip': false, }); </script>  <script type="text/javascript" id="hs-script-loader" async defer src="//js.hs-scripts.com/4845432.js"></script> </body> </html>