deploy: e38cce8

viam_sdk/Arm-class.html

@@ -64,6 +64,7 @@ <h1><span class="kind-class">Arm</span> class
 
 <section class="desc markdown">
   <p>Arm represents a physical robot arm that exists in three-dimensional space.</p>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/Arm/endPosition.html

@@ -73,9 +73,9 @@ <h1><span class="kind-method">endPosition</span> abstract method
 
 <section class="desc markdown">
   <p>Get the current <code>Pose</code> of the end of the arm.</p>
-<pre class="language-dart"><code>// Get the pose of an arm named "myArm"
-final currentPose = await myArm.endPosition();
+<pre class="language-dart"><code>final currentPose = await myArm.endPosition();
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/Arm/fromRobot.html

@@ -74,6 +74,7 @@ <h1><span class="kind-method">fromRobot</span> static method
 
 <section class="desc markdown">
   <p>Get the <a href="../../viam_sdk/Arm-class.html">Arm</a> named <code>name</code> from the provided robot.</p>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/Arm/getResourceName.html

@@ -73,6 +73,7 @@ <h1><span class="kind-method">getResourceName</span> static method
 
 <section class="desc markdown">
   <p>Get the <a href="../../viam_sdk/ResourceName-class.html">ResourceName</a> for this <a href="../../viam_sdk/Arm-class.html">Arm</a> with the given <code>name</code>.</p>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/Arm/isMoving.html

@@ -74,6 +74,7 @@ <h1><span class="kind-method">isMoving</span> abstract method
   <p>Whether the arm is currently moving</p>
 <pre class="language-dart"><code>bool isArmMoving = await myArm.isMoving();
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/Arm/jointPositions.html

@@ -75,6 +75,7 @@ <h1><span class="kind-method">jointPositions</span> abstract method
   <p>Get the <code>List</code> of current joint angles of each arm joint</p>
 <pre class="language-dart"><code>List&lt;double&gt; currentJointPositions = await myArm.moveToJointPosition();
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/Arm/moveToJointPositions.html

@@ -80,6 +80,7 @@ <h1><span class="kind-method">moveToJointPositions</span> abstract method
 // Move the arm joints to those angles
 await myArm.moveToJointPositions(targetPositions);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/Arm/moveToPosition.html

@@ -80,6 +80,7 @@ <h1><span class="kind-method">moveToPosition</span> abstract method
 // Move the arm to the pose
 await myArm.moveToPosition(targetPose);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/Arm/stop.html

@@ -75,6 +75,7 @@ <h1><span class="kind-method">stop</span> abstract method
   <p>Stop all motion of the arm. It is assumed that the arm stops immediately.</p>
 <pre class="language-dart"><code>await myArm.stop();
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/ArmClient/endPosition.html

@@ -78,9 +78,9 @@ <h1><span class="kind-method">endPosition</span> method
 
 <section class="desc markdown">
   <p>Get the current <code>Pose</code> of the end of the arm.</p>
-<pre class="language-dart"><code>// Get the pose of an arm named "myArm"
-final currentPose = await myArm.endPosition();
+<pre class="language-dart"><code>final currentPose = await myArm.endPosition();
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/ArmClient/isMoving.html

@@ -79,6 +79,7 @@ <h1><span class="kind-method">isMoving</span> method
   <p>Whether the arm is currently moving</p>
 <pre class="language-dart"><code>bool isArmMoving = await myArm.isMoving();
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/ArmClient/jointPositions.html

@@ -80,6 +80,7 @@ <h1><span class="kind-method">jointPositions</span> method
   <p>Get the <code>List</code> of current joint angles of each arm joint</p>
 <pre class="language-dart"><code>List&lt;double&gt; currentJointPositions = await myArm.moveToJointPosition();
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/ArmClient/moveToJointPositions.html

@@ -85,6 +85,7 @@ <h1><span class="kind-method">moveToJointPositions</span> method
 // Move the arm joints to those angles
 await myArm.moveToJointPositions(targetPositions);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/ArmClient/moveToPosition.html

@@ -85,6 +85,7 @@ <h1><span class="kind-method">moveToPosition</span> method
 // Move the arm to the pose
 await myArm.moveToPosition(targetPose);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/ArmClient/stop.html

@@ -80,6 +80,7 @@ <h1><span class="kind-method">stop</span> method
   <p>Stop all motion of the arm. It is assumed that the arm stops immediately.</p>
 <pre class="language-dart"><code>await myArm.stop();
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/arm/">Arm component</a>.</p>
 </section>
 
 

viam_sdk/Base-class.html

@@ -64,6 +64,7 @@ <h1><span class="kind-class">Base</span> class
 
 <section class="desc markdown">
   <p>Base represents a physical base of a robot.</p>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/Base/fromRobot.html

@@ -74,6 +74,7 @@ <h1><span class="kind-method">fromRobot</span> static method
 
 <section class="desc markdown">
   <p>Get the <a href="../../viam_sdk/Base-class.html">Base</a> named <code>name</code> from the provided robot.</p>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/Base/getResourceName.html

@@ -73,6 +73,7 @@ <h1><span class="kind-method">getResourceName</span> static method
 
 <section class="desc markdown">
   <p>Get the <a href="../../viam_sdk/ResourceName-class.html">ResourceName</a> for this <a href="../../viam_sdk/Base-class.html">Base</a> with the given <code>name</code></p>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/Base/isMoving.html

@@ -74,6 +74,7 @@ <h1><span class="kind-method">isMoving</span> abstract method
   <p>Whether the base is currently moving</p>
 <pre class="language-dart"><code>bool baseIsMoving = await myBase.isMoving();
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/Base/moveStraight.html

@@ -81,6 +81,7 @@ <h1><span class="kind-method">moveStraight</span> abstract method
 <pre class="language-dart"><code>// Move the base 40mm forward at 90 mm/s
 await myBase.moveStraight(40, 90);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/Base/properties.html

@@ -74,6 +74,7 @@ <h1><span class="kind-method">properties</span> abstract method
 <section class="desc markdown">
   <p>Report a dictionary mapping optional properties to
 whether it is supported by this base.</p>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/Base/setPower.html

@@ -93,6 +93,7 @@ <h1><span class="kind-method">setPower</span> abstract method
 // Turn the base to the right at 60% power:
 await myBase.setPower(Vector3(), Vector3(0, 0, -0.6));
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/Base/setVelocity.html

@@ -81,6 +81,7 @@ <h1><span class="kind-method">setVelocity</span> abstract method
 //
 await myBase.setVelocity(Vector3(0, 50, 0), Vector3(0, 0, 15));
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/Base/spin.html

@@ -80,6 +80,7 @@ <h1><span class="kind-method">spin</span> abstract method
 <pre class="language-dart"><code>// Spin the base 10 degrees at 15 deg/s
 await myBase.spin(10, 15);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/Base/stop.html

@@ -75,6 +75,7 @@ <h1><span class="kind-method">stop</span> abstract method
   <p>Stop the base.</p>
 <pre class="language-dart"><code>await myBase.stop();
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/BaseClient/isMoving.html

@@ -79,6 +79,7 @@ <h1><span class="kind-method">isMoving</span> method
   <p>Whether the base is currently moving</p>
 <pre class="language-dart"><code>bool baseIsMoving = await myBase.isMoving();
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/BaseClient/moveStraight.html

@@ -86,6 +86,7 @@ <h1><span class="kind-method">moveStraight</span> method
 <pre class="language-dart"><code>// Move the base 40mm forward at 90 mm/s
 await myBase.moveStraight(40, 90);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/BaseClient/properties.html

@@ -79,6 +79,7 @@ <h1><span class="kind-method">properties</span> method
 <section class="desc markdown">
   <p>Report a dictionary mapping optional properties to
 whether it is supported by this base.</p>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/BaseClient/setPower.html

@@ -98,6 +98,7 @@ <h1><span class="kind-method">setPower</span> method
 // Turn the base to the right at 60% power:
 await myBase.setPower(Vector3(), Vector3(0, 0, -0.6));
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/BaseClient/setVelocity.html

@@ -86,6 +86,7 @@ <h1><span class="kind-method">setVelocity</span> method
 //
 await myBase.setVelocity(Vector3(0, 50, 0), Vector3(0, 0, 15));
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/BaseClient/spin.html

@@ -85,6 +85,7 @@ <h1><span class="kind-method">spin</span> method
 <pre class="language-dart"><code>// Spin the base 10 degrees at 15 deg/s
 await myBase.spin(10, 15);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/BaseClient/stop.html

@@ -80,6 +80,7 @@ <h1><span class="kind-method">stop</span> method
   <p>Stop the base.</p>
 <pre class="language-dart"><code>await myBase.stop();
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/base/">Base component</a>.</p>
 </section>
 
 

viam_sdk/Board-class.html

@@ -65,6 +65,7 @@ <h1><span class="kind-class">Board</span> class
 <section class="desc markdown">
   <p>Board represents a physical general purpose compute board that contains various
 components such as analog readers, and digital interrupts.</p>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/addCallbacks.html

@@ -80,6 +80,7 @@ <h1><span class="kind-method">addCallbacks</span> abstract method
 final tickQueue = Queue&lt;Tick&gt;();
 await myBoard.addCallbacks(interrupts, tickQueue);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/analogReaderValue.html

@@ -77,6 +77,7 @@ <h1><span class="kind-method">analogReaderValue</span> abstract method
 <pre class="language-dart"><code>// Get the current value of an analog reader named "my_example_analog"
 var analogVal = await myBoard.analogReaderValue('my_example_analog');
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/digitalInterruptValue.html

@@ -77,6 +77,7 @@ <h1><span class="kind-method">digitalInterruptValue</span> abstract method
 <pre class="language-dart"><code>// Get the current value of a digital interrupt named "my_example_digital_interrupt"
 var interruptVal = await myBoard.digitalInterruptValue('my_example_digital_interrupt');
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/fromRobot.html

@@ -74,6 +74,7 @@ <h1><span class="kind-method">fromRobot</span> static method
 
 <section class="desc markdown">
   <p>Get the <a href="../../viam_sdk/Board-class.html">Board</a> named <code>name</code> from the provided robot.</p>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/getResourceName.html

@@ -73,6 +73,7 @@ <h1><span class="kind-method">getResourceName</span> static method
 
 <section class="desc markdown">
   <p>Get the <a href="../../viam_sdk/ResourceName-class.html">ResourceName</a> for this <a href="../../viam_sdk/Board-class.html">Board</a> with the given <code>name</code></p>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/gpio.html

@@ -77,6 +77,7 @@ <h1><span class="kind-method">gpio</span> abstract method
 <pre class="language-dart"><code>// Whether the state of pin 15 is currently high
 bool pinStateIsHigh = await myBoard.gpio('15');
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/pwm.html

@@ -77,6 +77,7 @@ <h1><span class="kind-method">pwm</span> abstract method
 <pre class="language-dart"><code>// Get the PWM duty cycle of pin 15
 var dutyCycle = await myBoard.pwm('15');
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/pwmFrequency.html

@@ -77,6 +77,7 @@ <h1><span class="kind-method">pwmFrequency</span> abstract method
 <pre class="language-dart"><code>// Get the PWM frequency of pin 11
 var frequency = await myBoard.pwmFrequency('11');
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/setGpioState.html

@@ -78,6 +78,7 @@ <h1><span class="kind-method">setGpioState</span> abstract method
 <pre class="language-dart"><code>// Set pin 15 to high
 await myBoard.setGpioState('15', true);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/setPowerMode.html

@@ -81,6 +81,7 @@ <h1><span class="kind-method">setPowerMode</span> abstract method
 const powerMode = PowerMode.POWER_MODE_OFFLINE_DEEP;
 await myBoard.setPowerMode(powerMode, 60, 0);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/setPwm.html

@@ -78,6 +78,7 @@ <h1><span class="kind-method">setPwm</span> abstract method
 <pre class="language-dart"><code>// Set the PWM duty cycle of pin 13
 await myBoard.setPwm('13', 0.6);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/setPwmFrequency.html

@@ -78,6 +78,7 @@ <h1><span class="kind-method">setPwmFrequency</span> abstract method
 <pre class="language-dart"><code>// Set the PWM frequency of pin 15 to 1600 Hz
 await myBoard.setPwmFrequency('15', 1600);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/streamTicks.html

@@ -78,6 +78,7 @@ <h1><span class="kind-method">streamTicks</span> abstract method
 var interrupts = ['8', '11'];
 Stream&lt;Tick&gt; tickStream = await myBoard.streamTicks(interrupts);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/Board/writeAnalog.html

@@ -78,6 +78,7 @@ <h1><span class="kind-method">writeAnalog</span> abstract method
 <pre class="language-dart"><code>// Set pin 11 to value 48
 await myBoard.writeAnalog('11', 48);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/BoardClient/addCallbacks.html

@@ -85,6 +85,7 @@ <h1><span class="kind-method">addCallbacks</span> method
 final tickQueue = Queue&lt;Tick&gt;();
 await myBoard.addCallbacks(interrupts, tickQueue);
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>
 
 

viam_sdk/BoardClient/analogReaderValue.html

@@ -82,6 +82,7 @@ <h1><span class="kind-method">analogReaderValue</span> method
 <pre class="language-dart"><code>// Get the current value of an analog reader named "my_example_analog"
 var analogVal = await myBoard.analogReaderValue('my_example_analog');
 </code></pre>
+<p>For more information, see <a href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </section>