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

Update documentation

Browse Source
This commit is contained in:
GitHub Action
2022-10-18 17:33:47 +00:00
parent fc0886d386
commit 4df4391333
40 changed files with 767 additions and 191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/compiling.html
View File

@ -5,9 +5,10 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Contributing" href="contributing.html" /><link rel="prev" title="Data Formats" href="data.html" />
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
<title>Compiling the software - GravityMon 1.1.0 documentation</title>
<title>Compiling the software - GravityMon 1.2.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=df49af52631e7917044a9c21a57f7b83170a6dd0" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=fade93df149f7c5fedb3ff897f799dc7d283b420" />
@ -122,7 +123,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">GravityMon 1.1.0 documentation</div></a>
<a href="index.html"><div class="brand">GravityMon 1.2.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
@ -145,7 +146,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">GravityMon 1.1.0 documentation</span>
<span class="sidebar-brand-text">GravityMon 1.2.0 documentation</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@ -224,16 +225,10 @@
<ul class="simple">
<li><p>gravity-debug; Maximum logging for trouble shooting, deep sleep is disabled.</p></li>
<li><p>gravity-release; Standard release</p></li>
<li><p>gravity-perf; Standard release but contains code for measuring performance.</p></li>
<li><p>gravity32-release: Version for ESP32.</p></li>
<li><p>gravity32-perf: Version for ESP32 but contains code for measuring performance.</p></li>
<li><p>gravity32-release: Version for ESP32 mini.</p></li>
<li><p>gravity32-c3-release: Version for ESP32 C3 mini.</p></li>
<li><p>gravity32-s2-release: Version for ESP32 S2 mini.</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>There is an experimental ESP32 target but since platformio only supports SDK 1.0.6 and the WIFI connection is really slow compared to ESP8266,
so the recommendation is to wait for support on 2.0.x branch. With the tested version an wifi connection takes 3-8s on a ESP32 compared
to 0.5s on an ESP8266. There is also a bug in OneWire connected to ESP32 that has not been fixed in the main repository yet.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>The debug target can be unstable and crash the device under certain circumstanses. Excessive logging to the serial port can cause corruption and crashes.
@ -314,16 +309,13 @@ So only enable enough debugging to troubleshoot your changes.</p>
<tr class="row-odd"><td><p>USE_LITTLEFS</p></td>
<td><p>Use the new filesystem in Ardurino</p></td>
</tr>
<tr class="row-even"><td><p>EMBED_HTML</p></td>
<td><p>Html files are included in code, if not defined they are served from the file system.</p></td>
</tr>
<tr class="row-odd"><td><p>USER_SSID</p></td>
<tr class="row-even"><td><p>USER_SSID</p></td>
<td><p>If defined the device will always use this SSID</p></td>
</tr>
<tr class="row-even"><td><p>USER_SSID_PWD</p></td>
<tr class="row-odd"><td><p>USER_SSID_PWD</p></td>
<td><p>Password to the SSID</p></td>
</tr>
<tr class="row-odd"><td><p>CFG_APPVER</p></td>
<tr class="row-even"><td><p>CFG_APPVER</p></td>
<td><p>Defines the version of the compiled software</p></td>
</tr>
</tbody>
@ -400,5 +392,7 @@ So only enable enough debugging to troubleshoot your changes.</p>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/scripts/furo.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
</body>
</html>