Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modified read me files and content for it #80

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
1db18af
Create cmake-multi-platform.yml
Martinius79 Jul 10, 2024
37eed9b
Update cmake-multi-platform.yml
Martinius79 Jul 10, 2024
20f95d8
Update cmake-multi-platform.yml
Martinius79 Jul 11, 2024
f449a7c
Update cmake-multi-platform.yml
Martinius79 Jul 11, 2024
fc782b2
Update cmake-multi-platform.yml
Martinius79 Jul 11, 2024
c55bc88
Update cmake-multi-platform.yml
Martinius79 Jul 11, 2024
b9fd466
edited and renamed github action workflow file
Martinius79 Jul 13, 2024
97460f7
updated build definition
Martinius79 Jul 21, 2024
ee12888
fixing build definition
Martinius79 Jul 21, 2024
5ad825b
Merge branch 'SmittyHalibut:main' into main
Martinius79 Jul 25, 2024
c997beb
Modified the root README.MD file - Added images - Created new subfold…
Martinius79 Aug 3, 2024
59b56a9
Added and changed content in the README.MD
Martinius79 Aug 11, 2024
59a1e33
Merge branch 'main' into ModifiedReadMeFilesAndContentForIt
aly-fly Aug 30, 2024
abe3555
Merge branch 'main' of https://github.com/Martinius79/EleksTubeHAX
Martinius79 Sep 3, 2024
3a255b0
Merged changes for HA edition
Martinius79 Sep 3, 2024
d7389fc
Merged from main from base repo
Martinius79 Sep 4, 2024
e89d5ab
Merge branch 'main' of https://github.com/Martinius79/EleksTubeHAX in…
Martinius79 Sep 4, 2024
1f7ba87
Changed info about IPSTUBE boards (Q1 transsitor)
Martinius79 Sep 5, 2024
3ba3046
Merge branch 'main' into ModifiedReadMeFilesAndContentForIt
Martinius79 Sep 5, 2024
268ec08
fixed merge conflicts
Martinius79 Sep 5, 2024
0ebc6b2
Merge branch 'SmittyHalibut:main' into ModifiedReadMeFilesAndContentF…
Martinius79 Sep 7, 2024
834738c
Update clock model information and firmware features, especially for …
Martinius79 Sep 13, 2024
a892cc4
Updated Home Assistant integration section - Added picture of EleksTu…
Martinius79 Sep 14, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file.
5 changes: 0 additions & 5 deletions Hardware modification/README.md

This file was deleted.

569 changes: 445 additions & 124 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion TO-DO.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Binary file removed data - other graphics/30 dog.bmp
Binary file not shown.
File renamed without changes.
Binary file added documentation/ImagesMD/EleksTube_Gen2_PCB.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added documentation/ImagesMD/IPSTUBE_H401_PCB.jpg
Binary file added documentation/ImagesMD/IPSTUBE_H402_PCB.jpg
File renamed without changes
Binary file added documentation/ImagesMD/PlatformIOBuild.png
Binary file added documentation/ImagesMD/PlatformIOBuildOutput.png
Binary file added documentation/ImagesMD/PlatformIOUploadOutput.png
File renamed without changes.
78 changes: 54 additions & 24 deletions pre-built-firmware/README.md
Original file line number Diff line number Diff line change
@@ -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!