Skip to content

Commit 7c34f0e

Browse files
authored
Update README.md
1 parent 4cc58ad commit 7c34f0e

1 file changed

Lines changed: 68 additions & 16 deletions

File tree

README.md

Lines changed: 68 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,69 @@ which is closer to your location in line 44 ```const char* ntpServer = "pool.ntp
3131
Below are a few common NTP server URLs:-
3232
<br>
3333

34-
![Alt text](images/ntp.png)
34+
Area | HostName
35+
-------:|:-------------------------
36+
Asia | asia.pool.ntp.org
37+
Europe | europe.pool.ntp.org
38+
North America | north-america.pool.ntp.org
39+
Oceania | oceania.pool.ntp.org
40+
South America | south-america.pool.ntp.org
3541

3642
## For Platformio users
3743
### TQT pro N4R2 (Flash: 4MB, PSRAM: 2MB)
3844
Just upload the code without any changes to the ```platformio.ini``` file. It should look like this:
3945
<br>
40-
![Alt text](images/TQT-psram-conf.png)
46+
```
47+
; PlatformIO Project Configuration File
48+
49+
50+
[platformio]
51+
boards_dir = ./board
52+
;default_envs = T-QT-Pro-N8
53+
default_envs = T-QT-Pro-N4R2
54+
description = Open source watch OS for ESP32 based watches
55+
56+
;[env:T-QT-Pro-N8]
57+
[env:T-QT-Pro-N4R2]
58+
platform = espressif32@6.6.0
59+
board = esp32-s3-t-qt-pro
60+
framework = arduino
61+
build_flags =
62+
-DBOARD_HAS_PSRAM
63+
lib_deps =
64+
lennarthennigs/Button2@^2.3.3
65+
adafruit/Adafruit GFX Library@^1.11.11
66+
adafruit/Adafruit MPU6050 @ ^2.0.3
67+
adafruit/Adafruit Unified Sensor @ ^1.1.4
68+
```
4169

4270
Note:- Platformio is currently assuming we have total 1MB of flash and not detecting the PSRAM.
4371
### TQT pro N8 (Flash: 8MB, PSRAM: none)
4472
You will need to do some changes in the ```platformio.ini``` file before uploading the code. It should look like this:
4573
<br>
46-
![Alt text](images/TQT-non-psram-conf.png)
74+
```
75+
; PlatformIO Project Configuration File
76+
77+
78+
[platformio]
79+
boards_dir = ./board
80+
default_envs = T-QT-Pro-N8
81+
;default_envs = T-QT-Pro-N4R2
82+
description = Open source watch OS for ESP32 based watches
83+
84+
[env:T-QT-Pro-N8]
85+
;[env:T-QT-Pro-N4R2]
86+
platform = espressif32@6.6.0
87+
board = esp32-s3-t-qt-pro
88+
framework = arduino
89+
build_flags =
90+
; -DBOARD_HAS_PSRAM
91+
lib_deps =
92+
lennarthennigs/Button2@^2.3.3
93+
adafruit/Adafruit GFX Library@^1.11.11
94+
adafruit/Adafruit MPU6050 @ ^2.0.3
95+
adafruit/Adafruit Unified Sensor @ ^1.1.4
96+
```
4797

4898
## For Arduino IDE users
4999
All of the required code is in the ```src``` directory, just rename the file ```main.cpp``` to ```main.ino``` and install the below libraries and upload the code
@@ -56,7 +106,7 @@ All of the required code is in the ```src``` directory, just rename the file ```
56106
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.
57107

58108
## Configurator Tool
59-
The OpenTimeWatch Configurator tool is a python script which allows users to configure the WiFi network and time settings before compiling and uploading the firmware to the watch. This tool does not configure your board type nor does it compile and upload the code. To run the tool type
109+
The OpenTimeWatch Configurator tool is a python script which allows users to configure the Board, WiFi network and time settings before compiling and uploading the firmware to the watch. This tool does not compile and upload the code. To run the tool type
60110

61111
```python otwConfigurator.py```
62112

@@ -66,6 +116,8 @@ or
66116

67117
in your terminal.
68118

119+
Note:- This tool only configures the board for the usage in PlatformIO IDE
120+
69121
# Features
70122
1. Home screen with custom background
71123
2. Activity view shows steps walked, calories burned and weather (It is just a dummy and not functionally implemented yet)
@@ -87,25 +139,25 @@ in your terminal.
87139
4. While playing pong scroll button moves the paddle up and the menu button moves the paddle down
88140

89141
# Release Notes
90-
1. **V0.3.2** - New OpenTimeWatch Configurator tool.
91-
2. **V0.3.1** - otwUI bug fix, updated configuration for TQT pro N8 in ```platformio.ini``` file and better documentation.
92-
3. **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 separated from the ```main.cpp``` file.
93-
4. **V0.2.1** - Added refinements to the OS navigation, added a manual in the ```README.md``` and changed the tone of the speaker.
94-
5. **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.
95-
6. **V0.1** - The initial release it just had a home screen and an about screen.
142+
1. **V0.3.3** - OpenTimeWatch Configurator tool can now configure board settings.
143+
2. **V0.3.2** - New OpenTimeWatch Configurator tool.
144+
3. **V0.3.1** - otwUI bug fix, updated configuration for TQT pro N8 in ```platformio.ini``` file and better documentation.
145+
4. **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 separated from the ```main.cpp``` file.
146+
5. **V0.2.1** - Added refinements to the OS navigation, added a manual in the ```README.md``` and changed the tone of the speaker.
147+
6. **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.
148+
7. **V0.1** - The initial release it just had a home screen and an about screen.
96149

97150
# What to expect in V0.4?
98151
1. Support for our new watch hardware:- OpenTimeWatch 1
99152
2. Weather synchronisation
100153
3. Accent colours
101154
4. IR transmitter support
102155
5. Support for 3 navigation buttons
103-
6. Pulse sensor support
104-
7. Screen brightness adjustment
105-
8. Screen on-time adjustment
106-
9. Watch endurance
107-
10. Flappy bird clone
108-
11. UART console support
156+
6. Screen brightness adjustment
157+
7. Screen on-time adjustment
158+
8. Watch endurance
159+
9. Flappy bird clone
160+
10. UART console support
109161

110162
# Can I contribute ?
111163
Yes, you can contribute to the project by the following ways :

0 commit comments

Comments
 (0)