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-09-15 18:15:49 +00:00
parent 7682653588
commit 87e87c3ff2
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/_sources/intro.rst.txt
View File

@ -3,7 +3,7 @@
Getting started Getting started
=============== ===============
First you need a completed iSpindle hardware, there are several resouces around that topic so it 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 `iSpindel Homepage <https://www.ispindel.de>`_ for will not be covered in this documentation. Please visit `iSpindel Homepage <https://www.ispindel.de>`_ for
more information. more information.
@ -29,7 +29,7 @@ Step 3 - Configuration
---------------------- ----------------------
Once the device can connect to WIFI it will go into `configuration mode` and start a web server for Once the device can connect to WIFI it will go into `configuration mode` 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 adress. doing the initial configuration. In order to access the device you will need to find its name or ip address.
It will broadcast a name like gravitymonXXXXXX.local over mDNS. Where the XXXXXX is the unique device id. You can 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 find the name via an mDNS browser, check your router or connect the device to a serial monitor. On windows mDNS
@ -50,7 +50,7 @@ Configuration - Device Settings - Gyro Calibration
++++++++++++++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++++++++++++++
You need to place the device on a flat surface and then press the 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 degress. Without 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. calibration the device will not go into gravity mode.
Configuration - Push Settings Configuration - Push Settings
@ -65,7 +65,7 @@ previous calibration then you can add them here, if not follow the calibration g
There are several guides for how to calibrate the device (`iSpindle Calibration <https://www.ispindel.de/docs/Calibration_en.html>`_) There are several guides for how to calibrate the device (`iSpindle Calibration <https://www.ispindel.de/docs/Calibration_en.html>`_)
This will get the data points needed to create the formula, and the datapoints will be stored on the device so you can 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. adjust them when needed.
Step 4 - Completed Step 4 - Completed

8
docs/intro.html
View File

@ -199,7 +199,7 @@
<article role="main"> <article role="main">
<div class="section" id="getting-started"> <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> <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 resouces around that topic so it <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 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> more information.</p>
<div class="section" id="step-1-flash-the-device"> <div class="section" id="step-1-flash-the-device">
@ -221,7 +221,7 @@ and <a class="reference external" href="https://code.jquery.com">https://code.jq
<div class="section" id="step-3-configuration"> <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> <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 <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 adress.</p> 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 <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 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> might not work so then use the IP address instead. Once connected you will meet a web interface that looks like this.</p>
@ -234,7 +234,7 @@ might not work so then use the IP address instead. Once connected you will meet
<div class="section" id="configuration-device-settings-gyro-calibration"> <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> <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 <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 degress. Without 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> calibration the device will not go into gravity mode.</p>
</div> </div>
<div class="section" id="configuration-push-settings"> <div class="section" id="configuration-push-settings">
@ -246,7 +246,7 @@ calibration the device will not go into gravity mode.</p>
<p>I recommend to use the calibration feature to create a gravity formula. If you have values from a <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> 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>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 datapoints will be stored on the device so you can <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> adjust them when needed.</p>
</div> </div>
</div> </div>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long