Merge pull request #15 from jaswch/main

V0.3.1

Author: jaswch

README.md

@@ -1,5 +1,5 @@
 # OpenTimeWatch-OS
-An open source watch OS for ESP32 based development boards and watches which integrates flexibility of users customizing their watches and developers making their own apps, watch faces, widgets,etc. This OS currently supported by LILYGO TQT Pro based on ESP32-S3, we will add support for more microcontrollers and development boards in the future.
+An open source watch OS for ESP32-S3 based development boards and watches which integrates flexibility of users customizing their watches and developers making their own apps, watch faces, widgets,etc. This OS currently supported by LILYGO TQT Pro based on ESP32-S3, we will add support for more microcontrollers and development boards in the future.
 
 # Why need another OS for watches?
 When we look at the current smart watches (especially the cheap ones) the are pretty bad, specifically the software (and also the hardware) as it is very limited in features, lack of flexibility, comes with preloaded watch faces which we cannot remove, most of the time there are no games :( ,etc. We wanted to bring a change as these cheap smartwatches are being bought by millions around the world where many consumers are dissappointed by the lack features and the microcontrollers getting cheaper day-by-day, it was our chance to make a revolution! To be honest I just wanted to make a watch with games so I won't get bored during the annual day dance practice.
@@ -21,10 +21,15 @@ When we look at the current smart watches (especially the cheap ones) the are pr
 5. Connect the Stemma qt connector to the TQT Pro
 
 # Installation (for platformio users)
-Clone the repository and upload the code (Note:-If using an 8MB version of TQT Pro uncomment line 10 and comment line 11 and 17 in ```platformio.ini``` file)
+## TQT pro N4R2 (Flash: 4MB, PSRAM: 2MB)
+Just upload the code without any changes to the ```platformio.ini``` file. It should look like this:
+![Alt text](images/TQT-psram-conf.png)
+## TQT pro N8 (Flash: 8MB, PSRAM: none)
+You will need to do some changes in the ```platformio.ini``` file before uploading the code. It should look like this:
+![Alt text](images/TQT-non-psram-conf.png)
 
 # Installation (for arduino users)
-All of the required code is in the ```src``` directory, just rename the file ```main.cpp``` to ```main.ino``` and install ```Button2```, ```TFT_eSPI``` (according to LILYGO TFT_eSPI version 2.0.14 or lower is recommended), ```Adafruit GFX```, ```Adafruit MPU6050``` and ```Adafruit Unified Sensor``` in the ide and upload the code 
+All of the required code is in the ```src``` directory, just rename the file ```main.cpp``` to ```main.ino``` and install ```Button2```, ```TFT_eSPI``` (according to LILYGO TFT_eSPI version 2.0.14 or lower is recommended), ```Adafruit GFX```, ```Adafruit MPU6050``` and ```Adafruit Unified Sensor``` in the ide and upload the code. Note:- also refer to the README.md at [TQT pro](https://github.com/Xinyuan-LilyGO/T-QT/tree/main?tab=readme-ov-file#quick-start) for setting up the board in arduino ide.
 
 # Features
 1. Home screen with custom background
@@ -36,7 +41,7 @@ All of the required code is in the ```src``` directory, just rename the file ```
 7. Time setting using WiFi
 8. Multiple Watch Faces
 9. Shows CPU temperature
-10. Hacker Mode (ITS JUST A MATRIX EFFECT AND NOT ANYTHING RELATED TO HACKING AND DON'T GET MAD AT ME)
+10. Hacker Mode (ITS JUST A MATRIX EFFECT AND NOT ANYTHING RELATED TO HACKING)
 11. Battery voltage
 12. Battery Charging
 
@@ -47,10 +52,11 @@ All of the required code is in the ```src``` directory, just rename the file ```
 4. While playing pong scroll button moves the paddle up and the menu button moves the paddle down
 
 # Release Notes
-1. **V0.3** - New UI (created using [lopaka.app](https://lopaka.app/sandbox)), multiple watch faces, Wifi support, time synchronisation, back option in menus, accelerometer support and apps and sub menus sepereted from the ```main.cpp``` file.
-2. **V0.2.1** - Added refinements to the OS navigation, added a manual in the ```README.md``` and changed the tone of the speaker.
-3. **V0.2** - A significant update compared to V0.1, as it introduced menus, pong, interaction with peripherals (torch and speaker), OS being open sourced, matrix effect, settings menu. 
-4. **V0.1** - The initial release it just had a home screen and an about screen.
+1. **V0.3.1** - otwUI bug fix, updated configuration for TQT pro N8 in ```platformio.ini``` file and better documentation.
+2. **V0.3** - New UI (created using [lopaka.app](https://lopaka.app/sandbox)), multiple watch faces, Wifi support, time synchronisation, back option in menus, accelerometer support and apps and sub menus sepereted from the ```main.cpp``` file.
+3. **V0.2.1** - Added refinements to the OS navigation, added a manual in the ```README.md``` and changed the tone of the speaker.
+4. **V0.2** - A significant update compared to V0.1, as it introduced menus, pong, interaction with peripherals (torch and speaker), OS being open sourced, matrix effect, settings menu. 
+5. **V0.1** - The initial release it just had a home screen and an about screen.
 
 # When could you expect SDKs for apps, custom home screens and widgets
 By V0.7 or V0.8 we could start making SDKs for developers to make apps and games, we will also extend support for other microcontrollers and screen resolutions as the OS currently runs at 128 * 128 px.
@@ -59,18 +65,26 @@ By V0.7 or V0.8 we could start making SDKs for developers to make apps and games
 Yes, you can contribute to the project by the following ways :
 1. Help us add features to the project by making a PR.
 2. Help us test and find bugs.
-3. Give feature suggestions in this [issue](https://github.com/OpenTimeWatch-Project/OpenTimeWatch-OS/issues/1).
+3. Give feature suggestions at this [issue](https://github.com/OpenTimeWatch-Project/OpenTimeWatch-OS/issues/1).
 4. Help us test or review PRs.
-5. PS : If you have a better logo for the project please let us know by opening a new issue (don't worry we will credit you)
 Note:- PRs for grammar correction or punctuations will not be merged instead create an issue for it.
 
 # Images
+## Homescreen
 ![Alt text](images/IMG_20241119_201516.jpg)
+## Main menu
 ![Alt text](images/IMG_20241119_201547.jpg)
+## Activity view
 ![Alt text](images/IMG_20241119_201559.jpg)
+## Pong game
 ![Alt text](images/IMG_20241119_201614.jpg)
+## Peripheral Menu
 ![Alt text](images/IMG_20241119_201707.jpg)
+## Torch turned on
 ![Alt text](images/IMG_20241119_201715.jpg)
+## Settings
 ![Alt text](images/IMG_20241119_201733.jpg)
+## About screen
 ![Alt text](images/IMG_20241119_201758.jpg)
+## Hacker mode (Matrix animation)
 ![Alt text](images/IMG_20241119_202308.jpg)

images/TQT-non-psram-conf.png

@@ -3,20 +3,19 @@
 
 [platformio]
 boards_dir = ./board
+;default_envs = T-QT-Pro-N8
 default_envs = T-QT-Pro-N4R2
 description = Open source watch OS for ESP32 based watches
 
-; uncomment the below line if you have 8mb of flash and no PSRAM and comment the line below it
 ;[env:T-QT-Pro-N8]
 [env:T-QT-Pro-N4R2]
 platform = espressif32@6.6.0
 board = esp32-s3-t-qt-pro
 framework = arduino
 build_flags = 
-    ; comment the below line if you don't have PSRAM
 	-DBOARD_HAS_PSRAM
 lib_deps = 
 	lennarthennigs/Button2@^2.3.3
 	adafruit/Adafruit GFX Library@^1.11.11
 	adafruit/Adafruit MPU6050 @ ^2.0.3
-    adafruit/Adafruit Unified Sensor @ ^1.1.4
+        adafruit/Adafruit Unified Sensor @ ^1.1.4

images/TQT-psram-conf.png

@@ -1,6 +1,6 @@
 /*
  *                                                      OpenTime Watch OS
- *                                                            V0.3
+ *                                                           V0.3.1
  *  An open source OS for watches.
  * 
  *  created on 15 November 2024
@@ -15,6 +15,10 @@
  *  Made improvements in navigation of the OS and updated the README.md file to include a manual and changed the tone of the speaker.
  *  31 December 2024 - V 0.3 Beta 1 -
  *  Added new UI, better controls, time synchronisation, new watch face, accelerometer support.
+ *  10 January 2025 - V 0.3 -
+ *  Stable release of V0.3
+ *  15 February 2025 - V 0.3.1 -
+ *  Minor update, otwUI bug fix and better documentation.
  */
 
 // include all the necessary libraries for the OS

platformio.ini

@@ -4,9 +4,9 @@
    #include <TFT_eSPI.h>
    extern TFT_eSPI tft;
    extern int selected;
-   extern TFT_eSprite timing;
+   extern TFT_eSprite screenSprite;
    void clearScreen();
    void cursorControll(int menuItemNoHolder);
    void menuScreen(String menuItemHolder[], int menuItemNoHolder);
    void clearScreenSprite();
-#endif
+#endif

src/main.cpp

@@ -48,8 +48,9 @@ void infoScreen(){
   tft.fillScreen(TFT_BLACK);
   tft.setTextColor(TFT_WHITE);
   tft.drawString("OpenTime Watch OS",0,0,2);
-  tft.drawString("Version : V 0.2.1",0,20,2);
+  tft.drawString("Version : V 0.3.1",0,20,2);
   tft.drawString("CPU : ESP32-S3",0,40,2);
   tft.drawString("PSRAM : 2MB",0,60,2);
   tft.drawString("Flash : 4MB",0,80,2);
+  tft.drawString("By : jaswch",0,80,2);
 }