deploy: 27e8730

viamrobotics · Dec 31, 2024 · 04e7fa0 · 04e7fa0
1 parent fef043e
commit 04e7fa0
Show file tree

Hide file tree

Showing 12 changed files with 5 additions and 345 deletions.
diff --git a/_modules/viam/components/board/board.html b/_modules/viam/components/board/board.html
@@ -449,44 +449,6 @@ <h1>Source code for viam.components.board.board</h1><div class="highlight"><pre>
 <span class="sd">        Returns:</span>
 <span class="sd">            GPIOPin: The pin.</span>
 
-<span class="sd">        For more information, see `Board component &lt;https://docs.viam.com/components/board/&gt;`_.</span>
-<span class="sd">        &quot;&quot;&quot;</span>
-        <span class="o">...</span></div>
-
-<div class="viewcode-block" id="Board.analog_names"><a class="viewcode-back" href="../../../../autoapi/viam/components/board/index.html#viam.components.board.board.Board.analog_names">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
-    <span class="k">async</span> <span class="k">def</span> <span class="nf">analog_names</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">        Get the names of all known analog readers and/or writers.</span>
-
-<span class="sd">        ::</span>
-
-<span class="sd">            my_board = Board.from_robot(robot=machine, name=&quot;my_board&quot;)</span>
-
-<span class="sd">            # Get the name of every Analog configured on the board.</span>
-<span class="sd">            names = await my_board.analog_names()</span>
-
-<span class="sd">        Returns:</span>
-<span class="sd">            List[str]: The list of names of all known analog readers/writers.</span>
-
-<span class="sd">        For more information, see `Board component &lt;https://docs.viam.com/components/board/&gt;`_.</span>
-<span class="sd">        &quot;&quot;&quot;</span>
-        <span class="o">...</span></div>
-
-<div class="viewcode-block" id="Board.digital_interrupt_names"><a class="viewcode-back" href="../../../../autoapi/viam/components/board/index.html#viam.components.board.board.Board.digital_interrupt_names">[docs]</a>    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
-    <span class="k">async</span> <span class="k">def</span> <span class="nf">digital_interrupt_names</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">        Get the names of all known digital interrupts.</span>
-
-<span class="sd">        ::</span>
-
-<span class="sd">            my_board = Board.from_robot(robot=machine, name=&quot;my_board&quot;)</span>
-
-<span class="sd">            # Get the name of every DigitalInterrupt configured on the board.</span>
-<span class="sd">            names = await my_board.digital_interrupt_names()</span>
-
-<span class="sd">        Returns:</span>
-<span class="sd">            List[str]: The names of the digital interrupts.</span>
-
 <span class="sd">        For more information, see `Board component &lt;https://docs.viam.com/components/board/&gt;`_.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="o">...</span></div>

diff --git a/_modules/viam/components/board/client.html b/_modules/viam/components/board/client.html
@@ -273,16 +273,6 @@ <h1>Source code for viam.components.board.client</h1><div class="highlight"><pre
 <div class="viewcode-block" id="BoardClient.gpio_pin_by_name"><a class="viewcode-back" href="../../../../autoapi/viam/components/board/client/index.html#viam.components.board.client.BoardClient.gpio_pin_by_name">[docs]</a>    <span class="k">async</span> <span class="k">def</span> <span class="nf">gpio_pin_by_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Board</span><span class="o">.</span><span class="n">GPIOPin</span><span class="p">:</span>
         <span class="k">return</span> <span class="n">GPIOPinClient</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span></div>
 
-<div class="viewcode-block" id="BoardClient.analog_names"><a class="viewcode-back" href="../../../../autoapi/viam/components/board/client/index.html#viam.components.board.client.BoardClient.analog_names">[docs]</a>    <span class="k">async</span> <span class="k">def</span> <span class="nf">analog_names</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
-        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_analog_names</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
-            <span class="k">return</span> <span class="p">[]</span>
-        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_analog_names</span></div>
-
-<div class="viewcode-block" id="BoardClient.digital_interrupt_names"><a class="viewcode-back" href="../../../../autoapi/viam/components/board/client/index.html#viam.components.board.client.BoardClient.digital_interrupt_names">[docs]</a>    <span class="k">async</span> <span class="k">def</span> <span class="nf">digital_interrupt_names</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
-        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_digital_interrupt_names</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
-            <span class="k">return</span> <span class="p">[]</span>
-        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_digital_interrupt_names</span></div>
-
 <div class="viewcode-block" id="BoardClient.do_command"><a class="viewcode-back" href="../../../../autoapi/viam/components/board/client/index.html#viam.components.board.client.BoardClient.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>

diff --git a/_sources/autoapi/viam/components/board/board/index.rst.txt b/_sources/autoapi/viam/components/board/board/index.rst.txt
@@ -414,50 +414,6 @@ Module Contents
 
 
 
-   .. py:method:: analog_names() -> List[str]
-      :abstractmethod:
-
-      :async:
-
-
-      Get the names of all known analog readers and/or writers.
-
-      ::
-
-          my_board = Board.from_robot(robot=machine, name="my_board")
-
-          # Get the name of every Analog configured on the board.
-          names = await my_board.analog_names()
-
-      :returns: The list of names of all known analog readers/writers.
-      :rtype: List[str]
-
-      For more information, see `Board component <https://docs.viam.com/components/board/>`_.
-
-
-
-   .. py:method:: digital_interrupt_names() -> List[str]
-      :abstractmethod:
-
-      :async:
-
-
-      Get the names of all known digital interrupts.
-
-      ::
-
-          my_board = Board.from_robot(robot=machine, name="my_board")
-
-          # Get the name of every DigitalInterrupt configured on the board.
-          names = await my_board.digital_interrupt_names()
-
-      :returns: The names of the digital interrupts.
-      :rtype: List[str]
-
-      For more information, see `Board component <https://docs.viam.com/components/board/>`_.
-
-
-
    .. py:method:: set_power_mode(mode: viam.proto.component.board.PowerMode.ValueType, duration: Optional[datetime.timedelta] = None, *, timeout: Optional[float] = None, **kwargs)
       :abstractmethod:
 

diff --git a/_sources/autoapi/viam/components/board/client/index.rst.txt b/_sources/autoapi/viam/components/board/client/index.rst.txt
@@ -354,46 +354,6 @@ Module Contents
 
 
 
-   .. py:method:: analog_names() -> List[str]
-      :async:
-
-
-      Get the names of all known analog readers and/or writers.
-
-      ::
-
-          my_board = Board.from_robot(robot=machine, name="my_board")
-
-          # Get the name of every Analog configured on the board.
-          names = await my_board.analog_names()
-
-      :returns: The list of names of all known analog readers/writers.
-      :rtype: List[str]
-
-      For more information, see `Board component <https://docs.viam.com/components/board/>`_.
-
-
-
-   .. py:method:: digital_interrupt_names() -> List[str]
-      :async:
-
-
-      Get the names of all known digital interrupts.
-
-      ::
-
-          my_board = Board.from_robot(robot=machine, name="my_board")
-
-          # Get the name of every DigitalInterrupt configured on the board.
-          names = await my_board.digital_interrupt_names()
-
-      :returns: The names of the digital interrupts.
-      :rtype: List[str]
-
-      For more information, see `Board component <https://docs.viam.com/components/board/>`_.
-
-
-
    .. py:method:: do_command(command: Mapping[str, viam.utils.ValueTypes], *, timeout: Optional[float] = None, **kwargs) -> Mapping[str, viam.utils.ValueTypes]
       :async:
 

diff --git a/_sources/autoapi/viam/components/board/index.rst.txt b/_sources/autoapi/viam/components/board/index.rst.txt
@@ -421,50 +421,6 @@ Package Contents
 
 
 
-   .. py:method:: analog_names() -> List[str]
-      :abstractmethod:
-
-      :async:
-
-
-      Get the names of all known analog readers and/or writers.
-
-      ::
-
-          my_board = Board.from_robot(robot=machine, name="my_board")
-
-          # Get the name of every Analog configured on the board.
-          names = await my_board.analog_names()
-
-      :returns: The list of names of all known analog readers/writers.
-      :rtype: List[str]
-
-      For more information, see `Board component <https://docs.viam.com/components/board/>`_.
-
-
-
-   .. py:method:: digital_interrupt_names() -> List[str]
-      :abstractmethod:
-
-      :async:
-
-
-      Get the names of all known digital interrupts.
-
-      ::
-
-          my_board = Board.from_robot(robot=machine, name="my_board")
-
-          # Get the name of every DigitalInterrupt configured on the board.
-          names = await my_board.digital_interrupt_names()
-
-      :returns: The names of the digital interrupts.
-      :rtype: List[str]
-
-      For more information, see `Board component <https://docs.viam.com/components/board/>`_.
-
-
-
    .. py:method:: set_power_mode(mode: viam.proto.component.board.PowerMode.ValueType, duration: Optional[datetime.timedelta] = None, *, timeout: Optional[float] = None, **kwargs)
       :abstractmethod:
 

diff --git a/autoapi/viam/components/board/board/index.html b/autoapi/viam/components/board/board/index.html
@@ -94,8 +94,6 @@
 <li class="toctree-l8"><a class="reference internal" href="#viam.components.board.board.Board.analog_by_name"><code class="docutils literal notranslate"><span class="pre">Board.analog_by_name()</span></code></a></li>
 <li class="toctree-l8"><a class="reference internal" href="#viam.components.board.board.Board.digital_interrupt_by_name"><code class="docutils literal notranslate"><span class="pre">Board.digital_interrupt_by_name()</span></code></a></li>
 <li class="toctree-l8"><a class="reference internal" href="#viam.components.board.board.Board.gpio_pin_by_name"><code class="docutils literal notranslate"><span class="pre">Board.gpio_pin_by_name()</span></code></a></li>
-<li class="toctree-l8"><a class="reference internal" href="#viam.components.board.board.Board.analog_names"><code class="docutils literal notranslate"><span class="pre">Board.analog_names()</span></code></a></li>
-<li class="toctree-l8"><a class="reference internal" href="#viam.components.board.board.Board.digital_interrupt_names"><code class="docutils literal notranslate"><span class="pre">Board.digital_interrupt_names()</span></code></a></li>
 <li class="toctree-l8"><a class="reference internal" href="#viam.components.board.board.Board.set_power_mode"><code class="docutils literal notranslate"><span class="pre">Board.set_power_mode()</span></code></a></li>
 <li class="toctree-l8"><a class="reference internal" href="#viam.components.board.board.Board.stream_ticks"><code class="docutils literal notranslate"><span class="pre">Board.stream_ticks()</span></code></a></li>
 <li class="toctree-l8"><a class="reference internal" href="#viam.components.board.board.Board.from_robot"><code class="docutils literal notranslate"><span class="pre">Board.from_robot()</span></code></a></li>
@@ -609,56 +607,6 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalin
 <p>For more information, see <a class="reference external" href="https://docs.viam.com/components/board/">Board component</a>.</p>
 </dd></dl>
 
-<dl class="py method">
-<dt class="sig sig-object py" id="viam.components.board.board.Board.analog_names">
-<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">analog_names</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../../../_modules/viam/components/board/board.html#Board.analog_names"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#viam.components.board.board.Board.analog_names" title="Permalink to this definition"></a></dt>
-<dd><dl class="field-list simple">
-<dt class="field-odd">Async<span class="colon">:</span></dt>
-<dd class="field-odd"><p></p></dd>
-</dl>
-<p>Get the names of all known analog readers and/or writers.</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">my_board</span> <span class="o">=</span> <span class="n">Board</span><span class="o">.</span><span class="n">from_robot</span><span class="p">(</span><span class="n">robot</span><span class="o">=</span><span class="n">machine</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;my_board&quot;</span><span class="p">)</span>
-
-<span class="c1"># Get the name of every Analog configured on the board.</span>
-<span class="n">names</span> <span class="o">=</span> <span class="k">await</span> <span class="n">my_board</span><span class="o">.</span><span class="n">analog_names</span><span class="p">()</span>
-</pre></div>
-</div>
-<dl class="field-list simple">
-<dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>The list of names of all known analog readers/writers.</p>
-</dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>List[str]</p>
-</dd>
-</dl>
-<p>For more information, see <a class="reference external" href="https://docs.viam.com/components/board/">Board component</a>.</p>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="viam.components.board.board.Board.digital_interrupt_names">
-<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">digital_interrupt_names</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="../../../../../_modules/viam/components/board/board.html#Board.digital_interrupt_names"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#viam.components.board.board.Board.digital_interrupt_names" title="Permalink to this definition"></a></dt>
-<dd><dl class="field-list simple">
-<dt class="field-odd">Async<span class="colon">:</span></dt>
-<dd class="field-odd"><p></p></dd>
-</dl>
-<p>Get the names of all known digital interrupts.</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">my_board</span> <span class="o">=</span> <span class="n">Board</span><span class="o">.</span><span class="n">from_robot</span><span class="p">(</span><span class="n">robot</span><span class="o">=</span><span class="n">machine</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;my_board&quot;</span><span class="p">)</span>
-
-<span class="c1"># Get the name of every DigitalInterrupt configured on the board.</span>
-<span class="n">names</span> <span class="o">=</span> <span class="k">await</span> <span class="n">my_board</span><span class="o">.</span><span class="n">digital_interrupt_names</span><span class="p">()</span>
-</pre></div>
-</div>
-<dl class="field-list simple">
-<dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>The names of the digital interrupts.</p>
-</dd>
-<dt class="field-even">Return type<span class="colon">:</span></dt>
-<dd class="field-even"><p>List[str]</p>
-</dd>
-</dl>
-<p>For more information, see <a class="reference external" href="https://docs.viam.com/components/board/">Board component</a>.</p>
-</dd></dl>
-
 <dl class="py method">
 <dt class="sig sig-object py" id="viam.components.board.board.Board.set_power_mode">
 <em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">set_power_mode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">viam.proto.component.board.PowerMode.ValueType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">duration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime.timedelta</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/viam/components/board/board.html#Board.set_power_mode"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#viam.components.board.board.Board.set_power_mode" title="Permalink to this definition"></a></dt>