Skip to content

Commit

Permalink
fixed minor formatting issues in the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bd-sdk-publisher committed Jun 13, 2023
1 parent 7b0a06c commit aa607fe
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 29 deletions.
34 changes: 18 additions & 16 deletions docs/html/docs/release_notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -744,31 +744,33 @@ <h4>Navigation<a class="headerlink" href="#navigation" title="Permalink to this
<h4>Choreography<a class="headerlink" href="#choreography" title="Permalink to this headline"></a></h4>
<p>Added a new <code class="docutils literal notranslate"><span class="pre">ChoreographyCommand</span></code> RPC to support <a class="reference internal" href="concepts/choreography/custom_gait.html"><span class="doc">interactive choreography moves</span></a>.</p>
<p>Added a new <code class="docutils literal notranslate"><span class="pre">ChoreographyStatus</span></code> RPC so that users can receive feedback on the dance state a robot is in and a robot’s progress in completing a dance or current move(s) in a dance.</p>
<p>Added <code class="docutils literal notranslate"><span class="pre">exit_state</span></code> field in <code class="docutils literal notranslate"><span class="pre">SequenceInfo</span></code> message to specify the exit transition state of the sequence.
Added <code class="docutils literal notranslate"><span class="pre">execution_id</span></code> field in <code class="docutils literal notranslate"><span class="pre">ExecuteChoreographyResponse</span></code> message with the unique ID for the execution.
Added <code class="docutils literal notranslate"><span class="pre">id</span></code> field in <code class="docutils literal notranslate"><span class="pre">MoveParams</span></code> message, set by the client or auto-assigned by the service, to be reported in the <code class="docutils literal notranslate"><span class="pre">ChoreographyStatusResponse</span></code> <code class="docutils literal notranslate"><span class="pre">ActiveMoves</span></code> field.
Added <code class="docutils literal notranslate"><span class="pre">custom_gait_params</span></code> and <code class="docutils literal notranslate"><span class="pre">leg_joint_params</span></code> fields in <code class="docutils literal notranslate"><span class="pre">MoveParams</span></code> object.
Added <code class="docutils literal notranslate"><span class="pre">is_looping</span></code> field in <code class="docutils literal notranslate"><span class="pre">MoveInfo</span></code> message.
Added <code class="docutils literal notranslate"><span class="pre">entrance_state</span></code> field in <code class="docutils literal notranslate"><span class="pre">ChoreographySequence</span></code> message to specify an explicit entrance state in the case where the first legs-track move accepts multiple entrance states.
Animations now support more flexibility to adjusting timing, can specify whether the animation starts from a sit pose, or can specify that an Animation can be used for a custom gait.</p>
<ul class="simple">
<li><p>Added <code class="docutils literal notranslate"><span class="pre">exit_state</span></code> field in <code class="docutils literal notranslate"><span class="pre">SequenceInfo</span></code> message to specify the exit transition state of the sequence.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">execution_id</span></code> field in <code class="docutils literal notranslate"><span class="pre">ExecuteChoreographyResponse</span></code> message with the unique ID for the execution.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">id</span></code> field in <code class="docutils literal notranslate"><span class="pre">MoveParams</span></code> message, set by the client or auto-assigned by the service, to be reported in the <code class="docutils literal notranslate"><span class="pre">ChoreographyStatusResponse</span></code> <code class="docutils literal notranslate"><span class="pre">ActiveMoves</span></code> field.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">custom_gait_params</span></code> and <code class="docutils literal notranslate"><span class="pre">leg_joint_params</span></code> fields in <code class="docutils literal notranslate"><span class="pre">MoveParams</span></code> object.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">is_looping</span></code> field in <code class="docutils literal notranslate"><span class="pre">MoveInfo</span></code> message.</p></li>
<li><p>Added <code class="docutils literal notranslate"><span class="pre">entrance_state</span></code> field in <code class="docutils literal notranslate"><span class="pre">ChoreographySequence</span></code> message to specify an explicit entrance state in the case where the first legs-track move accepts multiple entrance states.</p></li>
<li><p>Animations now support more flexibility to adjusting timing, can specify whether the animation starts from a sit pose, or can specify that an Animation can be used for a custom gait.</p></li>
</ul>
</section>
<section id="payloads">
<h4>Payloads<a class="headerlink" href="#payloads" title="Permalink to this headline"></a></h4>
<p>New fields in the Payload proto enable a liveness check, similar to a service liveness check. The robot will periodically try to ping (ICMP) the payload to see if it is still connected.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">liveness_timeout_secs</span></code>: How long payload can be unpingable before a liveness fault is raised.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ipv4_address</span></code>: Address for the robot to ping the payload at.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">link_speed</span></code>: Expected ethernet speed negotiated.
If present, the <code class="docutils literal notranslate"><span class="pre">ipv4_address</span></code> field will also be used to detect whether a payload is mounted to the front or rear payload port. If a payload preset has a label “mount_port:rear” and the payload is connected to the front port, it will not be displayed on the registration page. The same is true if there is a preset “mount_port:front” and the payload is connected to the rear port.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">link_speed</span></code>: Expected ethernet speed negotiated.</p></li>
</ul>
<p>If present, the <code class="docutils literal notranslate"><span class="pre">ipv4_address</span></code> field will also be used to detect whether a payload is mounted to the front or rear payload port. If a payload preset has a label “mount_port:rear” and the payload is connected to the front port, it will not be displayed on the registration page. The same is true if there is a preset “mount_port:front” and the payload is connected to the rear port.</p>
</section>
<section id="images-and-data">
<h4>Images and Data<a class="headerlink" href="#images-and-data" title="Permalink to this headline"></a></h4>
<p>Added the SpotCamAlignment action wrapper for aligning Spot Cam image captures.</p>
<p>Images can be stored for Data Acquisition and RemoteGrpc elements in order to aid in editing walks.</p>
<p>Updated the <code class="docutils literal notranslate"><span class="pre">IrMeterOverlay</span></code> Spot Cam message and added a new RPC to get the current overlay.
Added new RPCs for setting and getting the focus state of the Spot Cam PTZ.
Added exposure settings to the <code class="docutils literal notranslate"><span class="pre">StreamParams</span></code> message.</p>
<p>Updated the <code class="docutils literal notranslate"><span class="pre">IrMeterOverlay</span></code> Spot Cam message and added a new RPC to get the current overlay.</p>
<p>Added new RPCs for setting and getting the focus state of the Spot Cam PTZ.</p>
<p>Added exposure settings to the <code class="docutils literal notranslate"><span class="pre">StreamParams</span></code> message.</p>
<p>New <code class="docutils literal notranslate"><span class="pre">AvailableModels</span></code> message to describe Network Compute Bridge models available for data acquisition capture.</p>
<p>New unique <code class="docutils literal notranslate"><span class="pre">id</span></code> returned in <code class="docutils literal notranslate"><span class="pre">Store*</span></code> responses from the <code class="docutils literal notranslate"><span class="pre">DataAcquisitionStore</span></code> service. This id can be used in a <code class="docutils literal notranslate"><span class="pre">DataIdentifier</span></code> to uniquely identify a particular piece of stored data.</p>
</section>
Expand Down Expand Up @@ -816,10 +818,10 @@ <h4>NetworkComputeBridge<a class="headerlink" href="#networkcomputebridge" title
</section>
<section id="deprecated-fields-and-values">
<h4>Deprecated fields and values<a class="headerlink" href="#deprecated-fields-and-values" title="Permalink to this headline"></a></h4>
<p><strong>GripperCameraParam</strong>: Renamed <code class="docutils literal notranslate"><span class="pre">CameraMode</span></code> enum values.
<strong>Graph Nav</strong>: The <code class="docutils literal notranslate"><span class="pre">StraightStaircase</span></code> representation of staircases is deprecated and replaced with the new <code class="docutils literal notranslate"><span class="pre">StaircaseWithLandings</span></code>.
<strong>Choreography</strong>; The <code class="docutils literal notranslate"><span class="pre">precise_timing</span></code> in <code class="docutils literal notranslate"><span class="pre">Animation</span></code> message is deprecated and replaced by the more fine-grained control of <code class="docutils literal notranslate"><span class="pre">timing_adjustability</span></code> field.
<strong>Leases</strong>: Use <code class="docutils literal notranslate"><span class="pre">is_stale</span></code> instead of the stale time in the <code class="docutils literal notranslate"><span class="pre">LeaseResource</span></code> message to determine staleness.</p>
<p><strong>GripperCameraParam</strong>: Renamed <code class="docutils literal notranslate"><span class="pre">CameraMode</span></code> enum values.</p>
<p><strong>Graph Nav</strong>: The <code class="docutils literal notranslate"><span class="pre">StraightStaircase</span></code> representation of staircases is deprecated and replaced with the new <code class="docutils literal notranslate"><span class="pre">StaircaseWithLandings</span></code>.</p>
<p><strong>Choreography</strong>; The <code class="docutils literal notranslate"><span class="pre">precise_timing</span></code> in <code class="docutils literal notranslate"><span class="pre">Animation</span></code> message is deprecated and replaced by the more fine-grained control of <code class="docutils literal notranslate"><span class="pre">timing_adjustability</span></code> field.</p>
<p><strong>Leases</strong>: Use <code class="docutils literal notranslate"><span class="pre">is_stale</span></code> instead of the stale time in the <code class="docutils literal notranslate"><span class="pre">LeaseResource</span></code> message to determine staleness.</p>
</section>
<section id="python-functions">
<h4>Python functions<a class="headerlink" href="#python-functions" title="Permalink to this headline"></a></h4>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -742,7 +742,7 @@
</dl>
<dl class="py method">
<dt id="bosdyn.client.area_callback_region_handler_base.AreaCallbackRegionHandlerBase.begin">
<code class="sig-name descname">begin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span><span class="p">:</span> <span class="n">bosdyn.api.graph_nav.area_callback_pb2.BeginCallbackRequest</span></em><span class="sig-paren">)</span> &#x2192; &lt;google.protobuf.internal.enum_type_wrapper.EnumTypeWrapper object at 0x7f57d7d81c60&gt;<a class="reference internal" href="../../../../../_modules/bosdyn/client/area_callback_region_handler_base.html#AreaCallbackRegionHandlerBase.begin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bosdyn.client.area_callback_region_handler_base.AreaCallbackRegionHandlerBase.begin" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">begin</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span><span class="p">:</span> <span class="n">bosdyn.api.graph_nav.area_callback_pb2.BeginCallbackRequest</span></em><span class="sig-paren">)</span> &#x2192; &lt;google.protobuf.internal.enum_type_wrapper.EnumTypeWrapper object at 0x7f055c2917e0&gt;<a class="reference internal" href="../../../../../_modules/bosdyn/client/area_callback_region_handler_base.html#AreaCallbackRegionHandlerBase.begin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bosdyn.client.area_callback_region_handler_base.AreaCallbackRegionHandlerBase.begin" title="Permalink to this definition"></a></dt>
<dd><p>Validates that configuration passed to BeginCallback is valid.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
Expand Down Expand Up @@ -950,7 +950,7 @@

<dl class="py method">
<dt id="bosdyn.client.area_callback_region_handler_base.AreaCallbackRegionHandlerBase.internal_set_stage">
<code class="sig-name descname">internal_set_stage</code><span class="sig-paren">(</span><em class="sig-param">stage: &lt;google.protobuf.internal.enum_type_wrapper.EnumTypeWrapper object at 0x7f57d7d81d20&gt;</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/bosdyn/client/area_callback_region_handler_base.html#AreaCallbackRegionHandlerBase.internal_set_stage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bosdyn.client.area_callback_region_handler_base.AreaCallbackRegionHandlerBase.internal_set_stage" title="Permalink to this definition"></a></dt>
<code class="sig-name descname">internal_set_stage</code><span class="sig-paren">(</span><em class="sig-param">stage: &lt;google.protobuf.internal.enum_type_wrapper.EnumTypeWrapper object at 0x7f055c292da0&gt;</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/bosdyn/client/area_callback_region_handler_base.html#AreaCallbackRegionHandlerBase.internal_set_stage"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bosdyn.client.area_callback_region_handler_base.AreaCallbackRegionHandlerBase.internal_set_stage" title="Permalink to this definition"></a></dt>
<dd><p>Update the stage via an incoming UpdateCallbackRequest.</p>
</dd></dl>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -764,7 +764,7 @@

<dl class="py class">
<dt id="bosdyn.client.estop.EstopClient">
<em class="property">class </em><code class="sig-prename descclassname">bosdyn.client.estop.</code><code class="sig-name descname">EstopClient</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">'EstopClient - PID: 93980'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/bosdyn/client/estop.html#EstopClient"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bosdyn.client.estop.EstopClient" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="sig-prename descclassname">bosdyn.client.estop.</code><code class="sig-name descname">EstopClient</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">'EstopClient - PID: 40683'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/bosdyn/client/estop.html#EstopClient"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#bosdyn.client.estop.EstopClient" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="common.html#bosdyn.client.common.BaseClient" title="bosdyn.client.common.BaseClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">bosdyn.client.common.BaseClient</span></code></a></p>
<p>Client to the estop service.</p>
<dl class="py attribute">
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js

Large diffs are not rendered by default.

0 comments on commit aa607fe

Please sign in to comment.