Skip to content

Commit

Permalink
deploy: c6ab72d
Browse files Browse the repository at this point in the history
  • Loading branch information
stuqdog committed Nov 19, 2024
1 parent 10e0b52 commit 01d7b34
Show file tree
Hide file tree
Showing 141 changed files with 2,571 additions and 3,275 deletions.
1 change: 0 additions & 1 deletion arm_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@
<div class="textblock"><code>#include &lt;string&gt;</code><br />
<code>#include &lt;boost/optional/optional.hpp&gt;</code><br />
<code>#include &lt;boost/variant/variant.hpp&gt;</code><br />
<code>#include &lt;viam/api/common/v1/common.pb.h&gt;</code><br />
<code>#include &lt;viam/sdk/common/pose.hpp&gt;</code><br />
<code>#include &lt;viam/sdk/resource/stoppable.hpp&gt;</code><br />
<code>#include &lt;viam/sdk/spatialmath/geometry.hpp&gt;</code><br />
Expand Down
270 changes: 133 additions & 137 deletions arm_8hpp_source.html

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions arm__client_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,15 +138,15 @@
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>} <span class="comment">// namespace sdk</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>} <span class="comment">// namespace viam</span></div>
<div class="ttc" id="aarm_8hpp_html"><div class="ttname"><a href="arm_8hpp.html">arm.hpp</a></div><div class="ttdoc">Defines an Arm component.</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></div><div class="ttdoc">An Arm represents a physical robot arm that exists in three-dimensional space.</div><div class="ttdef"><b>Definition</b> arm.hpp:28</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a1684010009781539671c88c57bae7d68"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a1684010009781539671c88c57bae7d68">viam::sdk::Arm::get_kinematics</a></div><div class="ttdeci">KinematicsData get_kinematics()</div><div class="ttdoc">Get the kinematics data associated with the arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:145</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a1a5198860ccffa77d21b6d0ea047b018"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a1a5198860ccffa77d21b6d0ea047b018">viam::sdk::Arm::get_joint_positions</a></div><div class="ttdeci">std::vector&lt; double &gt; get_joint_positions()</div><div class="ttdoc">Lists the joint positions in degrees of every joint on a robot arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:94</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a48cc947a63a1c32bbe122017aab51849"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a48cc947a63a1c32bbe122017aab51849">viam::sdk::Arm::move_to_joint_positions</a></div><div class="ttdeci">void move_to_joint_positions(const std::vector&lt; double &gt; &amp;positions)</div><div class="ttdoc">Move each joint on the arm to the corresponding angle specified in.</div><div class="ttdef"><b>Definition</b> arm.hpp:103</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a5604ac4418042783a0227e43c573a9ac"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a5604ac4418042783a0227e43c573a9ac">viam::sdk::Arm::get_geometries</a></div><div class="ttdeci">std::vector&lt; GeometryConfig &gt; get_geometries()</div><div class="ttdoc">Returns GeometryConfigs associated with the calling arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:150</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a72ace37c311ae8bf430df9ccf3ad0775"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a72ace37c311ae8bf430df9ccf3ad0775">viam::sdk::Arm::KinematicsData</a></div><div class="ttdeci">boost::variant&lt; KinematicsDataUnspecified, KinematicsDataSVA, KinematicsDataURDF &gt; KinematicsData</div><div class="ttdoc">The kinematics of the component.</div><div class="ttdef"><b>Definition</b> arm.hpp:61</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a9d9497dfc7b23872f5909eaf8c670cbd"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a9d9497dfc7b23872f5909eaf8c670cbd">viam::sdk::Arm::move_through_joint_positions</a></div><div class="ttdeci">void move_through_joint_positions(const std::vector&lt; std::vector&lt; double &gt; &gt; &amp;positions, const MoveOptions &amp;options)</div><div class="ttdoc">Move each joint on the arm through the positions specified in.</div><div class="ttdef"><b>Definition</b> arm.hpp:116</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_ae5acbc1a20c1ad5814e10dde57b34c16"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#ae5acbc1a20c1ad5814e10dde57b34c16">viam::sdk::Arm::get_end_position</a></div><div class="ttdeci">pose get_end_position()</div><div class="ttdoc">Get the current position of the end of the arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:74</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_aee61208d32415894fca591554e394cdb"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#aee61208d32415894fca591554e394cdb">viam::sdk::Arm::move_to_position</a></div><div class="ttdeci">void move_to_position(const pose &amp;pose)</div><div class="ttdoc">Move the end of the arm to.</div><div class="ttdef"><b>Definition</b> arm.hpp:84</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></div><div class="ttdoc">An Arm represents a physical robot arm that exists in three-dimensional space.</div><div class="ttdef"><b>Definition</b> arm.hpp:26</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a1684010009781539671c88c57bae7d68"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a1684010009781539671c88c57bae7d68">viam::sdk::Arm::get_kinematics</a></div><div class="ttdeci">KinematicsData get_kinematics()</div><div class="ttdoc">Get the kinematics data associated with the arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:141</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a1a5198860ccffa77d21b6d0ea047b018"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a1a5198860ccffa77d21b6d0ea047b018">viam::sdk::Arm::get_joint_positions</a></div><div class="ttdeci">std::vector&lt; double &gt; get_joint_positions()</div><div class="ttdoc">Lists the joint positions in degrees of every joint on a robot arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:90</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a48cc947a63a1c32bbe122017aab51849"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a48cc947a63a1c32bbe122017aab51849">viam::sdk::Arm::move_to_joint_positions</a></div><div class="ttdeci">void move_to_joint_positions(const std::vector&lt; double &gt; &amp;positions)</div><div class="ttdoc">Move each joint on the arm to the corresponding angle specified in.</div><div class="ttdef"><b>Definition</b> arm.hpp:99</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a5604ac4418042783a0227e43c573a9ac"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a5604ac4418042783a0227e43c573a9ac">viam::sdk::Arm::get_geometries</a></div><div class="ttdeci">std::vector&lt; GeometryConfig &gt; get_geometries()</div><div class="ttdoc">Returns GeometryConfigs associated with the calling arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:146</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a72ace37c311ae8bf430df9ccf3ad0775"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a72ace37c311ae8bf430df9ccf3ad0775">viam::sdk::Arm::KinematicsData</a></div><div class="ttdeci">boost::variant&lt; KinematicsDataUnspecified, KinematicsDataSVA, KinematicsDataURDF &gt; KinematicsData</div><div class="ttdoc">The kinematics of the component.</div><div class="ttdef"><b>Definition</b> arm.hpp:59</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a9d9497dfc7b23872f5909eaf8c670cbd"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a9d9497dfc7b23872f5909eaf8c670cbd">viam::sdk::Arm::move_through_joint_positions</a></div><div class="ttdeci">void move_through_joint_positions(const std::vector&lt; std::vector&lt; double &gt; &gt; &amp;positions, const MoveOptions &amp;options)</div><div class="ttdoc">Move each joint on the arm through the positions specified in.</div><div class="ttdef"><b>Definition</b> arm.hpp:112</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_ae5acbc1a20c1ad5814e10dde57b34c16"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#ae5acbc1a20c1ad5814e10dde57b34c16">viam::sdk::Arm::get_end_position</a></div><div class="ttdeci">pose get_end_position()</div><div class="ttdoc">Get the current position of the end of the arm.</div><div class="ttdef"><b>Definition</b> arm.hpp:70</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_aee61208d32415894fca591554e394cdb"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#aee61208d32415894fca591554e394cdb">viam::sdk::Arm::move_to_position</a></div><div class="ttdeci">void move_to_position(const pose &amp;pose)</div><div class="ttdoc">Move the end of the arm to.</div><div class="ttdef"><b>Definition</b> arm.hpp:80</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Resource_html_a52ea612e31f5c09785b500bd2610d97d"><div class="ttname"><a href="classviam_1_1sdk_1_1Resource.html#a52ea612e31f5c09785b500bd2610d97d">viam::sdk::Resource::name</a></div><div class="ttdeci">virtual std::string name() const</div><div class="ttdoc">Return the resource's name.</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Stoppable_html_a5248adce66d2ff61cf1c69daaf4cf754"><div class="ttname"><a href="classviam_1_1sdk_1_1Stoppable.html#a5248adce66d2ff61cf1c69daaf4cf754">viam::sdk::Stoppable::stop</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">Stops a resource from running.</div><div class="ttdef"><b>Definition</b> stoppable.hpp:16</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1impl_1_1ArmClient_html"><div class="ttname"><a href="classviam_1_1sdk_1_1impl_1_1ArmClient.html">viam::sdk::impl::ArmClient</a></div><div class="ttdoc">gRPC client implementation of an Arm component.</div><div class="ttdef"><b>Definition</b> arm_client.hpp:19</div></div>
Expand All @@ -160,7 +160,7 @@
<div class="ttc" id="aclassviam_1_1sdk_1_1impl_1_1ArmClient_html_accc7b76c68782dfbe46b8a917495ecbd"><div class="ttname"><a href="classviam_1_1sdk_1_1impl_1_1ArmClient.html#accc7b76c68782dfbe46b8a917495ecbd">viam::sdk::impl::ArmClient::get_geometries</a></div><div class="ttdeci">std::vector&lt; GeometryConfig &gt; get_geometries(const ProtoStruct &amp;extra) override</div><div class="ttdoc">Returns GeometryConfigs associated with the calling arm.</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1impl_1_1ArmClient_html_ade7188c3473c99d2952dfddf5b9dd617"><div class="ttname"><a href="classviam_1_1sdk_1_1impl_1_1ArmClient.html#ade7188c3473c99d2952dfddf5b9dd617">viam::sdk::impl::ArmClient::get_kinematics</a></div><div class="ttdeci">Arm::KinematicsData get_kinematics(const ProtoStruct &amp;extra) override</div><div class="ttdoc">Get the kinematics data associated with the arm.</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1impl_1_1ArmClient_html_af04abb33323a81ee5f5ebe712923347b"><div class="ttname"><a href="classviam_1_1sdk_1_1impl_1_1ArmClient.html#af04abb33323a81ee5f5ebe712923347b">viam::sdk::impl::ArmClient::move_through_joint_positions</a></div><div class="ttdeci">void move_through_joint_positions(const std::vector&lt; std::vector&lt; double &gt; &gt; &amp;positions, const Arm::MoveOptions &amp;options, const ProtoStruct &amp;extra) override</div><div class="ttdoc">Move each joint on the arm through the positions specified in.</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1Arm_1_1MoveOptions_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Arm_1_1MoveOptions.html">viam::sdk::Arm::MoveOptions</a></div><div class="ttdoc">Movement specifications for move_through_join_positions.</div><div class="ttdef"><b>Definition</b> arm.hpp:65</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1Arm_1_1MoveOptions_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Arm_1_1MoveOptions.html">viam::sdk::Arm::MoveOptions</a></div><div class="ttdoc">Movement specifications for move_through_join_positions.</div><div class="ttdef"><b>Definition</b> arm.hpp:63</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1pose_html"><div class="ttname"><a href="structviam_1_1sdk_1_1pose.html">viam::sdk::pose</a></div><div class="ttdef"><b>Definition</b> pose.hpp:18</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
Expand Down
2 changes: 1 addition & 1 deletion arm__server_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span>} <span class="comment">// namespace sdk</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span>} <span class="comment">// namespace viam</span></div>
<div class="ttc" id="aarm_8hpp_html"><div class="ttname"><a href="arm_8hpp.html">arm.hpp</a></div><div class="ttdoc">Defines an Arm component.</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></div><div class="ttdoc">An Arm represents a physical robot arm that exists in three-dimensional space.</div><div class="ttdef"><b>Definition</b> arm.hpp:28</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html">viam::sdk::Arm</a></div><div class="ttdoc">An Arm represents a physical robot arm that exists in three-dimensional space.</div><div class="ttdef"><b>Definition</b> arm.hpp:26</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1ResourceServer_html"><div class="ttname"><a href="classviam_1_1sdk_1_1ResourceServer.html">viam::sdk::ResourceServer</a></div><div class="ttdef"><b>Definition</b> resource_server_base.hpp:8</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1impl_1_1ArmServer_html"><div class="ttname"><a href="classviam_1_1sdk_1_1impl_1_1ArmServer.html">viam::sdk::impl::ArmServer</a></div><div class="ttdoc">gRPC server implementation of an Arm component.</div><div class="ttdef"><b>Definition</b> arm_server.hpp:20</div></div>
<div class="ttc" id="aresource__manager_8hpp_html"><div class="ttname"><a href="resource__manager_8hpp.html">resource_manager.hpp</a></div><div class="ttdoc">Defines a general-purpose resource manager.</div></div>
Expand Down
4 changes: 2 additions & 2 deletions base_2impl_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -151,12 +151,12 @@
<div class="ttc" id="aclassMyBase_html_a8cead5373013579c5c37cc16d2b9c9a0"><div class="ttname"><a href="classMyBase.html#a8cead5373013579c5c37cc16d2b9c9a0">MyBase::move_straight</a></div><div class="ttdeci">void move_straight(int64_t distance_mm, double mm_per_sec, const ProtoStruct &amp;extra) override</div><div class="ttdoc">Move a robot's base in a straight line by a given distance. This method blocks until completed or can...</div><div class="ttdef"><b>Definition</b> impl.hpp:33</div></div>
<div class="ttc" id="aclassMyBase_html_ac4a3f8e49119096dace7ab68de7c98d7"><div class="ttname"><a href="classMyBase.html#ac4a3f8e49119096dace7ab68de7c98d7">MyBase::do_command</a></div><div class="ttdeci">ProtoStruct do_command(const ProtoStruct &amp;command) override</div><div class="ttdoc">Send/receive arbitrary commands to the resource.</div></div>
<div class="ttc" id="aclassMyBase_html_af529f81b9a197327a08d63a19bc59bd8"><div class="ttname"><a href="classMyBase.html#af529f81b9a197327a08d63a19bc59bd8">MyBase::stop</a></div><div class="ttdeci">void stop(const ProtoStruct &amp;extra) override</div><div class="ttdoc">Stops a resource from running.</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Base_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Base.html">viam::sdk::Base</a></div><div class="ttdoc">A Base is the platform that the other parts of a mobile robot attach to.</div><div class="ttdef"><b>Definition</b> base.hpp:27</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Base_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Base.html">viam::sdk::Base</a></div><div class="ttdoc">A Base is the platform that the other parts of a mobile robot attach to.</div><div class="ttdef"><b>Definition</b> base.hpp:25</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Reconfigurable_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Reconfigurable.html">viam::sdk::Reconfigurable</a></div><div class="ttdef"><b>Definition</b> reconfigurable.hpp:9</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1ResourceConfig_html"><div class="ttname"><a href="classviam_1_1sdk_1_1ResourceConfig.html">viam::sdk::ResourceConfig</a></div><div class="ttdef"><b>Definition</b> resource.hpp:23</div></div>
<div class="ttc" id="aclassviam_1_1sdk_1_1Vector3_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Vector3.html">viam::sdk::Vector3</a></div><div class="ttdef"><b>Definition</b> linear_algebra.hpp:15</div></div>
<div class="ttc" id="amotor_8hpp_html"><div class="ttname"><a href="motor_8hpp.html">motor.hpp</a></div><div class="ttdoc">Defines a Motor component.</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1Base_1_1properties_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Base_1_1properties.html">viam::sdk::Base::properties</a></div><div class="ttdoc">Information about the physical base.</div><div class="ttdef"><b>Definition</b> base.hpp:31</div></div>
<div class="ttc" id="astructviam_1_1sdk_1_1Base_1_1properties_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Base_1_1properties.html">viam::sdk::Base::properties</a></div><div class="ttdoc">Information about the physical base.</div><div class="ttdef"><b>Definition</b> base.hpp:29</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
1 change: 0 additions & 1 deletion base_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@
<p>Defines a <code>Base</code> component.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;string&gt;</code><br />
<code>#include &lt;viam/api/component/base/v1/base.pb.h&gt;</code><br />
<code>#include &lt;viam/sdk/common/linear_algebra.hpp&gt;</code><br />
<code>#include &lt;viam/sdk/common/proto_value.hpp&gt;</code><br />
<code>#include &lt;viam/sdk/common/utils.hpp&gt;</code><br />
Expand Down
Loading

0 comments on commit 01d7b34

Please sign in to comment.