From ceab98597ed38eb10ed063d0524be8c0c4ec7a88 Mon Sep 17 00:00:00 2001
From: Folke <folke@ashberg.de>
Date: Sun, 11 Sep 2022 14:04:11 +0200
Subject: [PATCH] Versioning and Naming

---
 .vscode/extensions.json        |  4 +++-
 lib/WAdapter                   |  2 +-
 pio/espupload.py               |  2 +-
 platformio.ini                 | 13 ++++++++++++-
 platformio_override.sample.ini |  2 ++
 5 files changed, 19 insertions(+), 4 deletions(-)

diff --git a/.vscode/extensions.json b/.vscode/extensions.json
index fd8e23f..e8bd642 100644
--- a/.vscode/extensions.json
+++ b/.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"
     ]
 }
diff --git a/lib/WAdapter b/lib/WAdapter
index 8cdbf06..703b7bc 160000
--- a/lib/WAdapter
+++ b/lib/WAdapter
@@ -1 +1 @@
-Subproject commit 8cdbf0683b13cde64ea092590e486d17a37e4727
+Subproject commit 703b7bcb5fefd522dc234ad0faaa3574baf369b3
diff --git a/pio/espupload.py b/pio/espupload.py
index badfea6..31bef5e 100644
--- a/pio/espupload.py
+++ b/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
 #
diff --git a/platformio.ini b/platformio.ini
index 2464de3..bc906a4 100644
--- a/platformio.ini
+++ b/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,6 +93,8 @@ 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}
@@ -97,6 +102,9 @@ 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
 	NTPClient@3.2.1
 
+# 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
diff --git a/platformio_override.sample.ini b/platformio_override.sample.ini
index 7e10c4e..ae96986 100644
--- a/platformio_override.sample.ini
+++ b/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