Merge branch 'main' into sam/ir-tracker

* main:
  Support for 24-bit RGB888 simulator and fonts (#1112)
  Revert FreeRTOS assert-on-yield behavior
  BLE defines cleanup (#1110)
  Fix compilation error in astubs (#1109)
  Codebase cleanup from the ESP32-P4 branch (#1108)
  CMake build for Freetype (#1106)
  Fix BLEAddress serialization (#1107)
  Bump esp-nimble-cpp to 2.1.1 (#1102)
  TTF 16bits rgb support (#1104)
  Support for 16-bit simulator (#1103)
  Bump esp_littlefs to v1.16.4 (#1101)
  Update FreeRTOS POSIX port and fix a freeze (#1100)
  iOS Framework Build (#1093)
  Fix hang in TestTelemetry (#1099)
  Bump to IDF 5.3.1 (#948)
  Update FreeRTOS posix port to 94263d23b (#1097)
  Prefix `Rect`/`Size`/`Point`/`Inset` types with `Sol` to avoid naming conflicts with iOS (#1090)
  FreeRTOS threads improvement (#1092)
  Fix CI for new GH ubuntu 24.04 runners (#1091)

Author: samuelclay

.clang-tidy

@@ -9,6 +9,9 @@
 # This is also a good check, but we also have a lot of narrowing conversions
 # especially related to display stuff since Adafruit GFX uses uint16_t a lot.
 #   -bugprone-narrowing-conversions,
+# This is busted in clang-tidy 16 and hangs forever
+# See: https://github.com/llvm/llvm-project/issues/63101
+#   -bugprone-unchecked-optional-access,
 
 # Enable Cert checks
 #   cert-*,
@@ -106,6 +109,7 @@ Checks: >-
   bugprone-*,
   -bugprone-easily-swappable-parameters,
   -bugprone-narrowing-conversions,
+  -bugprone-unchecked-optional-access,
   cert-*,
   -cert-dcl03-c,
   clang-analyzer-*,

.github/workflows/build.yml

@@ -29,7 +29,7 @@ jobs:
         with:
           python-version: "3.11"
 
-      - name: Install SDL
+      - name: Install prerequisites
         run: sudo apt update && sudo apt install -y libsdl2-dev libsdl2-image-dev
 
       - name: build
@@ -54,7 +54,7 @@ jobs:
       matrix:
         # Tags from here: https://hub.docker.com/r/espressif/idf/tags
         idf_version:
-          - v5.1.5
+          - v5.3.2
           # - latest
         target:
           - glasses-debug
@@ -117,7 +117,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           submodules: "recursive"
-      
+
       # Build scripts/epub-render with cmake
       - name: Build epub-render
         run: make epub-render-build
@@ -150,8 +150,8 @@ jobs:
         id: download-firmware
         uses: actions/download-artifact@v4
         with:
-          name: embedded-app-${{ github.sha }}-IDFv5.1.5
-          path: embedded-app-${{ github.sha }}-IDFv5.1.5
+          name: embedded-app-${{ github.sha }}-IDFv5.3.2
+          path: embedded-app-${{ github.sha }}-IDFv5.3.2
 
       - name: Download epub-render binaries
         id: download-epub-render
@@ -184,7 +184,7 @@ jobs:
           -F "release_notes=TODO"
 
       - name: Zip back up the firmware build
-        run: zip -r embedded-app-${{ steps.set-version.outputs.version }}-${{ github.sha }}-IDFv5.1.5.zip embedded-app-${{ github.sha }}-IDFv5.1.5
+        run: zip -r embedded-app-${{ steps.set-version.outputs.version }}-${{ github.sha }}-IDFv5.3.2.zip embedded-app-${{ github.sha }}-IDFv5.3.2
 
       - name: Rename epub-render binary
         run: |
@@ -198,7 +198,7 @@ jobs:
         if: startsWith(github.ref, 'refs/tags/')
         with:
           files: |
-            embedded-app-${{ steps.set-version.outputs.version }}-${{ github.sha }}-IDFv5.1.5.zip
+            embedded-app-${{ steps.set-version.outputs.version }}-${{ github.sha }}-IDFv5.3.2.zip
             epub-render-${{ steps.set-version.outputs.version }}-${{ github.sha }}.zip
 
       - name: Notify Slack

.github/workflows/clang-tools.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on:
       group: Beefy
     container:
-      image: espressif/idf:v5.1.5
+      image: espressif/idf:v5.3.2
 
     steps:
       - uses: actions/checkout@v4
@@ -45,12 +45,10 @@ jobs:
           PR_GITHUB_SHA: ${{ github.event.pull_request.head.sha || github.sha }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: DoozyX/[email protected]
-        with:
-          source: "./src"
-          extensions: "hpp,h,cpp,c"
-          clangFormatVersion: 15
-          inplace: True
+      - name: Run clang-format
+        run: |
+          . $IDF_PATH/export.sh
+          make clang-format
 
       - name: "Commit changes if necessary"
         if: github.event_name == 'pull_request'

.gitmodules

@@ -18,7 +18,7 @@
 	url = [email protected]:sindarin-inc/astubs.git
 [submodule "components/freetype/freetype"]
 	path = components/freetype/freetype
-	url = [email protected]:freetype/freetype.git
+	url = [email protected]:sindarin-inc/freetype.git
 [submodule "lib/mbedtls"]
 	path = lib/mbedtls
 	url = https://github.com/Mbed-TLS/mbedtls.git

Makefile

@@ -36,12 +36,12 @@ else ifeq ($(TARGET),sharp-27in)
 endif
 
 # Optional variables for the Simulator builds
-CMAKE_SIM_DISPLAY_OPTIONS := $(if $(SIM_WIDTH),-DSIM_WIDTH=$(SIM_WIDTH)) $(if $(SIM_HEIGHT),-DSIM_HEIGHT=$(SIM_HEIGHT)) $(if $(SIM_SCALE),-DSIM_SCALE=$(SIM_SCALE)) $(if $(SIM_LAYOUT_DEBUG),-DSIM_LAYOUT_DEBUG=$(SIM_LAYOUT_DEBUG)) $(if $(SIM_ONE_BIT),-DSIM_ONE_BIT=$(SIM_ONE_BIT))
+CMAKE_SIM_DISPLAY_OPTIONS := $(if $(DISPLAY_WIDTH),-DDISPLAY_WIDTH=$(DISPLAY_WIDTH)) $(if $(DISPLAY_HEIGHT),-DDISPLAY_HEIGHT=$(DISPLAY_HEIGHT)) $(if $(DISPLAY_SCALE),-DDISPLAY_SCALE=$(DISPLAY_SCALE)) $(if $(SIM_LAYOUT_DEBUG),-DSIM_LAYOUT_DEBUG=$(SIM_LAYOUT_DEBUG)) $(if $(DISPLAY_TYPE),-DDISPLAY_TYPE=$(DISPLAY_TYPE)) $(if $(TTF_SCREEN_RES_PER_INCH),-DTTF_SCREEN_RES_PER_INCH=$(TTF_SCREEN_RES_PER_INCH))
 
 .PHONY: sim-build
 sim-build:
 	mkdir -p lib/Simulator/build
-	cd lib/Simulator/build && cmake $(CMAKE_FLAGS) $(CMAKE_SIM_DISPLAY_OPTIONS) .. && $(MAKE)
+	cd lib/Simulator/build && cmake $(CMAKE_FLAGS) -DSIM_SCALE=2 $(CMAKE_SIM_DISPLAY_OPTIONS) .. && $(MAKE)
 
 .PHONY: sim-run
 sim: sim-build
@@ -50,12 +50,30 @@ sim: sim-build
 .PHONY: sim8-build
 sim8-build:
 	mkdir -p lib/Simulator/build8
-	cd lib/Simulator/build8 && cmake $(CMAKE_FLAGS) -DENABLE_8BIT_DISPLAY=ON $(CMAKE_SIM_DISPLAY_OPTIONS) .. && $(MAKE)
+	cd lib/Simulator/build8 && cmake $(CMAKE_FLAGS) -DDISPLAY_TYPE=DISPLAY_SIM_8BIT -DDISPLAY_WIDTH=600 -DDISPLAY_HEIGHT=600 $(CMAKE_SIM_DISPLAY_OPTIONS) .. && $(MAKE)
 
 .PHONY: sim-run8
 sim8: sim8-build
 	./lib/Simulator/build8/simulator
 
+.PHONY: sim16-build
+sim16-build:
+	mkdir -p lib/Simulator/build16
+	cd lib/Simulator/build16 && cmake $(CMAKE_FLAGS) -DDISPLAY_TYPE=DISPLAY_SIM_16BIT -DDISPLAY_WIDTH=600 -DDISPLAY_HEIGHT=600 $(CMAKE_SIM_DISPLAY_OPTIONS) .. && $(MAKE)
+
+.PHONY: sim-run16
+sim16: sim16-build
+	./lib/Simulator/build16/simulator
+
+.PHONY: sim24-build
+sim24-build:
+	mkdir -p lib/Simulator/build24
+	cd lib/Simulator/build24 && cmake $(CMAKE_FLAGS) -DDISPLAY_TYPE=DISPLAY_SIM_24BIT -DDISPLAY_WIDTH=600 -DDISPLAY_HEIGHT=600 $(CMAKE_SIM_DISPLAY_OPTIONS) .. && $(MAKE)
+
+.PHONY: sim-run24
+sim24: sim24-build
+	./lib/Simulator/build24/simulator
+
 .PHONY: lldb
 lldb: sim-build
 	lldb lib/Simulator/build/simulator
@@ -152,6 +170,10 @@ monitor-jtag: check_idf
 monitor-devboard: check_idf
 	idf.py $(IDF_PROFILE) monitor --no-reset --port $$(python3 scripts/port_tool.py find_port devboard)
 
+.PHONY: ios-framework
+ios-framework:
+	cd lib/Simulator/CommonIos && make build
+
 .PHONY: clean
 clean:
 	rm -fr build*
@@ -160,6 +182,7 @@ clean:
 	rm -fr test/CatchTests/build
 	rm -fr test/CatchTests/Images/TestRun/*diff.png
 	rm -fr test/CatchTests/Images/TestRun/GylphTests/*diff.png
+	rm -fr lib/Simulator/CommonIos/build*
 
 .PHONY: clang-tidy
 clang-tidy: check_idf
@@ -174,6 +197,10 @@ clang-tidy: check_idf
 	IDF_TOOLCHAIN=clang idf.py -B build-clang clang-check --run-clang-tidy-py scripts/run-clang-tidy.py --run-clang-tidy-options "-fix -header-filter=embedded-app/src/.*" --exclude-paths managed_components --exclude-paths components
 	find src -iname "*.hpp" -o -iname "*.h" -o -iname "*.cpp" -o -iname "*.c" | xargs clang-format -i
 
+.PHONY: clang-format
+clang-format: check_idf
+	find src -iname "*.hpp" -o -iname "*.h" -o -iname "*.cpp" -o -iname "*.c" | xargs clang-format -i
+
 program-mode:
 	python3 scripts/port_tool.py find_port programming
 

README.md

@@ -13,7 +13,7 @@ git submodule update --init --recursive
 The primary way to build the firmware itself is with Espressif's official [esp-idf toolchain](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/linux-macos-setup.html). In some other directory (not in this repo), run:
 
 ```sh
-git clone -b v5.1.5 --recursive https://github.com/espressif/esp-idf.git
+git clone -b v5.3.2 --recursive https://github.com/espressif/esp-idf.git
 cd esp-idf
 ./install.sh esp32s3
 ```
@@ -75,7 +75,7 @@ Issues that will be fixed automatically will be fixed by clang-tidy, warnings wi
 
 The simulator compiles in <20s from a clean build, and even less on an incremental build. This makes it fast for us to iterate on anything that doesn't need the physical hardware.
 
-You'll need SDL2, openssl, and freetype for it to work: `brew install sdl2 openssl freetype` (on Ubuntu `sudo apt install libsdl2-dev libssl-dev libfreetype-dev`). Then you can run `make sim` to run it (or `make sim8` for the high-res version). After building once, you can also debug with lldb at the command line: `lldb lib/Simulator/build/simulator`.
+You'll need SDL2, openssl for it to work: `brew install sdl2 openssl` (on Ubuntu `sudo apt install libsdl2-dev libssl-dev`). Then you can run `make sim` to run it (or `make sim8` for the high-res version). After building once, you can also debug with lldb at the command line: `lldb lib/Simulator/build/simulator`.
 
 ### Extract your Sol cloud access token to download content onto the Simulator