Versioning and Naming

.vscode/extensions.json

@@ -4,7 +4,9 @@
     "recommendations": [
         "bierner.github-markdown-preview",
         "davidanson.vscode-markdownlint",
-        "ms-vscode.cpptools-extension-pack",
         "platformio.platformio-ide"
+    ],
+    "unwantedRecommendations": [
+        "ms-vscode.cpptools-extension-pack"
     ]
 }

pio/espupload.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 #
 # espupload by Theo Arends - 20170930
-# Modified for WTHermostat by Folke Ashberg - 202010
+# Modified for WThermostat by Folke Ashberg - 202010
 #
 # Uploads binary file to OTA server
 #

platformio.ini

@@ -16,7 +16,9 @@ extra_configs = platformio_override.ini
 default_envs = wthermostat
 
 [common]
-appversion = 1.20.beta3-fas
+# appversion is just devel, during github-actions its set to branch-date-hash or tagname by platformio_override.ini 
+# you can set your own in your local platformio_override.ini (see platformio_override.sample.ini)
+appversion = 1.20.dev
 framework = arduino
 board = esp01_1m
 board_build.flash_mode = dout
@@ -69,6 +71,7 @@ extra_scripts =
 	pio/strip-floats.py
 	pio/name-firmware.py
 
+
 [env]
 platform = ${common.platform}
 platform_packages = ${common.platform_packages}
@@ -90,13 +93,18 @@ check_tool = ${common.check_tool}
 check_flags = ${common.check_flags}
 check_severity = ${common.check_severity}
 
+
+# this is the default production env
 [env:wthermostat]
 build_type = release
 build_flags = ${env.build_flags}
 upload_protocol = custom
 upload_command = python pio/espupload.py -u 10.10.200.80 -f $SOURCE
 lib_deps = ${env.lib_deps}
 
+# this is the minimal version. No MQTT and no Thermostat Support.
+# meant for OTA Upgrading when standard is too small.
+# After flashing minimal do an upgrade to normal
 [env:wthermostat-minimal]
 build_type = release
 build_flags = ${env.build_flags}
@@ -106,6 +114,9 @@ lib_deps =
 	paulstoffregen/Time@^1.6.1
 	[email protected]
 
+# this is the debug version
+# do NOT install to real thermostat hardware
+# it's meant for flashing to nodemcu for development/testing
 [env:wthermostat-debug]
 board = nodemcuv2
 build_type = debug

platformio_override.sample.ini

@@ -12,6 +12,8 @@ default_envs =
 #    wthermostat-debug
 
 [common]
+# define here the name of your fw
+appversion = devel-xyz
 # Upload-Speed an COM-Port
 monitor_speed = 9600
 upload_speed = 115200