deploy: eda8b8c

viam_sdk/Gripper-class.html

@@ -191,7 +191,7 @@ <h2>Methods</h2>
 
 </dt>
 <dd>
-  If the <a href="../viam_sdk/Gripper-class.html">Gripper</a> is currently moving
+  Whether the <a href="../viam_sdk/Gripper-class.html">Gripper</a> is currently moving.
 
 
 </dd>
@@ -217,7 +217,7 @@ <h2>Methods</h2>
 
 </dt>
 <dd>
-  Open the <a href="../viam_sdk/Gripper-class.html">Gripper</a>
+  Open the <a href="../viam_sdk/Gripper-class.html">Gripper</a>.
 
 
 </dd>
@@ -230,7 +230,7 @@ <h2>Methods</h2>
 
 </dt>
 <dd>
-  Stop all motion of the <a href="../viam_sdk/Gripper-class.html">Gripper</a>. It is assumed the <a href="../viam_sdk/Gripper-class.html">Gripper</a> stops immediately
+  Stop all motion of the <a href="../viam_sdk/Gripper-class.html">Gripper</a>. It is assumed the <a href="../viam_sdk/Gripper-class.html">Gripper</a> stops immediately.
 
 
 </dd>

viam_sdk/Gripper/isMoving.html

@@ -71,7 +71,7 @@ <h1><span class="kind-method">isMoving</span> abstract method
     </section>
 
 <section class="desc markdown">
-  <p>If the <a href="../../viam_sdk/Gripper-class.html">Gripper</a> is currently moving</p>
+  <p>Whether the <a href="../../viam_sdk/Gripper-class.html">Gripper</a> is currently moving.</p>
 <pre class="language-dart"><code>var isItMoving = await myGripper.isMoving();
 </code></pre>
 </section>

viam_sdk/Gripper/open.html

@@ -72,7 +72,7 @@ <h1><span class="kind-method">open</span> abstract method
     </section>
 
 <section class="desc markdown">
-  <p>Open the <a href="../../viam_sdk/Gripper-class.html">Gripper</a></p>
+  <p>Open the <a href="../../viam_sdk/Gripper-class.html">Gripper</a>.</p>
 <pre class="language-dart"><code>await myGripper.open();
 </code></pre>
 </section>

viam_sdk/Gripper/stop.html

@@ -72,7 +72,7 @@ <h1><span class="kind-method">stop</span> abstract method
     </section>
 
 <section class="desc markdown">
-  <p>Stop all motion of the <a href="../../viam_sdk/Gripper-class.html">Gripper</a>. It is assumed the <a href="../../viam_sdk/Gripper-class.html">Gripper</a> stops immediately</p>
+  <p>Stop all motion of the <a href="../../viam_sdk/Gripper-class.html">Gripper</a>. It is assumed the <a href="../../viam_sdk/Gripper-class.html">Gripper</a> stops immediately.</p>
 <pre class="language-dart"><code>await myGripper.stop();
 </code></pre>
 </section>

viam_sdk/GripperClient-class.html

@@ -217,7 +217,7 @@ <h2>Methods</h2>
 
 </dt>
 <dd>
-  If the <a href="../viam_sdk/Gripper-class.html">Gripper</a> is currently moving
+  Whether the <a href="../viam_sdk/Gripper-class.html">Gripper</a> is currently moving.
   <div class="features"><span class="feature">override</span></div>
 
 </dd>
@@ -243,7 +243,7 @@ <h2>Methods</h2>
 
 </dt>
 <dd>
-  Open the <a href="../viam_sdk/Gripper-class.html">Gripper</a>
+  Open the <a href="../viam_sdk/Gripper-class.html">Gripper</a>.
   <div class="features"><span class="feature">override</span></div>
 
 </dd>
@@ -256,7 +256,7 @@ <h2>Methods</h2>
 
 </dt>
 <dd>
-  Stop all motion of the <a href="../viam_sdk/Gripper-class.html">Gripper</a>. It is assumed the <a href="../viam_sdk/Gripper-class.html">Gripper</a> stops immediately
+  Stop all motion of the <a href="../viam_sdk/Gripper-class.html">Gripper</a>. It is assumed the <a href="../viam_sdk/Gripper-class.html">Gripper</a> stops immediately.
   <div class="features"><span class="feature">override</span></div>
 
 </dd>

viam_sdk/GripperClient/isMoving.html

@@ -76,7 +76,7 @@ <h1><span class="kind-method">isMoving</span> method
     </section>
 
 <section class="desc markdown">
-  <p>If the <a href="../../viam_sdk/Gripper-class.html">Gripper</a> is currently moving</p>
+  <p>Whether the <a href="../../viam_sdk/Gripper-class.html">Gripper</a> is currently moving.</p>
 <pre class="language-dart"><code>var isItMoving = await myGripper.isMoving();
 </code></pre>
 </section>

viam_sdk/GripperClient/open.html

@@ -77,7 +77,7 @@ <h1><span class="kind-method">open</span> method
     </section>
 
 <section class="desc markdown">
-  <p>Open the <a href="../../viam_sdk/Gripper-class.html">Gripper</a></p>
+  <p>Open the <a href="../../viam_sdk/Gripper-class.html">Gripper</a>.</p>
 <pre class="language-dart"><code>await myGripper.open();
 </code></pre>
 </section>

viam_sdk/GripperClient/stop.html

@@ -77,7 +77,7 @@ <h1><span class="kind-method">stop</span> method
     </section>
 
 <section class="desc markdown">
-  <p>Stop all motion of the <a href="../../viam_sdk/Gripper-class.html">Gripper</a>. It is assumed the <a href="../../viam_sdk/Gripper-class.html">Gripper</a> stops immediately</p>
+  <p>Stop all motion of the <a href="../../viam_sdk/Gripper-class.html">Gripper</a>. It is assumed the <a href="../../viam_sdk/Gripper-class.html">Gripper</a> stops immediately.</p>
 <pre class="language-dart"><code>await myGripper.stop();
 </code></pre>
 </section>

viam_sdk/Motor-class.html

@@ -250,7 +250,10 @@ <h2>Methods</h2>
 
 </dt>
 <dd>
-  Returns whether or not the motor is currently running.
+  Returns whether or not the motor is currently powered, and the portion
+of max power (between 0 and 1; 0 indicates that power is off). Stepper
+motors report <code>true</code> if they are being powered while holding a position,
+as well as when they are turning themselves.
 
 
 </dd>
@@ -263,7 +266,7 @@ <h2>Methods</h2>
 
 </dt>
 <dd>
-  Report a dictionary mapping optional properties to
+  Report a dictionary mapping each optional property to
 whether it is supported by this motor.
 
 
@@ -385,7 +388,7 @@ <h2>Static Methods</h2>
 
 </dt>
 <dd>
-  Get the <a href="../viam_sdk/ResourceName-class.html">ResourceName</a> for this <a href="../viam_sdk/Motor-class.html">Motor</a> with the given <code>name</code>
+  Get the <a href="../viam_sdk/ResourceName-class.html">ResourceName</a> for this <a href="../viam_sdk/Motor-class.html">Motor</a> with the given <code>name</code>.
 
 
 </dd>

viam_sdk/Motor/getResourceName.html

@@ -72,7 +72,9 @@ <h1><span class="kind-method">getResourceName</span> static method
     </section>
 
 <section class="desc markdown">
-  <p>Get the <a href="../../viam_sdk/ResourceName-class.html">ResourceName</a> for this <a href="../../viam_sdk/Motor-class.html">Motor</a> with the given <code>name</code></p>
+  <p>Get the <a href="../../viam_sdk/ResourceName-class.html">ResourceName</a> for this <a href="../../viam_sdk/Motor-class.html">Motor</a> with the given <code>name</code>.</p>
+<pre class="language-dart"><code>var name = Motor.getResourceName('myMotor');
+</code></pre>
 </section>
 
 

viam_sdk/Motor/goFor.html

@@ -77,6 +77,9 @@ <h1><span class="kind-method">goFor</span> abstract method
   <p>Spin the <a href="../../viam_sdk/Motor-class.html">Motor</a> the specified number of <code>revolutions</code> at specified <code>rpm</code>.
 When <code>rpm</code> or <code>revolutions</code> is a negative value, the rotation will be in the backward direction.
 Note: if both <code>rpm</code> and <code>revolutions</code> are negative, the motor will spin in the forward direction.</p>
+<pre class="language-dart"><code>// Turn the motor 7.2 revolutions forward at 60 RPM.
+await myMotor.goFor(60, 7.2);
+</code></pre>
 </section>
 
 

viam_sdk/Motor/goTo.html

@@ -78,6 +78,9 @@ <h1><span class="kind-method">goTo</span> abstract method
 at the specified speed, in revolutions per minute.
 Regardless of the directionality of the <code>rpm</code> this function will move
 the <a href="../../viam_sdk/Motor-class.html">Motor</a> towards the specified position.</p>
+<pre class="language-dart"><code>// Turn the motor to 8.3 revolutions from home at 75 RPM.
+await myMotor.goTo(75, 8.3);
+</code></pre>
 </section>
 
 

viam_sdk/Motor/isMoving.html

@@ -73,6 +73,9 @@ <h1><span class="kind-method">isMoving</span> abstract method
 
 <section class="desc markdown">
   <p>Get if the <a href="../../viam_sdk/Motor-class.html">Motor</a> is currently moving.</p>
+<pre class="language-dart"><code>// Check whether the motor is moving.
+var moving = await myMotor.isMoving();
+</code></pre>
 </section>
 
 

viam_sdk/Motor/position.html

@@ -75,6 +75,9 @@ <h1><span class="kind-method">position</span> abstract method
   <p>Report the position of the motor based on its encoder.
 The value returned is the number of revolutions relative to its zero position.
 This method will raise an exception if position reporting is not supported by the motor.</p>
+<pre class="language-dart"><code>// Get the current position of an encoded motor.
+var position = await myMotor.position();
+</code></pre>
 </section>
 
 

viam_sdk/Motor/powerState.html

@@ -72,7 +72,16 @@ <h1><span class="kind-method">powerState</span> abstract method
     </section>
 
 <section class="desc markdown">
-  <p>Returns whether or not the motor is currently running.</p>
+  <p>Returns whether or not the motor is currently powered, and the portion
+of max power (between 0 and 1; 0 indicates that power is off). Stepper
+motors report <code>true</code> if they are being powered while holding a position,
+as well as when they are turning themselves.</p>
+<pre class="language-dart"><code>// Check whether the motor is currently powered and
+// check the percentage of max power to the motor.
+var powerState = await myMotor.powerState();
+var powered = powerState.isOn;
+var pct = powerState.powerPct;
+</code></pre>
 </section>
 
 

viam_sdk/Motor/properties.html

@@ -72,8 +72,11 @@ <h1><span class="kind-method">properties</span> abstract method
     </section>
 
 <section class="desc markdown">
-  <p>Report a dictionary mapping optional properties to
+  <p>Report a dictionary mapping each optional property to
 whether it is supported by this motor.</p>
+<pre class="language-dart"><code>// Return whether the motor supports certain optional features
+var properties = await myMotor.properties();
+</code></pre>
 </section>
 
 

viam_sdk/Motor/resetZeroPosition.html

@@ -74,6 +74,9 @@ <h1><span class="kind-method">resetZeroPosition</span> abstract method
 
 <section class="desc markdown">
   <p>Set the current position (modified by <code>offset</code>) to be the new zero (home) position.</p>
+<pre class="language-dart"><code>// Set the current position as the new home position with no offset.
+await myMotor.resetZeroPosition(0.0);
+</code></pre>
 </section>
 
 

viam_sdk/Motor/setPower.html

@@ -75,6 +75,9 @@ <h1><span class="kind-method">setPower</span> abstract method
 <section class="desc markdown">
   <p>Sets the "percentage" of power the <a href="../../viam_sdk/Motor-class.html">Motor</a> should employ between -1 and 1.
 When <code>powerPct</code> is negative, the rotation will be in the backward direction.</p>
+<pre class="language-dart"><code>// Set the power to  40% forwards.
+await myMotor.setPower(0.4);
+</code></pre>
 </section>
 
 

viam_sdk/Motor/setRPM.html

@@ -75,6 +75,9 @@ <h1><span class="kind-method">setRPM</span> abstract method
 <section class="desc markdown">
   <p>Spin the <a href="../../viam_sdk/Motor-class.html">Motor</a> indefinitely at the specified speed, in revolutions per minute.
 If <code>rpm</code> is positive, the motor will spin forwards, and if <code>rpm</code> is negative, the motor will spin backwards.</p>
+<pre class="language-dart"><code>// Set the motor to turn backwards at 120.5 RPM.
+await myMotor.setRPM(-120.5);
+</code></pre>
 </section>
 
 

viam_sdk/Motor/stop.html

@@ -73,6 +73,9 @@ <h1><span class="kind-method">stop</span> abstract method
 
 <section class="desc markdown">
   <p>Stop the motor immediately, without any gradual step down.</p>
+<pre class="language-dart"><code>// Stop the motor.
+await myMotor.stop();
+</code></pre>
 </section>
 
 

viam_sdk/MotorClient-class.html

@@ -276,7 +276,10 @@ <h2>Methods</h2>
 
 </dt>
 <dd>
-  Returns whether or not the motor is currently running.
+  Returns whether or not the motor is currently powered, and the portion
+of max power (between 0 and 1; 0 indicates that power is off). Stepper
+motors report <code>true</code> if they are being powered while holding a position,
+as well as when they are turning themselves.
   <div class="features"><span class="feature">override</span></div>
 
 </dd>
@@ -289,7 +292,7 @@ <h2>Methods</h2>
 
 </dt>
 <dd>
-  Report a dictionary mapping optional properties to
+  Report a dictionary mapping each optional property to
 whether it is supported by this motor.
   <div class="features"><span class="feature">override</span></div>
 

viam_sdk/MotorClient/goFor.html

@@ -82,6 +82,9 @@ <h1><span class="kind-method">goFor</span> method
   <p>Spin the <a href="../../viam_sdk/Motor-class.html">Motor</a> the specified number of <code>revolutions</code> at specified <code>rpm</code>.
 When <code>rpm</code> or <code>revolutions</code> is a negative value, the rotation will be in the backward direction.
 Note: if both <code>rpm</code> and <code>revolutions</code> are negative, the motor will spin in the forward direction.</p>
+<pre class="language-dart"><code>// Turn the motor 7.2 revolutions forward at 60 RPM.
+await myMotor.goFor(60, 7.2);
+</code></pre>
 </section>
 
 

viam_sdk/MotorClient/goTo.html

@@ -83,6 +83,9 @@ <h1><span class="kind-method">goTo</span> method
 at the specified speed, in revolutions per minute.
 Regardless of the directionality of the <code>rpm</code> this function will move
 the <a href="../../viam_sdk/Motor-class.html">Motor</a> towards the specified position.</p>
+<pre class="language-dart"><code>// Turn the motor to 8.3 revolutions from home at 75 RPM.
+await myMotor.goTo(75, 8.3);
+</code></pre>
 </section>
 
 

viam_sdk/MotorClient/isMoving.html

@@ -78,6 +78,9 @@ <h1><span class="kind-method">isMoving</span> method
 
 <section class="desc markdown">
   <p>Get if the <a href="../../viam_sdk/Motor-class.html">Motor</a> is currently moving.</p>
+<pre class="language-dart"><code>// Check whether the motor is moving.
+var moving = await myMotor.isMoving();
+</code></pre>
 </section>
 
 

viam_sdk/MotorClient/position.html

@@ -80,6 +80,9 @@ <h1><span class="kind-method">position</span> method
   <p>Report the position of the motor based on its encoder.
 The value returned is the number of revolutions relative to its zero position.
 This method will raise an exception if position reporting is not supported by the motor.</p>
+<pre class="language-dart"><code>// Get the current position of an encoded motor.
+var position = await myMotor.position();
+</code></pre>
 </section>
 
 

viam_sdk/MotorClient/powerState.html

@@ -77,7 +77,16 @@ <h1><span class="kind-method">powerState</span> method
     </section>
 
 <section class="desc markdown">
-  <p>Returns whether or not the motor is currently running.</p>
+  <p>Returns whether or not the motor is currently powered, and the portion
+of max power (between 0 and 1; 0 indicates that power is off). Stepper
+motors report <code>true</code> if they are being powered while holding a position,
+as well as when they are turning themselves.</p>
+<pre class="language-dart"><code>// Check whether the motor is currently powered and
+// check the percentage of max power to the motor.
+var powerState = await myMotor.powerState();
+var powered = powerState.isOn;
+var pct = powerState.powerPct;
+</code></pre>
 </section>
 
 

viam_sdk/MotorClient/properties.html

@@ -77,8 +77,11 @@ <h1><span class="kind-method">properties</span> method
     </section>
 
 <section class="desc markdown">
-  <p>Report a dictionary mapping optional properties to
+  <p>Report a dictionary mapping each optional property to
 whether it is supported by this motor.</p>
+<pre class="language-dart"><code>// Return whether the motor supports certain optional features
+var properties = await myMotor.properties();
+</code></pre>
 </section>
 
 

viam_sdk/MotorClient/resetZeroPosition.html

@@ -79,6 +79,9 @@ <h1><span class="kind-method">resetZeroPosition</span> method
 
 <section class="desc markdown">
   <p>Set the current position (modified by <code>offset</code>) to be the new zero (home) position.</p>
+<pre class="language-dart"><code>// Set the current position as the new home position with no offset.
+await myMotor.resetZeroPosition(0.0);
+</code></pre>
 </section>
 
 

viam_sdk/MotorClient/setPower.html

@@ -80,6 +80,9 @@ <h1><span class="kind-method">setPower</span> method
 <section class="desc markdown">
   <p>Sets the "percentage" of power the <a href="../../viam_sdk/Motor-class.html">Motor</a> should employ between -1 and 1.
 When <code>powerPct</code> is negative, the rotation will be in the backward direction.</p>
+<pre class="language-dart"><code>// Set the power to  40% forwards.
+await myMotor.setPower(0.4);
+</code></pre>
 </section>
 
 

viam_sdk/MotorClient/setRPM.html

@@ -80,6 +80,9 @@ <h1><span class="kind-method">setRPM</span> method
 <section class="desc markdown">
   <p>Spin the <a href="../../viam_sdk/Motor-class.html">Motor</a> indefinitely at the specified speed, in revolutions per minute.
 If <code>rpm</code> is positive, the motor will spin forwards, and if <code>rpm</code> is negative, the motor will spin backwards.</p>
+<pre class="language-dart"><code>// Set the motor to turn backwards at 120.5 RPM.
+await myMotor.setRPM(-120.5);
+</code></pre>
 </section>
 
 

viam_sdk/MotorClient/stop.html

@@ -78,6 +78,9 @@ <h1><span class="kind-method">stop</span> method
 
 <section class="desc markdown">
   <p>Stop the motor immediately, without any gradual step down.</p>
+<pre class="language-dart"><code>// Stop the motor.
+await myMotor.stop();
+</code></pre>
 </section>