You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-10Lines changed: 24 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# OpenTimeWatch-OS
2
-
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.
2
+
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.
3
3
4
4
# Why need another OS for watches?
5
5
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
21
21
5. Connect the Stemma qt connector to the TQT Pro
22
22
23
23
# Installation (for platformio users)
24
-
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)
24
+
## TQT pro N4R2 (Flash: 4MB, PSRAM: 2MB)
25
+
Just upload the code without any changes to the ```platformio.ini``` file. It should look like this:
26
+
27
+
## TQT pro N8 (Flash: 8MB, PSRAM: none)
28
+
You will need to do some changes in the ```platformio.ini``` file before uploading the code. It should look like this:
29
+
25
30
26
31
# Installation (for arduino users)
27
-
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
32
+
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.
28
33
29
34
# Features
30
35
1. Home screen with custom background
@@ -36,7 +41,7 @@ All of the required code is in the ```src``` directory, just rename the file ```
36
41
7. Time setting using WiFi
37
42
8. Multiple Watch Faces
38
43
9. Shows CPU temperature
39
-
10. Hacker Mode (ITS JUST A MATRIX EFFECT AND NOT ANYTHING RELATED TO HACKING AND DON'T GET MAD AT ME)
44
+
10. Hacker Mode (ITS JUST A MATRIX EFFECT AND NOT ANYTHING RELATED TO HACKING)
40
45
11. Battery voltage
41
46
12. Battery Charging
42
47
@@ -47,10 +52,11 @@ All of the required code is in the ```src``` directory, just rename the file ```
47
52
4. While playing pong scroll button moves the paddle up and the menu button moves the paddle down
48
53
49
54
# Release Notes
50
-
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.
51
-
2.**V0.2.1** - Added refinements to the OS navigation, added a manual in the ```README.md``` and changed the tone of the speaker.
52
-
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.
53
-
4.**V0.1** - The initial release it just had a home screen and an about screen.
55
+
1.**V0.3.1** - otwUI bug fix, updated configuration for TQT pro N8 in ```platformio.ini``` file and better documentation.
56
+
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.
57
+
3.**V0.2.1** - Added refinements to the OS navigation, added a manual in the ```README.md``` and changed the tone of the speaker.
58
+
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.
59
+
5.**V0.1** - The initial release it just had a home screen and an about screen.
54
60
55
61
# When could you expect SDKs for apps, custom home screens and widgets
56
62
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
59
65
Yes, you can contribute to the project by the following ways :
60
66
1. Help us add features to the project by making a PR.
61
67
2. Help us test and find bugs.
62
-
3. Give feature suggestions in this [issue](https://github.com/OpenTimeWatch-Project/OpenTimeWatch-OS/issues/1).
68
+
3. Give feature suggestions at this [issue](https://github.com/OpenTimeWatch-Project/OpenTimeWatch-OS/issues/1).
63
69
4. Help us test or review PRs.
64
-
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)
65
70
Note:- PRs for grammar correction or punctuations will not be merged instead create an issue for it.
0 commit comments