Modified the root README.MD file heavily - Added images - Created new…

… subfolder "documentation" - Changed location for images in the MD - Moved hardware description folders and other to the documentation folder - Modified README.MD in the pre-build-images subfolder - Added photos of Elekstube IPS Gen1 and Gen2 and PunkCyber IPS
aly-fly · Nov 18, 2024 · 2e34849 · 2e34849
1 parent 1aa6b5b
commit 2e34849
Show file tree

Hide file tree

Showing 102 changed files with 773 additions and 179 deletions.
diff --git a/EleksTubeHAX_pio/src/_USER_DEFINES - empty.h b/EleksTubeHAX_pio/src/_USER_DEFINES - empty.h
@@ -40,13 +40,30 @@
 #define GEOLOCATION_API_KEY "__enter_your_api_key_here__"
 
 // ************* MQTT config *************
-// #define MQTT_ENABLED  // enable after creating an account, setting up the Thermostat device on www.smartnest.cz and filling in all the data below:
-// #define MQTT_HOME_ASSISTANT // enable if you want Home Assistant support
-// #define MQTT_HOME_ASSISTANT_DISCOVERY
-// #define MQTT_HOME_ASSISTANT_DISCOVERY_DEVICE_MANUFACTURER "EleksMaker"
-// #define MQTT_HOME_ASSISTANT_DISCOVERY_DEVICE_MODEL "Elekstube IPS PR2"
-// #define MQTT_HOME_ASSISTANT_DISCOVERY_SW_VERSION "0.8 Home Assistant Edition"
-// #define MQTT_HOME_ASSISTANT_DISCOVERY_HW_VERSION "2.3.04"
+// #define MQTT_ENABLED // enable general MQTT support
+
+// --- MQTT Home Assistant settings ---
+// You will either need a local MQTT broker to use MQTT with Home Assistant (e.g. Mosquitto) or use an internet-based broker with Home Assistant support.
+// If not done already, you can set up a local one easily via an Add-On in HA. See: https://www.home-assistant.io/integrations/mqtt/
+// Enter the credential data into the MQTT broker settings section below accordingly.
+
+// #define MQTT_HOME_ASSISTANT // Uncomment if you want Home Assistant (HA) support (MQTT_ENABLED must be also enabled)
+// all following MQTT_HOME_ASSISTANT_* settings require MQTT_HOME_ASSISTANT to be enabled
+// #define MQTT_HOME_ASSISTANT_DISCOVERY                                         // Uncomment if you want HA auto-discovery
+// #define MQTT_HOME_ASSISTANT_DISCOVERY_DEVICE_MANUFACTURER "EleksMaker"        // Name of the manufacturer shown in HA
+// #define MQTT_HOME_ASSISTANT_DISCOVERY_DEVICE_MODEL "Elekstube IPS"            // Name of the model shown in HA
+// #define MQTT_HOME_ASSISTANT_DISCOVERY_SW_VERSION "1.0 Home Assistant Edition" // Firmware version shown in HA
+// #define MQTT_HOME_ASSISTANT_DISCOVERY_HW_VERSION "2.3.04"                     // Hardware version shown in HA
+
+// --- MQTT broker settings ---
+// NOTE: If Home Assistant is not enabled, the MQTT support is very limited in the moment!
+// You can still use MQTT to control the clock, but only via direct sent MQTT messages, sent from a MQTT client like MQTT Explorer or similar.
+// The actual pure MQTT implementation is "emulating" a temperature sensor, so you can use "set temperature" commands to control the clock.
+// This is a workaround to have a basic MQTT support.
+// For pure MQTT support you can either use any internet-based MQTT broker (i.e. smartnest.cz or HiveMQ) or a local one (i.e. Mosquitto).
+// If you choose an internet based one, you will need to create an account, (maybe setting up the device there) and filling in the data below then.
+// If you choose a local one, you will need to set up the broker on your local network and fill in the data below.
+
 #define MQTT_BROKER "smartnest.cz"                   // Broker host
 #define MQTT_PORT 1883                               // Broker port
 #define MQTT_USERNAME "__enter_your_username_here__" // Username from Smartnest

diff --git a/Hardware modification/README.md b/Hardware modification/README.md
diff --git a/Photos/PunkCyber_ips_clock.jpg b/Photos/PunkCyber_ips_clock.jpg
diff --git a/README.md b/README.md
diff --git a/TO-DO.txt b/TO-DO.txt
@@ -3,4 +3,4 @@
 - MQTT transmissions in a single block.
 - Temperature sensor readout in a single block.
 - Limit IP Geolocation to every Sunday (copy code from the fork)
-- Add static zime zone data if IP Geo is disabled  (copy code from the fork)
+- Add static time zone data if IP Geo is disabled  (copy code from the fork)
diff --git a/documentation/Hardware EleksTube Gen2/01 - Elekstube Gen2 - Box front.jpg b/documentation/Hardware EleksTube Gen2/01 - Elekstube Gen2 - Box front.jpg
diff --git a/documentation/Hardware EleksTube Gen2/02 - Elekstube Gen2 - Box back PR1.jpg b/documentation/Hardware EleksTube Gen2/02 - Elekstube Gen2 - Box back PR1.jpg
diff --git a/documentation/Hardware EleksTube Gen2/03 - Elekstube Gen2 - Box back PR2.jpg b/documentation/Hardware EleksTube Gen2/03 - Elekstube Gen2 - Box back PR2.jpg
diff --git a/documentation/Hardware EleksTube Gen2/04 - Elekstube Gen2 - Box opened 1.jpg b/documentation/Hardware EleksTube Gen2/04 - Elekstube Gen2 - Box opened 1.jpg
diff --git a/documentation/Hardware EleksTube Gen2/05 - Elekstube Gen2 - Box opened 2.jpg b/documentation/Hardware EleksTube Gen2/05 - Elekstube Gen2 - Box opened 2.jpg
diff --git a/documentation/Hardware EleksTube Gen2/06 - Elekstube Gen2 - Box content.jpg b/documentation/Hardware EleksTube Gen2/06 - Elekstube Gen2 - Box content.jpg
diff --git a/documentation/Hardware EleksTube Gen2/07 - Elekstube Gen2 - Device PR1 top.jpg b/documentation/Hardware EleksTube Gen2/07 - Elekstube Gen2 - Device PR1 top.jpg
diff --git a/documentation/Hardware EleksTube Gen2/08 - Elekstube Gen2 - Device PR2 top.jpg b/documentation/Hardware EleksTube Gen2/08 - Elekstube Gen2 - Device PR2 top.jpg
diff --git a/documentation/Hardware EleksTube Gen2/09 - Elekstube Gen2 - Device bottom.jpg b/documentation/Hardware EleksTube Gen2/09 - Elekstube Gen2 - Device bottom.jpg
diff --git a/documentation/Hardware EleksTube Gen2/10 - Elekstube Gen2 - Disassembled.jpg b/documentation/Hardware EleksTube Gen2/10 - Elekstube Gen2 - Disassembled.jpg
diff --git a/documentation/Hardware EleksTube Gen2/11 - Elekstube Gen2 - Clock front PR1.jpg b/documentation/Hardware EleksTube Gen2/11 - Elekstube Gen2 - Clock front PR1.jpg
diff --git a/documentation/Hardware EleksTube Gen2/12 - Elekstube Gen2 - Clock front PR2.jpg b/documentation/Hardware EleksTube Gen2/12 - Elekstube Gen2 - Clock front PR2.jpg
diff --git a/documentation/Hardware EleksTube Gen2/13 - Elekstube Gen2 - Clock rear.jpg b/documentation/Hardware EleksTube Gen2/13 - Elekstube Gen2 - Clock rear.jpg
diff --git a/documentation/Hardware EleksTube Gen2/14 - Elekstube Gen2 - PCB top.jpg b/documentation/Hardware EleksTube Gen2/14 - Elekstube Gen2 - PCB top.jpg
diff --git a/documentation/Hardware EleksTube Gen2/15 - Elekstube Gen2 - PCB bottom.jpg b/documentation/Hardware EleksTube Gen2/15 - Elekstube Gen2 - PCB bottom.jpg
diff --git a/documentation/Hardware EleksTube/01 - Elekstube - Box.jpg b/documentation/Hardware EleksTube/01 - Elekstube - Box.jpg
diff --git a/documentation/Hardware EleksTube/02 - Elekstube - Box opened 1.jpg b/documentation/Hardware EleksTube/02 - Elekstube - Box opened 1.jpg
diff --git a/documentation/Hardware EleksTube/03 - Elekstube - Box opened 2.jpg b/documentation/Hardware EleksTube/03 - Elekstube - Box opened 2.jpg
diff --git a/documentation/Hardware EleksTube/04 - Elekstube - Box Content.jpg b/documentation/Hardware EleksTube/04 - Elekstube - Box Content.jpg
diff --git a/documentation/Hardware EleksTube/05 - Elekstube - Device top.jpg b/documentation/Hardware EleksTube/05 - Elekstube - Device top.jpg
diff --git a/documentation/Hardware EleksTube/06 - Elekstube - Device bottom.jpg b/documentation/Hardware EleksTube/06 - Elekstube - Device bottom.jpg
diff --git a/documentation/Hardware EleksTube/07 - Elekstube - Disassembled.jpg b/documentation/Hardware EleksTube/07 - Elekstube - Disassembled.jpg
diff --git a/documentation/Hardware EleksTube/08 - Elekstube - Clock front.jpg b/documentation/Hardware EleksTube/08 - Elekstube - Clock front.jpg
diff --git a/documentation/Hardware EleksTube/09 - Elekstube - PCB top - unmodified.jpg b/documentation/Hardware EleksTube/09 - Elekstube - PCB top - unmodified.jpg
diff --git a/documentation/Hardware EleksTube/10 - Elekstube - PCB bottom - unmodified.jpg b/documentation/Hardware EleksTube/10 - Elekstube - PCB bottom - unmodified.jpg
diff --git a/...elLife/NovelLife-SE-SPECTRUM-PCB-Back.jpg → ...ife SE/NovelLife-SE-SPECTRUM-PCB-Back.jpg b/...elLife/NovelLife-SE-SPECTRUM-PCB-Back.jpg → ...ife SE/NovelLife-SE-SPECTRUM-PCB-Back.jpg
diff --git a/...lLife/NovelLife-SE-SPECTRUM-PCB-Front.jpg → ...fe SE/NovelLife-SE-SPECTRUM-PCB-Front.jpg b/...lLife/NovelLife-SE-SPECTRUM-PCB-Front.jpg → ...fe SE/NovelLife-SE-SPECTRUM-PCB-Front.jpg
diff --git a/...e NovelLife/NovelLife-SE-SPECTRUM-Top.jpg → ...ovelLife SE/NovelLife-SE-SPECTRUM-Top.jpg b/...e NovelLife/NovelLife-SE-SPECTRUM-Top.jpg → ...ovelLife SE/NovelLife-SE-SPECTRUM-Top.jpg
diff --git a/Hardware NovelLife/NovelLife_top.jpg → ...n/Hardware NovelLife SE/NovelLife_top.jpg b/Hardware NovelLife/NovelLife_top.jpg → ...n/Hardware NovelLife SE/NovelLife_top.jpg
diff --git a/Hardware NovelLife/Novellife_SE.jpg → ...on/Hardware NovelLife SE/Novellife_SE.jpg b/Hardware NovelLife/Novellife_SE.jpg → ...on/Hardware NovelLife SE/Novellife_SE.jpg
diff --git a/documentation/Hardware PunkCyber IPS/01 - PunkCyber - Box.jpg b/documentation/Hardware PunkCyber IPS/01 - PunkCyber - Box.jpg
diff --git a/documentation/Hardware PunkCyber IPS/02 - PunkCyber - Box opened.jpg b/documentation/Hardware PunkCyber IPS/02 - PunkCyber - Box opened.jpg
diff --git a/documentation/Hardware PunkCyber IPS/03 - PunkCyber - Box content.jpg b/documentation/Hardware PunkCyber IPS/03 - PunkCyber - Box content.jpg
diff --git a/documentation/Hardware PunkCyber IPS/04 - PunkCyber - Displays.jpg b/documentation/Hardware PunkCyber IPS/04 - PunkCyber - Displays.jpg
diff --git a/documentation/Hardware PunkCyber IPS/05 - PunkCyber - Device top.jpg b/documentation/Hardware PunkCyber IPS/05 - PunkCyber - Device top.jpg
diff --git a/documentation/Hardware PunkCyber IPS/06 - PunkCyber - Device bottom.jpg b/documentation/Hardware PunkCyber IPS/06 - PunkCyber - Device bottom.jpg
diff --git a/...n/Hardware PunkCyber IPS/07 - PunkCyber - Sideparts and coverplates removed.jpg b/...n/Hardware PunkCyber IPS/07 - PunkCyber - Sideparts and coverplates removed.jpg
diff --git a/documentation/Hardware PunkCyber IPS/08 - PunkCyber - Screws.jpg b/documentation/Hardware PunkCyber IPS/08 - PunkCyber - Screws.jpg
diff --git a/documentation/Hardware PunkCyber IPS/09 - PunkCyber - Clock front.jpg b/documentation/Hardware PunkCyber IPS/09 - PunkCyber - Clock front.jpg
diff --git a/documentation/Hardware PunkCyber IPS/10 - PunkCyber - Clock rear.jpg b/documentation/Hardware PunkCyber IPS/10 - PunkCyber - Clock rear.jpg
diff --git a/documentation/Hardware PunkCyber IPS/11 - PunkCyber - PCB bottom.jpg b/documentation/Hardware PunkCyber IPS/11 - PunkCyber - PCB bottom.jpg
diff --git a/documentation/Hardware PunkCyber IPS/12 - PunkCyber - PCB top.jpg b/documentation/Hardware PunkCyber IPS/12 - PunkCyber - PCB top.jpg
diff --git a/documentation/Hardware PunkCyber IPS/Hardware modification - Missing CH340 chip.md b/documentation/Hardware PunkCyber IPS/Hardware modification - Missing CH340 chip.md
@@ -0,0 +1,3 @@
+#### PunkCyber IPS clock: No CH340 chip soldered on PCB of newer editions
+
+See the "Hardware modifications" section in the `README.md` in the root of this repo.
diff --git a/...s reversed (new - different hardware).url → ...s reversed (new - different hardware).url b/...s reversed (new - different hardware).url → ...s reversed (new - different hardware).url
diff --git a/...S CLOCK (pcbway)/still_from_the_video.PNG → ...captured_frame_from_the_fake-ad-video.png b/...S CLOCK (pcbway)/still_from_the_video.PNG → ...captured_frame_from_the_fake-ad-video.png
diff --git a/... IPS CLOCK (pcbway)/original firmware.url → ...dware PunkCyber IPS/original firmware.url b/... IPS CLOCK (pcbway)/original firmware.url → ...dware PunkCyber IPS/original firmware.url
diff --git a/...NKCYBER IPS CLOCK (pcbway)/pic_bottom.jpg → ...ion/Hardware PunkCyber IPS/pic_bottom.jpg b/...NKCYBER IPS CLOCK (pcbway)/pic_bottom.jpg → ...ion/Hardware PunkCyber IPS/pic_bottom.jpg
diff --git a/... PUNKCYBER IPS CLOCK (pcbway)/pic_top.jpg → ...tation/Hardware PunkCyber IPS/pic_top.jpg b/... PUNKCYBER IPS CLOCK (pcbway)/pic_top.jpg → ...tation/Hardware PunkCyber IPS/pic_top.jpg
diff --git a/...ller RGB Glow Tube DIY Clock - PCBWay.url → ...ller RGB Glow Tube DIY Clock - PCBWay.url b/...ller RGB Glow Tube DIY Clock - PCBWay.url → ...ller RGB Glow Tube DIY Clock - PCBWay.url
diff --git a/... clock (chinese copy)/1 bottom mirror.jpg → ...ation/Hardware SI HAI/1 bottom mirror.jpg b/... clock (chinese copy)/1 bottom mirror.jpg → ...ation/Hardware SI HAI/1 bottom mirror.jpg
diff --git a/... SI HAI clock (chinese copy)/1 bottom.jpg → documentation/Hardware SI HAI/1 bottom.jpg b/... SI HAI clock (chinese copy)/1 bottom.jpg → documentation/Hardware SI HAI/1 bottom.jpg
diff --git a/...are SI HAI clock (chinese copy)/2 top.jpg → documentation/Hardware SI HAI/2 top.jpg b/...are SI HAI clock (chinese copy)/2 top.jpg → documentation/Hardware SI HAI/2 top.jpg
diff --git a/...e SI HAI clock (chinese copy)/3 top A.jpg → documentation/Hardware SI HAI/3 top A.jpg b/...e SI HAI clock (chinese copy)/3 top A.jpg → documentation/Hardware SI HAI/3 top A.jpg
diff --git a/...e SI HAI clock (chinese copy)/4 top B.jpg → documentation/Hardware SI HAI/4 top B.jpg b/...e SI HAI clock (chinese copy)/4 top B.jpg → documentation/Hardware SI HAI/4 top B.jpg
diff --git a/...e SI HAI clock (chinese copy)/5 top C.jpg → documentation/Hardware SI HAI/5 top C.jpg b/...e SI HAI clock (chinese copy)/5 top C.jpg → documentation/Hardware SI HAI/5 top C.jpg
diff --git a/...ck (chinese copy)/5158661573495959139.png → ...n/Hardware SI HAI/5158661573495959139.png b/...ck (chinese copy)/5158661573495959139.png → ...n/Hardware SI HAI/5158661573495959139.png
diff --git a/...are SI HAI clock (chinese copy)/6 bot.jpg → documentation/Hardware SI HAI/6 bot.jpg b/...are SI HAI clock (chinese copy)/6 bot.jpg → documentation/Hardware SI HAI/6 bot.jpg
diff --git a/...ck (chinese copy)/8754011573496799881.png → ...n/Hardware SI HAI/8754011573496799881.png b/...ck (chinese copy)/8754011573496799881.png → ...n/Hardware SI HAI/8754011573496799881.png
diff --git a/...re SI HAI clock (chinese copy)/DS1302.pdf → documentation/Hardware SI HAI/DS1302.pdf b/...re SI HAI clock (chinese copy)/DS1302.pdf → documentation/Hardware SI HAI/DS1302.pdf
diff --git a/...HAI clock (chinese copy)/Display back.jpg → ...entation/Hardware SI HAI/Display back.jpg b/...HAI clock (chinese copy)/Display back.jpg → ...entation/Hardware SI HAI/Display back.jpg
diff --git a/...lock (chinese copy)/Display back_edit.png → ...ion/Hardware SI HAI/Display back_edit.png b/...lock (chinese copy)/Display back_edit.png → ...ion/Hardware SI HAI/Display back_edit.png
diff --git a/...AI clock (chinese copy)/Display front.jpg → ...ntation/Hardware SI HAI/Display front.jpg b/...AI clock (chinese copy)/Display front.jpg → ...ntation/Hardware SI HAI/Display front.jpg
diff --git a/... SI HAI clock (chinese copy)/ESP pins.svg → documentation/Hardware SI HAI/ESP pins.svg b/... SI HAI clock (chinese copy)/ESP pins.svg → documentation/Hardware SI HAI/ESP pins.svg
diff --git a/... SI HAI clock (chinese copy)/Testing.docx → documentation/Hardware SI HAI/Testing.docx b/... SI HAI clock (chinese copy)/Testing.docx → documentation/Hardware SI HAI/Testing.docx
diff --git a/... Display Breakout Board - Hackaday.io.url → ... Display Breakout Board - Hackaday.io.url b/... Display Breakout Board - Hackaday.io.url → ... Display Breakout Board - Hackaday.io.url
diff --git a/...AI clock (chinese copy)/reverse board.txt → ...ntation/Hardware SI HAI/reverse board.txt b/...AI clock (chinese copy)/reverse board.txt → ...ntation/Hardware SI HAI/reverse board.txt
diff --git a/Hardware pinout.xlsx → ...rdware pinout - EleksTube and SI HAI.xlsx b/Hardware pinout.xlsx → ...rdware pinout - EleksTube and SI HAI.xlsx
diff --git a/Photos/Clock_Smartnest_IoT.jpg → ...entation/ImagesMD/Clock_Smartnest_IoT.jpg b/Photos/Clock_Smartnest_IoT.jpg → ...entation/ImagesMD/Clock_Smartnest_IoT.jpg
diff --git a/documentation/ImagesMD/EleksTube_Gen2_PCB.jpg b/documentation/ImagesMD/EleksTube_Gen2_PCB.jpg
diff --git a/Hardware modification/CH340C_mod.jpg → ...ion/ImagesMD/EleksTube_IPS_CH340C_mod.jpg b/Hardware modification/CH340C_mod.jpg → ...ion/ImagesMD/EleksTube_IPS_CH340C_mod.jpg
diff --git a/Photos/Clock1.jpg → ...magesMD/EleksTube_IPS_Classic_Edition.jpg b/Photos/Clock1.jpg → ...magesMD/EleksTube_IPS_Classic_Edition.jpg
diff --git a/Photos/EleksTube_original_PCB.jpg → ...ation/ImagesMD/EleksTube_original_PCB.jpg b/Photos/EleksTube_original_PCB.jpg → ...ation/ImagesMD/EleksTube_original_PCB.jpg
diff --git a/documentation/ImagesMD/GitHubActionsArtifactView.png b/documentation/ImagesMD/GitHubActionsArtifactView.png
diff --git a/documentation/ImagesMD/GitHubActionsOverview.png b/documentation/ImagesMD/GitHubActionsOverview.png
diff --git a/documentation/ImagesMD/HAMQTTBackLightDetails.png b/documentation/ImagesMD/HAMQTTBackLightDetails.png
diff --git a/documentation/ImagesMD/HAMQTTIntegrationDetails.png b/documentation/ImagesMD/HAMQTTIntegrationDetails.png
diff --git a/documentation/ImagesMD/HAMQTTIntegrationOverview.png b/documentation/ImagesMD/HAMQTTIntegrationOverview.png
diff --git a/documentation/ImagesMD/HAMQTTMainLightDetails.png b/documentation/ImagesMD/HAMQTTMainLightDetails.png
diff --git a/documentation/ImagesMD/IPSTUBE_H401_PCB.jpg b/documentation/ImagesMD/IPSTUBE_H401_PCB.jpg
diff --git a/documentation/ImagesMD/IPSTUBE_H402_PCB.jpg b/documentation/ImagesMD/IPSTUBE_H402_PCB.jpg
diff --git a/Photos/NovelLife_SE.jpg → documentation/ImagesMD/NovelLife_SE.jpg b/Photos/NovelLife_SE.jpg → documentation/ImagesMD/NovelLife_SE.jpg
diff --git a/documentation/ImagesMD/PlatformIOBuild.png b/documentation/ImagesMD/PlatformIOBuild.png
diff --git a/documentation/ImagesMD/PlatformIOBuildFilesystem.png b/documentation/ImagesMD/PlatformIOBuildFilesystem.png
diff --git a/documentation/ImagesMD/PlatformIOBuildOutput.png b/documentation/ImagesMD/PlatformIOBuildOutput.png
diff --git a/documentation/ImagesMD/PlatformIOUploadOutput.png b/documentation/ImagesMD/PlatformIOUploadOutput.png
diff --git a/documentation/ImagesMD/PunkCyber_IPS_clock_PCB.jpg b/documentation/ImagesMD/PunkCyber_IPS_clock_PCB.jpg
diff --git a/documentation/ImagesMD/PunkCyber_PCB_CH340_header.jpg b/documentation/ImagesMD/PunkCyber_PCB_CH340_header.jpg
diff --git a/documentation/ImagesMD/PunkCyber_backup_successful.jpg b/documentation/ImagesMD/PunkCyber_backup_successful.jpg
diff --git a/documentation/ImagesMD/PunkCyber_connected_UART-USB_bridge_and_reset_button.jpg b/documentation/ImagesMD/PunkCyber_connected_UART-USB_bridge_and_reset_button.jpg
diff --git a/documentation/ImagesMD/PunkCyber_soldered_sockets.jpg b/documentation/ImagesMD/PunkCyber_soldered_sockets.jpg
diff --git a/documentation/ImagesMD/PunkCyber_soldered_sockets_with_backplate.jpg b/documentation/ImagesMD/PunkCyber_soldered_sockets_with_backplate.jpg
diff --git a/Photos/SI_HAI_ips_clock.jpg → documentation/ImagesMD/SI_HAI_ips_clock.jpg b/Photos/SI_HAI_ips_clock.jpg → documentation/ImagesMD/SI_HAI_ips_clock.jpg
diff --git a/documentation/ImagesMD/WindowsDeviceManagerCOMport.png b/documentation/ImagesMD/WindowsDeviceManagerCOMport.png
diff --git a/...est #28 · arduino-libraries-NTPClient.url → ...est #28 · arduino-libraries-NTPClient.url b/...est #28 · arduino-libraries-NTPClient.url → ...est #28 · arduino-libraries-NTPClient.url
diff --git a/NTP time info/NTP Data description.txt → ...on/NTP time info/NTP Data description.txt b/NTP time info/NTP Data description.txt → ...on/NTP time info/NTP Data description.txt
diff --git a/NTP time info/ntp4.pdf → documentation/NTP time info/ntp4.pdf b/NTP time info/ntp4.pdf → documentation/NTP time info/ntp4.pdf
diff --git a/pre-built-firmware/README.md b/pre-built-firmware/README.md
@@ -1,33 +1,92 @@
 # EleksTubeHAX - An aftermarket custom firmware for the desk clock
-![EleksTube IPS clock](/Photos/Clock1.jpg)
 
-Supported hardware models:
-### "EleksTube IPS clock", "SI HAI IPS clock", "NovelLife SE clock", "PunkCyber clock", "RGB Glow Tube DIY clock"
+## 1. Pre-built firmware files
 
-In this folder you can find pre-built firmware images that you can upload to your clock.
+In this folder you can find pre-built firmware image files that you can directly upload/flash to your clock.
 
-Note that these firmwares may have limited functionality.
+These firmwares may have limited functionality compared to a self-built firmware, because not all available features are enabled or can be configured.
 
-## Enabled functions:
-- WPS connectivity (press WPS button on your router for WiFi setup).
-- DEBUG_OUTPUT - it will produce diagnostic messages on the serial port.
-- DCORE_DEBUG_LEVEL=5 - it will produce diagnostic messages from the operating system.
-- Night time from 22h in the evening to 7h in the morning.
-- No geolocation (time zone & DST must be set manually).
-- No MQTT (without remote control).
-- No thermometer.
-- Image files are fixed and can't be changed without development tools.
+The image files (clock faces) are fixed and can't be changed without building your own firmware file with the development tools (see README.md)!
 
-### Select appropriate .bin file that fits your hardware and upload it using the `_ESP32 write flash.cmd` file. 
-Available files:
-- original Elekstube clock - `FW_Elekstube_HAX_1.0_original.bin`
-- original Elekstube clock Gen2.1 (ESP32 Pico D4 Chip) - `FW_Elekstube_HAX_1.0_Gen2-1.bin`
-- SI HAI copy of the clock - `FW_SI_HAI_CLOCK_HAX_1.0.bin`
-- NovelLife SE version (non-SE not tested) - `FW_NovelLife_SE_HAX_1.0.bin`
-- PunkCyber / RGB Glow tube / PCBway clock - `FW_PunkCyber_Glow_PCBway_HAX_1.0.bin`
+### 1.1 Pre-configured functionality
 
-Make sure to edit it and write correct COM port and file name into it before running.
+Enabled:
 
-## Save your original firmware using the `_ESP32 save flash 4MB.cmd` before tinkering.
+- WiFi connectivity via WPS (While clock is in boot phase, press WPS button on your router for WiFi setup).
+- Night time dimming enabled - from 22:00h (10 pm) in the evening to 07:00h (7 am) in the morning.
 
-## There is no warranty of any type.
+Disabled:
+
+- IP-based geolocation disabled - time zone & DST must be set manually via the menu.
+- MQTT disabled - no 'remote control'. Because of this, also no Home Assistant support!
+- Debug Outputs via serial interface is disabled
+
+General:
+
+- 6 different sets of clock faces present. See [data](https://github.com/SmittyHalibut/EleksTubeHAX/tree/main/EleksTubeHAX_pio/data).
+- BMP mode active for the given clock faces
+- CORE_DEBUG_LEVEL=5 - This produces diagnostic messages from the ESP32 "operating system" in case of an error over the serial interface.
+
+## 2. Backup your original firmware
+
+**Always backup YOUR clock firmware version as first step!**
+
+Save your original firmware using the `_ESP32 save flash 4MB.cmd` by changing the COM port to the number, your clock uses.
+
+Rename and store the `backup1.bin` on a save location.
+
+See also the section "Backup first" and following in the `README.MD` file in the root.
+
+## 3. Available image files
+
+In this folder (```pre-build-firmwares```) you will find the flashable files.
+They are updated from time to time in the repository, so version number may vary.
+
+| clock model | firmware image file |
+|--|--|  
+| EleksTube IPS - Orginal Version | `FW_Elekstube_HAX_1.0_original.bin` |
+| EleksTube IPS - Gen2 models | `FW_Elekstube_HAX_1.0_Gen2-1.bin` |
+| SI HAI IPS | `FW_SI_HAI_CLOCK_HAX_1.0.bin` |
+| NovelLife SE version | `FW_NovelLife_SE_HAX_1.0.bin` |
+| PunkCyber/RGB Glow Tube DIY | `FW_PunkCyber_Glow_PCBway_HAX_1.0.bin` |
+
+Note: All "Original" EleksTube clocks, sold after July 2022 are "Gen2" versions. See [Note on EleksTube website](https://elekstube.com/blogs/news/instructions-on-elekstube-clock-for-gen2-systems). But always check the PCB version of your clock!
+
+## 4. Write the EleksTubeHAX firmware file
+
+- Choose the right pre-built firmware file for your clock.
+- Edit the file `_ESP32 write flash.cmd` with an editor.
+- Write the correct COM port of your clock.
+- Write the correct firmware file name for your clock.
+- Run the CMD file.
+
+The CMD file should look like this:
+
+```esptool --port COM5 --baud 921600 write_flash --erase-all 0x0000 FW_Elekstube_HAX_1.0_Gen2-1.bin```
+
+Note: Most clocks will go into to the "download mode" automatically when esptool is trying to write to it.
+Some clocks needs a button pressed while the powering phase (plugging the USB cable) to enter this mode.
+
+## 5. Download the newest firmware files
+
+Everytime a commit is done to the main branch of this repo, a GitHub action is triggered and a workflow run builds all firmware files.
+
+All workflow runs of the GutHub action can be found under [EleksTubeHAX generate firmware files]("https://github.com/SmittyHalibut/EleksTubeHAX/actions/workflows/pio-build-and-publish-all-firmware-files.yml")
+
+Should look like:
+
+![GitHub Actions Overview](../documentation/ImagesMD/GitHubActionsOverview.png)
+
+The first entry is always the newest.
+
+If you click on the workflow run, you will be able to donwload either all firmwares at once, by downloading the `all-firmware-vX.X.X`, or the file for your clock seperately.
+
+![GitHub Actions Artifact view](../documentation/ImagesMD/GitHubActionsArtifactView.png)
+
+The downloaded firmware file can be flashed to the clock modifing the existing CMD file or using the esptool directly.
+
+## 6. There is no warranty of any type
+
+Use at your own risk!
+
+If you mess-up your clock, it's only your fault!
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		#### PunkCyber IPS clock: No CH340 chip soldered on PCB of newer editions

		See the "Hardware modifications" section in the `README.md` in the root of this repo.