alex/ESP-Nodes
1
0
Fork 0
mirror of https://github.com/alexandrebobkov/ESP-Nodes.git synced 2025-08-08 11:10:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

RC Robot Tutorial

Browse Source
This commit is contained in:
Alex B.
2025-07-19 01:34:55 -04:00
parent 4138eaeae2
commit b9137aad7f
13 changed files with 187 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
ESP-IDF_Robot/tutorial/docs/build/doctrees/environment.pickle vendored
View File

Binary file not shown.

BIN
ESP-IDF_Robot/tutorial/docs/build/doctrees/index.doctree vendored
View File

Binary file not shown.

3
ESP-IDF_Robot/tutorial/docs/build/html/_sources/index.rst.txt vendored
View File

@@ -9,7 +9,8 @@ ByteRider documentation
.. image:: _static/ESP-IDF_Robot.jpg
.. toctree::
:maxdepth: 2
:maxdepth: 3
:numbered:
intro
overview

35
ESP-IDF_Robot/tutorial/docs/build/html/data.html vendored
View File

@@ -5,7 +5,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>DATA STRUCTS &#8212; Byte Rider 06-2025 documentation</title>
<title>3. DATA STRUCTS &#8212; Byte Rider 06-2025 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
@@ -14,8 +14,8 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="TRANSMITTER" href="transmitter.html" />
<link rel="prev" title="HOW DOES IT WORK?" href="overview.html" />
<link rel="next" title="4. TRANSMITTER" href="transmitter.html" />
<link rel="prev" title="2. HOW DOES IT WORK?" href="overview.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -34,7 +34,7 @@
<div class="body" role="main">
<section id="data-structs">
<h1>DATA STRUCTS<a class="headerlink" href="#data-structs" title="Link to this heading"></a></h1>
<h1><span class="section-number">3. </span>DATA STRUCTS<a class="headerlink" href="#data-structs" title="Link to this heading"></a></h1>
<p>The struct serves as the data payload for sending control signals from the transmitting device to the receiver using ESP-NOW.
In addition, it may contain additional data such as telemetry, battery status, etc. The <em>sensors_data_t</em> struct encapsulates all control commands and sensor states
relevant to the vehicle’s operation. It’s intended to be sent from a transmitting device (like a remote control) to a receiver
@@ -70,14 +70,14 @@ powerful in systems programming, embedded projects, and when dealing with raw bi
ESP-NOW.</p>
</div>
<section id="data-payload">
<h2>Data Payload<a class="headerlink" href="#data-payload" title="Link to this heading"></a></h2>
<h2><span class="section-number">3.1. </span>Data Payload<a class="headerlink" href="#data-payload" 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>
<p><em>motor1_rpm_pwm</em> to <em>motor4_rpm_pwm</em> provide individual PWM signals to four DC motors.
This enables fine-grained speed control, supports differential drive configurations, and even allows for maneuvering in multi-directional platforms like omni-wheel robots.</p>
<section id="why-use-attribute-packed">
<h3>Why use __attribute((packed))?<a class="headerlink" href="#why-use-attribute-packed" title="Link to this heading"></a></h3>
<h3><span class="section-number">3.1.1. </span>Why use __attribute((packed))?<a class="headerlink" href="#why-use-attribute-packed" title="Link to this heading"></a></h3>
<p>ESP-NOW uses fixed-size data packets (up to 250 bytes). The <em>__attribute__((packed))</em> removes compiler-added padding for precise byte alignment.</p>
<p>As <em>packed</em> attribute tells the compiler not to add any padding between fields in memory, this makes the struct:</p>
<blockquote>
@@ -119,24 +119,27 @@ This enables fine-grained speed control, supports differential drive configurati
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">OVERVIEW</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 STRUCTS</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#data-payload">Data Payload</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">1. OVERVIEW</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">2. HOW DOES IT WORK?</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">3. DATA STRUCTS</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#data-payload">3.1. Data Payload</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#why-use-attribute-packed">3.1.1. Why use __attribute((packed))?</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="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="references.html">REFERENCES</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="transmitter.html">4. TRANSMITTER</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver.html">5. RECEIVER</a></li>
<li class="toctree-l1"><a class="reference internal" href="progress.html">6. WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">7. REFERENCES</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="overview.html" title="previous chapter">HOW DOES IT WORK?</a></li>
<li>Next: <a href="transmitter.html" title="next chapter">TRANSMITTER</a></li>
<li>Previous: <a href="overview.html" title="previous chapter"><span class="section-number">2. </span>HOW DOES IT WORK?</a></li>
<li>Next: <a href="transmitter.html" title="next chapter"><span class="section-number">4. </span>TRANSMITTER</a></li>
</ul></li>
</ul>
</div>

14
ESP-IDF_Robot/tutorial/docs/build/html/genindex.html vendored
View File

@@ -64,13 +64,13 @@
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">OVERVIEW</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="data.html">DATA STRUCTS</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="progress.html">WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">REFERENCES</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">1. OVERVIEW</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">2. HOW DOES IT WORK?</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">3. DATA STRUCTS</a></li>
<li class="toctree-l1"><a class="reference internal" href="transmitter.html">4. TRANSMITTER</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver.html">5. RECEIVER</a></li>
<li class="toctree-l1"><a class="reference internal" href="progress.html">6. WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">7. REFERENCES</a></li>
</ul>
<div class="relations">

73
ESP-IDF_Robot/tutorial/docs/build/html/index.html vendored
View File

@@ -14,7 +14,7 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="OVERVIEW" href="intro.html" />
<link rel="next" title="1. OVERVIEW" href="intro.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -37,42 +37,49 @@
<img alt="_images/ESP-IDF_Robot.jpg" src="_images/ESP-IDF_Robot.jpg" />
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">OVERVIEW</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#abstract">ABSTRACT</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">1. OVERVIEW</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intro.html#abstract">1.1. ABSTRACT</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">HOW DOES IT WORK?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#reserved-pins-gpios">Reserved Pins &amp; GPIOs</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#fusion-of-software-with-hardware">Fusion of Software with Hardware</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#schematic">Schematic</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">2. HOW DOES IT WORK?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#reserved-pins-gpios">2.1. Reserved Pins &amp; GPIOs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="overview.html#x-and-y-axis">2.1.1. x- and y- axis</a></li>
<li class="toctree-l3"><a class="reference internal" href="overview.html#direction-and-speed">2.1.2. Direction and Speed</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="data.html">DATA STRUCTS</a><ul>
<li class="toctree-l2"><a class="reference internal" href="data.html#data-payload">Data Payload</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#fusion-of-software-with-hardware">2.2. Fusion of Software with Hardware</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#schematic">2.3. Schematic</a></li>
</ul>
</li>
<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#configuration-variables">Configuration Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="transmitter.html#reading-joystick-x-and-y-axis-values">Reading Joystick x- and y- Axis Values</a></li>
<li class="toctree-l2"><a class="reference internal" href="transmitter.html#sending-ecapsulating-data">Sending &amp; Ecapsulating Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="transmitter.html#main-function">Main Function</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">3. DATA STRUCTS</a><ul>
<li class="toctree-l2"><a class="reference internal" href="data.html#data-payload">3.1. Data Payload</a><ul>
<li class="toctree-l3"><a class="reference internal" href="data.html#why-use-attribute-packed">3.1.1. Why use __attribute((packed))?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="receiver.html">RECEIVER</a><ul>
<li class="toctree-l2"><a class="reference internal" href="receiver.html#configuration-variables">Configuration Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="receiver.html#receiving-extracting-data">Receiving &amp; Extracting Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="receiver.html#main-function">Main Function</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="progress.html">WORK-IN-PROGRESS WALK THROUGH</a><ul>
<li class="toctree-l2"><a class="reference internal" href="progress.html#finished-work">Finished Work</a></li>
<li class="toctree-l2"><a class="reference internal" href="progress.html#chassis">Chassis</a></li>
<li class="toctree-l2"><a class="reference internal" href="progress.html#wiring">Wiring</a></li>
<li class="toctree-l2"><a class="reference internal" href="progress.html#motor-wires-harness">Motor Wires Harness</a></li>
<li class="toctree-l1"><a class="reference internal" href="transmitter.html">4. TRANSMITTER</a><ul>
<li class="toctree-l2"><a class="reference internal" href="transmitter.html#configuration-variables">4.1. Configuration Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="transmitter.html#reading-joystick-x-and-y-axis-values">4.2. Reading Joystick x- and y- Axis Values</a></li>
<li class="toctree-l2"><a class="reference internal" href="transmitter.html#sending-ecapsulating-data">4.3. Sending &amp; Ecapsulating Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="transmitter.html#main-function">4.4. Main Function</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="references.html">REFERENCES</a><ul>
<li class="toctree-l2"><a class="reference internal" href="references.html#github">GitHub</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver.html">5. RECEIVER</a><ul>
<li class="toctree-l2"><a class="reference internal" href="receiver.html#configuration-variables">5.1. Configuration Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="receiver.html#receiving-extracting-data">5.2. Receiving &amp; Extracting Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="receiver.html#main-function">5.3. Main Function</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="progress.html">6. WORK-IN-PROGRESS WALK THROUGH</a><ul>
<li class="toctree-l2"><a class="reference internal" href="progress.html#finished-work">6.1. Finished Work</a></li>
<li class="toctree-l2"><a class="reference internal" href="progress.html#chassis">6.2. Chassis</a></li>
<li class="toctree-l2"><a class="reference internal" href="progress.html#wiring">6.3. Wiring</a></li>
<li class="toctree-l2"><a class="reference internal" href="progress.html#motor-wires-harness">6.4. Motor Wires Harness</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="references.html">7. REFERENCES</a><ul>
<li class="toctree-l2"><a class="reference internal" href="references.html#github">7.1. GitHub</a></li>
</ul>
</li>
</ul>
@@ -106,20 +113,20 @@
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">OVERVIEW</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="data.html">DATA STRUCTS</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="progress.html">WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">REFERENCES</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">1. OVERVIEW</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">2. HOW DOES IT WORK?</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">3. DATA STRUCTS</a></li>
<li class="toctree-l1"><a class="reference internal" href="transmitter.html">4. TRANSMITTER</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver.html">5. RECEIVER</a></li>
<li class="toctree-l1"><a class="reference internal" href="progress.html">6. WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">7. REFERENCES</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="intro.html" title="next chapter">OVERVIEW</a></li>
<li>Next: <a href="intro.html" title="next chapter"><span class="section-number">1. </span>OVERVIEW</a></li>
</ul></li>
</ul>
</div>

26
ESP-IDF_Robot/tutorial/docs/build/html/intro.html vendored
View File

@@ -5,7 +5,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>OVERVIEW &#8212; Byte Rider 06-2025 documentation</title>
<title>1. OVERVIEW &#8212; Byte Rider 06-2025 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
@@ -14,7 +14,7 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="HOW DOES IT WORK?" href="overview.html" />
<link rel="next" title="2. HOW DOES IT WORK?" href="overview.html" />
<link rel="prev" title="ByteRider documentation" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -34,7 +34,7 @@
<div class="body" role="main">
<section id="overview">
<h1>OVERVIEW<a class="headerlink" href="#overview" title="Link to this heading"></a></h1>
<h1><span class="section-number">1. </span>OVERVIEW<a class="headerlink" href="#overview" title="Link to this heading"></a></h1>
<p>At the heart of this project is a customizable remote-controlled car that responds to real-time control inputs, capable of handling speed adjustments,
directional changes, and even extended features like lights or sensors. The foundational setup uses ESP-NOW for transmitter and receiver devices,
allowing you to wirelessly guide the car’s behaviour. While the design and physical appearance of the RC car can vary wildly depending on your
@@ -47,7 +47,7 @@ setup where a transmitter sends data to a receiver to define the car’s speed a
implementation focuses on movement, additional features like lights, sensors, or telemetry can easily be integrated by expanding the source code. This
modular design gives users the freedom to customize both the appearance and behaviour of their RC car, resulting in endless creative possibilities.</p>
<section id="abstract">
<h2>ABSTRACT<a class="headerlink" href="#abstract" title="Link to this heading"></a></h2>
<h2><span class="section-number">1.1. </span>ABSTRACT<a class="headerlink" href="#abstract" title="Link to this heading"></a></h2>
<p>To enable real-time remote operation of the RC car, the system translates joystick x- and y- axis inputs into PWM (Pulse Width Modulation) signals that control the DC motors.
These PWM values are stored in a predefined data structure, which is then transmitted wirelessly using ESP-NOW — a low-latency, connectionless
communication protocol developed by Espressif. Both the transmitter and receiver modules are based on ESP32-C3 microcontrollers.</p>
@@ -85,16 +85,16 @@ allows the RC car to respond instantly to user input, managing speed and directi
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">OVERVIEW</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#abstract">ABSTRACT</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">1. OVERVIEW</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#abstract">1.1. ABSTRACT</a></li>
</ul>
</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="data.html">DATA STRUCTS</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="progress.html">WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">REFERENCES</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">2. HOW DOES IT WORK?</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">3. DATA STRUCTS</a></li>
<li class="toctree-l1"><a class="reference internal" href="transmitter.html">4. TRANSMITTER</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver.html">5. RECEIVER</a></li>
<li class="toctree-l1"><a class="reference internal" href="progress.html">6. WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">7. REFERENCES</a></li>
</ul>
<div class="relations">
@@ -102,7 +102,7 @@ allows the RC car to respond instantly to user input, managing speed and directi
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">ByteRider documentation</a></li>
<li>Next: <a href="overview.html" title="next chapter">HOW DOES IT WORK?</a></li>
<li>Next: <a href="overview.html" title="next chapter"><span class="section-number">2. </span>HOW DOES IT WORK?</a></li>
</ul></li>
</ul>
</div>

46
ESP-IDF_Robot/tutorial/docs/build/html/overview.html vendored
View File

@@ -5,7 +5,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>HOW DOES IT WORK? &#8212; Byte Rider 06-2025 documentation</title>
<title>2. HOW DOES IT WORK? &#8212; Byte Rider 06-2025 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
@@ -14,8 +14,8 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="DATA STRUCT" href="data.html" />
<link rel="prev" title="OVERVIEW" href="intro.html" />
<link rel="next" title="3. DATA STRUCTS" href="data.html" />
<link rel="prev" title="1. OVERVIEW" href="intro.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -34,19 +34,19 @@
<div class="body" role="main">
<section id="how-does-it-work">
<h1>HOW DOES IT WORK?<a class="headerlink" href="#how-does-it-work" title="Link to this heading"></a></h1>
<h1><span class="section-number">2. </span>HOW DOES IT WORK?<a class="headerlink" href="#how-does-it-work" title="Link to this heading"></a></h1>
<p>The BitByteRider RC car is powered by ESP32-C3 Breadboard &amp; Power adapter developmemt board.
The Schematic and KiCAd PCB board are available on <a class="reference external" href="https://github.com/alexandrebobkov/ESP32-C3_Breadboard-Adapter">GitHub</a>: <a class="reference external" href="https://github.com/alexandrebobkov/ESP32-C3_Breadboard-Adapter">https://github.com/alexandrebobkov/ESP32-C3_Breadboard-Adapter</a></p>
<section id="reserved-pins-gpios">
<h2>Reserved Pins &amp; GPIOs<a class="headerlink" href="#reserved-pins-gpios" title="Link to this heading"></a></h2>
<h2><span class="section-number">2.1. </span>Reserved Pins &amp; GPIOs<a class="headerlink" href="#reserved-pins-gpios" title="Link to this heading"></a></h2>
<p>The following table summarizes GPIOs and pins reserved for operations purposes.</p>
<p>The GPIO numbers correspond to those on the ESP32-C3 WROOM microcontroller. The Pin number corresponds to the pin on the Breadboard and Power adapter development board.</p>
<section id="x-and-y-axis">
<h3>x- and y- axis<a class="headerlink" href="#x-and-y-axis" title="Link to this heading"></a></h3>
<h3><span class="section-number">2.1.1. </span>x- and y- axis<a class="headerlink" href="#x-and-y-axis" title="Link to this heading"></a></h3>
<p>The <strong>GPIO0</strong> and <strong>GPIO1</strong> assigned to measuring the voltage of x- and y- axis of the Joystick. Lastly, there is a group of GPIO pairs responsible for PWM for DC motors.</p>
</section>
<section id="direction-and-speed">
<h3>Direction and Speed<a class="headerlink" href="#direction-and-speed" title="Link to this heading"></a></h3>
<h3><span class="section-number">2.1.2. </span>Direction and Speed<a class="headerlink" href="#direction-and-speed" title="Link to this heading"></a></h3>
<p>The pairs of DC motors on the left side are wired to the dedicated PWM channels. This means that <em>ESP32-C3 Breadboard DevBoard</em> can control rotation speed and direction of DC motors in pairs only (i.e. left and right side).
Consequently, only four PWM channels are sufficient for controlling the direction of the RC car.
Based on this constraint, the RC car can only move front, back, and turn/rotate left and right. Any other movements are not possible (i.e. diagonal or sideways).</p>
@@ -170,7 +170,7 @@ Right DC Motors spin clockwise</p></td>
</section>
</section>
<section id="fusion-of-software-with-hardware">
<h2>Fusion of Software with Hardware<a class="headerlink" href="#fusion-of-software-with-hardware" title="Link to this heading"></a></h2>
<h2><span class="section-number">2.2. </span>Fusion of Software with Hardware<a class="headerlink" href="#fusion-of-software-with-hardware" title="Link to this heading"></a></h2>
<p>The <em>struct</em> for storing motors PWM values.</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span><span class="w"> </span><span class="nc">motors_rpm</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">motor1_rpm_pwm</span><span class="p">;</span>
@@ -243,7 +243,7 @@ Right DC Motors spin clockwise</p></td>
</div>
</section>
<section id="schematic">
<h2>Schematic<a class="headerlink" href="#schematic" title="Link to this heading"></a></h2>
<h2><span class="section-number">2.3. </span>Schematic<a class="headerlink" href="#schematic" title="Link to this heading"></a></h2>
<img alt="_images/ESP-IDF_Robot_schematic.png" src="_images/ESP-IDF_Robot_schematic.png" />
</section>
</section>
@@ -275,26 +275,30 @@ Right DC Motors spin clockwise</p></td>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">OVERVIEW</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">HOW DOES IT WORK?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#reserved-pins-gpios">Reserved Pins &amp; GPIOs</a></li>
<li class="toctree-l2"><a class="reference internal" href="#fusion-of-software-with-hardware">Fusion of Software with Hardware</a></li>
<li class="toctree-l2"><a class="reference internal" href="#schematic">Schematic</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">1. OVERVIEW</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">2. HOW DOES IT WORK?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#reserved-pins-gpios">2.1. Reserved Pins &amp; GPIOs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#x-and-y-axis">2.1.1. x- and y- axis</a></li>
<li class="toctree-l3"><a class="reference internal" href="#direction-and-speed">2.1.2. Direction and Speed</a></li>
</ul>
</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="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="progress.html">WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">REFERENCES</a></li>
<li class="toctree-l2"><a class="reference internal" href="#fusion-of-software-with-hardware">2.2. Fusion of Software with Hardware</a></li>
<li class="toctree-l2"><a class="reference internal" href="#schematic">2.3. Schematic</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="data.html">3. DATA STRUCTS</a></li>
<li class="toctree-l1"><a class="reference internal" href="transmitter.html">4. TRANSMITTER</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver.html">5. RECEIVER</a></li>
<li class="toctree-l1"><a class="reference internal" href="progress.html">6. WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">7. REFERENCES</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="intro.html" title="previous chapter">OVERVIEW</a></li>
<li>Next: <a href="data.html" title="next chapter">DATA STRUCT</a></li>
<li>Previous: <a href="intro.html" title="previous chapter"><span class="section-number">1. </span>OVERVIEW</a></li>
<li>Next: <a href="data.html" title="next chapter"><span class="section-number">3. </span>DATA STRUCTS</a></li>
</ul></li>
</ul>
</div>

39
ESP-IDF_Robot/tutorial/docs/build/html/progress.html vendored
View File

@@ -5,7 +5,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>WORK-IN-PROGRESS WALK THROUGH &#8212; Byte Rider 06-2025 documentation</title>
<title>6. WORK-IN-PROGRESS WALK THROUGH &#8212; Byte Rider 06-2025 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
@@ -14,7 +14,8 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="RECEIVER" href="receiver.html" />
<link rel="next" title="7. REFERENCES" href="references.html" />
<link rel="prev" title="5. RECEIVER" href="receiver.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -33,13 +34,13 @@
<div class="body" role="main">
<section id="work-in-progress-walk-through">
<h1>WORK-IN-PROGRESS WALK THROUGH<a class="headerlink" href="#work-in-progress-walk-through" title="Link to this heading"></a></h1>
<h1><span class="section-number">6. </span>WORK-IN-PROGRESS WALK THROUGH<a class="headerlink" href="#work-in-progress-walk-through" title="Link to this heading"></a></h1>
<section id="finished-work">
<h2>Finished Work<a class="headerlink" href="#finished-work" title="Link to this heading"></a></h2>
<h2><span class="section-number">6.1. </span>Finished Work<a class="headerlink" href="#finished-work" title="Link to this heading"></a></h2>
<img alt="_images/ESP-IDF_Robot.jpg" src="_images/ESP-IDF_Robot.jpg" />
</section>
<section id="chassis">
<h2>Chassis<a class="headerlink" href="#chassis" title="Link to this heading"></a></h2>
<h2><span class="section-number">6.2. </span>Chassis<a class="headerlink" href="#chassis" title="Link to this heading"></a></h2>
<figure class="align-center" id="id1">
<a class="reference internal image-reference" href="_images/chassi-progress_002d.jpg"><img alt="_images/chassi-progress_002d.jpg" src="_images/chassi-progress_002d.jpg" style="height: 300px;" />
</a>
@@ -49,7 +50,7 @@
</figure>
</section>
<section id="wiring">
<h2>Wiring<a class="headerlink" href="#wiring" title="Link to this heading"></a></h2>
<h2><span class="section-number">6.3. </span>Wiring<a class="headerlink" href="#wiring" title="Link to this heading"></a></h2>
<figure class="align-center" id="id2">
<a class="reference internal image-reference" href="_images/chassi-progress_003a.jpg"><img alt="_images/chassi-progress_003a.jpg" src="_images/chassi-progress_003a.jpg" style="height: 750px;" />
</a>
@@ -59,7 +60,7 @@
</figure>
</section>
<section id="motor-wires-harness">
<h2>Motor Wires Harness<a class="headerlink" href="#motor-wires-harness" title="Link to this heading"></a></h2>
<h2><span class="section-number">6.4. </span>Motor Wires Harness<a class="headerlink" href="#motor-wires-harness" title="Link to this heading"></a></h2>
<figure class="align-center" id="id3">
<img alt="_images/motors-wiring-harness-001.jpg" src="_images/motors-wiring-harness-001.jpg" />
<figcaption>
@@ -96,25 +97,27 @@
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<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="overview.html">HOW DOES IT WORK?</a></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="transmitter.html">TRANSMITTER</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver.html">RECEIVER</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">WORK-IN-PROGRESS WALK THROUGH</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#finished-work">Finished Work</a></li>
<li class="toctree-l2"><a class="reference internal" href="#chassis">Chassis</a></li>
<li class="toctree-l2"><a class="reference internal" href="#wiring">Wiring</a></li>
<li class="toctree-l2"><a class="reference internal" href="#motor-wires-harness">Motor Wires Harness</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">1. OVERVIEW</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">2. HOW DOES IT WORK?</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">3. DATA STRUCTS</a></li>
<li class="toctree-l1"><a class="reference internal" href="transmitter.html">4. TRANSMITTER</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver.html">5. RECEIVER</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">6. WORK-IN-PROGRESS WALK THROUGH</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#finished-work">6.1. Finished Work</a></li>
<li class="toctree-l2"><a class="reference internal" href="#chassis">6.2. Chassis</a></li>
<li class="toctree-l2"><a class="reference internal" href="#wiring">6.3. Wiring</a></li>
<li class="toctree-l2"><a class="reference internal" href="#motor-wires-harness">6.4. Motor Wires Harness</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="references.html">7. REFERENCES</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="receiver.html" title="previous chapter">RECEIVER</a></li>
<li>Previous: <a href="receiver.html" title="previous chapter"><span class="section-number">5. </span>RECEIVER</a></li>
<li>Next: <a href="references.html" title="next chapter"><span class="section-number">7. </span>REFERENCES</a></li>
</ul></li>
</ul>
</div>

38
ESP-IDF_Robot/tutorial/docs/build/html/receiver.html vendored
View File

@@ -5,7 +5,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>RECEIVER &#8212; Byte Rider 06-2025 documentation</title>
<title>5. RECEIVER &#8212; Byte Rider 06-2025 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
@@ -14,8 +14,8 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="WORK-IN-PROGRESS WALK THROUGH" href="progress.html" />
<link rel="prev" title="TRANSMITTER" href="transmitter.html" />
<link rel="next" title="6. WORK-IN-PROGRESS WALK THROUGH" href="progress.html" />
<link rel="prev" title="4. TRANSMITTER" href="transmitter.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -34,9 +34,9 @@
<div class="body" role="main">
<section id="receiver">
<h1>RECEIVER<a class="headerlink" href="#receiver" title="Link to this heading"></a></h1>
<h1><span class="section-number">5. </span>RECEIVER<a class="headerlink" href="#receiver" title="Link to this heading"></a></h1>
<section id="configuration-variables">
<h2>Configuration Variables<a class="headerlink" href="#configuration-variables" title="Link to this heading"></a></h2>
<h2><span class="section-number">5.1. </span>Configuration Variables<a class="headerlink" href="#configuration-variables" title="Link to this heading"></a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">transmitter_mac</span><span class="p">[</span><span class="n">ESP_NOW_ETH_ALEN</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="mh">0x9C</span><span class="p">,</span><span class="w"> </span><span class="mh">0x9E</span><span class="p">,</span><span class="w"> </span><span class="mh">0x6E</span><span class="p">,</span><span class="w"> </span><span class="mh">0x14</span><span class="p">,</span><span class="w"> </span><span class="mh">0xB5</span><span class="p">,</span><span class="w"> </span><span class="mh">0x54</span><span class="p">};</span>
<span class="k">typedef</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="p">{</span>
@@ -61,7 +61,7 @@
</div>
</section>
<section id="receiving-extracting-data">
<h2>Receiving &amp; Extracting Data<a class="headerlink" href="#receiving-extracting-data" title="Link to this heading"></a></h2>
<h2><span class="section-number">5.2. </span>Receiving &amp; Extracting Data<a class="headerlink" href="#receiving-extracting-data" title="Link to this heading"></a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span><span class="w"> </span><span class="nf">onDataReceived</span><span class="w"> </span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">mac_addr</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="o">*</span><span class="n">data</span><span class="p">,</span><span class="w"> </span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">data_len</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="p">...</span>
@@ -80,7 +80,7 @@
</div>
</section>
<section id="main-function">
<h2>Main Function<a class="headerlink" href="#main-function" title="Link to this heading"></a></h2>
<h2><span class="section-number">5.3. </span>Main Function<a class="headerlink" href="#main-function" title="Link to this heading"></a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;string.h&gt;</span>
<span class="cp">#include</span><span class="w"> </span><span class="cpf">&quot;freertos/FreeRTOS.h&quot;</span>
<span class="cp">#include</span><span class="w"> </span><span class="cpf">&quot;nvs_flash.h&quot;</span>
@@ -152,26 +152,26 @@
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">OVERVIEW</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="data.html">DATA STRUCTS</a></li>
<li class="toctree-l1"><a class="reference internal" href="transmitter.html">TRANSMITTER</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">RECEIVER</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#configuration-variables">Configuration Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="#receiving-extracting-data">Receiving &amp; Extracting Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#main-function">Main Function</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">1. OVERVIEW</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">2. HOW DOES IT WORK?</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">3. DATA STRUCTS</a></li>
<li class="toctree-l1"><a class="reference internal" href="transmitter.html">4. TRANSMITTER</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">5. RECEIVER</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#configuration-variables">5.1. Configuration Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="#receiving-extracting-data">5.2. Receiving &amp; Extracting Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#main-function">5.3. Main Function</a></li>
</ul>
</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="references.html">REFERENCES</a></li>
<li class="toctree-l1"><a class="reference internal" href="progress.html">6. WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">7. REFERENCES</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="transmitter.html" title="previous chapter">TRANSMITTER</a></li>
<li>Next: <a href="progress.html" title="next chapter">WORK-IN-PROGRESS WALK THROUGH</a></li>
<li>Previous: <a href="transmitter.html" title="previous chapter"><span class="section-number">4. </span>TRANSMITTER</a></li>
<li>Next: <a href="progress.html" title="next chapter"><span class="section-number">6. </span>WORK-IN-PROGRESS WALK THROUGH</a></li>
</ul></li>
</ul>
</div>

26
ESP-IDF_Robot/tutorial/docs/build/html/references.html vendored
View File

@@ -5,7 +5,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>REFERENCES &#8212; Byte Rider 06-2025 documentation</title>
<title>7. REFERENCES &#8212; Byte Rider 06-2025 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
@@ -14,7 +14,7 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="WORK-IN-PROGRESS WALK THROUGH" href="progress.html" />
<link rel="prev" title="6. WORK-IN-PROGRESS WALK THROUGH" href="progress.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -33,9 +33,9 @@
<div class="body" role="main">
<section id="references">
<h1>REFERENCES<a class="headerlink" href="#references" title="Link to this heading"></a></h1>
<h1><span class="section-number">7. </span>REFERENCES<a class="headerlink" href="#references" title="Link to this heading"></a></h1>
<section id="github">
<h2>GitHub<a class="headerlink" href="#github" title="Link to this heading"></a></h2>
<h2><span class="section-number">7.1. </span>GitHub<a class="headerlink" href="#github" title="Link to this heading"></a></h2>
<p>Complete source <a class="reference external" href="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/ESP-IDF_Robot/README.md">code</a> with README.md file: <a class="reference external" href="https://github.com/alexandrebobkov/ESP-Nodes/blob/main/ESP-IDF_Robot/README.md">https://github.com/alexandrebobkov/ESP-Nodes/blob/main/ESP-IDF_Robot/README.md</a></p>
<p>KiCAd <a class="reference external" href="https://github.com/alexandrebobkov/ESP32-C3_Breadboard-Adapter">Schematic</a> and PCB design: <a class="reference external" href="https://github.com/alexandrebobkov/ESP32-C3_Breadboard-Adapter">https://github.com/alexandrebobkov/ESP32-C3_Breadboard-Adapter</a></p>
</section>
@@ -68,14 +68,14 @@
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<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="overview.html">HOW DOES IT WORK?</a></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="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="progress.html">WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">REFERENCES</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#github">GitHub</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">1. OVERVIEW</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">2. HOW DOES IT WORK?</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">3. DATA STRUCTS</a></li>
<li class="toctree-l1"><a class="reference internal" href="transmitter.html">4. TRANSMITTER</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver.html">5. RECEIVER</a></li>
<li class="toctree-l1"><a class="reference internal" href="progress.html">6. WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">7. REFERENCES</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#github">7.1. GitHub</a></li>
</ul>
</li>
</ul>
@@ -84,7 +84,7 @@
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="progress.html" title="previous chapter">WORK-IN-PROGRESS WALK THROUGH</a></li>
<li>Previous: <a href="progress.html" title="previous chapter"><span class="section-number">6. </span>WORK-IN-PROGRESS WALK THROUGH</a></li>
</ul></li>
</ul>
</div>

14
ESP-IDF_Robot/tutorial/docs/build/html/search.html vendored
View File

@@ -82,13 +82,13 @@
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">OVERVIEW</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="data.html">DATA STRUCTS</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="progress.html">WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">REFERENCES</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">1. OVERVIEW</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">2. HOW DOES IT WORK?</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">3. DATA STRUCTS</a></li>
<li class="toctree-l1"><a class="reference internal" href="transmitter.html">4. TRANSMITTER</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver.html">5. RECEIVER</a></li>
<li class="toctree-l1"><a class="reference internal" href="progress.html">6. WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">7. REFERENCES</a></li>
</ul>
<div class="relations">

42
ESP-IDF_Robot/tutorial/docs/build/html/transmitter.html vendored
View File

@@ -5,7 +5,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TRANSMITTER &#8212; Byte Rider 06-2025 documentation</title>
<title>4. TRANSMITTER &#8212; Byte Rider 06-2025 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
@@ -14,8 +14,8 @@
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="RECEIVER" href="receiver.html" />
<link rel="prev" title="DATA STRUCTS" href="data.html" />
<link rel="next" title="5. RECEIVER" href="receiver.html" />
<link rel="prev" title="3. DATA STRUCTS" href="data.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -34,9 +34,9 @@
<div class="body" role="main">
<section id="transmitter">
<h1>TRANSMITTER<a class="headerlink" href="#transmitter" title="Link to this heading"></a></h1>
<h1><span class="section-number">4. </span>TRANSMITTER<a class="headerlink" href="#transmitter" title="Link to this heading"></a></h1>
<section id="configuration-variables">
<h2>Configuration Variables<a class="headerlink" href="#configuration-variables" title="Link to this heading"></a></h2>
<h2><span class="section-number">4.1. </span>Configuration Variables<a class="headerlink" href="#configuration-variables" title="Link to this heading"></a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">uint8_t</span><span class="w"> </span><span class="n">receiver_mac</span><span class="p">[</span><span class="n">ESP_NOW_ETH_ALEN</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="mh">0xe4</span><span class="p">,</span><span class="w"> </span><span class="mh">0xb0</span><span class="p">,</span><span class="w"> </span><span class="mh">0x63</span><span class="p">,</span><span class="w"> </span><span class="mh">0x17</span><span class="p">,</span><span class="w"> </span><span class="mh">0x9e</span><span class="p">,</span><span class="w"> </span><span class="mh">0x44</span><span class="p">};</span>
<span class="k">typedef</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="p">{</span>
@@ -53,10 +53,10 @@
</div>
</section>
<section id="reading-joystick-x-and-y-axis-values">
<h2>Reading Joystick x- and y- Axis Values<a class="headerlink" href="#reading-joystick-x-and-y-axis-values" title="Link to this heading"></a></h2>
<h2><span class="section-number">4.2. </span>Reading Joystick x- and y- Axis Values<a class="headerlink" href="#reading-joystick-x-and-y-axis-values" title="Link to this heading"></a></h2>
</section>
<section id="sending-ecapsulating-data">
<h2>Sending &amp; Ecapsulating Data<a class="headerlink" href="#sending-ecapsulating-data" title="Link to this heading"></a></h2>
<h2><span class="section-number">4.3. </span>Sending &amp; Ecapsulating Data<a class="headerlink" href="#sending-ecapsulating-data" title="Link to this heading"></a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span><span class="w"> </span><span class="nf">sendData</span><span class="w"> </span><span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="p">...</span><span class="w"> </span><span class="p">...</span>
@@ -75,7 +75,7 @@
</div>
</section>
<section id="main-function">
<h2>Main Function<a class="headerlink" href="#main-function" title="Link to this heading"></a></h2>
<h2><span class="section-number">4.4. </span>Main Function<a class="headerlink" href="#main-function" title="Link to this heading"></a></h2>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="cp">#include</span><span class="w"> </span><span class="cpf">&quot;freertos/FreeRTOS.h&quot;</span>
<span class="cp">#include</span><span class="w"> </span><span class="cpf">&quot;nvs_flash.h&quot;</span>
<span class="cp">#include</span><span class="w"> </span><span class="cpf">&quot;esp_err.h&quot;</span>
@@ -138,27 +138,27 @@
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">OVERVIEW</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="data.html">DATA STRUCTS</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">TRANSMITTER</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#configuration-variables">Configuration Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="#reading-joystick-x-and-y-axis-values">Reading Joystick x- and y- Axis Values</a></li>
<li class="toctree-l2"><a class="reference internal" href="#sending-ecapsulating-data">Sending &amp; Ecapsulating Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#main-function">Main Function</a></li>
<li class="toctree-l1"><a class="reference internal" href="intro.html">1. OVERVIEW</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">2. HOW DOES IT WORK?</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">3. DATA STRUCTS</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">4. TRANSMITTER</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#configuration-variables">4.1. Configuration Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="#reading-joystick-x-and-y-axis-values">4.2. Reading Joystick x- and y- Axis Values</a></li>
<li class="toctree-l2"><a class="reference internal" href="#sending-ecapsulating-data">4.3. Sending &amp; Ecapsulating Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#main-function">4.4. Main Function</a></li>
</ul>
</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="references.html">REFERENCES</a></li>
<li class="toctree-l1"><a class="reference internal" href="receiver.html">5. RECEIVER</a></li>
<li class="toctree-l1"><a class="reference internal" href="progress.html">6. WORK-IN-PROGRESS WALK THROUGH</a></li>
<li class="toctree-l1"><a class="reference internal" href="references.html">7. REFERENCES</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="data.html" title="previous chapter">DATA STRUCTS</a></li>
<li>Next: <a href="receiver.html" title="next chapter">RECEIVER</a></li>
<li>Previous: <a href="data.html" title="previous chapter"><span class="section-number">3. </span>DATA STRUCTS</a></li>
<li>Next: <a href="receiver.html" title="next chapter"><span class="section-number">5. </span>RECEIVER</a></li>
</ul></li>
</ul>
</div>