412 lines
17 KiB
HTML
412 lines
17 KiB
HTML
<!doctype html>
|
||
<html class="no-js">
|
||
<head><meta charset="utf-8"/>
|
||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||
<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="Setting up device" href="configuration.html" />
|
||
|
||
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
||
<title>Compiling the software - GravityMon 0.6.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/styles/furo-extensions.css?digest=fade93df149f7c5fedb3ff897f799dc7d283b420" />
|
||
|
||
|
||
|
||
|
||
<style>
|
||
body {
|
||
--color-code-background: #f8f8f8;
|
||
--color-code-foreground: black;
|
||
|
||
}
|
||
body[data-theme="dark"] {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
@media (prefers-color-scheme: dark) {
|
||
body:not([data-theme="light"]) {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
}
|
||
</style></head>
|
||
<body>
|
||
<script>
|
||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||
</script>
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||
<title>Contents</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round">
|
||
<path stroke="none" d="M0 0h24v24H0z" />
|
||
<line x1="4" y1="6" x2="20" y2="6" />
|
||
<line x1="10" y1="12" x2="20" y2="12" />
|
||
<line x1="6" y1="18" x2="20" y2="18" />
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||
<title>Menu</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||
<title>Expand</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||
<polyline points="9 18 15 12 9 6"></polyline>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||
<title>Light mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||
<circle cx="12" cy="12" r="5"></circle>
|
||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||
<title>Dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||
<title>Auto light/dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||
<circle cx="12" cy="12" r="9" />
|
||
<path d="M13 12h5" />
|
||
<path d="M13 15h4" />
|
||
<path d="M13 18h1" />
|
||
<path d="M13 9h4" />
|
||
<path d="M13 6h1" />
|
||
</svg>
|
||
</symbol>
|
||
</svg>
|
||
|
||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||
<label class="overlay sidebar-overlay" for="__navigation">
|
||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||
</label>
|
||
<label class="overlay toc-overlay" for="__toc">
|
||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||
</label>
|
||
|
||
|
||
|
||
<div class="page">
|
||
<header class="mobile-header">
|
||
<div class="header-left">
|
||
<label class="nav-overlay-icon" for="__navigation">
|
||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<div class="header-center">
|
||
<a href="index.html"><div class="brand">GravityMon 0.6.0 documentation</div></a>
|
||
</div>
|
||
<div class="header-right">
|
||
<div class="theme-toggle-container theme-toggle-header">
|
||
<button class="theme-toggle">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
</header>
|
||
<aside class="sidebar-drawer">
|
||
<div class="sidebar-container">
|
||
|
||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||
|
||
|
||
<span class="sidebar-brand-text">GravityMon 0.6.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">
|
||
<input type="hidden" name="check_keywords" value="yes">
|
||
<input type="hidden" name="area" value="default">
|
||
</form>
|
||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="license.html">Licence</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="functionallity.html">Functionallity</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="configuration.html">Setting up device</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="configuration.html#create-formula">Create formula</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="configuration.html#rest-api">REST API</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="configuration.html#data-formats">Data Formats</a></li>
|
||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">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="q_and_a.html">Q & A</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="backlog.html">Backlog of changes</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</aside>
|
||
<div class="main">
|
||
<div class="content">
|
||
<div class="article-container">
|
||
<div class="content-icon-container">
|
||
<div class="theme-toggle-container theme-toggle-content">
|
||
<button class="theme-toggle">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<article role="main">
|
||
<div class="section" id="compiling-the-software">
|
||
<span id="id1"></span><h1>Compiling the software<a class="headerlink" href="#compiling-the-software" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="tools">
|
||
<h2>Tools<a class="headerlink" href="#tools" title="Permalink to this headline">¶</a></h2>
|
||
<p>I use the following tools in order to build and manage the software:</p>
|
||
<ul class="simple">
|
||
<li><p>Visual Studio Code</p></li>
|
||
<li><p>PlatformIO</p></li>
|
||
<li><p>Git for Windows</p></li>
|
||
<li><p>VSCode plugin: Minify (used to minimise the html files)</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="code-formatting">
|
||
<h2>Code Formatting<a class="headerlink" href="#code-formatting" title="Permalink to this headline">¶</a></h2>
|
||
<p>I use pre-commit and their cpp style checks to validate the code. Plugin defintions are found in <strong>.pre-commit-config.yaml</strong></p>
|
||
<p><a class="reference external" href="https://www.pre-commit.com">Pre-Commit</a></p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>There is not yet any automatic checks since this does not work on Windows. It works if running under WSL2 with Ubuntu.</p>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="targets">
|
||
<h2>Targets<a class="headerlink" href="#targets" title="Permalink to this headline">¶</a></h2>
|
||
<p>In the platformio config there are 3 targets defined</p>
|
||
<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>
|
||
</ul>
|
||
<div class="admonition warning">
|
||
<p class="admonition-title">Warning</p>
|
||
<p>The debug target can be unsable and crash the device under certain circumstanses.
|
||
Excessive logging to the serial port can cause corruption and crashes. I’m still
|
||
trying to figure out what causes these issues in the debug target. Other targets are
|
||
stable and works fine.</p>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="source-structure">
|
||
<h2>Source structure<a class="headerlink" href="#source-structure" title="Permalink to this headline">¶</a></h2>
|
||
<div class="table-wrapper"><table class="colwidths-given docutils align-default" id="id2">
|
||
<caption><span class="caption-text">Directory structure</span><a class="headerlink" href="#id2" title="Permalink to this table">¶</a></caption>
|
||
<colgroup>
|
||
<col style="width: 40%"/>
|
||
<col style="width: 60%"/>
|
||
</colgroup>
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>path</p></th>
|
||
<th class="head"><p>content</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p>/bin</p></td>
|
||
<td><p>Contains compiled binaries</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>/data</p></td>
|
||
<td><p>Directory for flashing device filesystem</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>/doc</p></td>
|
||
<td><p>Various external documents used as input</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>/html</p></td>
|
||
<td><p>Source for html files</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>/img</p></td>
|
||
<td><p>Images uses in README.md</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>/lib</p></td>
|
||
<td><p>External libraries used when compiling</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>/script</p></td>
|
||
<td><p>Scripts used in build process</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>/src</p></td>
|
||
<td><p>Source code for software</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>/src_docs</p></td>
|
||
<td><p>Source code for documentation</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>/stl</p></td>
|
||
<td><p>3d models</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>/test</p></td>
|
||
<td><p>Test data for developing html files</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="section" id="options">
|
||
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
|
||
<p>This is a list of C++ defines that is used to enable/disable functions in the code.</p>
|
||
<div class="table-wrapper"><table class="colwidths-given docutils align-default" id="id3">
|
||
<caption><span class="caption-text">Defines</span><a class="headerlink" href="#id3" title="Permalink to this table">¶</a></caption>
|
||
<colgroup>
|
||
<col style="width: 40%"/>
|
||
<col style="width: 60%"/>
|
||
</colgroup>
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>define</p></th>
|
||
<th class="head"><p>description</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><p>ACTIVATE_OTA</p></td>
|
||
<td><p>Enables the OTA functionallity in the code</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>SKIP_SLEEPMODE</p></td>
|
||
<td><p>THe device never goes into sleep mode, useful when developing.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>CFG_DISABLE_LOGGING</p></td>
|
||
<td><p>Done include verbose logging in Config class. Excessive logging may crash device.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>GYRO_DISABLE_LOGGING</p></td>
|
||
<td><p>Done include verbose logging in Gyro class. Excessive logging may crash device.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>PUSH_DISABLE_LOGGING</p></td>
|
||
<td><p>Done include verbose logging in PushTarget class. Excessive logging may crash device.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>TSEN_DISABLE_LOGGING</p></td>
|
||
<td><p>Done include verbose logging in TempSensor class. Excessive logging may crash device.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>WEB_DISABLE_LOGGING</p></td>
|
||
<td><p>Done include verbose logging in WebServer class. Excessive logging may crash device.</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>MAIN_DISABLE_LOGGING</p></td>
|
||
<td><p>Done include verbose logging in Main class. Excessive logging may crash device.</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>USE_LITTLEFS</p></td>
|
||
<td><p>Use the new filesystem in Ardurino</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><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-even"><td><p>USER_SSID</p></td>
|
||
<td><p>If defined the device will always use this SSID</p></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><p>USER_SSID_PWD</p></td>
|
||
<td><p>Password to the SSID</p></td>
|
||
</tr>
|
||
<tr class="row-even"><td><p>CFG_APPVER</p></td>
|
||
<td><p>Defines the version of the compiled software</p></td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
|
||
</article>
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="related-pages">
|
||
<a class="next-page" href="contributing.html">
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Next</span>
|
||
</div>
|
||
<div class="title">Contributing</div>
|
||
</div>
|
||
<svg><use href="#svg-arrow-right"></use></svg>
|
||
</a>
|
||
<a class="prev-page" href="configuration.html">
|
||
<svg><use href="#svg-arrow-right"></use></svg>
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Previous</span>
|
||
</div>
|
||
|
||
<div class="title">Setting up device</div>
|
||
|
||
</div>
|
||
</a>
|
||
</div>
|
||
|
||
<div class="related-information">
|
||
Copyright © 2021-2022, Magnus Persson |
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||
<a href="https://github.com/pradyunsg/furo">Furo theme</a>.
|
||
</div>
|
||
|
||
</footer>
|
||
</div>
|
||
<aside class="toc-drawer">
|
||
|
||
|
||
<div class="toc-sticky toc-scroll">
|
||
<div class="toc-title-container">
|
||
<span class="toc-title">
|
||
Contents
|
||
</span>
|
||
</div>
|
||
<div class="toc-tree-container">
|
||
<div class="toc-tree">
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Compiling the software</a><ul>
|
||
<li><a class="reference internal" href="#tools">Tools</a></li>
|
||
<li><a class="reference internal" href="#code-formatting">Code Formatting</a></li>
|
||
<li><a class="reference internal" href="#targets">Targets</a></li>
|
||
<li><a class="reference internal" href="#source-structure">Source structure</a></li>
|
||
<li><a class="reference internal" href="#options">Options</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</aside>
|
||
</div>
|
||
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/scripts/furo.js"></script>
|
||
</body>
|
||
</html> |