Merge branch 'ModifiedReadMeFilesAndContentForIt' into AddedIPSTUBEs

SmittyHalibut · Sep 15, 2024 · 296b003 · 296b003
2 parents 8a0fd77 + a892cc4
commit 296b003
Show file tree

Hide file tree

Showing 53 changed files with 500 additions and 154 deletions.
diff --git a/EleksTubeHAX_pio/.vscode/settings.json b/EleksTubeHAX_pio/.vscode/settings.json
diff --git a/Hardware modification/README.md b/Hardware modification/README.md
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/data - other graphics/30 dog.bmp b/data - other graphics/30 dog.bmp
diff --git a/...elLife/NovelLife-SE-SPECTRUM-PCB-Back.jpg → ...elLife/NovelLife-SE-SPECTRUM-PCB-Back.jpg b/...elLife/NovelLife-SE-SPECTRUM-PCB-Back.jpg → ...elLife/NovelLife-SE-SPECTRUM-PCB-Back.jpg
diff --git a/...lLife/NovelLife-SE-SPECTRUM-PCB-Front.jpg → ...lLife/NovelLife-SE-SPECTRUM-PCB-Front.jpg b/...lLife/NovelLife-SE-SPECTRUM-PCB-Front.jpg → ...lLife/NovelLife-SE-SPECTRUM-PCB-Front.jpg
diff --git a/...e NovelLife/NovelLife-SE-SPECTRUM-Top.jpg → ...e NovelLife/NovelLife-SE-SPECTRUM-Top.jpg b/...e NovelLife/NovelLife-SE-SPECTRUM-Top.jpg → ...e NovelLife/NovelLife-SE-SPECTRUM-Top.jpg
diff --git a/Hardware NovelLife/NovelLife_top.jpg → ...tion/Hardware NovelLife/NovelLife_top.jpg b/Hardware NovelLife/NovelLife_top.jpg → ...tion/Hardware NovelLife/NovelLife_top.jpg
diff --git a/Hardware NovelLife/Novellife_SE.jpg → ...ation/Hardware NovelLife/Novellife_SE.jpg b/Hardware NovelLife/Novellife_SE.jpg → ...ation/Hardware NovelLife/Novellife_SE.jpg
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/... IPS CLOCK (pcbway)/original firmware.url → ... IPS CLOCK (pcbway)/original firmware.url b/... IPS CLOCK (pcbway)/original firmware.url → ... IPS CLOCK (pcbway)/original firmware.url
diff --git a/...NKCYBER IPS CLOCK (pcbway)/pic_bottom.jpg → ...NKCYBER IPS CLOCK (pcbway)/pic_bottom.jpg b/...NKCYBER IPS CLOCK (pcbway)/pic_bottom.jpg → ...NKCYBER IPS CLOCK (pcbway)/pic_bottom.jpg
diff --git a/... PUNKCYBER IPS CLOCK (pcbway)/pic_top.jpg → ... PUNKCYBER IPS CLOCK (pcbway)/pic_top.jpg b/... PUNKCYBER IPS CLOCK (pcbway)/pic_top.jpg → ... PUNKCYBER IPS CLOCK (pcbway)/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/...S CLOCK (pcbway)/still_from_the_video.PNG → ...S CLOCK (pcbway)/still_from_the_video.PNG b/...S CLOCK (pcbway)/still_from_the_video.PNG → ...S CLOCK (pcbway)/still_from_the_video.PNG
diff --git a/... clock (chinese copy)/1 bottom mirror.jpg → ... clock (chinese copy)/1 bottom mirror.jpg b/... clock (chinese copy)/1 bottom mirror.jpg → ... clock (chinese copy)/1 bottom mirror.jpg
diff --git a/... SI HAI clock (chinese copy)/1 bottom.jpg → ... SI HAI clock (chinese copy)/1 bottom.jpg b/... SI HAI clock (chinese copy)/1 bottom.jpg → ... SI HAI clock (chinese copy)/1 bottom.jpg
diff --git a/...are SI HAI clock (chinese copy)/2 top.jpg → ...are SI HAI clock (chinese copy)/2 top.jpg b/...are SI HAI clock (chinese copy)/2 top.jpg → ...are SI HAI clock (chinese copy)/2 top.jpg
diff --git a/...e SI HAI clock (chinese copy)/3 top A.jpg → ...e SI HAI clock (chinese copy)/3 top A.jpg b/...e SI HAI clock (chinese copy)/3 top A.jpg → ...e SI HAI clock (chinese copy)/3 top A.jpg
diff --git a/...e SI HAI clock (chinese copy)/4 top B.jpg → ...e SI HAI clock (chinese copy)/4 top B.jpg b/...e SI HAI clock (chinese copy)/4 top B.jpg → ...e SI HAI clock (chinese copy)/4 top B.jpg
diff --git a/...e SI HAI clock (chinese copy)/5 top C.jpg → ...e SI HAI clock (chinese copy)/5 top C.jpg b/...e SI HAI clock (chinese copy)/5 top C.jpg → ...e SI HAI clock (chinese copy)/5 top C.jpg
diff --git a/...ck (chinese copy)/5158661573495959139.png → ...ck (chinese copy)/5158661573495959139.png b/...ck (chinese copy)/5158661573495959139.png → ...ck (chinese copy)/5158661573495959139.png
diff --git a/...are SI HAI clock (chinese copy)/6 bot.jpg → ...are SI HAI clock (chinese copy)/6 bot.jpg b/...are SI HAI clock (chinese copy)/6 bot.jpg → ...are SI HAI clock (chinese copy)/6 bot.jpg
diff --git a/...ck (chinese copy)/8754011573496799881.png → ...ck (chinese copy)/8754011573496799881.png b/...ck (chinese copy)/8754011573496799881.png → ...ck (chinese copy)/8754011573496799881.png
diff --git a/...re SI HAI clock (chinese copy)/DS1302.pdf → ...re SI HAI clock (chinese copy)/DS1302.pdf b/...re SI HAI clock (chinese copy)/DS1302.pdf → ...re SI HAI clock (chinese copy)/DS1302.pdf
diff --git a/...HAI clock (chinese copy)/Display back.jpg → ...HAI clock (chinese copy)/Display back.jpg b/...HAI clock (chinese copy)/Display back.jpg → ...HAI clock (chinese copy)/Display back.jpg
diff --git a/...lock (chinese copy)/Display back_edit.png → ...lock (chinese copy)/Display back_edit.png b/...lock (chinese copy)/Display back_edit.png → ...lock (chinese copy)/Display back_edit.png
diff --git a/...AI clock (chinese copy)/Display front.jpg → ...AI clock (chinese copy)/Display front.jpg b/...AI clock (chinese copy)/Display front.jpg → ...AI clock (chinese copy)/Display front.jpg
diff --git a/... SI HAI clock (chinese copy)/ESP pins.svg → ... SI HAI clock (chinese copy)/ESP pins.svg b/... SI HAI clock (chinese copy)/ESP pins.svg → ... SI HAI clock (chinese copy)/ESP pins.svg
diff --git a/... SI HAI clock (chinese copy)/Testing.docx → ... SI HAI clock (chinese copy)/Testing.docx b/... SI HAI clock (chinese copy)/Testing.docx → ... SI HAI clock (chinese copy)/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 → ...AI clock (chinese copy)/reverse board.txt b/...AI clock (chinese copy)/reverse board.txt → ...AI clock (chinese copy)/reverse board.txt
diff --git a/Hardware pinout.xlsx → documentation/Hardware pinout.xlsx b/Hardware pinout.xlsx → documentation/Hardware pinout.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/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/Photos/PunkCyber_ips_clock.jpg → ...entation/ImagesMD/PunkCyber_ips_clock.jpg b/Photos/PunkCyber_ips_clock.jpg → ...entation/ImagesMD/PunkCyber_ips_clock.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,63 @@
 # 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"
+## 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 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 pre-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.
+These image files are fixed and can't be changed without development tools!
 
-### 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`
+## Pre-configured functionality
 
-Make sure to edit it and write correct COM port and file name into it before running.
+- 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.
+- IP-based geolocation disabled - time zone & DST must be set manually via the clocks menu.
+- MQTT disabled - no 'remote control'.
+- External thermometer sensor disabled.
+- DEBUG_OUTPUT enabled - This produces diagnostic messages from the firmware over the serial port.
+- DCORE_DEBUG_LEVEL=5 - This produces diagnostic messages from the ESP32 operating system in case of an error over the serial port.
 
-## Save your original firmware using the `_ESP32 save flash 4MB.cmd` before tinkering.
+### Available image files
 
-## There is no warranty of any type.
+| 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` |
+| IPSTUBE - Model H401 | TBD |
+
+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!
+
+## Backup your original firmware
+
+**Always backup YOUR clocks firmware version as first step!**
+
+Note for original EleksTube clocks: Backup images from other users **DO NOT WORK** as the original EleksTube firmware is locked to the MAC address of the ESP32.
+
+For other clocks it MAY work, but don't assume it!
+
+Save your original firmware using the `_ESP32 save flash 4MB.cmd` (or 8MB version for the IPSTUBE) 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.
+
+## 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.
+
+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, like the IPSTUBE ones. 
+
+## There is no warranty of any type
+
+Use at your own risk!
+
+If you mess-up your clock, it's only your fault!