Implemented emulator for #190

.github/workflows/test-emulator.yml

@@ -0,0 +1,26 @@
+name: OSW-EMULATOR-test
+
+on:
+  workflow_dispatch:
+  push:
+  pull_request:
+    branches: [ master, develop ]
+
+jobs:
+  build-EMULATOR:
+    runs-on: ubuntu-22.04
+    steps:
+    - name: Checkout repository and submodules
+      uses: actions/checkout@v2
+      with:
+        submodules: recursive
+    - name: Update packages
+      run: sudo apt-get update && sudo apt-get upgrade -y
+    - name: Install packages
+      run: sudo apt-get -y install gcc g++ cmake libsdl2-dev libsdl2-image-dev
+    - name: Create build directory
+      run: mkdir build
+    - name: CMake (debug)
+      run: cd build && cmake -DCMAKE_BUILD_TYPE=Debug ..
+    - name: Make
+      run: cd build && make

.gitignore

@@ -5,3 +5,5 @@ firmware.elf
 bin
 /*.png
 screenshots/
+build/
+emulator_nvs/

.gitmodules

@@ -1,6 +1,3 @@
-[submodule "lib/lib-open-smartwatch"]
-	path = lib/lib-open-smartwatch
-	url = https://github.com/Open-Smartwatch/lib-open-smartwatch.git
 [submodule "lib/pngle"]
 	path = lib/pngle
 	url = https://github.com/kikuchan/pngle.git
@@ -23,3 +20,12 @@
 	path = lib/LUA
 	url = https://github.com/lua/lua.git
 	branch = v5.3
+[submodule "emulator/lib/ArduinoJson"]
+	path = emulator/lib/ArduinoJson
+	url = https://github.com/bblanchon/ArduinoJson.git
+[submodule "emulator/lib/Jzon"]
+	path = emulator/lib/Jzon
+	url = https://github.com/Zguy/Jzon.git
+[submodule "emulator/lib/ImGUI"]
+	path = emulator/lib/ImGUI
+	url = https://github.com/ocornut/imgui.git

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "GDB: Emulator",
+            "type": "cppdbg",
+            "request": "launch",
+            "program": "${workspaceFolder}/build/emulator.run",
+            "args": [],
+            "stopAtEntry": false,
+            "cwd": "${workspaceFolder}/build",
+            "environment": [],
+            "externalConsole": false,
+            "MIMode": "gdb",
+            "setupCommands": [
+                {
+                    "description": "Enable pretty-printing for gdb",
+                    "text": "-enable-pretty-printing",
+                    "ignoreFailures": true
+                },
+                {
+                    "description": "Set Disassembly Flavor to Intel",
+                    "text": "-gdb-set disassembly-flavor intel",
+                    "ignoreFailures": true
+                }
+            ]
+        }
+    ]
+}

CMakeLists.txt

@@ -0,0 +1,108 @@
+cmake_minimum_required (VERSION 3.10)
+project (OSW-OS-Emulator)
+
+set(CMAKE_CXX_STANDARD 20)
+
+# Prepare some defines, which are normally evaluated using some Python snippets...
+execute_process(COMMAND "git" "rev-parse" "--short" "HEAD" OUTPUT_VARIABLE GIT_COMMIT_HASH)
+execute_process(COMMAND "git" "log" "-1" "--pretty=format:%cd" "--date=format:%Y-%m-%dT%H:%M:%S%z" OUTPUT_VARIABLE GIT_COMMIT_TIME)
+execute_process(COMMAND "git" "rev-parse" "--abbrev-ref" "HEAD" OUTPUT_VARIABLE GIT_BRANCH_NAME)
+string(STRIP ${GIT_COMMIT_HASH} GIT_COMMIT_HASH)
+string(STRIP ${GIT_COMMIT_TIME} GIT_COMMIT_TIME)
+string(STRIP ${GIT_BRANCH_NAME} GIT_BRANCH_NAME)
+
+# For threads
+set(THREADS_PREFER_PTHREAD_FLAG ON)
+find_package(Threads REQUIRED)
+
+# This uses pkg-config, as sdl2-image does not has any CMake bindings (and the sdl2 package via vcpkg is just broken under Linux)
+INCLUDE(FindPkgConfig)
+PKG_SEARCH_MODULE(SDL2 REQUIRED sdl2>=2.0.20)
+PKG_SEARCH_MODULE(SDL2IMAGE REQUIRED SDL2_image)
+
+# Pngle
+file(GLOB_RECURSE SOURCES_Pngle ./lib/pngle/*.c)
+add_library(Pngle ${SOURCES_Pngle})
+target_include_directories(Pngle PUBLIC ./lib/pngle/src/)
+
+# ArduinoJSON
+add_subdirectory(emulator/lib/ArduinoJson)
+
+# Jzon
+add_library(Jzon emulator/lib/Jzon/Jzon.cpp)
+target_include_directories(Jzon PUBLIC emulator/lib/Jzon/)
+
+# ImGUI
+add_library(ImGUI
+    emulator/lib/ImGUI/imgui.cpp
+    emulator/lib/ImGUI/imgui_draw.cpp
+    emulator/lib/ImGUI/imgui_widgets.cpp
+    emulator/lib/ImGUI/imgui_tables.cpp
+    emulator/lib/ImGUI/backends/imgui_impl_sdl.cpp
+    emulator/lib/ImGUI/backends/imgui_impl_sdlrenderer.cpp
+)
+target_include_directories(ImGUI PUBLIC
+    emulator/lib/ImGUI/
+    emulator/lib/ImGUI/backends
+    ${SDL2_INCLUDE_DIRS}
+)
+target_link_libraries(ImGUI LINK_PUBLIC
+    ${SDL2_LIBRARY}
+    ${SDL2IMAGE_LIBRARIES}
+)
+
+# Emulator
+file(GLOB_RECURSE SOURCES_OSW ./src/*.cpp)
+file(GLOB_RECURSE SOURCES_OSW_EMULATOR ./emulator/src/*.cpp)
+add_executable(emulator.run
+    ${SOURCES_OSW}
+    ${SOURCES_OSW_EMULATOR}
+)
+target_include_directories(emulator.run PUBLIC
+    ./emulator/include
+    ./include
+    ./lib/lib-open-smartwatch
+    emulator/lib/Jzon/
+    ${SDL2_INCLUDE_DIRS}
+    ${SDL2IMAGE_INCLUDE_DIRS}
+)
+target_link_libraries(emulator.run LINK_PUBLIC
+    Pngle
+    ArduinoJson
+    Threads::Threads
+    Jzon
+    ${SDL2_LIBRARY}
+    ${SDL2IMAGE_LIBRARIES}
+    ImGUI
+)
+target_compile_definitions(emulator.run PUBLIC
+    OSW_TARGET_PLATFORM_HEADER="platform/EMULATOR.h"
+    OSW_EMULATOR=1
+    GIT_COMMIT_HASH="${GIT_COMMIT_HASH}"
+    GIT_COMMIT_TIME="${GIT_COMMIT_TIME}"
+    GIT_BRANCH_NAME="${GIT_BRANCH_NAME}"
+    PIO_ENV_NAME="VIRTUAL"
+    $<$<CONFIG:Debug>:
+      DEBUG=1 # Just for legacy reasons
+    >
+    $<$<CONFIG:Release>:
+      NDEBUG=1
+    >
+    # Comment these as you wish...
+    OSW_FEATURE_STATS_STEPS
+)
+target_compile_options(emulator.run PUBLIC
+  $<$<CONFIG:Debug>:
+    -O0
+    -g3
+    -Wall
+  >
+  $<$<CONFIG:Release>:
+    -O4
+  >
+)
+
+# Including SDL2 using the system libraries is broken under MacOS, so we have to add this path manually...
+if (${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
+    link_directories(/usr/local/lib)
+endif()

Readme.md

@@ -42,15 +42,15 @@ $ pio run -e pico32_GPS_EDITION -t upload
 
 Depending on the watch model.
 
-## Debugging(CLI)
+## Debugging (CLI)
 
 If you want to print out the log for debugging, following command:
 
 ```
 $ pio device monitor
 ```
 
-## Creating Screen Shots of your Apps
+## Creating Screenshots of your Apps
 
 <img src="./screenshots/watchface_analog_osw.png" width="40%"><img src="./screenshots/watchface_digital_osw.png" width="40%">
 
@@ -98,3 +98,40 @@ You did not rename `include/config.h.example`
 ### Failed to connect to ESP32: Timed out waiting for packet header
 
 You did not hold down BTN1(FLASH) and then tap the RESET button on the watch whilst platform.io was trying to connect.
+
+## OSW Emulator
+![emulator](screenshots/emulator_demo.png)
+
+The OS itself can be executed as a regular program on your machine. This saves you time compiling for the watch and flashing the OS, every time you make a minor change - e.g. while developing the UI or a game, which not explicitly depend on the hardware of the watch.
+
+This also implies some limitations what you can do with the emulator, as we had to hack and reimplement some of the Arduino-specific libraries and their (conflicting) simplifications. This also means, that it maybe necessary to extend those extensions down the road as we (likely) missed that one specific function you try to use... :wink:
+
+### Build (cmake)
+The emulator can be build using the `CMakeLists.txt` file - you may need to install additional libraries to be able to use it.
+
+Here is a small example running on "Ubuntu 22.04 LTS":
+```bash
+$ sudo apt install libsdl2-dev libsdl2-image-dev g++ gcc cmake make build-essential
+$ mkdir build && cd build
+$ cmake ..
+$ make -j $(nproc)
+$ ./emulator.run
+```
+
+You also may extend the `cmake`-command with `-DCMAKE_BUILD_TYPE=Release` to get an even faster and smaller binary.
+
+### With Docker
+If a library is unavailable, you can still use the emulator using docker (e.g. on Ubuntu 20.04 SDL2 is too old). Proceed with a typical docker installation. Showing an application running in docker requires some additional steps:
+
+#### Host PC
+*Tested on Ubuntu 20.04.*
+```bash
+$ xhost +
+$ xauth list # Copy the result of the command. 
+$ docker run --net=host -e DISPLAY -v /tmp/.X11-unix -d --name OSW -p 22:22 -it --privileged ubuntu:22.04
+```
+
+#### Docker
+```bash
+$ xauth add <'xauth list' command result>
+```

emulator/include/Arduino.h

@@ -0,0 +1,9 @@
+#include "DataTypes.h"
+#include "Defines.h"
+
+unsigned long millis();
+long random(int howbig);
+long random(int howsmall, int howbig);
+void delay(long millis);
+int32_t min(int32_t a, int32_t b);
+int32_t max(int32_t a, int32_t b);

emulator/include/Arduino_G.h

@@ -0,0 +1,25 @@
+#pragma once
+
+#include "DataTypes.h"
+
+// Code for Arduino_G was copy-pasted from Arduino_GFX
+
+class Arduino_G
+{
+public:
+  Arduino_G(int16_t w, int16_t h): WIDTH(w), HEIGHT(h) {}; // Constructor
+
+  // This MUST be defined by the subclass:
+  virtual void begin(int32_t speed = 0) = 0;
+
+  virtual void drawBitmap(int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h, uint16_t color, uint16_t bg) = 0;
+  virtual void drawIndexedBitmap(int16_t x, int16_t y, uint8_t *bitmap, uint16_t *color_index, int16_t w, int16_t h) = 0;
+  virtual void draw3bitRGBBitmap(int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h) = 0;
+  virtual void draw16bitRGBBitmap(int16_t x, int16_t y, uint16_t *bitmap, int16_t w, int16_t h) = 0;
+  virtual void draw24bitRGBBitmap(int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h) = 0;
+
+protected:
+  int16_t
+      WIDTH,  ///< This is the 'raw' display width - never changes
+      HEIGHT; ///< This is the 'raw' display height - never changes
+};

emulator/include/Arduino_GFX.h

@@ -0,0 +1,6 @@
+#pragma once
+
+class Graphics2DPrint;
+typedef Graphics2DPrint Arduino_GFX;
+
+#include "Arduino_G.h"

emulator/include/CPU.h

@@ -0,0 +1,3 @@
+#pragma once
+
+void setCpuFrequencyMhz(int);

emulator/include/DataTypes.h

@@ -0,0 +1,4 @@
+#include <cstdint>
+#include <math.h>
+
+#define RTC_DATA_ATTR

emulator/include/Defines.h

@@ -0,0 +1,12 @@
+#pragma once
+
+#include <iostream>
+
+#define PI 3.1415926535897932384626433832795
+#define HALF_PI 1.5707963267948966192313216916398
+#define TWO_PI 6.283185307179586476925286766559
+#define DEG_TO_RAD 0.017453292519943295769236907684886
+#define RAD_TO_DEG 57.295779513082320876798154814105
+#define EULER 2.718281828459045235360287471352
+
+#define OSW_EMULATOR_THIS_IS_NOT_IMPLEMENTED std::cerr << "FIXME: " << __FILE__ << ":" << __LINE__ << "->" << __FUNCTION__ << "() Not implemented!" << std::endl;

emulator/include/Display.h

@@ -0,0 +1,35 @@
+#pragma once
+
+#include <memory>
+
+#include <SDL2/SDL.h>
+
+#include "Arduino_GFX.h"
+#include "Defines.h"
+
+class FakeDisplay : public Arduino_G {
+public:
+    FakeDisplay(int width, int height, SDL_Window* window, SDL_Renderer* renderer);
+    ~FakeDisplay();
+
+    void displayOn();
+    void displayOff();
+
+    void drawPixel(int32_t x, int32_t y, uint16_t color);
+
+    // Required by Arduino_G
+    void begin(int32_t speed = 0) override;
+    void drawBitmap(int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h, uint16_t color, uint16_t bg) override;
+    void drawIndexedBitmap(int16_t x, int16_t y, uint8_t *bitmap, uint16_t *color_index, int16_t w, int16_t h) override;
+    void draw3bitRGBBitmap(int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h) override;
+    void draw16bitRGBBitmap(int16_t x, int16_t y, uint16_t *bitmap, int16_t w, int16_t h) override;
+    void draw24bitRGBBitmap(int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h) override;
+private:
+    SDL_Window* mainWindow;
+    SDL_Renderer* mainRenderer;
+    const int width;
+    const int height;
+    bool isEnabled = false;
+};
+
+extern std::unique_ptr<FakeDisplay> fakeDisplayInstance;

emulator/include/ESP.h

@@ -0,0 +1,16 @@
+#pragma once
+
+#include "Emulator.hpp"
+#include "Defines.h"
+
+class ESP_t {
+public:
+    void restart() {
+        OswEmulator::instance->enterSleep(true);
+        throw OswEmulator::EmulatorSleep();
+    }
+};
+
+extern ESP_t ESP;
+
+#define ESP_OK true