v0.18.0 🎉

.github/workflows/test-EMULATOR.yml

@@ -56,6 +56,6 @@ jobs:
         if: failure()
         uses: actions/upload-artifact@v4
         with:
-          name: test-results
+          name: test-results-${{ matrix.build-configuration }}
           path: |
             build/Testing

.github/workflows/test-OS.yml

@@ -75,3 +75,8 @@ jobs:
         run: mv include/config.h.example include/config.h
       - name: Compile language ${{ matrix.language }} model ${{ matrix.model }}
         run: python3 .github/buildFirmware.py -l "${{ matrix.language }}" -m "${{ matrix.model }}" -b debug
+      - name: Upload ${{ matrix.os }} firmware artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: firmwares-${{ matrix.os }}-${{ matrix.language }}-${{ matrix.model }}
+          path: "*.bin"

.github/workflows/test-OSW.yml

@@ -85,9 +85,9 @@ jobs:
       - name: Compile language ${{ matrix.language }} model ${{ matrix.model }}
         run: python3 .github/buildFirmware.py -l "${{ matrix.language }}" -m "${{ matrix.model }}" -b "${{ matrix.build-configuration }}"
       - name: Upload firmware artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: firmwares
+          name: firmwares-${{ matrix.language }}-${{ matrix.model }}-${{ matrix.build-configuration }}
           path: "*.bin"
 
   # do this last step seperately to avoid race conditions with firmware upload
@@ -96,14 +96,14 @@ jobs:
     needs: build-OSW
     if: startsWith(github.ref, 'refs/tags/v')
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
-          pattern: "*.bin"
+          pattern: firmwares*
           merge-multiple: true
       - name: Create release and upload firmware to it
         uses: softprops/action-gh-release@v2
         with:
-          files: "firmwares/*.bin"
+          files: "*.bin"
           draft: true
           prerelease: true
           generate_release_notes: true

README.md

@@ -118,7 +118,7 @@ $ ./createScreenshot.sh <IP_OF_WATCH> <SCREENSHOT>
 
 ## Troubleshooting
 
-For more information on troubleshooting, see [Wiki](https://open-smartwatch.github.io/resources/firmware/#troubleshooting).
+For more information on troubleshooting, see [Wiki](https://open-smartwatch.github.io/firmware/troubleshooting/).
 
 ### Arduino_TFT.h: No such file or directory
 

docs/firmware/apps/watchfaces.md

@@ -1,6 +1,8 @@
 # Watchfaces
 
 ## Default
+!!! tip
+    On most watchfaces, you can control the screen brightness by pressing the `UP` and `DOWN` buttons and store it quickly as default by long-pressing the `DOWN` button.
 
 ### Analog
 

docs/firmware/flags.md

@@ -6,6 +6,7 @@ The table below list all currently available features of the OSW-OS. These featu
 | `OSW_FEATURE_STATS_STEPS`    | Enable step history (displayed on the watchfaces)                                    | -                                  |
 | `OSW_FEATURE_WIFI`           | Enable all wifi related functions (services, webinterface)                           | -                                  |
 | `OSW_FEATURE_WIFI_ONBOOT`    | Allow the user to enable the wifi on boot                                            | `OSW_FEATURE_WIFI`                 |
+| `OSW_FEATURE_BLE_SERVER`     | Enable BLE server for the watch                                                      | -                                  |
 | `OSW_FEATURE_BLE_MEDIA_CTRL` | Enables media control via BLE                                                        | -                                  |
 | `OSW_FEATURE_LUA`            | Enable LUA scripting support for apps                                                | `LUA_C89_NUMBERS`                  |
 | `SERVICE_BLE_COMPANION=1`    | Enables the BLE Companion Service (unstable, requires custom smartphone application) | -                                  |

include/apps/watchfaces/OswAppWatchfaceDigital.h

@@ -17,12 +17,12 @@ class OswAppWatchfaceDigital: public OswAppV2 {
     void onDraw() override;
     void onButton(Button id, bool up, ButtonStateNames state) override;
 
-    inline static uint8_t getDateFormat();  // Return 0 : mm/dd/yyyy 1 : dd.mm.yyyy 2 : yy.mm/dd
+    inline static uint8_t getDateFormat();
     static void refreshDateFormatCache();
     static void drawSteps();
     static void digitalWatch(short timeZone, uint8_t fontSize, uint8_t dateCoordY, uint8_t timeCoordY);
-    static void timeOutput(uint32_t hour, uint32_t minute, uint32_t second, bool showSecond = true);
-    static void dateOutput(uint32_t yearInt, uint32_t monthInt, uint32_t dayInt);
+    static void timeOutput(const OswTime& oswTime, bool showSecond = true);
+    static void dateOutput(const OswDate& oswDate);
     static void displayWeekDay3(const char* weekday);
 
   private:

include/apps/watchfaces/OswAppWatchfaceFitnessAnalog.h

@@ -25,21 +25,15 @@ class OswAppWatchfaceFitnessAnalog : public OswAppV2 {
 
     static uint32_t calculateDistance(uint32_t steps);
 
-    void timeDisplay(OswHal* hal, uint32_t hour, uint32_t minute, uint32_t second);
-    void timeDisplay(OswHal* hal, uint32_t hour, uint32_t minute, uint32_t second, bool afterNoon);
-    void dateDisplay(OswHal* hal, uint32_t hour, uint32_t minute, uint32_t second, bool afterNoon);
-
-    void test();
-
     ~OswAppWatchfaceFitnessAnalog() {}
 
   private:
     time_t lastTime = 0;
     unsigned screen = 0;
 
     void showFitnessTracking(OswHal* hal);
-    void drawWatchFace(OswHal* hal, uint32_t hour, uint32_t minute, uint32_t second, bool afterNoon);
-    void drawDateFace(OswHal* hal, uint32_t hour, uint32_t minute, uint32_t second, bool afterNoon);
+    void drawWatchFace(OswHal* hal, const OswTime& oswTime);
+    void drawDateFace(OswHal* hal, const OswDate& oswDate, const OswTime& oswTime);
 
 #ifdef GIF_BG
     OswAppGifPlayer* bgGif = nullptr;

include/config_defaults.h

@@ -86,6 +86,10 @@
 #define CONFIG_FALLBACK_2ND_WIFI_PASS ""
 #endif
 
+#ifndef BLE_ON_BOOT
+#define BLE_ON_BOOT false
+#endif
+
 #ifndef DISPLAY_BRIGHTNESS
 // DISPLAY_MIN_BRIGHTNESS - 255
 #define DISPLAY_BRIGHTNESS 128
@@ -174,7 +178,7 @@
 // The following settings are configurable later on using the web ui, you can still set the defaults here.
 
 #ifndef CONFIG_DATE_FORMAT
-// possibilities: "mm/dd/yyyy","dd.mm.yyyy" and "yy.mm/dd"
+// see src/osw_config_keys.cpp for possible values (look for this define in the file)
 #define CONFIG_DATE_FORMAT "mm/dd/yyyy"
 #endif
 
@@ -238,8 +242,10 @@
 #define TOOL_TIMER_BTN_TIMEOUT 1800
 #endif
 
-/*
- * Experimentals/Services:
+/**
+ * Experimentals/Services
+ *
+ * Keep in mind, that the OSW may not be tested with these flags (un)set. Be prepared to fix some bugs ;)
  */
 
 // Experimentals (1 = enable, 0 = disable):

include/gfx_2d_print.h

@@ -453,7 +453,7 @@ class Graphics2DPrint : public Graphics2D, public Print {
      * @brief Set the text size.
      *
      * Size "1" mean a size of 8px height and 6 px width.
-     * Size "2" mean a double size => 18px height x 12px width
+     * Size "2" mean a double size => 16px height x 12px width
      *
      * @param s Size of the text
      */

include/locales/de-DE.h

@@ -50,6 +50,9 @@
 #define LANG_WEBSRV_AP_PASSWORD_ON "AutoAP PW an"
 #define LANG_WEBSRV_AP_PASSWORD_OFF "AutoAP PW aus"
 
+// App: Watchface Parent Class
+#define LANG_WATCHFACE_DEFAULT_SET "Standard Uhr Design\ngespeichert."
+
 // App: Watchface Binary
 #define LANG_WATCHFACE_BINARY_STEPS "Schritte"
 

include/locales/en-US.h

@@ -149,6 +149,11 @@
 #define LANG_WEBSRV_AP_PASSWORD_OFF "AutoAP PW OFF"
 #endif
 
+// App: Watchface Parent Class
+#ifndef LANG_WATCHFACE_DEFAULT_SET
+#define LANG_WATCHFACE_DEFAULT_SET "Default watchface\nchanged."
+#endif
+
 // App: Watchface Binary
 #ifndef LANG_WATCHFACE_BINARY_STEPS
 #define LANG_WATCHFACE_BINARY_STEPS "steps"

include/osw_config_keys.h

@@ -24,8 +24,10 @@ class OswConfigKeyRGB;
 
 // All externally accessible keys are listed here (add them to osw_config_keys.cpp oswConfigKeys for config ui)
 namespace OswConfigAllKeys {
-#ifdef OSW_FEATURE_WIFI
+#if defined(OSW_FEATURE_WIFI) || defined(OSW_FEATURE_BLE_SERVER)
 extern OswConfigKeyString hostname;
+#endif
+#ifdef OSW_FEATURE_WIFI
 extern OswConfigKeyBool hostPasswordEnabled;
 extern OswConfigKeyPassword hostPass;
 #ifdef OSW_FEATURE_WIFI_ONBOOT
@@ -40,6 +42,9 @@ extern OswConfigKeyPassword fallbackWifiPass1st;
 extern OswConfigKeyString fallbackWifiSsid2nd;
 extern OswConfigKeyPassword fallbackWifiPass2nd;
 #endif
+#ifdef OSW_FEATURE_BLE_SERVER
+extern OswConfigKeyBool bleBootEnabled;
+#endif
 extern OswConfigKeyRGB themeBackgroundColor;
 extern OswConfigKeyRGB themeBackgroundDimmedColor;
 extern OswConfigKeyRGB themeForegroundColor;

include/osw_hal.h

@@ -29,17 +29,17 @@
 #define ERR_SD_MOUNT_FAILED 2
 
 typedef struct {
-    uint32_t hour;
-    uint32_t minute;
-    uint32_t second;
+    uint8_t hour;
+    uint8_t minute;
+    uint8_t second;
     bool afterNoon;
 } OswTime;
 
 typedef struct {
-    uint32_t year;
-    uint32_t month;
-    uint32_t day;
-    uint32_t weekDay;
+    uint16_t year;
+    uint8_t month;
+    uint8_t day;
+    uint8_t weekDay;
 } OswDate;
 
 class OswHal {
@@ -79,14 +79,15 @@ class OswHal {
     void setup(bool fromLightSleep);
     void setupFileSystem(void);
     void setupButtons();
-    void setupDisplay();
+    void setupDisplay(bool fromLightSleep);
     void setupPower(bool fromLightSleep);
 #if defined(GPS_EDITION) || defined(GPS_EDITION_ROTATED)
     void setupGps(void);
 #endif
 
     // Stop
     void stop(bool toLightSleep);
+    void stopDisplay(bool toLightSleep);
     void stopPower();
 
     // Buttons (Engine-Style)

include/osw_pins.h

@@ -6,8 +6,8 @@
 // SD_MISO 19
 // for SCK, MOSI see TFT
 
-#define GPS_RX 14
-#define GPS_TX 27
+#define GPS_RX 27
+#define GPS_TX 14
 #define GPS_FON 26
 #define GPS_3D_FIX 36
 #define GPS_GEO_FENCE 39
@@ -16,14 +16,10 @@
 #define BTN_1 0
 #define BTN_2 13
 #define BTN_3 33
-#define GPS_RX1 27
-#define GPS_TX1 14
 #elif defined(GPS_EDITION_ROTATED)
 #define BTN_1 13
 #define BTN_2 33
 #define BTN_3 0
-#define GPS_RX1 27
-#define GPS_TX1 14
 #else
 #define BTN_1 0
 #define BTN_2 13

include/osw_ui.h

@@ -46,16 +46,26 @@ class OswUI {
             return message;
         }
 
+        unsigned char getMessageLines() const {
+            return lines;
+        }
+
         unsigned long getEndTime() const {
             return endTime;
         }
 
-        const static unsigned char sDrawHeight = 16;  // EVERY notification must not be taller than this!
+        unsigned char getDrawHeight() const;
 
       private:
-        size_t id{};
+        unsigned char countLines(const std::string& message) const;
+
+        const unsigned long notificationDurationPerLinePersistant = 300'000;
+        const unsigned long notificationDurationPerLine = 5'000;
+
         static size_t count;
+        const size_t id{};
         const String message{};
+        const unsigned char lines;
         const unsigned long endTime{};
     };
 
@@ -87,6 +97,7 @@ class OswUI {
     size_t showNotification(std::string message, bool isPersistent);
     void hideNotification(size_t id);
 
+    void resetTextFont();
     void resetTextColors();
     void resetTextAlignment();
     void setTextCursor(Button btn);
@@ -109,6 +120,7 @@ class OswUI {
     unsigned int lastBGFlush = 0;
     std::mutex mNotificationsLock;
     std::list<OswUINotification> mNotifications;
+    bool mSelfNeedsRedraw = false;
     OswAppV2* mRootApplication = nullptr;
 };
 

include/services/NotifierClient.h

@@ -16,6 +16,8 @@ class NotifierClient {
     NotificationData createNotification(int hours, int minutes,
                                         std::string message = {}, std::array<bool, 7> daysOfWeek = {}, bool isPersistent = {});
 
+    NotificationData showToast(std::string message);
+
     std::vector<NotificationData> readNotifications();
 
     void deleteNotification(unsigned id);

include/services/OswServiceManager.h

@@ -19,13 +19,18 @@ class OswServiceManager {
         instance.reset();
     }
 
-    //Temp workaround until #137 is done
+    // Temp workaround until #137 is done
 #ifdef OSW_FEATURE_WIFI
-#define _SERVICE_WIFI 1
+#define _ADDITIONAL_STACK_SIZE_FOR_WIFI 8192
 #else
-#define _SERVICE_WIFI 0
+#define _ADDITIONAL_STACK_SIZE_FOR_WIFI 0
 #endif
-    const unsigned workerStackSize = 2048 + (8192 * _SERVICE_WIFI); // If wifi is active, set to same size as core 0
+#ifdef OSW_FEATURE_BLE_SERVER
+#define _ADDITIONAL_STACK_SIZE_FOR_BLE 2048
+#else
+#define _ADDITIONAL_STACK_SIZE_FOR_BLE 0
+#endif
+    const unsigned workerStackSize = 2048 + _ADDITIONAL_STACK_SIZE_FOR_WIFI + _ADDITIONAL_STACK_SIZE_FOR_BLE; // base stack size is 2k
     const unsigned workerStartupDelay = 2000;
     const unsigned workerLoopDelay = 10;
 

include/services/OswServiceTaskBLECompanion.h

@@ -1,8 +1,7 @@
-#ifndef OSW_SERVICE_COMPANION_H
-#define OSW_SERVICE_COMPANION_H
+#pragma once
 
-#ifndef OSW_EMULATOR
 #if SERVICE_BLE_COMPANION == 1
+#ifndef OSW_EMULATOR
 #include <BLECharacteristic.h>
 #include <BLEDevice.h>
 #include <osw_hal.h>
@@ -45,4 +44,3 @@ class OswServiceTaskBLECompanion : public OswServiceTask {
 
 #endif
 #endif
-#endif