Update documentation

docs/_sources/api.rst.txt

@@ -84,7 +84,7 @@ GET: /api/status
 Retrieve the current device status via an HTTP GET command. Payload is in JSON format.
 
 * ``temp-format`` can be either ``C`` or ``F``
-* ``platform`` can be either ``esp8266``, ``esp32c3``, ``esp32s2``, ``esp32`` or ``esp32lite`` (floaty hardware)
+* ``platform`` can be either ``esp8266``, ``esp32c3``, ``esp32s2``, ``esp32s3``, ``esp32`` or ``esp32lite`` (floaty hardware)
 * ``temp-c`` will be set to -273 C if there is no temp sensor
 * ``angle`` will be set to 0 if no valid angle is found and -1 if there is no gyro
 

docs/_sources/configuration.rst.txt

@@ -294,6 +294,10 @@ long encapsulated in a small glass tube. See hardware section for more informati
 
 If the build is using an ESP32 then you can send data over BLE, simulating a Tilt device. Choose the color that you want the device to simulate.
 
+* **Gravitymon BLE format: (Only ESP32)**
+
+Activates a gravitymon specific format that allows sending iSpindel JSON data over BLE. Will require specialized software to read this data. 
+
 * **OTA URL:**
 
 Should point to a URL where the firmware.bin file + version.json file are located. For an ESP32 target the firmware should be named firmware32.bin.
@@ -360,9 +364,14 @@ This option allows you to set the correction temperature used in the automatic t
 
 * **DS18B20 Resolution:**
 
-Define the resolution used on the temp sensor. 9 bits is default and will give an accuracy of 0.5C, 12 bits will give an accuracy of 0.0625C but will also 
-take longer time to measure..
-
+Define the resolution used on the temp sensor. 9 bits is default and will give an accuracy of 0.5C and and provide longest batterylife. See data below from the datasheet.
+
+- 9 bits = 0.5°C, up to 93 ms reading
+- 10 bits =0.25°C, up to 187 ms reading
+- 11 bits = 0.125°C, up to 375 ms reading
+- 12 bits = 0.0625°C, up to 850 ms reading
+
+
 * **Wifi connect timeout:**
 
 This is the amount of time allowed for a wifi connect. 

docs/_sources/functionality.rst.txt

@@ -60,6 +60,10 @@ The main features
   of RAM will cause the device to crash. So enable SSL with caution and only when you really need it. GravityMon will try
   to minimize the needed RAM but the remote service might not support that feature.
 
+* **Enhanced BLE data transmission**
+
+  Offers an option to send JSON payload over BLE (up to 512 chars) to include more data than standard TILT.
+
 * **Create gravity formulas on the device**
 
   Another big difference is that this software can create the gravity formula in the device, just enter the 

docs/_sources/hardware.rst.txt

@@ -37,6 +37,7 @@ Gravitymon supports a number of ESP32 boards that offers 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. 
+* esp32s3 mini, similar to the s2 board but with bluetooth support. 
 
 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.
 
@@ -65,6 +66,11 @@ ESP32s2 mini
 
 This is model is fully supported by gravitymon. Same setup as for ESP32C3 mini.
 
+ESP32s3 mini
+++++++++++++
+
+This is model is fully supported by gravitymon. Same setup as for ESP32S2 mini.
+
 ESP32 d1 mini
 +++++++++++++
 

docs/_sources/index.rst.txt

@@ -7,7 +7,7 @@ Welcome to GravityMon
 #####################
 
 .. note::
-  This documentation reflects **v1.4.0 beta**. Last updated 2023-10-02
+  This documentation reflects **v1.4.0 beta**. Last updated 2023-12-02
 
 What is GravityMon?
 --------------------

docs/_sources/installation.rst.txt

@@ -56,6 +56,11 @@ In the /bin directory you will find 4 different firmware builds;
   This is the release build for an ESP32s2-mini variant. When flashing an ESP32 you also need the *partition32s2.bin* file that outlines the flash memory structure. Due to 
   the size of the firmware we are using a custom partition setup.
 
+* **firmware32s3.bin**
+
+  This is the release build for an ESP32s3-mini variant. When flashing an ESP32 you also need the *partition32s3.bin* file that outlines the flash memory structure. Due to 
+  the size of the firmware we are using a custom partition setup.
+
 * **firmware32lite.bin**
 
   This is the release build for an ESP32lite which is used by the floaty build (clone).

docs/_sources/license.rst.txt

@@ -5,7 +5,7 @@ Licence
 
 MIT License
 
-Copyright (c) 2021-22 Magnus
+Copyright (c) 2021-23 Magnus
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/_sources/releases.rst.txt

@@ -6,15 +6,34 @@ Releases
 v1.4.0 (beta)
 =============
 
-* Changed wifi manager to modified version since the source project is no longer supported by author
+Features
+++++++++
+* *BUG* Reduced WIFI TX Power for C3 chip to improve WIFI connnection stability
+* *NEW* Added experimental support for extended BLE data transmission (will require specialized server software)
+* *NEW* Added support for ESP32S3 mini board
+* *NEW* Moved to async webserver to speed up performance in configuration mode
+* Added feature to migrate formula and gyro calibration data from an existing ispindel configuration (don't do a full erase before flashing)
 * Added possibility to set wifi settings in config (need manual reboot to apply)
++ Added option that shows the average value from the gyro reads + a button to reset that on the web ui. Might make it easier to do calibration of the value jumps around.
+
+Maintenance
++++++++++++
+* Changed wifi manager to modified version since the source project is no longer supported by author
 * Updated dependencies to latest versions as of Aug -23
-* Added feature to migrate formula and gyro calibration data from an existing ispindel configuration (don't do a full erase before flashing)
+* Added UI tests to improve test coverage
+* Added unit tests to improve test coverage
+* Added option to run unit test code coverage with WOKWI
+* Added scripts to check for code coverage on the esp32 (work in progess, not yet covering all parts of the code)
+* Created script that checks for updates to dependant projects (test/converage.py)
+
+Documentation
++++++++++++++
+* Published code coverage for unit tests and apitest.py (gcov/README.md)
+
+Issues adressed
+++++++++++++++++
 * Updated code so it now works with newer versions of ArduniJSON
-* Added option to check for unit test code coverage with WOKWI
-* Added unit tests to improve coverage
-* Fixed issue with ESP32 were reboot didnt work sometimes
-* Published code coverage for unit tests
+* Fixed issue with ESP32 were reboot didn't work sometimes
 
 v1.3.1
 ======

docs/api.html

@@ -276,7 +276,7 @@ <h2>GET: /api/status<a class="headerlink" href="#get-api-status" title="Permalin
 <p>Retrieve the current device status via an HTTP GET command. Payload is in JSON format.</p>
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">temp-format</span></code> can be either <code class="docutils literal notranslate"><span class="pre">C</span></code> or <code class="docutils literal notranslate"><span class="pre">F</span></code></p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">platform</span></code> can be either <code class="docutils literal notranslate"><span class="pre">esp8266</span></code>, <code class="docutils literal notranslate"><span class="pre">esp32c3</span></code>, <code class="docutils literal notranslate"><span class="pre">esp32s2</span></code>, <code class="docutils literal notranslate"><span class="pre">esp32</span></code> or <code class="docutils literal notranslate"><span class="pre">esp32lite</span></code> (floaty hardware)</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">platform</span></code> can be either <code class="docutils literal notranslate"><span class="pre">esp8266</span></code>, <code class="docutils literal notranslate"><span class="pre">esp32c3</span></code>, <code class="docutils literal notranslate"><span class="pre">esp32s2</span></code>, <code class="docutils literal notranslate"><span class="pre">esp32s3</span></code>, <code class="docutils literal notranslate"><span class="pre">esp32</span></code> or <code class="docutils literal notranslate"><span class="pre">esp32lite</span></code> (floaty hardware)</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">temp-c</span></code> will be set to -273 C if there is no temp sensor</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">angle</span></code> will be set to 0 if no valid angle is found and -1 if there is no gyro</p></li>
 </ul>

docs/configuration.html

@@ -444,6 +444,10 @@ <h3>Hardware Settings<a class="headerlink" href="#hardware-settings" title="Perm
 </ul>
 <p>If the build is using an ESP32 then you can send data over BLE, simulating a Tilt device. Choose the color that you want the device to simulate.</p>
 <ul class="simple">
+<li><p><strong>Gravitymon BLE format: (Only ESP32)</strong></p></li>
+</ul>
+<p>Activates a gravitymon specific format that allows sending iSpindel JSON data over BLE. Will require specialized software to read this data.</p>
+<ul class="simple">
 <li><p><strong>OTA URL:</strong></p></li>
 </ul>
 <p>Should point to a URL where the firmware.bin file + version.json file are located. For an ESP32 target the firmware should be named firmware32.bin.</p>
@@ -497,8 +501,13 @@ <h3>Advanced Settings<a class="headerlink" href="#advanced-settings" title="Perm
 <ul class="simple">
 <li><p><strong>DS18B20 Resolution:</strong></p></li>
 </ul>
-<p>Define the resolution used on the temp sensor. 9 bits is default and will give an accuracy of 0.5C, 12 bits will give an accuracy of 0.0625C but will also
-take longer time to measure..</p>
+<p>Define the resolution used on the temp sensor. 9 bits is default and will give an accuracy of 0.5C and and provide longest batterylife. See data below from the datasheet.</p>
+<ul class="simple">
+<li><p>9 bits = 0.5°C, up to 93 ms reading</p></li>
+<li><p>10 bits =0.25°C, up to 187 ms reading</p></li>
+<li><p>11 bits = 0.125°C, up to 375 ms reading</p></li>
+<li><p>12 bits = 0.0625°C, up to 850 ms reading</p></li>
+</ul>
 <ul class="simple">
 <li><p><strong>Wifi connect timeout:</strong></p></li>
 </ul>

docs/functionality.html

@@ -249,6 +249,9 @@ <h2>The main features<a class="headerlink" href="#the-main-features" title="Perm
 to minimize the needed RAM but the remote service might not support that feature.</p>
 </div>
 <ul>
+<li><p><strong>Enhanced BLE data transmission</strong></p>
+<p>Offers an option to send JSON payload over BLE (up to 512 chars) to include more data than standard TILT.</p>
+</li>
 <li><p><strong>Create gravity formulas on the device</strong></p>
 <p>Another big difference is that this software can create the gravity formula in the device, just enter the
 angle/gravity data that you have collected. You will also see a graph simulating how the formula would work.</p>

docs/hardware.html

@@ -225,6 +225,7 @@ <h2>iSpindle based on esp32<a class="headerlink" href="#ispindle-based-on-esp32"
 <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. Don’t 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>
+<li><p>esp32s3 mini, similar to the s2 board but with bluetooth support.</p></li>
 </ul>
 <p>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.</p>
 <div class="admonition note">
@@ -244,6 +245,10 @@ <h3>ESP32c3 mini<a class="headerlink" href="#esp32c3-mini" title="Permalink to t
 <h3>ESP32s2 mini<a class="headerlink" href="#esp32s2-mini" title="Permalink to this headline">¶</a></h3>
 <p>This is model is fully supported by gravitymon. Same setup as for ESP32C3 mini.</p>
 </div>
+<div class="section" id="esp32s3-mini">
+<h3>ESP32s3 mini<a class="headerlink" href="#esp32s3-mini" title="Permalink to this headline">¶</a></h3>
+<p>This is model is fully supported by gravitymon. Same setup as for ESP32S2 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>
 <p>I would suggest that you try how it fits into the PET tube before soldering it to the PCB. Make sure that the battery is attached since this will be a really tight fit.</p>
@@ -353,6 +358,7 @@ <h2>Hardware extensions<a class="headerlink" href="#hardware-extensions" title="
 <li><a class="reference internal" href="#ispindle-based-on-esp32">iSpindle based on esp32</a><ul>
 <li><a class="reference internal" href="#esp32c3-mini">ESP32c3 mini</a></li>
 <li><a class="reference internal" href="#esp32s2-mini">ESP32s2 mini</a></li>
+<li><a class="reference internal" href="#esp32s3-mini">ESP32s3 mini</a></li>
 <li><a class="reference internal" href="#esp32-d1-mini">ESP32 d1 mini</a></li>
 <li><a class="reference internal" href="#schema-for-esp32-build">Schema for esp32 build</a></li>
 <li><a class="reference internal" href="#adding-a-reed-magnetic-reset-switch">Adding a reed (magnetic) reset switch</a></li>

docs/index.html

@@ -204,7 +204,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.4.0 beta</strong>. Last updated 2023-10-02</p>
+<p>This documentation reflects <strong>v1.4.0 beta</strong>. Last updated 2023-12-02</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>

docs/installation.html

@@ -245,6 +245,10 @@ <h3>Binaries<a class="headerlink" href="#binaries" title="Permalink to this head
 <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
 the size of the firmware we are using a custom partition setup.</p>
 </li>
+<li><p><strong>firmware32s3.bin</strong></p>
+<p>This is the release build for an ESP32s3-mini variant. When flashing an ESP32 you also need the <em>partition32s3.bin</em> file that outlines the flash memory structure. Due to
+the size of the firmware we are using a custom partition setup.</p>
+</li>
 <li><p><strong>firmware32lite.bin</strong></p>
 <p>This is the release build for an ESP32lite which is used by the floaty build (clone).</p>
 </li>

docs/license.html

@@ -203,7 +203,7 @@
           <div class="section" id="licence">
 <span id="id1"></span><h1>Licence<a class="headerlink" href="#licence" title="Permalink to this headline">¶</a></h1>
 <p>MIT License</p>
-<p>Copyright (c) 2021-22 Magnus</p>
+<p>Copyright (c) 2021-23 Magnus</p>
 <p>Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the “Software”), to deal
 in the Software without restriction, including without limitation the rights