Updating docs to 444af15da30a411b40912d2f08accef6cffab498

uf-mil · Mar 6, 2024 · 77e017c · 77e017c
1 parent 0bf67fd
commit 77e017c
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 10 deletions.
diff --git a/docs/_modules/sub_actuator_board/packets.html b/docs/_modules/sub_actuator_board/packets.html
@@ -79,22 +79,36 @@ <h3><a href="../../index.html">Table of Contents</a></h3>
 
   <h1>Source code for sub_actuator_board.packets</h1><div class="highlight"><pre>
 <span></span><span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">dataclass</span>
+<span class="kn">from</span> <span class="nn">enum</span> <span class="kn">import</span> <span class="n">IntEnum</span>
 
 <span class="kn">from</span> <span class="nn">mil_usb_to_can.sub9</span> <span class="kn">import</span> <span class="n">Packet</span>
 
 
+<div class="viewcode-block" id="ActuatorPacketId"><a class="viewcode-back" href="../../subjugator/reference.html#sub_actuator_board.ActuatorPacketId">[docs]</a><span class="k">class</span> <span class="nc">ActuatorPacketId</span><span class="p">(</span><span class="n">IntEnum</span><span class="p">):</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Enumerator representing each controllable actuator.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="c1">#: The dropper actuator.</span>
+    <span class="n">DROPPER</span> <span class="o">=</span> <span class="mi">0</span>
+    <span class="c1">#: The torpedo launcher actuator.</span>
+    <span class="n">TORPEDO_LAUNCHER</span> <span class="o">=</span> <span class="mi">1</span>
+    <span class="c1">#: The ball drop actuator. Only one actuator is used for both balls.</span>
+    <span class="n">BALL_DROP</span> <span class="o">=</span> <span class="mi">2</span></div>
+
+
 <div class="viewcode-block" id="ActuatorSetPacket"><a class="viewcode-back" href="../../subjugator/reference.html#sub_actuator_board.ActuatorSetPacket">[docs]</a><span class="nd">@dataclass</span>
 <span class="k">class</span> <span class="nc">ActuatorSetPacket</span><span class="p">(</span><span class="n">Packet</span><span class="p">,</span> <span class="n">msg_id</span><span class="o">=</span><span class="mh">0x03</span><span class="p">,</span> <span class="n">subclass_id</span><span class="o">=</span><span class="mh">0x00</span><span class="p">,</span> <span class="n">payload_format</span><span class="o">=</span><span class="s2">&quot;BB&quot;</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Packet used by the actuator board to set a specific valve.</span>
 
 <span class="sd">    Attributes:</span>
-<span class="sd">        address (int): The actuator ID to set.</span>
+<span class="sd">        address (ActuatorPacketId): The actuator ID to set.</span>
 <span class="sd">        open (bool): Whether to open the specified actuator. ``True`` requests opening,</span>
 <span class="sd">            ``False`` requests closing.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
-    <span class="n">address</span><span class="p">:</span> <span class="nb">int</span>
+    <span class="n">address</span><span class="p">:</span> <span class="n">ActuatorPacketId</span>
     <span class="nb">open</span><span class="p">:</span> <span class="nb">bool</span></div>
 
 
@@ -107,9 +121,7 @@ <h1>Source code for sub_actuator_board.packets</h1><div class="highlight"><pre>
 <span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Packet used by the actuator board to request the status of all valves.</span>
-<span class="sd">    &quot;&quot;&quot;</span>
-
-    <span class="k">pass</span></div>
+<span class="sd">    &quot;&quot;&quot;</span></div>
 
 
 <div class="viewcode-block" id="ActuatorPollResponsePacket"><a class="viewcode-back" href="../../subjugator/reference.html#sub_actuator_board.ActuatorPollResponsePacket">[docs]</a><span class="nd">@dataclass</span>

diff --git a/docs/_sources/subjugator/reference.rst.txt b/docs/_sources/subjugator/reference.rst.txt
@@ -100,6 +100,11 @@ ActuatorBoardSimulation
 .. autoclass:: sub_actuator_board.ActuatorBoardSimulation
     :members:
 
+ActuatorPacketId
+^^^^^^^^^^^^^^^^
+.. autoclass:: sub_actuator_board.ActuatorPacketId
+    :members:
+
 ActuatorSetPacket
 ^^^^^^^^^^^^^^^^^
 .. attributetable:: sub_actuator_board.ActuatorSetPacket

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -148,6 +148,8 @@ <h2 id="A">A</h2>
       <li><a href="subjugator/reference.html#sub_actuator_board.ActuatorBoard">ActuatorBoard (class in sub_actuator_board)</a>
 </li>
       <li><a href="subjugator/reference.html#sub_actuator_board.ActuatorBoardSimulation">ActuatorBoardSimulation (class in sub_actuator_board)</a>
+</li>
+      <li><a href="subjugator/reference.html#sub_actuator_board.ActuatorPacketId">ActuatorPacketId (class in sub_actuator_board)</a>
 </li>
       <li><a href="subjugator/reference.html#sub_actuator_board.ActuatorPollRequestPacket">ActuatorPollRequestPacket (class in sub_actuator_board)</a>
 </li>
@@ -315,6 +317,8 @@ <h2 id="B">B</h2>
       <li><a href="reference/alarms.html#alarm_handlers.Kill.bagger_dump">bagger_dump() (alarm_handlers.Kill method)</a>
 </li>
       <li><a href="subjugator/reference.html#subjugator_gazebo_tools.BagManager">BagManager (class in subjugator_gazebo_tools)</a>
+</li>
+      <li><a href="subjugator/reference.html#sub_actuator_board.ActuatorPacketId.BALL_DROP">BALL_DROP (sub_actuator_board.ActuatorPacketId attribute)</a>
 </li>
       <li><a href="reference/passivesonar.html#mil_passive_sonar.algorithms.bandpass">bandpass() (in module mil_passive_sonar.algorithms)</a>
 </li>
@@ -333,11 +337,11 @@ <h2 id="B">B</h2>
       <li><a href="subjugator/reference.html#_CPPv427best_plane_from_combinationRKNSt6vectorIN5Eigen8Vector3dEEEdRNSt6vectorIdEE">best_plane_from_combination (C++ function)</a>
 </li>
       <li><a href="reference/passivesonar.html#mil_passive_sonar.algorithms.bin_to_freq">bin_to_freq() (in module mil_passive_sonar.algorithms)</a>
-</li>
-      <li><a href="reference/alarms.html#ros_alarms.Alarm.blank">blank() (ros_alarms.Alarm class method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="reference/alarms.html#ros_alarms.Alarm.blank">blank() (ros_alarms.Alarm class method)</a>
+</li>
       <li><a href="reference/actions.html#navigator_path_planner.msg.MoveGoal.blind">blind (navigator_path_planner.msg.MoveGoal attribute)</a>
 </li>
       <li><a href="reference/messages.html#navigator_msgs.msg.DockShape.BLUE">BLUE (navigator_msgs.msg.DockShape attribute)</a>
@@ -701,6 +705,8 @@ <h2 id="D">D</h2>
       <li><a href="reference/actions.html#navigator_path_planner.msg.MoveGoal.DRIVE">DRIVE (navigator_path_planner.msg.MoveGoal attribute)</a>
 </li>
       <li><a href="reference/actions.html#navigator_path_planner.msg.MoveGoal.DRIVE_SMOOTH">DRIVE_SMOOTH (navigator_path_planner.msg.MoveGoal attribute)</a>
+</li>
+      <li><a href="subjugator/reference.html#sub_actuator_board.ActuatorPacketId.DROPPER">DROPPER (sub_actuator_board.ActuatorPacketId attribute)</a>
 </li>
       <li><a href="subjugator/reference.html#subjugator_gazebo_tools.BagManager.dump">dump() (subjugator_gazebo_tools.BagManager method)</a>
 </li>
@@ -3816,6 +3822,8 @@ <h2 id="T">T</h2>
       <li><a href="reference/services.html#navigator_msgs.srv.GetDockShapesResponse.TOO_SMALL_SAMPLE">TOO_SMALL_SAMPLE (navigator_msgs.srv.GetDockShapesResponse attribute)</a>
 </li>
       <li><a href="reference/axros/api.html#axros.TooPastError">TooPastError (class in axros)</a>
+</li>
+      <li><a href="subjugator/reference.html#sub_actuator_board.ActuatorPacketId.TORPEDO_LAUNCHER">TORPEDO_LAUNCHER (sub_actuator_board.ActuatorPacketId attribute)</a>
 </li>
       <li><a href="subjugator/reference.html#_CPPv428TorpedoBoardReprojectionCost">TorpedoBoardReprojectionCost (C++ class)</a>
 </li>

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/subjugator/reference.html b/docs/subjugator/reference.html
@@ -75,6 +75,7 @@ <h3><a href="../index.html">Table of Contents</a></h3>
 <li class="toctree-l2"><a class="reference internal" href="#actuator-board">Actuator Board</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#actuatorboard">ActuatorBoard</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#actuatorboardsimulation">ActuatorBoardSimulation</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#actuatorpacketid">ActuatorPacketId</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#actuatorsetpacket">ActuatorSetPacket</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#actuatorpollrequestpacket">ActuatorPollRequestPacket</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#actuatorpollresponsepacket">ActuatorPollResponsePacket</a></li>
@@ -378,6 +379,33 @@ <h3>ActuatorBoardSimulation<a class="headerlink" href="#actuatorboardsimulation"
 
 </dd></dl>
 
+</section>
+<section id="actuatorpacketid">
+<h3>ActuatorPacketId<a class="headerlink" href="#actuatorpacketid" title="Permalink to this heading">¶</a></h3>
+<dl class="py class">
+<dt class="sig sig-object py" id="sub_actuator_board.ActuatorPacketId">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sub_actuator_board.</span></span><span class="sig-name descname"><span class="pre">ActuatorPacketId</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/sub_actuator_board/packets.html#ActuatorPacketId"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sub_actuator_board.ActuatorPacketId" title="Permalink to this definition">¶</a></dt>
+<dd><p>Enumerator representing each controllable actuator.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="sub_actuator_board.ActuatorPacketId.BALL_DROP">
+<span class="sig-name descname"><span class="pre">BALL_DROP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#sub_actuator_board.ActuatorPacketId.BALL_DROP" title="Permalink to this definition">¶</a></dt>
+<dd><p>The ball drop actuator. Only one actuator is used for both balls.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="sub_actuator_board.ActuatorPacketId.DROPPER">
+<span class="sig-name descname"><span class="pre">DROPPER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#sub_actuator_board.ActuatorPacketId.DROPPER" title="Permalink to this definition">¶</a></dt>
+<dd><p>The dropper actuator.</p>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="sub_actuator_board.ActuatorPacketId.TORPEDO_LAUNCHER">
+<span class="sig-name descname"><span class="pre">TORPEDO_LAUNCHER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#sub_actuator_board.ActuatorPacketId.TORPEDO_LAUNCHER" title="Permalink to this definition">¶</a></dt>
+<dd><p>The torpedo launcher actuator.</p>
+</dd></dl>
+
+</dd></dl>
+
 </section>
 <section id="actuatorsetpacket">
 <h3>ActuatorSetPacket<a class="headerlink" href="#actuatorsetpacket" title="Permalink to this heading">¶</a></h3>
@@ -389,15 +417,15 @@ <h3>ActuatorSetPacket<a class="headerlink" href="#actuatorsetpacket" title="Perm
 <a class="reference internal" href="#sub_actuator_board.ActuatorSetPacket.open">open</a></li></ul>
 </div></div><dl class="py class">
 <dt class="sig sig-object py" id="sub_actuator_board.ActuatorSetPacket">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sub_actuator_board.</span></span><span class="sig-name descname"><span class="pre">ActuatorSetPacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.8/library/functions.html#int" title="(in Python v3.8)"><span class="pre">int</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">open</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.8/library/functions.html#bool" title="(in Python v3.8)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/sub_actuator_board/packets.html#ActuatorSetPacket"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sub_actuator_board.ActuatorSetPacket" title="Permalink to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">sub_actuator_board.</span></span><span class="sig-name descname"><span class="pre">ActuatorSetPacket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#sub_actuator_board.ActuatorPacketId" title="sub_actuator_board.packets.ActuatorPacketId"><span class="pre">ActuatorPacketId</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">open</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3.8/library/functions.html#bool" title="(in Python v3.8)"><span class="pre">bool</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/sub_actuator_board/packets.html#ActuatorSetPacket"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#sub_actuator_board.ActuatorSetPacket" title="Permalink to this definition">¶</a></dt>
 <dd><p>Packet used by the actuator board to set a specific valve.</p>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="sub_actuator_board.ActuatorSetPacket.address">
 <span class="sig-name descname"><span class="pre">address</span></span><a class="headerlink" href="#sub_actuator_board.ActuatorSetPacket.address" title="Permalink to this definition">¶</a></dt>
 <dd><p>The actuator ID to set.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Type</dt>
-<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3.8/library/functions.html#int" title="(in Python v3.8)">int</a></p>
+<dd class="field-odd"><p><a class="reference internal" href="#sub_actuator_board.ActuatorPacketId" title="sub_actuator_board.ActuatorPacketId">ActuatorPacketId</a></p>
 </dd>
 </dl>
 </dd></dl>