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

manual

Browse Source
This commit is contained in:
Alex B.
2025-07-05 18:42:27 -04:00
parent 644e3e2143
commit 56a4576ef7
8 changed files with 78 additions and 13 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/transmitter.doctree vendored
View File

Binary file not shown.

21
ESP-IDF_Robot/tutorial/docs/build/html/_sources/transmitter.rst.txt vendored
View File

@@ -1,8 +1,25 @@
TRANSMITTER
===========
Data Encapsulation
------------------
Configuration Variables
-----------------------
.. code-block:: c
uint8_t receiver_mac[ESP_NOW_ETH_ALEN] = {0xe4, 0xb0, 0x63, 0x17, 0x9e, 0x44};
Receiving De-Ecapsulating Data
------------------------------
.. code-block:: c
void onDataReceived (const uint8_t *mac_addr, const uint8_t *data, uint8_t data_len) {
ESP_LOGI(TAG, "Data received from: %02x:%02x:%02x:%02x:%02x:%02x, len=%d", mac_addr[0], mac_addr[1], mac_addr[2], mac_addr[3], mac_addr[4], mac_addr[5], data_len);
memcpy(&buf, data, sizeof(buf));
x_axis = buf.x_axis;
y_axis = buf.y_axis
}
Main Function
-------------

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

@@ -49,7 +49,8 @@
</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#data-encapsulation">Data Encapsulation</a></li>
<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#receiving-de-ecapsulating-data">Receiving De-Ecapsulating Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="transmitter.html#main-function">Main Function</a></li>
</ul>
</li>

2
ESP-IDF_Robot/tutorial/docs/build/html/searchindex.js vendored
View File

File diff suppressed because one or more lines are too long

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

@@ -35,8 +35,23 @@
<section id="transmitter">
<h1>TRANSMITTER<a class="headerlink" href="#transmitter" title="Link to this heading"></a></h1>
<section id="data-encapsulation">
<h2>Data Encapsulation<a class="headerlink" href="#data-encapsulation" title="Link to this heading"></a></h2>
<section id="configuration-variables">
<h2>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>
</pre></div>
</div>
</section>
<section id="receiving-de-ecapsulating-data">
<h2>Receiving De-Ecapsulating Data<a class="headerlink" href="#receiving-de-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">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="n">ESP_LOGI</span><span class="p">(</span><span class="n">TAG</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;Data received from: %02x:%02x:%02x:%02x:%02x:%02x, len=%d&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">mac_addr</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span><span class="w"> </span><span class="n">mac_addr</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span><span class="w"> </span><span class="n">mac_addr</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span><span class="w"> </span><span class="n">mac_addr</span><span class="p">[</span><span class="mi">3</span><span class="p">],</span><span class="w"> </span><span class="n">mac_addr</span><span class="p">[</span><span class="mi">4</span><span class="p">],</span><span class="w"> </span><span class="n">mac_addr</span><span class="p">[</span><span class="mi">5</span><span class="p">],</span><span class="w"> </span><span class="n">data_len</span><span class="p">);</span>
<span class="w"> </span><span class="n">memcpy</span><span class="p">(</span><span class="o">&amp;</span><span class="n">buf</span><span class="p">,</span><span class="w"> </span><span class="n">data</span><span class="p">,</span><span class="w"> </span><span class="k">sizeof</span><span class="p">(</span><span class="n">buf</span><span class="p">));</span>
<span class="w"> </span><span class="n">x_axis</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">buf</span><span class="p">.</span><span class="n">x_axis</span><span class="p">;</span>
<span class="w"> </span><span class="n">y_axis</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">buf</span><span class="p">.</span><span class="n">y_axis</span>
<span class="p">}</span>
</pre></div>
</div>
</section>
<section id="main-function">
<h2>Main Function<a class="headerlink" href="#main-function" title="Link to this heading"></a></h2>
@@ -96,7 +111,8 @@
<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 current"><a class="current reference internal" href="#">TRANSMITTER</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#data-encapsulation">Data Encapsulation</a></li>
<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-de-ecapsulating-data">Receiving De-Ecapsulating Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#main-function">Main Function</a></li>
</ul>
</li>

2
ESP-IDF_Robot/tutorial/docs/build/simplepdf/.buildinfo vendored
View File

@@ -1,4 +1,4 @@
# 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.
config: de8c605d22cabaea60d5c70fb28ac570
config: 2c1beef841b2696feb9d0e5b3c7f6dd8
tags: 62a1e7829a13fc7881b6498c52484ec0

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

@@ -105,8 +105,13 @@
</a>
<ul>
<li class="toctree-l2">
<a class="reference internal" href="#data-encapsulation">
Data Encapsulation
<a class="reference internal" href="#configuration-variables">
Configuration Variables
</a>
</li>
<li class="toctree-l2">
<a class="reference internal" href="#receiving-de-ecapsulating-data">
Receiving De-Ecapsulating Data
</a>
</li>
<li class="toctree-l2">
@@ -767,13 +772,39 @@ This enables fine-grained speed control, supports differential drive configurati
&para;
</a>
</h2>
<section id="data-encapsulation">
<section id="configuration-variables">
<h3>
Data Encapsulation
<a class="headerlink" href="#data-encapsulation" title="Link to this heading">
Configuration Variables
<a class="headerlink" href="#configuration-variables" title="Link to this heading">
&para;
</a>
</h3>
<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>
</pre>
</div>
</div>
</section>
<section id="receiving-de-ecapsulating-data">
<h3>
Receiving De-Ecapsulating Data
<a class="headerlink" href="#receiving-de-ecapsulating-data" title="Link to this heading">
&para;
</a>
</h3>
<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="n">ESP_LOGI</span><span class="p">(</span><span class="n">TAG</span><span class="p">,</span><span class="w"> </span><span class="s">"Data received from: %02x:%02x:%02x:%02x:%02x:%02x, len=%d"</span><span class="p">,</span><span class="w"> </span><span class="n">mac_addr</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span><span class="w"> </span><span class="n">mac_addr</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span><span class="w"> </span><span class="n">mac_addr</span><span class="p">[</span><span class="mi">2</span><span class="p">],</span><span class="w"> </span><span class="n">mac_addr</span><span class="p">[</span><span class="mi">3</span><span class="p">],</span><span class="w"> </span><span class="n">mac_addr</span><span class="p">[</span><span class="mi">4</span><span class="p">],</span><span class="w"> </span><span class="n">mac_addr</span><span class="p">[</span><span class="mi">5</span><span class="p">],</span><span class="w"> </span><span class="n">data_len</span><span class="p">);</span>
<span class="w"> </span><span class="n">memcpy</span><span class="p">(</span><span class="o">&amp;</span><span class="n">buf</span><span class="p">,</span><span class="w"> </span><span class="n">data</span><span class="p">,</span><span class="w"> </span><span class="k">sizeof</span><span class="p">(</span><span class="n">buf</span><span class="p">));</span>
<span class="w"> </span><span class="n">x_axis</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">buf</span><span class="p">.</span><span class="n">x_axis</span><span class="p">;</span>
<span class="w"> </span><span class="n">y_axis</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">buf</span><span class="p">.</span><span class="n">y_axis</span>
<span class="p">}</span>
</pre>
</div>
</div>
</section>
<section id="main-function">
<h3>