343 lines
18 KiB
HTML
343 lines
18 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="Installation" href="installation.html" /><link rel="prev" title="Functionality" href="functionality.html" />
|
|
|
|
<meta name="generator" content="sphinx-4.3.2, furo 2022.01.02"/>
|
|
<title>Getting started - GravityMon v1.2.0</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" />
|
|
|
|
|
|
|
|
|
|
<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 v1.2.0</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 centered" href="index.html">
|
|
|
|
<div class="sidebar-logo-container">
|
|
<img class="sidebar-logo" src="_static/gravitymon_logo.png" alt="Logo"/>
|
|
</div>
|
|
|
|
<span class="sidebar-brand-text">GravityMon v1.2.0</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="functionality.html">Functionality</a></li>
|
|
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Getting started</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">Configuration</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="hardware.html">Hardware</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="formula.html">Create formula</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="services.html">Service Integration</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced Configuration</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="api.html">REST API</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="data.html">Data Formats</a></li>
|
|
<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="license.html">Licence</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="q_and_a.html">Q & A</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="getting-started">
|
|
<span id="id1"></span><h1>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h1>
|
|
<p>First you need a completed iSpindle hardware, there are several resources around that topic so it
|
|
will not be covered in this documentation. Please visit <a class="reference external" href="https://www.ispindel.de">iSpindel Homepage</a> for
|
|
more information.</p>
|
|
<div class="section" id="step-1-flash-the-device">
|
|
<h2>Step 1 - Flash the device<a class="headerlink" href="#step-1-flash-the-device" title="Permalink to this headline">¶</a></h2>
|
|
<p>The first step is to flash the firmware, I recommend using Brewflasher as the easy option. Detailed
|
|
instructions can be found here <a class="reference internal" href="installation.html#installation"><span class="std std-ref">Installation</span></a></p>
|
|
</div>
|
|
<div class="section" id="step-2-setup-wifi">
|
|
<h2>Step 2 - Setup WIFI<a class="headerlink" href="#step-2-setup-wifi" title="Permalink to this headline">¶</a></h2>
|
|
<p>When the device starts up the first time it will first start an WIFI access point so that the WIFI Settings
|
|
can be configured. The instructions for that can be found here <a class="reference internal" href="installation.html#setup-wifi"><span class="std std-ref">Configuring WIFI</span></a></p>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Note</p>
|
|
<p>Since the user interface is built using modern frameworks the device requires access to the internet
|
|
for the UI to render and data to be populated. The sites that are needed are; <a class="reference external" href="https://cdn.jsdelivr.net/npm/bootstrap">https://cdn.jsdelivr.net/npm/bootstrap</a>
|
|
and <a class="reference external" href="https://code.jquery.com">https://code.jquery.com</a></p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="step-3-configuration">
|
|
<h2>Step 3 - Configuration<a class="headerlink" href="#step-3-configuration" title="Permalink to this headline">¶</a></h2>
|
|
<p>Once the device can connect to WIFI it will go into <cite>configuration mode</cite> and start a web server for
|
|
doing the initial configuration. In order to access the device you will need to find its name or ip address.</p>
|
|
<p>It will broadcast a name like gravitymonXXXXXX.local over mDNS. Where the XXXXXX is the unique device id. You can
|
|
find the name via an mDNS browser, check your router or connect the device to a serial monitor. On windows mDNS
|
|
might not work so then use the IP address instead. Once connected you will meet a web interface that looks like this.</p>
|
|
<a class="reference internal image-reference" href="_images/index.png"><img alt="Index page" src="_images/index.png" style="width: 800px;"/></a>
|
|
<p>The next step is then to configure the device, most settings should work but there are a few that should be changed.</p>
|
|
<div class="section" id="configuration-device-settings-device-name">
|
|
<h3>Configuration - Device Settings - Device Name<a class="headerlink" href="#configuration-device-settings-device-name" title="Permalink to this headline">¶</a></h3>
|
|
<p>Give your device a good name.</p>
|
|
</div>
|
|
<div class="section" id="configuration-device-settings-gyro-calibration">
|
|
<h3>Configuration - Device Settings - Gyro Calibration<a class="headerlink" href="#configuration-device-settings-gyro-calibration" title="Permalink to this headline">¶</a></h3>
|
|
<p>You need to place the device on a flat surface and then press the
|
|
calibrate button. It will take a few seconds for this to complete and the angle should be close to 90 degrees. Without
|
|
calibration the device will not go into gravity mode.</p>
|
|
</div>
|
|
<div class="section" id="configuration-push-settings">
|
|
<h3>Configuration - Push Settings<a class="headerlink" href="#configuration-push-settings" title="Permalink to this headline">¶</a></h3>
|
|
<p>Add the endpoints where you want data to be transmitted. All URLs that contain a valid endpoint will receive the data.</p>
|
|
</div>
|
|
<div class="section" id="calibration">
|
|
<h3>Calibration<a class="headerlink" href="#calibration" title="Permalink to this headline">¶</a></h3>
|
|
<p>I recommend to use the calibration feature to create a gravity formula. If you have values from a
|
|
previous calibration then you can add them here, if not follow the calibration guidelines on the iSpindle site.</p>
|
|
<p>There are several guides for how to calibrate the device (<a class="reference external" href="https://www.ispindel.de/docs/Calibration_en.html">iSpindle Calibration</a>)</p>
|
|
<p>This will get the data points needed to create the formula, and the data points will be stored on the device so you can
|
|
adjust them when needed.</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="step-4-completed">
|
|
<h2>Step 4 - Completed<a class="headerlink" href="#step-4-completed" title="Permalink to this headline">¶</a></h2>
|
|
<p>You are now done and can enjoy the GravityMon software. Check out the <a class="reference internal" href="configuration.html#setting-up-device"><span class="std std-ref">Configuration</span></a> section for other configuration options.</p>
|
|
<p>If you want to enter the configuration mode place the device flat on a surface and do a reset (or wait until it wakes up).
|
|
Its recommended to attach the device to power when you have it in <cite>configuration mode</cite> so the battery is not drained.</p>
|
|
<p><strong>If you have suggestions for more awesome features, head over to the github repository and make a request.</strong></p>
|
|
</div>
|
|
</div>
|
|
|
|
</article>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="related-pages">
|
|
<a class="next-page" href="installation.html">
|
|
<div class="page-info">
|
|
<div class="context">
|
|
<span>Next</span>
|
|
</div>
|
|
<div class="title">Installation</div>
|
|
</div>
|
|
<svg><use href="#svg-arrow-right"></use></svg>
|
|
</a>
|
|
<a class="prev-page" href="functionality.html">
|
|
<svg><use href="#svg-arrow-right"></use></svg>
|
|
<div class="page-info">
|
|
<div class="context">
|
|
<span>Previous</span>
|
|
</div>
|
|
|
|
<div class="title">Functionality</div>
|
|
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<div class="related-information">
|
|
Copyright © 2021-2023, 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="#">Getting started</a><ul>
|
|
<li><a class="reference internal" href="#step-1-flash-the-device">Step 1 - Flash the device</a></li>
|
|
<li><a class="reference internal" href="#step-2-setup-wifi">Step 2 - Setup WIFI</a></li>
|
|
<li><a class="reference internal" href="#step-3-configuration">Step 3 - Configuration</a><ul>
|
|
<li><a class="reference internal" href="#configuration-device-settings-device-name">Configuration - Device Settings - Device Name</a></li>
|
|
<li><a class="reference internal" href="#configuration-device-settings-gyro-calibration">Configuration - Device Settings - Gyro Calibration</a></li>
|
|
<li><a class="reference internal" href="#configuration-push-settings">Configuration - Push Settings</a></li>
|
|
<li><a class="reference internal" href="#calibration">Calibration</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#step-4-completed">Step 4 - Completed</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>
|
|
<script src="_static/clipboard.min.js"></script>
|
|
<script src="_static/copybutton.js"></script>
|
|
</body>
|
|
</html> |