deploy: 3a682dc

_modules/viam/components/component_base.html

@@ -128,7 +128,7 @@ <h1>Source code for viam.components.component_base</h1><div class="highlight"><p
 <span class="sd">            Self: The component, if it exists on the robot</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">component</span> <span class="o">=</span> <span class="n">robot</span><span class="o">.</span><span class="n">get_component</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">get_resource_name</span><span class="p">(</span><span class="n">name</span><span class="p">))</span>
-        <span class="k">return</span> <span class="n">cast</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">component</span><span class="p">)</span></div>
+        <span class="k">return</span> <span class="n">cast</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">component</span><span class="p">)</span>  <span class="c1"># type: ignore</span></div>
 
 <div class="viewcode-block" id="ComponentBase.do_command"><a class="viewcode-back" href="../../../autoapi/viam/components/component_base/index.html#viam.components.component_base.ComponentBase.do_command">[docs]</a>    <span class="k">async</span> <span class="k">def</span> <span class="nf">do_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">:</span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">ValueTypes</span><span class="p">],</span> <span class="o">*</span><span class="p">,</span> <span class="n">timeout</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">ValueTypes</span><span class="p">]:</span>
         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

_modules/viam/resource/easy_resource.html

@@ -91,7 +91,7 @@ <h1>Source code for viam.resource.easy_resource</h1><div class="highlight"><pre>
 <span></span><span class="kn">import</span> <span class="nn">inspect</span>
 <span class="kn">import</span> <span class="nn">re</span>
 <span class="kn">from</span> <span class="nn">abc</span> <span class="kn">import</span> <span class="n">ABCMeta</span>
-<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Union</span>
+<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">ClassVar</span><span class="p">,</span> <span class="n">Mapping</span><span class="p">,</span> <span class="n">Union</span>
 
 <span class="kn">from</span> <span class="nn">viam.proto.app.robot</span> <span class="kn">import</span> <span class="n">ComponentConfig</span>
 <span class="kn">from</span> <span class="nn">viam.proto.common</span> <span class="kn">import</span> <span class="n">ResourceName</span>
@@ -182,16 +182,16 @@ <h1>Source code for viam.resource.easy_resource</h1><div class="highlight"><pre>
 <span class="sd">    See examples/easy_resource/main.py for extended usage.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
-    <span class="n">SUBTYPE</span><span class="p">:</span> <span class="n">Subtype</span>
-    <span class="n">MODEL</span><span class="p">:</span> <span class="n">Model</span>
+    <span class="n">SUBTYPE</span><span class="p">:</span> <span class="n">ClassVar</span><span class="p">[</span><span class="n">Subtype</span><span class="p">]</span>
+    <span class="n">MODEL</span><span class="p">:</span> <span class="n">ClassVar</span><span class="p">[</span><span class="n">Model</span><span class="p">]</span>
 
 <div class="viewcode-block" id="EasyResource.__init_subclass__"><a class="viewcode-back" href="../../../autoapi/viam/resource/easy_resource/index.html#viam.resource.easy_resource.EasyResource.__init_subclass__">[docs]</a>    <span class="k">def</span> <span class="nf">__init_subclass__</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">register</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        When you subclass this mixin, it parses cls.MODEL and registers cls in global registry.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">__init_subclass__</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="s2">&quot;MODEL&quot;</span><span class="p">):</span>
-            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;please define a MODEL like &#39;org:type:name&#39; on your class, for example &#39;viam:camera:IMX219&#39;&quot;</span><span class="p">)</span>
+            <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;Please define a MODEL with the format &#39;org:type:name&#39; on your class, for example &#39;viam:camera:IMX219&#39;&quot;</span><span class="p">)</span>
         <span class="bp">cls</span><span class="o">.</span><span class="n">MODEL</span> <span class="o">=</span> <span class="n">_parse_model</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">MODEL</span><span class="p">)</span>
         <span class="k">if</span> <span class="n">register</span><span class="p">:</span>
             <span class="bp">cls</span><span class="o">.</span><span class="n">register</span><span class="p">()</span></div>
@@ -207,7 +207,7 @@ <h1>Source code for viam.resource.easy_resource</h1><div class="highlight"><pre>
 <span class="sd">        when an instance of your model is instantiated. You can override this in your subclass.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="bp">self</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
-        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;created </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">SUBTYPE</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">MODEL</span><span class="p">,</span> <span class="n">config</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;created </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="bp">cls</span><span class="o">.</span><span class="n">SUBTYPE</span><span class="p">,</span> <span class="bp">cls</span><span class="o">.</span><span class="n">MODEL</span><span class="p">,</span> <span class="n">config</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">reconfigure</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">dependencies</span><span class="p">)</span>
         <span class="k">return</span> <span class="bp">self</span></div>
 

_modules/viam/services/service_base.html

@@ -139,7 +139,7 @@ <h1>Source code for viam.services.service_base</h1><div class="highlight"><pre>
 <span class="sd">            Self: The service, if it exists on the robot</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">service</span> <span class="o">=</span> <span class="n">robot</span><span class="o">.</span><span class="n">get_service</span><span class="p">(</span><span class="bp">cls</span><span class="o">.</span><span class="n">get_resource_name</span><span class="p">(</span><span class="n">name</span><span class="p">))</span>
-        <span class="k">return</span> <span class="n">cast</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">service</span><span class="p">)</span></div>
+        <span class="k">return</span> <span class="n">cast</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">service</span><span class="p">)</span>  <span class="c1"># type: ignore</span></div>
 
 <div class="viewcode-block" id="ServiceBase.do_command"><a class="viewcode-back" href="../../../autoapi/viam/services/service_base/index.html#viam.services.service_base.ServiceBase.do_command">[docs]</a>    <span class="k">async</span> <span class="k">def</span> <span class="nf">do_command</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command</span><span class="p">:</span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">ValueTypes</span><span class="p">],</span> <span class="o">*</span><span class="p">,</span> <span class="n">timeout</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">ValueTypes</span><span class="p">]:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Send/receive arbitrary commands.</span>

_sources/autoapi/viam/app/data_client/index.rst.txt

@@ -92,15 +92,9 @@ Module Contents
 
       .. py:method:: __str__() -> str
 
-         Return str(self).
-
-
 
       .. py:method:: __eq__(other: object) -> bool
 
-         Return self==value.
-
-
 
 
    .. py:method:: tabular_data_by_filter(filter: Optional[viam.proto.app.data.Filter] = None, limit: Optional[int] = None, sort_order: Optional[viam.proto.app.data.Order.ValueType] = None, last: Optional[str] = None, count_only: bool = False, include_internal_data: bool = False, dest: Optional[str] = None) -> Tuple[List[TabularData], int, str]

_sources/autoapi/viam/components/arm/arm/index.rst.txt

@@ -40,6 +40,8 @@ Module Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:method:: get_end_position(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs) -> viam.components.arm.Pose
       :abstractmethod:

_sources/autoapi/viam/components/arm/client/index.rst.txt

@@ -25,6 +25,12 @@ Module Contents
    Used to communicate with an existing ``Arm`` implementation over gRPC.
 
 
+   .. py:attribute:: channel
+
+
+   .. py:attribute:: client
+
+
    .. py:method:: get_end_position(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **__) -> viam.components.arm.Pose
       :async:
 

_sources/autoapi/viam/components/arm/index.rst.txt

@@ -136,6 +136,8 @@ Package Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:method:: get_end_position(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs) -> viam.components.arm.Pose
       :abstractmethod:

_sources/autoapi/viam/components/audio_input/audio_input/index.rst.txt

@@ -30,6 +30,8 @@ Module Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:class:: Properties
 

_sources/autoapi/viam/components/audio_input/client/index.rst.txt

@@ -23,6 +23,12 @@ Module Contents
    gRPC client for the AudioInput component.
 
 
+   .. py:attribute:: channel
+
+
+   .. py:attribute:: client
+
+
    .. py:method:: stream(*, timeout: Optional[float] = None, **__) -> viam.streams.Stream[viam.media.audio.Audio]
       :async:
 

_sources/autoapi/viam/components/audio_input/index.rst.txt

@@ -41,6 +41,8 @@ Package Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:class:: Properties
 

_sources/autoapi/viam/components/base/base/index.rst.txt

@@ -36,6 +36,8 @@ Module Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:class:: Properties
 

_sources/autoapi/viam/components/base/client/index.rst.txt

@@ -23,6 +23,12 @@ Module Contents
    gRPC client for the Base component.
 
 
+   .. py:attribute:: channel
+
+
+   .. py:attribute:: client
+
+
    .. py:method:: move_straight(distance: int, velocity: float, *, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **__)
       :async:
 

_sources/autoapi/viam/components/base/index.rst.txt

@@ -72,6 +72,8 @@ Package Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:class:: Properties
 

_sources/autoapi/viam/components/board/board/index.rst.txt

@@ -50,6 +50,8 @@ Module Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:class:: Analog(name: str)
 

_sources/autoapi/viam/components/board/client/index.rst.txt

@@ -36,6 +36,9 @@ Module Contents
    Analog represents an analog pin reader or writer that resides on a Board.
 
 
+   .. py:attribute:: board
+
+
    .. py:method:: read(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **__) -> viam.components.board.board.Board.Analog.Value
       :async:
 
@@ -96,6 +99,9 @@ Module Contents
    For more information, see `digital_interrupts <https://docs.viam.com/components/board/#digital_interrupts>`_.
 
 
+   .. py:attribute:: board
+
+
    .. py:method:: value(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **__) -> int
       :async:
 
@@ -131,6 +137,9 @@ Module Contents
    Abstract representation of an individual GPIO pin on a board.
 
 
+   .. py:attribute:: board
+
+
    .. py:method:: get(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **__) -> bool
       :async:
 
@@ -279,6 +288,12 @@ Module Contents
    gRPC client for the Board component.
 
 
+   .. py:attribute:: channel
+
+
+   .. py:attribute:: client
+
+
    .. py:method:: analog_by_name(name: str) -> viam.components.board.board.Board.Analog
       :async:
 

_sources/autoapi/viam/components/board/index.rst.txt

@@ -48,6 +48,8 @@ Package Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:class:: Analog(name: str)
 

_sources/autoapi/viam/components/camera/camera/index.rst.txt

@@ -36,6 +36,8 @@ Module Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:attribute:: Properties
       :type:  TypeAlias

_sources/autoapi/viam/components/camera/client/index.rst.txt

@@ -23,6 +23,12 @@ Module Contents
    gRPC client for the Camera component
 
 
+   .. py:attribute:: channel
+
+
+   .. py:attribute:: client
+
+
    .. py:method:: get_image(mime_type: str = '', *, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **__) -> viam.media.video.ViamImage
       :async:
 

_sources/autoapi/viam/components/camera/index.rst.txt

@@ -149,6 +149,8 @@ Package Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:attribute:: Properties
       :type:  TypeAlias

_sources/autoapi/viam/components/component_base/index.rst.txt

@@ -37,6 +37,13 @@ Module Contents
    .. py:attribute:: SUBTYPE
       :type:  ClassVar[viam.resource.types.Subtype]
 
+      The Subtype of the Resource
+
+
+   .. py:attribute:: name
+
+      The name of the Resource
+
 
    .. py:method:: from_robot(robot: viam.robot.client.RobotClient, name: str) -> typing_extensions.Self
       :classmethod:

_sources/autoapi/viam/components/encoder/client/index.rst.txt

@@ -23,6 +23,12 @@ Module Contents
    gRPC client for the Encoder component.
 
 
+   .. py:attribute:: channel
+
+
+   .. py:attribute:: client
+
+
    .. py:method:: reset_position(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **__)
       :async:
 

_sources/autoapi/viam/components/encoder/encoder/index.rst.txt

@@ -38,6 +38,8 @@ Module Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:method:: reset_position(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs)
       :abstractmethod:

_sources/autoapi/viam/components/encoder/index.rst.txt

@@ -49,6 +49,8 @@ Package Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:method:: reset_position(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs)
       :abstractmethod:

_sources/autoapi/viam/components/gantry/client/index.rst.txt

@@ -23,6 +23,12 @@ Module Contents
    gRPC client for the Gantry component.
 
 
+   .. py:attribute:: channel
+
+
+   .. py:attribute:: client
+
+
    .. py:method:: get_position(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **__) -> List[float]
       :async:
 

_sources/autoapi/viam/components/gantry/gantry/index.rst.txt

@@ -36,6 +36,8 @@ Module Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:method:: get_position(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs) -> List[float]
       :abstractmethod:

_sources/autoapi/viam/components/gantry/index.rst.txt

@@ -47,6 +47,8 @@ Package Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:method:: get_position(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs) -> List[float]
       :abstractmethod:

_sources/autoapi/viam/components/generic/client/index.rst.txt

@@ -31,6 +31,12 @@ Module Contents
    gRPC client for the Generic component.
 
 
+   .. py:attribute:: channel
+
+
+   .. py:attribute:: client
+
+
    .. py:method:: do_command(command: Mapping[str, Any], *, timeout: Optional[float] = None, **__) -> Mapping[str, Any]
       :async:
 

_sources/autoapi/viam/components/generic/generic/index.rst.txt

@@ -87,6 +87,8 @@ Module Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:method:: from_robot(robot: viam.robot.client.RobotClient, name: str) -> typing_extensions.Self
       :classmethod:

_sources/autoapi/viam/components/generic/index.rst.txt

@@ -98,6 +98,8 @@ Package Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:method:: from_robot(robot: viam.robot.client.RobotClient, name: str) -> typing_extensions.Self
       :classmethod:

_sources/autoapi/viam/components/gripper/client/index.rst.txt

@@ -23,6 +23,12 @@ Module Contents
    gRPC client for the Gripper component
 
 
+   .. py:attribute:: channel
+
+
+   .. py:attribute:: client
+
+
    .. py:method:: open(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **__)
       :async:
 

_sources/autoapi/viam/components/gripper/gripper/index.rst.txt

@@ -36,6 +36,8 @@ Module Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:method:: open(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs)
       :abstractmethod:

_sources/autoapi/viam/components/gripper/index.rst.txt

@@ -47,6 +47,8 @@ Package Contents
    .. py:attribute:: SUBTYPE
       :type:  Final
 
+      The Subtype of the Resource
+
 
    .. py:method:: open(*, extra: Optional[Dict[str, Any]] = None, timeout: Optional[float] = None, **kwargs)
       :abstractmethod: