Brewery/gravitymon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'docs' into ghactions

Browse Source
This commit is contained in:
Magnus Persson 2022-01-08 00:37:34 +01:00
commit fdd04bc19a
11 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/_sources/backlog.rst.txt
View File

@ -4,7 +4,6 @@ Backlog of changes
Documentation
-------------
- Updates over OTA (from PC)
- Write contribution instructions
Code

4
docs/_sources/installation.rst.txt
View File

@ -7,9 +7,9 @@ Official esptool
The prefered option for flashing esp8266 device is via the official esptool. Documentation can be found
here; https://docs.espressif.com/projects/esptool/en/latest/esp32/
The basic command for flashing is;
The basic command for flashing on Windows is;
``esptool.py --port COM4 write_flash 0x1000 firmware.bin``
``esptool.py --port COM4 write_flash 0x0 firmware.bin``
In the /bin directory you will find 3 different firmware builds;

1
docs/backlog.html
View File

@ -80,7 +80,6 @@
<section id="documentation">
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Updates over OTA (from PC)</p></li>
<li><p>Write contribution instructions</p></li>
</ul>
</section>

1
docs/configuration.html
View File

@ -77,7 +77,6 @@
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
<li class="toctree-l1"><a class="reference internal" href="backlog.html#header-1">Header 1</a></li>
</ul>
</div>

4
docs/installation.html
View File

@ -82,8 +82,8 @@
<h2>Official esptool<a class="headerlink" href="#official-esptool" title="Permalink to this headline"></a></h2>
<p>The prefered option for flashing esp8266 device is via the official esptool. Documentation can be found
here; <a class="reference external" href="https://docs.espressif.com/projects/esptool/en/latest/esp32/">https://docs.espressif.com/projects/esptool/en/latest/esp32/</a></p>
<p>The basic command for flashing is;</p>
<p><code class="docutils literal notranslate"><span class="pre">esptool.py</span> <span class="pre">--port</span> <span class="pre">COM4</span> <span class="pre">write_flash</span> <span class="pre">0x1000</span> <span class="pre">firmware.bin</span></code></p>
<p>The basic command for flashing on Windows is;</p>
<p><code class="docutils literal notranslate"><span class="pre">esptool.py</span> <span class="pre">--port</span> <span class="pre">COM4</span> <span class="pre">write_flash</span> <span class="pre">0x0</span> <span class="pre">firmware.bin</span></code></p>
<p>In the /bin directory you will find 3 different firmware builds;</p>
<ul>
<li><p><strong>firmware.bin</strong></p>

1
docs/releases.html
View File

@ -50,7 +50,6 @@
<li class="toctree-l1"><a class="reference internal" href="compiling.html">Compiling the software</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
<li class="toctree-l1"><a class="reference internal" href="backlog.html#header-1">Header 1</a></li>
</ul>
</div>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

1
src_docs/source/backlog.rst
View File

@ -4,7 +4,6 @@ Backlog of changes
Documentation
-------------
- Updates over OTA (from PC)
- Write contribution instructions
Code

14
src_docs/source/functionallity.rst
View File

@ -73,3 +73,17 @@ Experimental features
*See the compile section for more information.*
Typical performance
-------------------
Since I have the possibility to measaure the performance of different function in the code this is what I have been able to gather.
The typical runtime in a measurement cycle is approx 2 seconds and in some cases it can take up to 6-8 seconds but this is mainly related to establishing the WIFI connection. So stable wifi is
essential for long batterylife. Out of the 2 seconds of run-time the major time is spent on gyro readings (1.3s) and temperature measurements of (0.6s) so using the gyro sensor for measureing
temperature would reduce the total runtime with 25%. Sending data over http takes less than 100ms (on my local network) so this is not drawing much power.
The image below shows how the run-time varies over time. The pink line is the wifi connection time and this is why the time varies.
.. image:: images/perf1.png
:width: 800
:alt: Performance view

BIN
src_docs/source/images/perf1.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 85 KiB

4
src_docs/source/installation.rst
View File

@ -7,9 +7,9 @@ Official esptool
The prefered option for flashing esp8266 device is via the official esptool. Documentation can be found
here; https://docs.espressif.com/projects/esptool/en/latest/esp32/
The basic command for flashing is;
The basic command for flashing on Windows is;
``esptool.py --port COM4 write_flash 0x1000 firmware.bin``
``esptool.py --port COM4 write_flash 0x0 firmware.bin``
In the /bin directory you will find 3 different firmware builds;