This commit is contained in:
2025-07-05 17:14:56 -04:00
parent e90e041cc6
commit 15196b1bd3
9 changed files with 60 additions and 5 deletions

View File

@@ -18,4 +18,12 @@ It's intended to be sent from a transmitting device (like a remote control or ma
uint8_t motor2_rpm_pwm; uint8_t motor2_rpm_pwm;
uint8_t motor3_rpm_pwm; uint8_t motor3_rpm_pwm;
uint8_t motor4_rpm_pwm; uint8_t motor4_rpm_pwm;
} __attribute__((packed)) sensors_data_t; } __attribute__((packed)) sensors_data_t;
Struct Walkthrough
^^^^^^^^^^^^^^^^^^
*x_axis* and *y_axis* fields capture analog input from a joystick, determining direction and speed.
*nav_bttn* represents a joystick push-button.
*led* allows the transmitter to toggle an onboard LED and is used for status indication (e.g. pairing, battery warning, etc).

View File

@@ -51,6 +51,12 @@ Its intended to be sent from a transmitting device (like a remote control or
<span class="p">}</span><span class="w"> </span><span class="n">__attribute__</span><span class="p">((</span><span class="n">packed</span><span class="p">))</span><span class="w"> </span><span class="n">sensors_data_t</span><span class="p">;</span> <span class="p">}</span><span class="w"> </span><span class="n">__attribute__</span><span class="p">((</span><span class="n">packed</span><span class="p">))</span><span class="w"> </span><span class="n">sensors_data_t</span><span class="p">;</span>
</pre></div> </pre></div>
</div> </div>
<section id="struct-walkthrough">
<h2>Struct Walkthrough<a class="headerlink" href="#struct-walkthrough" title="Link to this heading"></a></h2>
<p><em>x_axis</em> and <em>y_axis</em> fields capture analog input from a joystick, determining direction and speed.
<em>nav_bttn</em> represents a joystick push-button.</p>
<p><em>led</em> allows the transmitter to toggle an onboard LED and is used for status indication (e.g. pairing, battery warning, etc).</p>
</section>
</section> </section>
@@ -82,7 +88,10 @@ Its intended to be sent from a transmitting device (like a remote control or
<ul class="current"> <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">INTRODUCTION</a></li> <li class="toctree-l1"><a class="reference internal" href="intro.html">INTRODUCTION</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">HOW DOES IT WORK?</a></li> <li class="toctree-l1"><a class="reference internal" href="overview.html">HOW DOES IT WORK?</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">DATA STRUCT</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">DATA STRUCT</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#struct-walkthrough">Struct Walkthrough</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="transmitter.html">TRANSMITTER</a></li> <li class="toctree-l1"><a class="reference internal" href="transmitter.html">TRANSMITTER</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver.html">RECEIVER</a></li> <li class="toctree-l1"><a class="reference internal" href="receiver.html">RECEIVER</a></li>
<li class="toctree-l1"><a class="reference internal" href="progress.html">WORK-IN-PROGRESS WALK THROUGH</a></li> <li class="toctree-l1"><a class="reference internal" href="progress.html">WORK-IN-PROGRESS WALK THROUGH</a></li>

View File

@@ -44,7 +44,10 @@
<li class="toctree-l2"><a class="reference internal" href="overview.html#schematic">Schematic</a></li> <li class="toctree-l2"><a class="reference internal" href="overview.html#schematic">Schematic</a></li>
</ul> </ul>
</li> </li>
<li class="toctree-l1"><a class="reference internal" href="data.html">DATA STRUCT</a></li> <li class="toctree-l1"><a class="reference internal" href="data.html">DATA STRUCT</a><ul>
<li class="toctree-l2"><a class="reference internal" href="data.html#struct-walkthrough">Struct Walkthrough</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="transmitter.html">TRANSMITTER</a><ul> <li class="toctree-l1"><a class="reference internal" href="transmitter.html">TRANSMITTER</a><ul>
<li class="toctree-l2"><a class="reference internal" href="transmitter.html#data-encapsulation">Data Encapsulation</a></li> <li class="toctree-l2"><a class="reference internal" href="transmitter.html#data-encapsulation">Data Encapsulation</a></li>
</ul> </ul>

File diff suppressed because one or more lines are too long

View File

@@ -1,4 +1,4 @@
# Sphinx build info version 1 # Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done. # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 33b22b97f821b03caa45f38a3cf429d9 config: 4ff0b7a7d45b83bb7dd9dbbad6843002
tags: 62a1e7829a13fc7881b6498c52484ec0 tags: 62a1e7829a13fc7881b6498c52484ec0

View File

@@ -91,6 +91,13 @@
<a class="reference internal" href="#data-struct"> <a class="reference internal" href="#data-struct">
DATA STRUCT DATA STRUCT
</a> </a>
<ul>
<li class="toctree-l2">
<a class="reference internal" href="#struct-walkthrough">
Struct Walkthrough
</a>
</li>
</ul>
</li> </li>
<li class="toctree-l1"> <li class="toctree-l1">
<a class="reference internal" href="#transmitter"> <a class="reference internal" href="#transmitter">
@@ -628,6 +635,34 @@ It&rsquo;s intended to be sent from a transmitting device (like a remote control
</pre> </pre>
</div> </div>
</div> </div>
<section id="struct-walkthrough">
<h3>
Struct Walkthrough
<a class="headerlink" href="#struct-walkthrough" title="Link to this heading">
&para;
</a>
</h3>
<p>
<em>
x_axis
</em>
and
<em>
y_axis
</em>
fields capture analog input from a joystick, determining direction and speed.
<em>
nav_bttn
</em>
represents a joystick push-button.
</p>
<p>
<em>
led
</em>
allows the transmitter to toggle an onboard LED and is used for status indication (e.g. pairing, battery warning, etc).
</p>
</section>
</section> </section>
<span id="document-transmitter"> <span id="document-transmitter">
</span> </span>