Update docs

msgtn · Dec 23, 2023 · e7ec17d · e7ec17d
1 parent e525d9b
commit e7ec17d
Show file tree

Hide file tree

Showing 12 changed files with 240 additions and 437 deletions.
diff --git a/_sources/source/r0b0.cables.rst.txt b/_sources/source/r0b0.cables.rst.txt
@@ -12,6 +12,14 @@ r0b0.cables.blsm module
    :undoc-members:
    :show-inheritance:
 
+r0b0.cables.cable module
+------------------------
+
+.. automodule:: r0b0.cables.cable
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 r0b0.cables.midi\_funcs module
 ------------------------------
 

diff --git a/genindex.html b/genindex.html
diff --git a/index.html b/index.html
@@ -83,6 +83,7 @@ <h1>Welcome to r0b0’s documentation!<a class="headerlink" href="#welcome-to-r0
 <li class="toctree-l4"><a class="reference internal" href="source/r0b0.cables.html">r0b0.cables package</a><ul>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.cables.html#submodules">Submodules</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.cables.html#module-r0b0.cables.blsm">r0b0.cables.blsm module</a></li>
+<li class="toctree-l5"><a class="reference internal" href="source/r0b0.cables.html#module-r0b0.cables.cable">r0b0.cables.cable module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.cables.html#module-r0b0.cables.midi_funcs">r0b0.cables.midi_funcs module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.cables.html#module-r0b0.cables.mouse_funcs">r0b0.cables.mouse_funcs module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.cables.html#module-r0b0.cables.msg_funcs">r0b0.cables.msg_funcs module</a></li>
@@ -92,22 +93,22 @@ <h1>Welcome to r0b0’s documentation!<a class="headerlink" href="#welcome-to-r0
 </li>
 <li class="toctree-l4"><a class="reference internal" href="source/r0b0.gadgets.html">r0b0.gadgets package</a><ul>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#submodules">Submodules</a></li>
-<li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#module-r0b0.gadgets.arduino">r0b0.gadgets.arduino module</a></li>
+<li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#r0b0-gadgets-arduino-module">r0b0.gadgets.arduino module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#module-r0b0.gadgets.camera">r0b0.gadgets.camera module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#r0b0-gadgets-chatbot-module">r0b0.gadgets.chatbot module</a></li>
-<li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#module-r0b0.gadgets.dxl_robot">r0b0.gadgets.dxl_robot module</a></li>
+<li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#r0b0-gadgets-dxl-robot-module">r0b0.gadgets.dxl_robot module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#module-r0b0.gadgets.gadget">r0b0.gadgets.gadget module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#r0b0-gadgets-mediapipe-gadget-module">r0b0.gadgets.mediapipe_gadget module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#r0b0-gadgets-microphone-module">r0b0.gadgets.microphone module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#r0b0-gadgets-midi-controller-module">r0b0.gadgets.midi_controller module</a></li>
-<li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#r0b0-gadgets-mouse-module">r0b0.gadgets.mouse module</a></li>
+<li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#module-r0b0.gadgets.mouse">r0b0.gadgets.mouse module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#module-r0b0.gadgets.page">r0b0.gadgets.page module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#r0b0-gadgets-pi-button-module">r0b0.gadgets.pi_button module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#r0b0-gadgets-pi-camera-module">r0b0.gadgets.pi_camera module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#r0b0-gadgets-pi-gadget-module">r0b0.gadgets.pi_gadget module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#r0b0-gadgets-pi-screen-module">r0b0.gadgets.pi_screen module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#module-r0b0.gadgets.pygame_gadget">r0b0.gadgets.pygame_gadget module</a></li>
-<li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#module-r0b0.gadgets.rtc">r0b0.gadgets.rtc module</a></li>
+<li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#r0b0-gadgets-rtc-module">r0b0.gadgets.rtc module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#module-r0b0.gadgets.tape">r0b0.gadgets.tape module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#module-r0b0.gadgets.tape_player">r0b0.gadgets.tape_player module</a></li>
 <li class="toctree-l5"><a class="reference internal" href="source/r0b0.gadgets.html#r0b0-gadgets-test-gadget-module">r0b0.gadgets.test_gadget module</a></li>
@@ -134,10 +135,7 @@ <h1>Welcome to r0b0’s documentation!<a class="headerlink" href="#welcome-to-r0
 </li>
 <li class="toctree-l3"><a class="reference internal" href="source/r0b0.html#submodules">Submodules</a></li>
 <li class="toctree-l3"><a class="reference internal" href="source/r0b0.html#module-r0b0.config">r0b0.config module</a></li>
-<li class="toctree-l3"><a class="reference internal" href="source/r0b0.html#module-r0b0">Module contents</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="source/r0b0.html#r0b0.get_timestamp"><code class="docutils literal notranslate"><span class="pre">get_timestamp()</span></code></a></li>
-</ul>
-</li>
+<li class="toctree-l3"><a class="reference internal" href="source/r0b0.html#module-r0b0">Module contents</a></li>
 </ul>
 </li>
 </ul>

diff --git a/objects.inv b/objects.inv
diff --git a/py-modindex.html b/py-modindex.html
@@ -99,6 +99,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="source/r0b0.cables.html#module-r0b0.cables.blsm"><code class="xref">r0b0.cables.blsm</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="source/r0b0.cables.html#module-r0b0.cables.cable"><code class="xref">r0b0.cables.cable</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
@@ -129,11 +134,6 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="source/r0b0.gadgets.html#module-r0b0.gadgets"><code class="xref">r0b0.gadgets</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-1">
-       <td></td>
-       <td>&#160;&#160;&#160;
-       <a href="source/r0b0.gadgets.html#module-r0b0.gadgets.arduino"><code class="xref">r0b0.gadgets.arduino</code></a></td><td>
-       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
@@ -142,12 +142,12 @@ <h1>Python Module Index</h1>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="source/r0b0.gadgets.html#module-r0b0.gadgets.dxl_robot"><code class="xref">r0b0.gadgets.dxl_robot</code></a></td><td>
+       <a href="source/r0b0.gadgets.html#module-r0b0.gadgets.gadget"><code class="xref">r0b0.gadgets.gadget</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="source/r0b0.gadgets.html#module-r0b0.gadgets.gadget"><code class="xref">r0b0.gadgets.gadget</code></a></td><td>
+       <a href="source/r0b0.gadgets.html#module-r0b0.gadgets.mouse"><code class="xref">r0b0.gadgets.mouse</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
@@ -159,11 +159,6 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="source/r0b0.gadgets.html#module-r0b0.gadgets.pygame_gadget"><code class="xref">r0b0.gadgets.pygame_gadget</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-1">
-       <td></td>
-       <td>&#160;&#160;&#160;
-       <a href="source/r0b0.gadgets.html#module-r0b0.gadgets.rtc"><code class="xref">r0b0.gadgets.rtc</code></a></td><td>
-       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;

diff --git a/searchindex.js b/searchindex.js
diff --git a/source/modules.html b/source/modules.html
@@ -85,6 +85,7 @@ <h1>r0b0<a class="headerlink" href="#r0b0" title="Link to this heading"></a><
 <li class="toctree-l3"><a class="reference internal" href="r0b0.cables.html">r0b0.cables package</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.cables.html#submodules">Submodules</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.cables.html#module-r0b0.cables.blsm">r0b0.cables.blsm module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="r0b0.cables.html#module-r0b0.cables.cable">r0b0.cables.cable module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.cables.html#module-r0b0.cables.midi_funcs">r0b0.cables.midi_funcs module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.cables.html#module-r0b0.cables.mouse_funcs">r0b0.cables.mouse_funcs module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.cables.html#module-r0b0.cables.msg_funcs">r0b0.cables.msg_funcs module</a></li>
@@ -94,22 +95,22 @@ <h1>r0b0<a class="headerlink" href="#r0b0" title="Link to this heading"></a><
 </li>
 <li class="toctree-l3"><a class="reference internal" href="r0b0.gadgets.html">r0b0.gadgets package</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#submodules">Submodules</a></li>
-<li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#module-r0b0.gadgets.arduino">r0b0.gadgets.arduino module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#r0b0-gadgets-arduino-module">r0b0.gadgets.arduino module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#module-r0b0.gadgets.camera">r0b0.gadgets.camera module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#r0b0-gadgets-chatbot-module">r0b0.gadgets.chatbot module</a></li>
-<li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#module-r0b0.gadgets.dxl_robot">r0b0.gadgets.dxl_robot module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#r0b0-gadgets-dxl-robot-module">r0b0.gadgets.dxl_robot module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#module-r0b0.gadgets.gadget">r0b0.gadgets.gadget module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#r0b0-gadgets-mediapipe-gadget-module">r0b0.gadgets.mediapipe_gadget module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#r0b0-gadgets-microphone-module">r0b0.gadgets.microphone module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#r0b0-gadgets-midi-controller-module">r0b0.gadgets.midi_controller module</a></li>
-<li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#r0b0-gadgets-mouse-module">r0b0.gadgets.mouse module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#module-r0b0.gadgets.mouse">r0b0.gadgets.mouse module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#module-r0b0.gadgets.page">r0b0.gadgets.page module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#r0b0-gadgets-pi-button-module">r0b0.gadgets.pi_button module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#r0b0-gadgets-pi-camera-module">r0b0.gadgets.pi_camera module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#r0b0-gadgets-pi-gadget-module">r0b0.gadgets.pi_gadget module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#r0b0-gadgets-pi-screen-module">r0b0.gadgets.pi_screen module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#module-r0b0.gadgets.pygame_gadget">r0b0.gadgets.pygame_gadget module</a></li>
-<li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#module-r0b0.gadgets.rtc">r0b0.gadgets.rtc module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#r0b0-gadgets-rtc-module">r0b0.gadgets.rtc module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#module-r0b0.gadgets.tape">r0b0.gadgets.tape module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#module-r0b0.gadgets.tape_player">r0b0.gadgets.tape_player module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="r0b0.gadgets.html#r0b0-gadgets-test-gadget-module">r0b0.gadgets.test_gadget module</a></li>
@@ -136,10 +137,7 @@ <h1>r0b0<a class="headerlink" href="#r0b0" title="Link to this heading"></a><
 </li>
 <li class="toctree-l2"><a class="reference internal" href="r0b0.html#submodules">Submodules</a></li>
 <li class="toctree-l2"><a class="reference internal" href="r0b0.html#module-r0b0.config">r0b0.config module</a></li>
-<li class="toctree-l2"><a class="reference internal" href="r0b0.html#module-r0b0">Module contents</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="r0b0.html#r0b0.get_timestamp"><code class="docutils literal notranslate"><span class="pre">get_timestamp()</span></code></a></li>
-</ul>
-</li>
+<li class="toctree-l2"><a class="reference internal" href="r0b0.html#module-r0b0">Module contents</a></li>
 </ul>
 </li>
 </ul>

diff --git a/source/r0b0.cables.html b/source/r0b0.cables.html
@@ -133,6 +133,27 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <span class="sig-name descname"><span class="pre">response2blsm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#r0b0.cables.blsm.response2blsm" title="Link to this definition"></a></dt>
 <dd></dd></dl>
 
+</section>
+<section id="module-r0b0.cables.cable">
+<span id="r0b0-cables-cable-module"></span><h2>r0b0.cables.cable module<a class="headerlink" href="#module-r0b0.cables.cable" title="Link to this heading"></a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="r0b0.cables.cable.Cable">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Cable</span></span><a class="headerlink" href="#r0b0.cables.cable.Cable" title="Link to this definition"></a></dt>
+<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="r0b0.cables.cable.Key2MouseCable">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Key2MouseCable</span></span><a class="headerlink" href="#r0b0.cables.cable.Key2MouseCable" title="Link to this definition"></a></dt>
+<dd><p>Bases: <a class="reference internal" href="#r0b0.cables.cable.Cable" title="r0b0.cables.cable.Cable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cable</span></code></a></p>
+</dd></dl>
+
+<dl class="py class">
+<dt class="sig sig-object py" id="r0b0.cables.cable.Motion2MotorCable">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Motion2MotorCable</span></span><a class="headerlink" href="#r0b0.cables.cable.Motion2MotorCable" title="Link to this definition"></a></dt>
+<dd><p>Bases: <a class="reference internal" href="#r0b0.cables.cable.Cable" title="r0b0.cables.cable.Cable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Cable</span></code></a></p>
+</dd></dl>
+
 </section>
 <section id="module-r0b0.cables.midi_funcs">
 <span id="r0b0-cables-midi-funcs-module"></span><h2>r0b0.cables.midi_funcs module<a class="headerlink" href="#module-r0b0.cables.midi_funcs" title="Link to this heading"></a></h2>