Merge pull request #231 from mairas/hotfix_0.5.1

Hotfix 0.5.1

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = SensESP
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 0.4.3
+PROJECT_NUMBER         = 0.5.1
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

README.md

@@ -8,7 +8,7 @@ servers.
 SensESP is heavily inspired by [SigkSens](https://github.com/mxtommy/SigkSens)
 and prior work done by [@mxtommy](https://github.com/mxtommy).
 
-Class documentation for SensESP is [here](http://signalk.org/SensESP/annotated.html).
+Class documentation for SensESP is [here](http://signalk.org/SensESP/generated/docs/annotated.html).
 
 A Wiki page with more detailed information about using SensESP is [here](https://github.com/SignalK/SensESP/wiki).
 

docs/RELEASE_PROCESS.md

@@ -1,6 +1,22 @@
 # SensESP release process
 
-1. Create a new `release` branch (or rebase an existing one)
+This release process is loosely based on the git-flow model with a few
+simplifications. Main differences are:
+
+- Since releasing is a rapid process, long-lived release branches are not
+  needed. Releases can be made directly from feature branches.
+- `master` (or `main` in the future) is the unstable development branch.
+- `latest` is the last released version. Releases must be tagged from
+  this branch.
+
+The release process is as follows:
+
+1. Create a new local feature branch for the release.
+
+2. Bump the version number in `Doxyfile`, `library.properties` and 
+   `library.json`.
+
+   Commit the changes.
 
 2. Update autogenerated html and js source files:
 
@@ -10,17 +26,20 @@
 
 3. Update the doxygen docs (first bump the version number in `Doxyfile`)
 
+    rm -rf docs/generated/docs/
     doxygen
 
    Again, commit the results.
 
-4. Push the changes to `upstream` `release` branch. This is the release branch
-   from which the actual release is made. 
+4. Push the changes to your local fork.
 
-5. Verify that everything looks OK in the SignalK/SensESP `release` branch.
+5. Verify that everything looks OK in your fork.
 
-6. Create (or rebase) a new local `latest` branch. Push that to
-   `upstream` `latest`.
+   Any release testing should happen now at this point.
+
+6. Once everything is fine, create a PR against the `latest` branch.
+
+   Merge it.
 
 7. Navigate to https://github.com/SignalK/SensESP/releases and click on 
    "Draft a new release". Tag version is "x.y.z". Be sure to select `latest`
@@ -29,6 +48,3 @@
 
 8. The release is now done. Finally, create a PR from `latest` to `master`
    and merge it. This will bring `master` up to date with the released version.
-
-
-

docs/generated/docs/ads1x15_8cpp.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>
@@ -93,7 +93,7 @@
 Include dependency graph for ads1x15.cpp:</div>
 <div class="dyncontent">
 <div class="center"><img src="ads1x15_8cpp__incl.png" border="0" usemap="#asrc_2sensors_2ads1x15_8cpp" alt=""/></div>
-<map name="src_2sensors_2ads1x15_8cpp" id="asrc_2sensors_2ads1x15_8cpp">
+<map name="src_2sensors_2ads1x15_8cpp" id="src_2sensors_2ads1x15_8cpp">
 <area shape="rect" title=" " alt="" coords="557,5,726,31"/>
 <area shape="rect" href="ads1x15_8h.html" title=" " alt="" coords="388,79,471,104"/>
 <area shape="rect" href="sensesp_8h.html" title=" " alt="" coords="654,372,736,397"/>

docs/generated/docs/ads1x15_8cpp_source.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>

docs/generated/docs/ads1x15_8h.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>
@@ -97,7 +97,7 @@
 Include dependency graph for ads1x15.h:</div>
 <div class="dyncontent">
 <div class="center"><img src="ads1x15_8h__incl.png" border="0" usemap="#asrc_2sensors_2ads1x15_8h" alt=""/></div>
-<map name="src_2sensors_2ads1x15_8h" id="asrc_2sensors_2ads1x15_8h">
+<map name="src_2sensors_2ads1x15_8h" id="src_2sensors_2ads1x15_8h">
 <area shape="rect" title=" " alt="" coords="125,5,279,31"/>
 <area shape="rect" title=" " alt="" coords="5,79,148,104"/>
 <area shape="rect" title=" " alt="" coords="172,79,232,104"/>
@@ -125,7 +125,7 @@
 This graph shows which files directly or indirectly include this file:</div>
 <div class="dyncontent">
 <div class="center"><img src="ads1x15_8h__dep__incl.png" border="0" usemap="#asrc_2sensors_2ads1x15_8hdep" alt=""/></div>
-<map name="src_2sensors_2ads1x15_8hdep" id="asrc_2sensors_2ads1x15_8hdep">
+<map name="src_2sensors_2ads1x15_8hdep" id="src_2sensors_2ads1x15_8hdep">
 <area shape="rect" title=" " alt="" coords="12,5,167,31"/>
 <area shape="rect" href="ads1x15_8cpp.html" title=" " alt="" coords="5,79,174,104"/>
 </map>

docs/generated/docs/ads1x15_8h_source.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>

docs/generated/docs/ads1x15__voltage_8cpp.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>
@@ -92,7 +92,7 @@
 Include dependency graph for ads1x15_voltage.cpp:</div>
 <div class="dyncontent">
 <div class="center"><img src="ads1x15__voltage_8cpp__incl.png" border="0" usemap="#asrc_2transforms_2ads1x15__voltage_8cpp" alt=""/></div>
-<map name="src_2transforms_2ads1x15__voltage_8cpp" id="asrc_2transforms_2ads1x15__voltage_8cpp">
+<map name="src_2transforms_2ads1x15__voltage_8cpp" id="src_2transforms_2ads1x15__voltage_8cpp">
 <area shape="rect" title=" " alt="" coords="231,5,391,44"/>
 <area shape="rect" href="ads1x15__voltage_8h.html" title=" " alt="" coords="245,92,378,117"/>
 <area shape="rect" title=" " alt="" coords="153,165,296,191"/>

docs/generated/docs/ads1x15__voltage_8cpp_source.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>

docs/generated/docs/ads1x15__voltage_8h.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>
@@ -96,7 +96,7 @@
 Include dependency graph for ads1x15_voltage.h:</div>
 <div class="dyncontent">
 <div class="center"><img src="ads1x15__voltage_8h__incl.png" border="0" usemap="#asrc_2transforms_2ads1x15__voltage_8h" alt=""/></div>
-<map name="src_2transforms_2ads1x15__voltage_8h" id="asrc_2transforms_2ads1x15__voltage_8h">
+<map name="src_2transforms_2ads1x15__voltage_8h" id="src_2transforms_2ads1x15__voltage_8h">
 <area shape="rect" title=" " alt="" coords="231,5,391,44"/>
 <area shape="rect" title=" " alt="" coords="153,92,296,117"/>
 <area shape="rect" href="transform_8h.html" title=" " alt="" coords="320,92,476,117"/>
@@ -123,7 +123,7 @@
 This graph shows which files directly or indirectly include this file:</div>
 <div class="dyncontent">
 <div class="center"><img src="ads1x15__voltage_8h__dep__incl.png" border="0" usemap="#asrc_2transforms_2ads1x15__voltage_8hdep" alt=""/></div>
-<map name="src_2transforms_2ads1x15__voltage_8hdep" id="asrc_2transforms_2ads1x15__voltage_8hdep">
+<map name="src_2transforms_2ads1x15__voltage_8hdep" id="src_2transforms_2ads1x15__voltage_8hdep">
 <area shape="rect" title=" " alt="" coords="5,5,165,44"/>
 <area shape="rect" href="ads1x15__voltage_8cpp.html" title=" " alt="" coords="5,92,165,131"/>
 </map>

docs/generated/docs/ads1x15__voltage_8h_source.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>

docs/generated/docs/analog__input_8cpp.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>
@@ -94,7 +94,7 @@
 Include dependency graph for analog_input.cpp:</div>
 <div class="dyncontent">
 <div class="center"><img src="analog__input_8cpp__incl.png" border="0" usemap="#asrc_2sensors_2analog__input_8cpp" alt=""/></div>
-<map name="src_2sensors_2analog__input_8cpp" id="asrc_2sensors_2analog__input_8cpp">
+<map name="src_2sensors_2analog__input_8cpp" id="src_2sensors_2analog__input_8cpp">
 <area shape="rect" title=" " alt="" coords="768,5,901,44"/>
 <area shape="rect" href="analog__input_8h.html" title=" " alt="" coords="684,92,793,117"/>
 <area shape="rect" title=" " alt="" coords="719,312,797,337"/>

docs/generated/docs/analog__input_8cpp_source.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>

docs/generated/docs/analog__input_8h.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>
@@ -95,7 +95,7 @@
 Include dependency graph for analog_input.h:</div>
 <div class="dyncontent">
 <div class="center"><img src="analog__input_8h__incl.png" border="0" usemap="#asrc_2sensors_2analog__input_8h" alt=""/></div>
-<map name="src_2sensors_2analog__input_8h" id="asrc_2sensors_2analog__input_8h">
+<map name="src_2sensors_2analog__input_8h" id="src_2sensors_2analog__input_8h">
 <area shape="rect" title=" " alt="" coords="146,5,279,44"/>
 <area shape="rect" href="analog__reader_8h.html" title=" " alt="" coords="5,165,123,191"/>
 <area shape="rect" href="sensor_8h.html" title=" " alt="" coords="267,92,339,117"/>
@@ -122,7 +122,7 @@
 This graph shows which files directly or indirectly include this file:</div>
 <div class="dyncontent">
 <div class="center"><img src="analog__input_8h__dep__incl.png" border="0" usemap="#asrc_2sensors_2analog__input_8hdep" alt=""/></div>
-<map name="src_2sensors_2analog__input_8hdep" id="asrc_2sensors_2analog__input_8hdep">
+<map name="src_2sensors_2analog__input_8hdep" id="src_2sensors_2analog__input_8hdep">
 <area shape="rect" title=" " alt="" coords="215,5,348,44"/>
 <area shape="rect" href="main_8cpp.html" title=" " alt="" coords="5,99,102,124"/>
 <area shape="rect" href="sensesp__app_8cpp.html" title=" " alt="" coords="127,99,274,124"/>

docs/generated/docs/analog__input_8h_source.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>

docs/generated/docs/analog__reader_8h.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>
@@ -95,7 +95,7 @@
 Include dependency graph for analog_reader.h:</div>
 <div class="dyncontent">
 <div class="center"><img src="analog__reader_8h__incl.png" border="0" usemap="#asrc_2sensors_2analog__reader_8h" alt=""/></div>
-<map name="src_2sensors_2analog__reader_8h" id="asrc_2sensors_2analog__reader_8h">
+<map name="src_2sensors_2analog__reader_8h" id="src_2sensors_2analog__reader_8h">
 <area shape="rect" title=" " alt="" coords="30,5,163,44"/>
 <area shape="rect" title=" " alt="" coords="5,92,84,117"/>
 <area shape="rect" href="sensesp_8h.html" title=" " alt="" coords="107,92,190,117"/>
@@ -107,7 +107,7 @@
 This graph shows which files directly or indirectly include this file:</div>
 <div class="dyncontent">
 <div class="center"><img src="analog__reader_8h__dep__incl.png" border="0" usemap="#asrc_2sensors_2analog__reader_8hdep" alt=""/></div>
-<map name="src_2sensors_2analog__reader_8hdep" id="asrc_2sensors_2analog__reader_8hdep">
+<map name="src_2sensors_2analog__reader_8hdep" id="src_2sensors_2analog__reader_8hdep">
 <area shape="rect" title=" " alt="" coords="215,5,348,44"/>
 <area shape="rect" href="analog__input_8h.html" title=" " alt="" coords="215,92,348,131"/>
 <area shape="rect" href="main_8cpp.html" title=" " alt="" coords="5,185,102,211"/>

docs/generated/docs/analog__reader_8h_source.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>

docs/generated/docs/analogvoltage_8cpp.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>
@@ -92,7 +92,7 @@
 Include dependency graph for analogvoltage.cpp:</div>
 <div class="dyncontent">
 <div class="center"><img src="analogvoltage_8cpp__incl.png" border="0" usemap="#asrc_2transforms_2analogvoltage_8cpp" alt=""/></div>
-<map name="src_2transforms_2analogvoltage_8cpp" id="asrc_2transforms_2analogvoltage_8cpp">
+<map name="src_2transforms_2analogvoltage_8cpp" id="src_2transforms_2analogvoltage_8cpp">
 <area shape="rect" title=" " alt="" coords="289,5,507,31"/>
 <area shape="rect" href="analogvoltage_8h.html" title=" " alt="" coords="340,79,456,104"/>
 <area shape="rect" href="transform_8h.html" title=" " alt="" coords="354,152,442,177"/>

docs/generated/docs/analogvoltage_8cpp_source.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>

docs/generated/docs/analogvoltage_8h.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>
@@ -95,7 +95,7 @@
 Include dependency graph for analogvoltage.h:</div>
 <div class="dyncontent">
 <div class="center"><img src="analogvoltage_8h__incl.png" border="0" usemap="#asrc_2transforms_2analogvoltage_8h" alt=""/></div>
-<map name="src_2transforms_2analogvoltage_8h" id="asrc_2transforms_2analogvoltage_8h">
+<map name="src_2transforms_2analogvoltage_8h" id="src_2transforms_2analogvoltage_8h">
 <area shape="rect" title=" " alt="" coords="296,5,500,31"/>
 <area shape="rect" href="transform_8h.html" title=" " alt="" coords="354,79,442,104"/>
 <area shape="rect" title=" " alt="" coords="145,299,251,324"/>
@@ -121,7 +121,7 @@
 This graph shows which files directly or indirectly include this file:</div>
 <div class="dyncontent">
 <div class="center"><img src="analogvoltage_8h__dep__incl.png" border="0" usemap="#asrc_2transforms_2analogvoltage_8hdep" alt=""/></div>
-<map name="src_2transforms_2analogvoltage_8hdep" id="asrc_2transforms_2analogvoltage_8hdep">
+<map name="src_2transforms_2analogvoltage_8hdep" id="src_2transforms_2analogvoltage_8hdep">
 <area shape="rect" title=" " alt="" coords="12,5,216,31"/>
 <area shape="rect" href="analogvoltage_8cpp.html" title=" " alt="" coords="5,79,223,104"/>
 </map>

docs/generated/docs/analogvoltage_8h_source.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>

docs/generated/docs/angle__correction_8cpp.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>
@@ -94,7 +94,7 @@
 Include dependency graph for angle_correction.cpp:</div>
 <div class="dyncontent">
 <div class="center"><img src="angle__correction_8cpp__incl.png" border="0" usemap="#asrc_2transforms_2angle__correction_8cpp" alt=""/></div>
-<map name="src_2transforms_2angle__correction_8cpp" id="asrc_2transforms_2angle__correction_8cpp">
+<map name="src_2transforms_2angle__correction_8cpp" id="src_2transforms_2angle__correction_8cpp">
 <area shape="rect" title=" " alt="" coords="327,5,469,44"/>
 <area shape="rect" href="angle__correction_8h.html" title=" " alt="" coords="332,92,463,117"/>
 <area shape="rect" href="transform_8h.html" title=" " alt="" coords="354,165,442,191"/>

docs/generated/docs/angle__correction_8cpp_source.html

@@ -26,7 +26,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">SensESP
-   &#160;<span id="projectnumber">0.4.3</span>
+   &#160;<span id="projectnumber">0.5.1</span>
    </div>
    <div id="projectbrief">Universal Signal K sensor framework for ESP8266 and ESP32</div>
   </td>