Update documentation

This commit is contained in:
GitHub Action 2022-12-06 20:49:49 +00:00
parent b0426b7a61
commit 788cf4d658
11 changed files with 79 additions and 113 deletions

View File

@ -30,9 +30,10 @@ In the platformio config there are 3 targets defined
* gravity-debug; Maximum logging for trouble shooting, deep sleep is disabled.
* gravity-release; Standard release
* gravity32-release: Version for ESP32 mini.
* gravity32-c3-release: Version for ESP32 C3 mini.
* gravity32-s2-release: Version for ESP32 S2 mini.
* gravity32-lite-release: Version for ESP32 lite (Floaty hardware).
* gravity32c3-release: Version for ESP32 C3 mini v2.1+.
* gravity32c3v1-release: Version for ESP32 C3 mini v1.0.
* gravity32s2-release: Version for ESP32 S2 mini.
* gravity32lite-release: Version for ESP32 lite (Floaty hardware).
.. warning::
The debug target can be unstable and crash the device under certain circumstanses. Excessive logging to the serial port can cause corruption and crashes.

View File

@ -5,8 +5,8 @@ Hardware
I'm not a hardware designer so I would recommend the following resources for more in depth information on this topic.
* `Cherry Philip Hardware design, <https://github.com/cherryphilip74/iSpindel-PCB>`_
* `OpenSource Distilling, <https://www.opensourcedistilling.com/ispindel>`_
* `Cherry Philip Hardware design <https://github.com/cherryphilip74/iSpindel-PCB>`_
* `OpenSource Distilling <https://www.opensourcedistilling.com/ispindel>`_
iSpindle based on esp8266
=========================
@ -25,24 +25,20 @@ Schema for esp8266 build
:width: 700
:alt: Schema esp8266
iSpindle based on esp32
=======================
I've experimented with porting my software version to esp32 and this is a selection of options i have been testing.
.. warning::
Work to support esp32s2 is still ongoing, ESP32-mini and ESP32c3-mini is confirmed to be working. However I would recommend the C3 variant.
Gravitymon supports a number of ESP32 boards that offers bluetooth support.
.. image:: images/esp32_hardware.jpg
:width: 500
:alt: iSpindle esp32 hardware options
* esp32 mini, this was the first board i tried which is a smaller form factor of the first generetion esp32 with 2 cores. Slow on connecting to wifi is the main downside.
* esp32c3 mini, a newer version based on the latest risc v7 architecture, is seen as the replacement for the esp8266 with bluetooth support.
* esp32d1 mini, this was the first board i tried which is a smaller form factor of the first generetion esp32 with 2 cores. Slow on connecting to wifi is the main downside.
* esp32c3 mini, a newer version based on the latest risc v7 architecture, is seen as the replacement for the esp8266 with bluetooth support. Don't buy v1.0 since that has a faulty wifi antenna.
* esp32s2 mini, similar to the c3 board but without bluetooth support.
It's possible to use this PCB and mount an ESP32 mini on top of that (c3 and s2 are prefered). The esp32 mini is a larger formfactor and can be hard to fit into the tube.
It's possible to use this PCB and mount an ESP32 mini on top of that (c3 or s2 are prefered). The esp32 d1 mini is a larger formfactor and can be hard to fit into the tube.
.. note::
You need to add a resistor between A0 (Analog PIN) and ground of 470k. The reason is that the esp8266 has a build in resistor for a voltage divider
@ -52,7 +48,7 @@ It's possible to use this PCB and mount an ESP32 mini on top of that (c3 and s2
ESP32c3 mini
++++++++++++
This is model is now fully supported by gravitymon.
This is model is fully supported by gravitymon.
.. image:: images/ispindel_esp32c3.jpg
:width: 500
@ -67,7 +63,7 @@ Here is an image of where I added the resistor for the voltage divider.
ESP32s2 mini
++++++++++++
This is model is now fully supported by gravitymon. Same setup as for ESP32C3 mini.
This is model is fully supported by gravitymon. Same setup as for ESP32C3 mini.
ESP32 d1 mini
+++++++++++++
@ -82,7 +78,7 @@ Schema for esp32 build
++++++++++++++++++++++
.. note::
This schema assumes that an ESP32 D1 Mini (pin compatible with ESP8266 D1 Mini is used). The ESP32 has two rows of pins but
This schema assumes that an ESP32 d1 mini (pin compatible with ESP8266). The ESP32 has two rows of pins but
only the inner row is used. The main difference is the added resistor R3 so we get a voltage divider for measuring battery.
The ESP8266 has a built in resistor thats not visible on the schema and this acts as a voltage divider.

View File

@ -7,7 +7,7 @@ Welcome to GravityMon
#####################
.. note::
This documentation reflects **v1.2 - beta 2**. Last updated 2022-11-19
This documentation reflects **v1.2.0**. Last updated 2022-12-06
What is GravityMon?
--------------------
@ -39,8 +39,8 @@ My approach to this software is a little different from that the original iSpind
The github repository can be found here; `GravityMon on Github <https://github.com/mp-se/gravitymon>`_
.. note::
I don't take responsibility for any errors or issues caused by the software. The software is provided as-is. I will however
try my best to fix issues that might occur.
I don't take responsibility for any errors or issues caused by the software or hardware.
The software is provided as-is. I will however try my best to fix issues that might occur.
I have tested this software on 40+ brews with good results.

View File

@ -45,8 +45,8 @@ In the /bin directory you will find 4 different firmware builds;
* **firmware32c3.bin**
This is the release build for an ESP32c3-mini variant. When flashing an ESP32 you also need the *partition32c3.bin* file that outlines the flash memory structure. Due to
the size of the firmware we are using a custom partition setup.
This is the release build for an ESP32c3-mini variant v2.1 or newer. When flashing an ESP32 you also need the *partition32c3.bin* file that outlines the flash memory structure. Due to
the size of the firmware we are using a custom partition setup. If you have a v1.0 board use the firmware32c3v1.bin instead.
* **firmware32s2.bin**

View File

@ -3,40 +3,31 @@
Releases
########
v1.2.0 - beta2
==============
v1.2.0
======
Features
++++++++
* Added function to calcualate voltage factor based on measured value.
* Updated battery estimation for the various esp32 boards.
* Added support for the ESP32 lite board which is used in the Floaty Hydrometer variant.
Documentation
+++++++++++++
* Added section about the Floaty hardware.
v1.2.0 - beta1
==============
* Changes to 1.2.0 only affect the ESP32 hardware, the ESP8266 is the same as for v1.1.1
Features
++++++++
* Added support for the ESP32 C3 mini board
* Added support for the ESP32 S2 mini board
* Serial output is written to TX/RX pins instead of the USB connection for the ESP32c3. This way the serial console can be viewed when running on battery power.
* Merged in unit tests and api tests into this project
* Added option to download firmware updates from https://www.gravitymon.com
Documentation
+++++++++++++
* Added section about the Floaty hardware
* Fixed schema errors in hardware section and linked PCB options
* Updated hardware section with options for ESP32 boards
* Updated installation instructions.
Issues adressed
++++++++++++++++
* BUG: The first portion of a format template was lost when doing conversion.
Documentation
+++++++++++++
* Updated hardware section with options for ESP32 boards
* Updated installation instructions.
v1.1.1
======
* BUG: The text before the first variable was missed in the conversion of a format template.

View File

@ -229,9 +229,10 @@
<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>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>
<li><p>gravity32-lite-release: Version for ESP32 lite (Floaty hardware).</p></li>
<li><p>gravity32c3-release: Version for ESP32 C3 mini v2.1+.</p></li>
<li><p>gravity32c3v1-release: Version for ESP32 C3 mini v1.0.</p></li>
<li><p>gravity32s2-release: Version for ESP32 S2 mini.</p></li>
<li><p>gravity32lite-release: Version for ESP32 lite (Floaty hardware).</p></li>
</ul>
<div class="admonition warning">
<p class="admonition-title">Warning</p>

View File

@ -205,8 +205,8 @@
<span id="id1"></span><h1>Hardware<a class="headerlink" href="#hardware" title="Permalink to this headline"></a></h1>
<p>Im not a hardware designer so I would recommend the following resources for more in depth information on this topic.</p>
<ul class="simple">
<li><p><a class="reference external" href="https://github.com/cherryphilip74/iSpindel-PCB">Cherry Philip Hardware design,</a></p></li>
<li><p><a class="reference external" href="https://www.opensourcedistilling.com/ispindel">OpenSource Distilling,</a></p></li>
<li><p><a class="reference external" href="https://github.com/cherryphilip74/iSpindel-PCB">Cherry Philip Hardware design</a></p></li>
<li><p><a class="reference external" href="https://www.opensourcedistilling.com/ispindel">OpenSource Distilling</a></p></li>
</ul>
<div class="section" id="ispindle-based-on-esp8266">
<h2>iSpindle based on esp8266<a class="headerlink" href="#ispindle-based-on-esp8266" title="Permalink to this headline"></a></h2>
@ -220,18 +220,14 @@ excellent pcb boards that, for example the iSpindel PCB v4.0 from Cherry Philip.
</div>
<div class="section" id="ispindle-based-on-esp32">
<h2>iSpindle based on esp32<a class="headerlink" href="#ispindle-based-on-esp32" title="Permalink to this headline"></a></h2>
<p>Ive experimented with porting my software version to esp32 and this is a selection of options i have been testing.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Work to support esp32s2 is still ongoing, ESP32-mini and ESP32c3-mini is confirmed to be working. However I would recommend the C3 variant.</p>
</div>
<p>Gravitymon supports a number of ESP32 boards that offers bluetooth support.</p>
<a class="reference internal image-reference" href="_images/esp32_hardware.jpg"><img alt="iSpindle esp32 hardware options" src="_images/esp32_hardware.jpg" style="width: 500px;"/></a>
<ul class="simple">
<li><p>esp32 mini, this was the first board i tried which is a smaller form factor of the first generetion esp32 with 2 cores. Slow on connecting to wifi is the main downside.</p></li>
<li><p>esp32c3 mini, a newer version based on the latest risc v7 architecture, is seen as the replacement for the esp8266 with bluetooth support.</p></li>
<li><p>esp32d1 mini, this was the first board i tried which is a smaller form factor of the first generetion esp32 with 2 cores. Slow on connecting to wifi is the main downside.</p></li>
<li><p>esp32c3 mini, a newer version based on the latest risc v7 architecture, is seen as the replacement for the esp8266 with bluetooth support. Dont buy v1.0 since that has a faulty wifi antenna.</p></li>
<li><p>esp32s2 mini, similar to the c3 board but without bluetooth support.</p></li>
</ul>
<p>Its possible to use this PCB and mount an ESP32 mini on top of that (c3 and s2 are prefered). The esp32 mini is a larger formfactor and can be hard to fit into the tube.</p>
<p>Its possible to use this PCB and mount an ESP32 mini on top of that (c3 or s2 are prefered). The esp32 d1 mini is a larger formfactor and can be hard to fit into the tube.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>You need to add a resistor between A0 (Analog PIN) and ground of 470k. The reason is that the esp8266 has a build in resistor for a voltage divider
@ -240,14 +236,14 @@ need to adjust the voltage factor so the battery reading is correct.</p>
</div>
<div class="section" id="esp32c3-mini">
<h3>ESP32c3 mini<a class="headerlink" href="#esp32c3-mini" title="Permalink to this headline"></a></h3>
<p>This is model is now fully supported by gravitymon.</p>
<p>This is model is fully supported by gravitymon.</p>
<a class="reference internal image-reference" href="_images/ispindel_esp32c3.jpg"><img alt="Esp32c3 mini build" src="_images/ispindel_esp32c3.jpg" style="width: 500px;"/></a>
<p>Here is an image of where I added the resistor for the voltage divider.</p>
<a class="reference internal image-reference" href="_images/esp32_res.jpg"><img alt="Esp32c3 adding resistor as voltage dividier." src="_images/esp32_res.jpg" style="width: 500px;"/></a>
</div>
<div class="section" id="esp32s2-mini">
<h3>ESP32s2 mini<a class="headerlink" href="#esp32s2-mini" title="Permalink to this headline"></a></h3>
<p>This is model is now fully supported by gravitymon. Same setup as for ESP32C3 mini.</p>
<p>This is model is fully supported by gravitymon. Same setup as for ESP32C3 mini.</p>
</div>
<div class="section" id="esp32-d1-mini">
<h3>ESP32 d1 mini<a class="headerlink" href="#esp32-d1-mini" title="Permalink to this headline"></a></h3>
@ -258,7 +254,7 @@ need to adjust the voltage factor so the battery reading is correct.</p>
<h3>Schema for esp32 build<a class="headerlink" href="#schema-for-esp32-build" title="Permalink to this headline"></a></h3>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This schema assumes that an ESP32 D1 Mini (pin compatible with ESP8266 D1 Mini is used). The ESP32 has two rows of pins but
<p>This schema assumes that an ESP32 d1 mini (pin compatible with ESP8266). The ESP32 has two rows of pins but
only the inner row is used. The main difference is the added resistor R3 so we get a voltage divider for measuring battery.
The ESP8266 has a built in resistor thats not visible on the schema and this acts as a voltage divider.</p>
</div>

View File

@ -205,7 +205,7 @@
<h1>Welcome to GravityMon<a class="headerlink" href="#welcome-to-gravitymon" title="Permalink to this headline"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This documentation reflects <strong>v1.2 - beta 2</strong>. Last updated 2022-11-19</p>
<p>This documentation reflects <strong>v1.2.0</strong>. Last updated 2022-12-06</p>
</div>
<div class="section" id="what-is-gravitymon">
<h2>What is GravityMon?<a class="headerlink" href="#what-is-gravitymon" title="Permalink to this headline"></a></h2>
@ -227,8 +227,8 @@ information on this topic and function please visit <a class="reference external
<p>The github repository can be found here; <a class="reference external" href="https://github.com/mp-se/gravitymon">GravityMon on Github</a></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>I dont take responsibility for any errors or issues caused by the software. The software is provided as-is. I will however
try my best to fix issues that might occur.</p>
<p>I dont take responsibility for any errors or issues caused by the software or hardware.
The software is provided as-is. I will however try my best to fix issues that might occur.</p>
<p>I have tested this software on 40+ brews with good results.</p>
</div>
</div>
@ -329,8 +329,7 @@ the following libraries and without these this would have been much more difficu
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a><ul>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-2-0-beta2">v1.2.0 - beta2</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-2-0-beta1">v1.2.0 - beta1</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-2-0">v1.2.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-1-1">v1.1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-1-0">v1.1.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="releases.html#v1-0-0">v1.0.0</a></li>

View File

@ -236,8 +236,8 @@ terminal it should say “waiting for download”.</p>
the size of the firmware we are using a custom partition setup.</p>
</li>
<li><p><strong>firmware32c3.bin</strong></p>
<p>This is the release build for an ESP32c3-mini variant. When flashing an ESP32 you also need the <em>partition32c3.bin</em> file that outlines the flash memory structure. Due to
the size of the firmware we are using a custom partition setup.</p>
<p>This is the release build for an ESP32c3-mini variant v2.1 or newer. When flashing an ESP32 you also need the <em>partition32c3.bin</em> file that outlines the flash memory structure. Due to
the size of the firmware we are using a custom partition setup. If you have a v1.0 board use the firmware32c3v1.bin instead.</p>
</li>
<li><p><strong>firmware32s2.bin</strong></p>
<p>This is the release build for an ESP32s2-mini variant. When flashing an ESP32 you also need the <em>partition32s2.bin</em> file that outlines the flash memory structure. Due to

View File

@ -203,34 +203,28 @@
<article role="main">
<div class="section" id="releases">
<span id="id1"></span><h1>Releases<a class="headerlink" href="#releases" title="Permalink to this headline"></a></h1>
<div class="section" id="v1-2-0-beta2">
<h2>v1.2.0 - beta2<a class="headerlink" href="#v1-2-0-beta2" title="Permalink to this headline"></a></h2>
<div class="section" id="v1-2-0">
<h2>v1.2.0<a class="headerlink" href="#v1-2-0" title="Permalink to this headline"></a></h2>
<div class="section" id="features">
<h3>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Added function to calcualate voltage factor based on measured value.</p></li>
<li><p>Updated battery estimation for the various esp32 boards.</p></li>
<li><p>Added support for the ESP32 lite board which is used in the Floaty Hydrometer variant.</p></li>
<li><p>Added support for the ESP32 C3 mini board</p></li>
<li><p>Added support for the ESP32 S2 mini board</p></li>
<li><p>Serial output is written to TX/RX pins instead of the USB connection for the ESP32c3. This way the serial console can be viewed when running on battery power.</p></li>
<li><p>Merged in unit tests and api tests into this project</p></li>
<li><p>Added option to download firmware updates from <a class="reference external" href="https://www.gravitymon.com">https://www.gravitymon.com</a></p></li>
</ul>
</div>
<div class="section" id="documentation">
<h3>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Added section about the Floaty hardware.</p></li>
</ul>
</div>
</div>
<div class="section" id="v1-2-0-beta1">
<h2>v1.2.0 - beta1<a class="headerlink" href="#v1-2-0-beta1" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p>Changes to 1.2.0 only affect the ESP32 hardware, the ESP8266 is the same as for v1.1.1</p></li>
</ul>
<div class="section" id="id2">
<h3>Features<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Added support for the ESP32 C3 mini board</p></li>
<li><p>Added support for the ESP32 S2 mini board</p></li>
<li><p>Serial output is written to TX/RX pins instead of the USB connection for the ESP32c3. This way the serial console can be viewed when running on battery power.</p></li>
<li><p>Added section about the Floaty hardware</p></li>
<li><p>Fixed schema errors in hardware section and linked PCB options</p></li>
<li><p>Updated hardware section with options for ESP32 boards</p></li>
<li><p>Updated installation instructions.</p></li>
</ul>
</div>
<div class="section" id="issues-adressed">
@ -239,13 +233,6 @@
<li><p>BUG: The first portion of a format template was lost when doing conversion.</p></li>
</ul>
</div>
<div class="section" id="id3">
<h3>Documentation<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Updated hardware section with options for ESP32 boards</p></li>
<li><p>Updated installation instructions.</p></li>
</ul>
</div>
</div>
<div class="section" id="v1-1-1">
<h2>v1.1.1<a class="headerlink" href="#v1-1-1" title="Permalink to this headline"></a></h2>
@ -255,8 +242,8 @@
</div>
<div class="section" id="v1-1-0">
<h2>v1.1.0<a class="headerlink" href="#v1-1-0" title="Permalink to this headline"></a></h2>
<div class="section" id="id4">
<h3>Features<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<div class="section" id="id2">
<h3>Features<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Added information to error log about abnormal resets (for instance crashes) to detect and fix those</p></li>
<li><p>Changed storage mode so that the device will go into deep sleep until reset (sleep forever)</p></li>
@ -306,8 +293,8 @@
<li><p>User can now edit the voltage level that forces the device into config mode (device detects charging)</p></li>
</ul>
</div>
<div class="section" id="id5">
<h3>Documentation<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<div class="section" id="id3">
<h3>Documentation<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Added documentation for Brewpiless as target</p></li>
<li><p>Added documentation for BVrewblox as target</p></li>
@ -331,8 +318,8 @@
</div>
<div class="section" id="v1-0-0">
<h2>v1.0.0<a class="headerlink" href="#v1-0-0" title="Permalink to this headline"></a></h2>
<div class="section" id="id6">
<h3>Documentation<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
<div class="section" id="id4">
<h3>Documentation<a class="headerlink" href="#id4" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Update documentation to match v1.0</p></li>
<li><p>Installation instructions updated on how to find the device after wifi has been configured.</p></li>
@ -341,8 +328,8 @@
<li><p>Added additional http error codes to troubleshooting documentation</p></li>
</ul>
</div>
<div class="section" id="id7">
<h3>User interface<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<div class="section" id="id5">
<h3>User interface<a class="headerlink" href="#id5" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Upgraded to bootstrap v5.1 for web pages.</p></li>
<li><p>Added button on index page to direct to github issues.</p></li>
@ -353,8 +340,8 @@
<li><p>Added function on format page so that its easy to copy a format template from the docs (simplify service integration).</p></li>
</ul>
</div>
<div class="section" id="id8">
<h3>Features<a class="headerlink" href="#id8" title="Permalink to this headline"></a></h3>
<div class="section" id="id6">
<h3>Features<a class="headerlink" href="#id6" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>Added advanced setting to ignore angles that are lower than water. This is disabled by default.</p></li>
<li><p>Added support for MPU6500 (standard is MPU6050).</p></li>
@ -371,8 +358,8 @@
<li><p>Advanced settings: Adjust resolution of temp sensor (9 bits to 12 bits), higher resolution takes longer thus reducing battery life</p></li>
</ul>
</div>
<div class="section" id="id9">
<h3>Issues addressed<a class="headerlink" href="#id9" title="Permalink to this headline"></a></h3>
<div class="section" id="id7">
<h3>Issues addressed<a class="headerlink" href="#id7" title="Permalink to this headline"></a></h3>
<ul class="simple">
<li><p>BUG: Fixed issue in formula calculation in case there were a gap in the data series</p></li>
<li><p>BUG: Field name for wifi strength changed from “rssi” to “RSSI”</p></li>
@ -549,32 +536,27 @@ the behaviour in v0.6 is wanted this can be done via the format editor.</p></li>
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Releases</a><ul>
<li><a class="reference internal" href="#v1-2-0-beta2">v1.2.0 - beta2</a><ul>
<li><a class="reference internal" href="#v1-2-0">v1.2.0</a><ul>
<li><a class="reference internal" href="#features">Features</a></li>
<li><a class="reference internal" href="#documentation">Documentation</a></li>
</ul>
</li>
<li><a class="reference internal" href="#v1-2-0-beta1">v1.2.0 - beta1</a><ul>
<li><a class="reference internal" href="#id2">Features</a></li>
<li><a class="reference internal" href="#issues-adressed">Issues adressed</a></li>
<li><a class="reference internal" href="#id3">Documentation</a></li>
</ul>
</li>
<li><a class="reference internal" href="#v1-1-1">v1.1.1</a></li>
<li><a class="reference internal" href="#v1-1-0">v1.1.0</a><ul>
<li><a class="reference internal" href="#id4">Features</a></li>
<li><a class="reference internal" href="#id2">Features</a></li>
<li><a class="reference internal" href="#known-issues-not-yet-fixed">Known issues, not yet fixed</a></li>
<li><a class="reference internal" href="#issues-addressed">Issues addressed</a></li>
<li><a class="reference internal" href="#user-interface">User interface</a></li>
<li><a class="reference internal" href="#id5">Documentation</a></li>
<li><a class="reference internal" href="#id3">Documentation</a></li>
<li><a class="reference internal" href="#other">Other</a></li>
</ul>
</li>
<li><a class="reference internal" href="#v1-0-0">v1.0.0</a><ul>
<li><a class="reference internal" href="#id6">Documentation</a></li>
<li><a class="reference internal" href="#id7">User interface</a></li>
<li><a class="reference internal" href="#id8">Features</a></li>
<li><a class="reference internal" href="#id9">Issues addressed</a></li>
<li><a class="reference internal" href="#id4">Documentation</a></li>
<li><a class="reference internal" href="#id5">User interface</a></li>
<li><a class="reference internal" href="#id6">Features</a></li>
<li><a class="reference internal" href="#id7">Issues addressed</a></li>
</ul>
</li>
<li><a class="reference internal" href="#v0-9-0">v0.9.0</a></li>

File diff suppressed because one or more lines are too long