Merge pull request #17 from jaswch/main

V0.3.2

Author: jaswch

README.md

@@ -55,6 +55,17 @@ All of the required code is in the ```src``` directory, just rename the file ```
 
 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.
 
+## Configurator Tool
+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 
+
+```python otwConfigurator.py```
+
+or
+
+```python3 otwConfigurator.py```
+
+in your terminal.
+
 # Features
 1. Home screen with custom background
 2. Activity view shows steps walked, calories burned and weather (It is just a dummy and not functionally implemented yet)
@@ -76,11 +87,12 @@ Note:- also refer to the README.md at [TQT pro](https://github.com/Xinyuan-LilyG
 4. While playing pong scroll button moves the paddle up and the menu button moves the paddle down
 
 # Release Notes
-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 separated 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.
+1. **V0.3.2** - New OpenTimeWatch Configurator tool.
+2. **V0.3.1** - otwUI bug fix, updated configuration for TQT pro N8 in ```platformio.ini``` file and better documentation.
+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.
+4. **V0.2.1** - Added refinements to the OS navigation, added a manual in the ```README.md``` and changed the tone of the speaker.
+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. 
+6. **V0.1** - The initial release it just had a home screen and an about screen.
 
 # What to expect in V0.4?
 1. Support for our new watch hardware:- OpenTimeWatch 1
@@ -95,9 +107,6 @@ Note:- also refer to the README.md at [TQT pro](https://github.com/Xinyuan-LilyG
 10. Flappy bird clone
 11. UART console support
 
-# 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.
-
 # Can I contribute ?
 Yes, you can contribute to the project by the following ways :
 1. Help us add features to the project by making a PR.

otwConfigurator.py

@@ -0,0 +1,69 @@
+# OpenTimeWatch Configurator tool
+
+print("Welcome to OpenTimeWatchOS configuration script")
+file_path = "/home/jaswanth/Developer/Arduino/OpenTimeWatch-OS/src/osVariables/osVariables.cpp"
+
+def configureWifiNetwork(userSSID):
+    try:
+        with open(file_path, 'r') as file:
+            lines = file.readlines()
+
+        with open(file_path, 'w') as file:
+            for line in lines:
+                if 'const char* ssid = ' in line:
+                    line = f'const char* ssid  = "{userSSID}";\n'
+                file.write(line)
+    except Exception as e:
+        print(f"An error occurred: {e}")
+
+def configureWifiPassword(userPassword):
+    try:
+        with open(file_path, 'r') as file:
+            lines = file.readlines()
+
+        with open(file_path, 'w') as file:
+            for line in lines:
+                if 'const char* password = ' in line:
+                    line = f'const char* password = "{userPassword}";\n'
+                file.write(line)
+    except Exception as e:
+        print(f"An error occurred: {e}")
+    
+def configureGMTOffset(userGMT):
+    try:
+        with open(file_path, 'r') as file:
+            lines = file.readlines()
+
+        with open(file_path, 'w') as file:
+            for line in lines:
+                if 'const long gmtOffset_sec = ' in line:
+                    line = f'const long  gmtOffset_sec = {userGMT};\n'
+                file.write(line)
+    except Exception as e:
+        print(f"An error occurred: {e}")
+
+def configureDayLightOffset(userDayLight):
+    try:
+        with open(file_path, 'r') as file:
+            lines = file.readlines()
+
+        with open(file_path, 'w') as file:
+            for line in lines:
+                if 'const int daylightOffset_sec = ' in line:
+                    line = f'const int daylightOffset_sec = {userDayLight};\n'
+                file.write(line)
+    except Exception as e:
+        print(f"An error occurred: {e}")
+
+if __name__ == "__main__":
+    
+    userSSID = input("Enter your WiFi network name: ")
+    configureWifiNetwork(userSSID)
+    userPassword = input("Enter your WiFi network password: ")
+    configureWifiPassword(userPassword)
+    userGMT = input("Enter your area's GMT offset(in seconds): ")
+    configureGMTOffset(userGMT)
+    userDayLight = input("Enter your area's day light offset(in seconds): ")
+    configureDayLightOffset(userDayLight)
+    
+print("Configuration complete. Please compile and upload the firmware.")

src/main.cpp

@@ -1,6 +1,6 @@
 /*
  *                                                      OpenTime Watch OS
- *                                                           V0.3.1
+ *                                                           V0.3.2
  *  An open source OS for watches.
  * 
  *  created on 15 November 2024
@@ -19,6 +19,8 @@
  *  Stable release of V0.3
  *  15 February 2025 - V 0.3.1 -
  *  Minor update, otwUI bug fix and better documentation.
+ *  19 April 2025 - V 0.3.1 -
+ *  A new configurator tool.
  */
 
 // include all the necessary libraries for the OS

src/osVariables/osVariables.cpp

@@ -43,9 +43,9 @@ const char* password = "yourPassword";
 // URL of the ntp server
 const char* ntpServer = "pool.ntp.org";
 // GMT offset (in seconds)
-const long  gmtOffset_sec = 0;
+const long gmtOffset_sec = 0;
 // Day light offset (in seconds)
-const int   daylightOffset_sec = 0;
+const int daylightOffset_sec = 0;
 // A variable to store the first 3 letters of the current weekday name
 char dayName[4];
 // A variable to store the first 3 letters of the current month name

src/settingsMenu/settingsMenu.cpp

@@ -48,7 +48,7 @@ void infoScreen(){
   tft.fillScreen(TFT_BLACK);
   tft.setTextColor(TFT_WHITE);
   tft.drawString("OpenTime Watch OS",0,0,2);
-  tft.drawString("Version : V 0.3.1",0,20,2);
+  tft.drawString("Version : V 0.3.2",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);