Add new README.md with preview of watchface

This commit is contained in:
Dominic Höglinger 2025-05-20 22:37:30 +02:00
parent 2c309a2ce1
commit b978a95198
4 changed files with 36 additions and 27 deletions

BIN
Images/Watchface.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.9 KiB

30
README-WatchyGSR.md Normal file
View File

@ -0,0 +1,30 @@
![Watchy GSR Face](https://github.com/GuruSR/Watchy_GSR/blob/main/Images/Watchy_GSR.gif)
This repo's format:
Bin folder contains the current OTA Bin that you can use a tool to upload with or an OTA Upgrade capable firmware to install the current OTA Bin to the Watchy.
src folder contains a universal (Arduino & PlatformIO) setup for compilation, instructions on how to get it to compile are in the src folder.
Needed libraries: Arduino Libraries, ArduinoOTA (included in ESP32 2.0.2), SmallRTC (1.6 or greater, GuruSR), SmallNTP (GuruSR), StableBMA (GuruSR), Olson2POSIX (GuruSR) AND Watchy (1.3.3 or greater) base.
**NOTES:**
- Watchy uses version 1.0.6 or 2.0.2 (or higher than 2.0.3) of the ESP32 libraries, 2.0.0 won't compile, 2.0.3 causes a boot crash loop, remove them manually and revert back to version 1.0.6 or use 2.0.2 (which seems to have been fixed).
**WARNING:**
As of Version 1.4.3H, the Compilation Instructions have changed, the GxEPD2 requires a define to be added to the .h file in the Compilation Instructions or the Dark Border will be disabled.
For instructions on usage of the firmware, see "Usage".
Below is a layout of the Watchy Connect & the OTA Website (used while online your network) that gives you options to various things.
![OTA Website](https://github.com/GuruSR/Watchy_GSR/blob/main/Images/Server-Help.png)
OTA update is **ONLY** possible via an OTA compatible firmware which are:
`Watchy GSR` and those overriding it.
**If you have an OTA upload function in your firmware, ask for it to be added here.**
For those wanting to override the looks of this Watchy face, look at the Override Information.

View File

@ -1,30 +1,9 @@
![Watchy GSR Face](https://github.com/GuruSR/Watchy_GSR/blob/main/Images/Watchy_GSR.gif) # My Watchy Watchface
This repo's format: Custom watchface with calendar, step history, moon phase and more.
It is based off a Watchy by someone anonymous on a certain technology board.
Bin folder contains the current OTA Bin that you can use a tool to upload with or an OTA Upgrade capable firmware to install the current OTA Bin to the Watchy. The original photo is lost media sadly,
and my Watchy suffered ESD damage so it isn't working.
src folder contains a universal (Arduino & PlatformIO) setup for compilation, instructions on how to get it to compile are in the src folder. ![Screenshot of the last simulator build to get a rough idea](Images/Watchface.png)
Needed libraries: Arduino Libraries, ArduinoOTA (included in ESP32 2.0.2), SmallRTC (1.6 or greater, GuruSR), SmallNTP (GuruSR), StableBMA (GuruSR), Olson2POSIX (GuruSR) AND Watchy (1.3.3 or greater) base.
**NOTES:**
- Watchy uses version 1.0.6 or 2.0.2 (or higher than 2.0.3) of the ESP32 libraries, 2.0.0 won't compile, 2.0.3 causes a boot crash loop, remove them manually and revert back to version 1.0.6 or use 2.0.2 (which seems to have been fixed).
**WARNING:**
As of Version 1.4.3H, the Compilation Instructions have changed, the GxEPD2 requires a define to be added to the .h file in the Compilation Instructions or the Dark Border will be disabled.
For instructions on usage of the firmware, see "Usage".
Below is a layout of the Watchy Connect & the OTA Website (used while online your network) that gives you options to various things.
![OTA Website](https://github.com/GuruSR/Watchy_GSR/blob/main/Images/Server-Help.png)
OTA update is **ONLY** possible via an OTA compatible firmware which are:
`Watchy GSR` and those overriding it.
**If you have an OTA upload function in your firmware, ask for it to be added here.**
For those wanting to override the looks of this Watchy face, look at the Override Information.