Skip to content

Commit 5a2d5f7

Browse files
committed
Add more Pages
1 parent 1bef96c commit 5a2d5f7

File tree

10 files changed

+195
-2
lines changed

10 files changed

+195
-2
lines changed

docs/Configurator Tool.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
This tool takes place of a python script which allows users to automatically configure their watch firmware before uploading it to the watch. This tool configures:-
2+
3+
1. WiFi settings(WiFi network and password)
4+
2. Time settings(GMT offset, day light offset and NTP server)
5+
3. Target hardware settings(T-QT-Pro-N4R2 or T-QT-Pro-N8)
6+
7+
## Requirements
8+
1. Python (3 or above)
9+
10+
!!! note
11+
12+
This tool does not upload or compile the firmware for the watch.
13+
14+
## Usage
15+
You can start using the tool by running ```python otwConfigurator.py``` or ```python3 otwConfigurator.py``` in your terminal.

docs/Hardware Setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
1. LILYGO TQT Pro
33
2. USB-C cable
44
3. 3mm LED (White colour)
5-
4. Small speaker
5+
4. Small speaker (earpiece speaker from Redmi 1s)
66
5. MPU6050 accelerometer
77
6. Stemma qt connector
88
7. A computer with PlatformIO installed

docs/Hardware.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## LILYGO TQT Pro
2+
1. Processor:- ESP32 S3
3+
2. RAM:- 2MB
4+
3. Flash:- 4MB/8MB
5+
4. 2 Buttons
6+
5. Torch
7+
6. Speaker
8+
7. 0.85" GC9107 128 x 128 IPS display
9+
8. MPU6050
10+
9. USB-C
11+
12+
13+
![TQT Pro](assets/TQT-Pro.png)
14+
15+
Near EOL due lack of functionality compared to OpenTimeWatch 1 Rev 2.
16+
17+
## OpenTimeWatch 1 Rev 1
18+
1. Processor:- ESP32 S3
19+
2. RAM:- 8MB
20+
3. Flash:- 16MB
21+
4. 3 Buttons
22+
5. Torch
23+
6. Speaker
24+
7. 1.44" 128 x 128 TFT display
25+
8. IR transmitter
26+
9. MPU6050
27+
10. Pulse sensor
28+
11. Micro USB-B
29+
30+
![Watch 1](assets/OpenTimeWatch1.jpg)
31+
32+
Superseded by OpenTimeWatch 1 Rev 2.
33+
34+
## OpenTimeWatch 1 Rev 2
35+
1. Processor:- ESP32 S3
36+
2. RAM:- 8MB
37+
3. Flash:- 16MB
38+
4. 3 Buttons
39+
6. Speaker
40+
7. 1.54" 128 x 128 TFT display
41+
8. IR transmitter
42+
9. MPU6050
43+
10. BMP280
44+
11. Micro USB-B
45+
46+
Still in development.

docs/Installation: Automatic.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
This guide is for beginners and people who don't want to manually configure the firmware, it allows the user to configure the firmware using the configuration tool.
2+
3+
## Requirements
4+
1. VSCode with PlatformIO IDE
5+
2. Python
6+
7+
## Configuration
8+
1. Download the ```.zip``` file of the firmware source code from [here](https://github.com/OpenTimeWatch-Project/OpenTimeWatch-OS/releases)
9+
2. Unzip the source code file
10+
3. Open the unzipped folder using VSCode
11+
4. Open terminal
12+
5. Execute the tool:- ```python otwConfigurator.py``` or ```python3 otwConfigurator.py```
13+
6. Start configuring using the command line tool
14+
15+
After succesfully configuring the firmware, you can now upload the firmware to your watch.
16+
17+
## Uploading
18+
1. Connect your watch to your computer using a USB cable.
19+
2. Upload the firmware by clicking the upload button on thee bottom left side of the screen or press ++ctrl+alt+u++
20+
21+
![Image title](assets/upload_button.png)
22+
23+
After successfully uploading the firmware you can start using the watch.

docs/Installation: Manual.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
This guide is for people who want to manually configure the firmware settings via the PlatformIO IDE.
2+
3+
!!! note
4+
5+
This guide is not recommended for beginners please refer to the automatic version of this guide.
6+
7+
## Requirements
8+
1. PlatformIO
9+
10+
## WiFi and Time configuration
11+
Changes in ```src/osVariables/osVariables.cpp``` :-
12+
13+
1. To configure your WiFi network enter your SSID (network name) in line 40
14+
```const char* ssid = "yourSSID";``` (replace
15+
yourSSID with your network name) and in line 42 replace yourPassword with your network password ```const char* password = "yourPassword";```
16+
2. To setup time enter the GMT offset of your region in line 46 ```const long gmtOffset_sec = 0;``` and daylight offset
17+
in line 48 ```const int daylightOffset_sec = 0;``` and make sure both of them are in seconds. If you can't get the time
18+
properly even after setting the GMT and daylight offset then you might have to change the URL of the NTP server to a URL
19+
which is closer to your location in line 44 ```const char* ntpServer = "pool.ntp.org";```.
20+
Below are a few common NTP server URLs:-
21+
<br>
22+
23+
Area | HostName
24+
:-------------|:-------------------------
25+
Asia | asia.pool.ntp.org
26+
Europe | europe.pool.ntp.org
27+
North America | north-america.pool.ntp.org
28+
Oceania | oceania.pool.ntp.org
29+
South America | south-america.pool.ntp.org
30+
31+
## Configuration for TQT pro N4R2 (Flash: 4MB, PSRAM: 2MB)
32+
Just upload the code without any changes to the ```platformio.ini``` file. It should look like this:
33+
<br>
34+
```ini title="platformio.ini" linenums="1"
35+
; PlatformIO Project Configuration File
36+
37+
38+
[platformio]
39+
boards_dir = ./board
40+
;default_envs = T-QT-Pro-N8
41+
default_envs = T-QT-Pro-N4R2
42+
description = Open source watch OS for ESP32 based watches
43+
44+
;[env:T-QT-Pro-N8]
45+
[env:T-QT-Pro-N4R2]
46+
47+
board = esp32-s3-t-qt-pro
48+
framework = arduino
49+
build_flags =
50+
-DBOARD_HAS_PSRAM
51+
lib_deps =
52+
lennarthennigs/Button2@^2.3.3
53+
adafruit/Adafruit GFX Library@^1.11.11
54+
adafruit/Adafruit MPU6050 @ ^2.0.3
55+
adafruit/Adafruit Unified Sensor @ ^1.1.4
56+
```
57+
58+
Note:- PlatformIO is currently assuming we have total 1MB of flash and not detecting the PSRAM.
59+
60+
61+
## Configuration for TQT pro N8 (Flash: 8MB, PSRAM: none)
62+
You will need to do some changes in the ```platformio.ini``` file before uploading the code. It should look like this:
63+
<br>
64+
```ini title="platformio.ini" linenums="1"
65+
; PlatformIO Project Configuration File
66+
67+
68+
[platformio]
69+
boards_dir = ./board
70+
default_envs = T-QT-Pro-N8
71+
;default_envs = T-QT-Pro-N4R2
72+
description = Open source watch OS for ESP32 based watches
73+
74+
[env:T-QT-Pro-N8]
75+
;[env:T-QT-Pro-N4R2]
76+
77+
board = esp32-s3-t-qt-pro
78+
framework = arduino
79+
build_flags =
80+
; -DBOARD_HAS_PSRAM
81+
lib_deps =
82+
lennarthennigs/Button2@^2.3.3
83+
adafruit/Adafruit GFX Library@^1.11.11
84+
adafruit/Adafruit MPU6050 @ ^2.0.3
85+
adafruit/Adafruit Unified Sensor @ ^1.1.4
86+
```
87+
88+
After configuring the firmware source code you can upload it to the watch.

docs/assets/Logo.png

1.23 KB
Loading

docs/assets/OpenTimeWatch1.jpg

2.09 MB
Loading

docs/assets/TQT-Pro.png

251 KB
Loading

docs/assets/upload_button.png

57 KB
Loading

mkdocs.yml

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ theme:
44
name: material
55
font:
66
code: Red Hat Mono
7+
logo: assets/Logo.png
8+
features:
9+
- navigation.footer
710
palette:
811
# Dark Mode
912
- scheme: slate
@@ -24,4 +27,22 @@ markdown_extensions:
2427
- attr_list
2528
- pymdownx.emoji:
2629
emoji_index: !!python/name:material.extensions.emoji.twemoji
27-
emoji_generator: !!python/name:material.extensions.emoji.to_svg
30+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
31+
- pymdownx.highlight:
32+
anchor_linenums: true
33+
line_spans: __span
34+
pygments_lang_class: true
35+
- pymdownx.inlinehilite
36+
- pymdownx.snippets
37+
- pymdownx.superfences
38+
- admonition
39+
- pymdownx.details
40+
- md_in_html
41+
- pymdownx.blocks.caption
42+
- pymdownx.critic
43+
- pymdownx.caret
44+
- pymdownx.keys
45+
- pymdownx.mark
46+
- pymdownx.tilde
47+
extra:
48+
copyright: Copyright &copy; 2024 Jaswanth Venkata Sai Chennu

0 commit comments

Comments
 (0)