deploy: 27c0697

arm_8hpp_source.html

@@ -227,7 +227,7 @@
 <div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span> </div>
 <div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span>}  <span class="comment">// namespace sdk</span></div>
 <div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span>}  <span class="comment">// namespace viam</span></div>
-<div class="ttc" id="aclassviam_1_1sdk_1_1API_html"><div class="ttname"><a href="classviam_1_1sdk_1_1API.html">viam::sdk::API</a></div><div class="ttdoc">Extends APIType to additionally define a resource's subtype (e.g., camera).</div><div class="ttdef"><b>Definition</b> resource_api.hpp:33</div></div>
+<div class="ttc" id="aclassviam_1_1sdk_1_1API_html"><div class="ttname"><a href="classviam_1_1sdk_1_1API.html">viam::sdk::API</a></div><div class="ttdoc">Extends APIType to additionally define a resource's subtype (e.g., camera).</div><div class="ttdef"><b>Definition</b> resource_api.hpp:45</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_a03e67125cfd7e762a3ead084aa488b07"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a03e67125cfd7e762a3ead084aa488b07">viam::sdk::Arm::is_moving</a></div><div class="ttdeci">virtual bool is_moving()=0</div><div class="ttdoc">Reports if the arm is in motion.</div></div>
 <div class="ttc" id="aclassviam_1_1sdk_1_1Arm_html_a09c9addd617929098027755f757f3340"><div class="ttname"><a href="classviam_1_1sdk_1_1Arm.html#a09c9addd617929098027755f757f3340">viam::sdk::Arm::move_through_joint_positions</a></div><div class="ttdeci">virtual void move_through_joint_positions(const std::vector&lt; std::vector&lt; double &gt; &gt; &amp;positions, const MoveOptions &amp;options, const ProtoStruct &amp;extra)=0</div><div class="ttdoc">Move each joint on the arm through the positions specified in.</div></div>
@@ -250,7 +250,7 @@
 <div class="ttc" id="aclassviam_1_1sdk_1_1Component_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Component.html">viam::sdk::Component</a></div><div class="ttdef"><b>Definition</b> component.hpp:10</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"><div class="ttname"><a href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></div><div class="ttdef"><b>Definition</b> stoppable.hpp:8</div></div>
-<div class="ttc" id="astructviam_1_1sdk_1_1API_1_1traits_html"><div class="ttname"><a href="structviam_1_1sdk_1_1API_1_1traits.html">viam::sdk::API::traits</a></div><div class="ttdef"><b>Definition</b> resource_api.hpp:50</div></div>
+<div class="ttc" id="astructviam_1_1sdk_1_1API_1_1traits_html"><div class="ttname"><a href="structviam_1_1sdk_1_1API_1_1traits.html">viam::sdk::API::traits</a></div><div class="ttdef"><b>Definition</b> resource_api.hpp:64</div></div>
 <div class="ttc" id="astructviam_1_1sdk_1_1Arm_1_1KinematicsDataSVA_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Arm_1_1KinematicsDataSVA.html">viam::sdk::Arm::KinematicsDataSVA</a></div><div class="ttdef"><b>Definition</b> arm.hpp:50</div></div>
 <div class="ttc" id="astructviam_1_1sdk_1_1Arm_1_1KinematicsDataURDF_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Arm_1_1KinematicsDataURDF.html">viam::sdk::Arm::KinematicsDataURDF</a></div><div class="ttdef"><b>Definition</b> arm.hpp:53</div></div>
 <div class="ttc" id="astructviam_1_1sdk_1_1Arm_1_1KinematicsDataUnspecified_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Arm_1_1KinematicsDataUnspecified.html">viam::sdk::Arm::KinematicsDataUnspecified</a></div><div class="ttdef"><b>Definition</b> arm.hpp:49</div></div>

base_2impl_8hpp_source.html

@@ -153,7 +153,7 @@
 <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: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_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:31</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:29</div></div>
 <div class="ttc" id="astructviam_1_1sdk_1_1Vector3_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Vector3.html">viam::sdk::Vector3</a></div><div class="ttdef"><b>Definition</b> linear_algebra.hpp:25</div></div>

base_8hpp_source.html

@@ -185,7 +185,7 @@
 <div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span> </div>
 <div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>}  <span class="comment">// namespace sdk</span></div>
 <div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>}  <span class="comment">// namespace viam</span></div>
-<div class="ttc" id="aclassviam_1_1sdk_1_1API_html"><div class="ttname"><a href="classviam_1_1sdk_1_1API.html">viam::sdk::API</a></div><div class="ttdoc">Extends APIType to additionally define a resource's subtype (e.g., camera).</div><div class="ttdef"><b>Definition</b> resource_api.hpp:33</div></div>
+<div class="ttc" id="aclassviam_1_1sdk_1_1API_html"><div class="ttname"><a href="classviam_1_1sdk_1_1API.html">viam::sdk::API</a></div><div class="ttdoc">Extends APIType to additionally define a resource's subtype (e.g., camera).</div><div class="ttdef"><b>Definition</b> resource_api.hpp:45</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_1Base_html_a15b197c155289bed1cdfdc09fe1b4bf6"><div class="ttname"><a href="classviam_1_1sdk_1_1Base.html#a15b197c155289bed1cdfdc09fe1b4bf6">viam::sdk::Base::do_command</a></div><div class="ttdeci">virtual ProtoStruct do_command(const ProtoStruct &amp;command)=0</div><div class="ttdoc">Send/receive arbitrary commands to the resource.</div></div>
 <div class="ttc" id="aclassviam_1_1sdk_1_1Base_html_a2a00ecd60f9aa192ce609d3e552ee24c"><div class="ttname"><a href="classviam_1_1sdk_1_1Base.html#a2a00ecd60f9aa192ce609d3e552ee24c">viam::sdk::Base::is_moving</a></div><div class="ttdeci">virtual bool is_moving()=0</div><div class="ttdoc">Reports if the base is in motion.</div></div>
@@ -205,7 +205,7 @@
 <div class="ttc" id="aclassviam_1_1sdk_1_1Component_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Component.html">viam::sdk::Component</a></div><div class="ttdef"><b>Definition</b> component.hpp:10</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"><div class="ttname"><a href="classviam_1_1sdk_1_1Stoppable.html">viam::sdk::Stoppable</a></div><div class="ttdef"><b>Definition</b> stoppable.hpp:8</div></div>
-<div class="ttc" id="astructviam_1_1sdk_1_1API_1_1traits_html"><div class="ttname"><a href="structviam_1_1sdk_1_1API_1_1traits.html">viam::sdk::API::traits</a></div><div class="ttdef"><b>Definition</b> resource_api.hpp:50</div></div>
+<div class="ttc" id="astructviam_1_1sdk_1_1API_1_1traits_html"><div class="ttname"><a href="structviam_1_1sdk_1_1API_1_1traits.html">viam::sdk::API::traits</a></div><div class="ttdef"><b>Definition</b> resource_api.hpp:64</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 class="ttc" id="astructviam_1_1sdk_1_1Vector3_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Vector3.html">viam::sdk::Vector3</a></div><div class="ttdef"><b>Definition</b> linear_algebra.hpp:25</div></div>
 </div><!-- fragment --></div><!-- contents -->

board_8hpp_source.html

@@ -261,7 +261,7 @@
 <div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span> </div>
 <div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span>}  <span class="comment">// namespace sdk</span></div>
 <div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span>}  <span class="comment">// namespace viam</span></div>
-<div class="ttc" id="aclassviam_1_1sdk_1_1API_html"><div class="ttname"><a href="classviam_1_1sdk_1_1API.html">viam::sdk::API</a></div><div class="ttdoc">Extends APIType to additionally define a resource's subtype (e.g., camera).</div><div class="ttdef"><b>Definition</b> resource_api.hpp:33</div></div>
+<div class="ttc" id="aclassviam_1_1sdk_1_1API_html"><div class="ttname"><a href="classviam_1_1sdk_1_1API.html">viam::sdk::API</a></div><div class="ttdoc">Extends APIType to additionally define a resource's subtype (e.g., camera).</div><div class="ttdef"><b>Definition</b> resource_api.hpp:45</div></div>
 <div class="ttc" id="aclassviam_1_1sdk_1_1Board_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Board.html">viam::sdk::Board</a></div><div class="ttdoc">Represents a physical board with gpio pins, digital interrupts, and analog voltage reading.</div><div class="ttdef"><b>Definition</b> board.hpp:24</div></div>
 <div class="ttc" id="aclassviam_1_1sdk_1_1Board_html_a04355aa57bcbde91293905a212cdcf3d"><div class="ttname"><a href="classviam_1_1sdk_1_1Board.html#a04355aa57bcbde91293905a212cdcf3d">viam::sdk::Board::read_digital_interrupt</a></div><div class="ttdeci">virtual digital_value read_digital_interrupt(const std::string &amp;digital_interrupt_name, const ProtoStruct &amp;extra)=0</div><div class="ttdoc">Returns the current value of the interrupt which is based on the type of interrupt....</div></div>
 <div class="ttc" id="aclassviam_1_1sdk_1_1Board_html_a0c188ac594afbf76bbf5a62d44e374f5"><div class="ttname"><a href="classviam_1_1sdk_1_1Board.html#a0c188ac594afbf76bbf5a62d44e374f5">viam::sdk::Board::get_geometries</a></div><div class="ttdeci">virtual std::vector&lt; GeometryConfig &gt; get_geometries(const ProtoStruct &amp;extra)=0</div><div class="ttdoc">Returns GeometryConfigs associated with the calling board.</div></div>
@@ -295,7 +295,7 @@
 <div class="ttc" id="aclassviam_1_1sdk_1_1Component_html"><div class="ttname"><a href="classviam_1_1sdk_1_1Component.html">viam::sdk::Component</a></div><div class="ttdef"><b>Definition</b> component.hpp:10</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="astructtick_html"><div class="ttname"><a href="structtick.html">tick</a></div><div class="ttdoc">A board's digital interrupt.</div></div>
-<div class="ttc" id="astructviam_1_1sdk_1_1API_1_1traits_html"><div class="ttname"><a href="structviam_1_1sdk_1_1API_1_1traits.html">viam::sdk::API::traits</a></div><div class="ttdef"><b>Definition</b> resource_api.hpp:50</div></div>
+<div class="ttc" id="astructviam_1_1sdk_1_1API_1_1traits_html"><div class="ttname"><a href="structviam_1_1sdk_1_1API_1_1traits.html">viam::sdk::API::traits</a></div><div class="ttdef"><b>Definition</b> resource_api.hpp:64</div></div>
 <div class="ttc" id="astructviam_1_1sdk_1_1Board_1_1Tick_html"><div class="ttname"><a href="structviam_1_1sdk_1_1Board_1_1Tick.html">viam::sdk::Board::Tick</a></div><div class="ttdef"><b>Definition</b> board.hpp:59</div></div>
 <div class="ttc" id="astructviam_1_1sdk_1_1Board_1_1Tick_html_a01ab8c12e21ca0022548948dba5735d8"><div class="ttname"><a href="structviam_1_1sdk_1_1Board_1_1Tick.html#a01ab8c12e21ca0022548948dba5735d8">viam::sdk::Board::Tick::time</a></div><div class="ttdeci">std::chrono::nanoseconds time</div><div class="ttdoc">time in nanoseconds the tick occured. This does not represent an absolute time.</div><div class="ttdef"><b>Definition</b> board.hpp:64</div></div>
 <div class="ttc" id="astructviam_1_1sdk_1_1Board_1_1Tick_html_a184710552160686a8e17f997d88f88a1"><div class="ttname"><a href="structviam_1_1sdk_1_1Board_1_1Tick.html#a184710552160686a8e17f997d88f88a1">viam::sdk::Board::Tick::pin_name</a></div><div class="ttdeci">std::string pin_name</div><div class="ttdoc">name of the digital interrupt pin.</div><div class="ttdef"><b>Definition</b> board.hpp:61</div></div>