SUKU formatting added

.clang-format

@@ -0,0 +1,5 @@
+ColumnLimit: 200  # Set to a very large value
+BasedOnStyle: LLVM
+IndentWidth: 2
+DerivePointerAlignment: false
+PointerAlignment: Left

.codespellrc

@@ -0,0 +1,10 @@
+# See: https://github.com/codespell-project/codespell#using-a-config-file
+[codespell]
+# In the event of a false positive, add the problematic word, in all lowercase, to 'ignore-words.txt' (one word per line).
+# Or copy & paste the whole problematic line to 'exclude-file.txt'
+ignore-words = ./ignore-words.txt
+exclude-file = ./exclude-file.txt
+check-filenames =
+check-hidden =
+count =
+skip = .git

.github/workflows/convert_bottom_position.py

@@ -26,4 +26,3 @@
       row[5] -= 360.0
   startwriter.writerow(row)
   print(row)
-

.github/workflows/convert_position_offset.py

@@ -28,4 +28,3 @@
     row[4] = float(row[4])-100.0
   startwriter.writerow(row)
   print(row)
-

.github/workflows/electrical_boards.yml

@@ -13,7 +13,7 @@ jobs:
   generate-artifacts:
     name: kicad export
     runs-on: ubuntu-latest
-    container: "setsoft/kicad_auto:ki7"    
+    container: "setsoft/kicad_auto:ki7"
     strategy:
       fail-fast: false
       matrix:
@@ -40,8 +40,8 @@ jobs:
       run: |
         python3 .github/workflows/convert_bottom_position.py ../../Electrical/Design/${{ matrix.board }}/mfg-bot/mfg/${{ matrix.board }}-both_pos.csv ../../Electrical/Design/${{ matrix.board }}/mfg-bot/mfg/${{ matrix.board }}-both_pos_fixed.csv
         rm Electrical/Design/${{ matrix.board }}/mfg-bot/mfg/${{ matrix.board }}-both_pos.csv
-  
-    - name: Zipping gerber      
+
+    - name: Zipping gerber
       uses: vimtor/action-zip@v1
       with:
         files: Electrical/Design/${{ matrix.board }}/mfg-bot/JLCPCB
@@ -56,7 +56,7 @@ jobs:
         mv Electrical/Design/${{ matrix.board }}/mfg-bot/PCB_Bottom.pdf Electrical/Design/${{ matrix.board }}/mfg-bot/${{ matrix.board }}_PCB_Bottom.pdf
         mv Electrical/Design/${{ matrix.board }}/mfg-bot/kibot_errors.filter Electrical/Design/${{ matrix.board }}/mfg-bot/${{ matrix.board }}_kibot_errors.filter
         mv Electrical/Design/${{ matrix.board }}/kibot_error.log Electrical/Design/${{ matrix.board }}/mfg-bot/${{ matrix.board }}_kibot_error.log
-        
+
         rm -r Electrical/Design/${{ matrix.board }}/mfg-bot/JLCPCB
 
     - name: Upload results
@@ -70,7 +70,7 @@ jobs:
 
   deploy-results:
     runs-on: ubuntu-latest
-    needs: generate-artifacts    
+    needs: generate-artifacts
     steps:
       - uses: actions/checkout@v2
         with:
@@ -97,10 +97,9 @@ jobs:
           done
 
       - name: Commit the files
-        run: |        
+        run: |
           git config --global user.name ${{ github.actor }}
-          git config --global user.email ${{ github.actor }}@users.noreply.github.com  
+          git config --global user.email ${{ github.actor }}@users.noreply.github.com
           git add Preview/*
           git commit -m "BOT ${{ github.workflow }} ${{ github.sha }}"
           git push
-

.github/workflows/firmware_build.yml

@@ -55,13 +55,13 @@ jobs:
             knot_esp32_nightly_${{ env.ACTION_DATE }}.uf2
             knot_esp32_nightly.uf2
 
-      - name: Zipping artifacts for Github Release 
+      - name: Zipping artifacts for Github Release
         uses: vimtor/action-zip@v1
         if: ${{ env.RELEASE_VERSION != '' }}
         with:
           files: knot_esp32_release_${{ env.ACTION_DATE }}.uf2
-          dest: knot_release.zip     
-            
+          dest: knot_release.zip
+
       - name: Release
         uses: softprops/action-gh-release@v1
         if: ${{ env.RELEASE_VERSION != '' }}

.github/workflows/pre-commit.yml

@@ -0,0 +1,25 @@
+name: pre-commit
+
+on:
+  workflow_dispatch:
+  push:
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Run pre-commit
+      uses: pre-commit/action@v3.0.0

.pre-commit-config.yaml

@@ -0,0 +1,53 @@
+# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+#
+# SPDX-License-Identifier: Unlicense
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: check-yaml
+  - id: trailing-whitespace
+    exclude: |
+      (?x)^(
+        Firmware/bootloader/|
+        Mechanical/|
+        Electrical/|
+        Graphics/|
+        Render/
+      )
+  - id: end-of-file-fixer
+    exclude: |
+      (?x)^(
+        Firmware/bootloader/|
+        Mechanical/|
+        Electrical/|
+        Graphics/|
+        Render/
+      )
+
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.4
+  hooks:
+  - id: codespell
+    args: [-w]
+    exclude: |
+      (?x)^(
+        Firmware/bootloader/|
+        Mechanical/|
+        Electrical/|
+        Graphics/|
+        Render/
+      )
+- repo: https://github.com/pre-commit/mirrors-clang-format
+  rev: v17.0.6
+  hooks:
+  - id: clang-format
+    exclude: |
+      (?x)^(
+        Firmware/bootloader/|
+        Mechanical/|
+        Electrical/|
+        Graphics/|
+        Render/
+      )

Firmware/.gitignore

@@ -1,3 +1,3 @@
 build
 managed_components
-dependencies.lock
+dependencies.lock

Firmware/.vscode/c_cpp_properties.json

@@ -1,19 +1,19 @@
 {
-    "configurations": [
-        {
-            "name": "Linux",
-            "includePath": [
-                "${workspaceFolder}/**",
-                "/usr/include/**"
-            ],
-            "defines": [],
-            "compilerPath": "/bin/cpp",
-            "cStandard": "gnu17",
-            "cppStandard": "gnu++17",
-            "intelliSenseMode": "linux-gcc-x64",
-            "compileCommands": "${workspaceFolder}/build/compile_commands.json",
-            "configurationProvider": "ms-vscode.makefile-tools"
-        }
-    ],
-    "version": 4
-}
+  "configurations": [
+    {
+      "name": "Linux",
+      "includePath": [
+        "${workspaceFolder}/**",
+        "/usr/include/**"
+      ],
+      "defines": [],
+      "compilerPath": "/bin/cpp",
+      "cStandard": "gnu17",
+      "cppStandard": "gnu++17",
+      "intelliSenseMode": "linux-gcc-x64",
+      "compileCommands": "${workspaceFolder}/build/compile_commands.json",
+      "configurationProvider": "ms-vscode.makefile-tools"
+    }
+  ],
+  "version": 4
+}

Firmware/.vscode/settings.json

@@ -36,36 +36,45 @@
     "grid_led.h": "c",
     "knot_midi_translator.h": "c",
     "knot_midi_uart.h": "c"
-},
+  },
   "actionButtons": {
-    "defaultColor": "#ff0034", // Can also use string color names.
-    "loadNpmCommands":false, // Disables automatic generation of actions for npm commands.
-    "reloadButton":"♻️", // Custom reload button text or icon (default ↻). null value enables automatic reload on configuration change
+    "defaultColor": "#ff0034",
+    // Can also use string color names.
+    "loadNpmCommands": false,
+    // Disables automatic generation of actions for npm commands.
+    "reloadButton": "♻️",
+    // Custom reload button text or icon (default ↻). null value enables automatic reload on configuration change
     "commands": [
-        {
-            "name": "ESP32 Docker",
-            "color": "white",
-            "singleInstance": true,
-            "command": "podman run --privileged -it -v /dev:/dev -v $PWD:/project -w /project espressif/idf:release-v5.1",
-            // clear && idf.py build && idf.py -p $(ls /dev/ttyACM*) flash
-            // ./burn_bootloader.sh
-            // clear && idf.py build && esptool.py --chip esp32s3 -p $(ls /dev/ttyACM*) --before=default_reset --after=no_reset write_flash --flash_mode dio --flash_size detect --flash_freq 80m 0x10000 build/midi_host_fw.bin && otatool.py -p $(ls /dev/ttyACM*) switch_ota_partition --slot 0
-            // clear && idf.py build && ./uf2convert.sh
-        },
-        {
-            "name": "ESP32 Monitor",
-            "color": "white",
-            "singleInstance": true,
-            "command": "podman run --privileged -it -v /dev:/dev -v $PWD:/project -w /project espressif/idf:release-v5.1",
-            // idf.py -p $(ls /dev/ttyUSB0) monitor
-        },
-        {
-            "name": "Unit Test",
-            "color": "white",
-            "singleInstance": true,
-            "command": "cd ./components/knot_midi_translator/host_test && ./test.sh",
-        }
+      {
+        "name": "pre-commit formatting",
+        "color": "white",
+        "singleInstance": true,
+        "command": "pre-commit run --show-diff-on-failure --color=always --all-files",
+      },
+      {
+        "name": "ESP32 Docker",
+        "color": "white",
+        "singleInstance": true,
+        "command": "podman run --privileged -it -v /dev:/dev -v $PWD:/project -w /project espressif/idf:release-v5.1",
+        // clear && idf.py build && idf.py -p $(ls /dev/ttyACM*) flash
+        // ./burn_bootloader.sh
+        // clear && idf.py build && esptool.py --chip esp32s3 -p $(ls /dev/ttyACM*) --before=default_reset --after=no_reset write_flash --flash_mode dio --flash_size detect --flash_freq 80m 0x10000
+        // build/midi_host_fw.bin && otatool.py -p $(ls /dev/ttyACM*) switch_ota_partition --slot 0 clear && idf.py build && ./uf2convert.sh
+      },
+      {
+        "name": "ESP32 Monitor",
+        "color": "white",
+        "singleInstance": true,
+        "command": "podman run --privileged -it -v /dev:/dev -v $PWD:/project -w /project espressif/idf:release-v5.1",
+        // idf.py -p $(ls /dev/ttyUSB0) monitor
+      },
+      {
+        "name": "Unit Test",
+        "color": "white",
+        "singleInstance": true,
+        "command": "cd ./components/knot_midi_translator/host_test && ./test.sh",
+      }
     ]
-},
-"git.ignoreLimitWarning": true
-}
+  },
+  "git.ignoreLimitWarning": true
+}

Firmware/build.sh

@@ -1,3 +1,3 @@
 . $HOME/$whoami/Documents/esp-idf/export.sh
 
-idf.py build
+idf.py build

Firmware/burn_bootloader.sh

@@ -3,4 +3,4 @@ esptool.py --chip esp32s3 -p $(ls /dev/ttyACM*) --before=default_reset \
 0x0 bootloader/bootloader.bin \
 0x8000 bootloader/partition-table.bin \
 0xe000 bootloader/ota_data_initial.bin \
-0x410000 bootloader/tinyuf2.bin
+0x410000 bootloader/tinyuf2.bin

Firmware/burn_firmware.sh

@@ -1 +1 @@
-clear && idf.py build && esptool.py --chip esp32s3 -p $(ls /dev/ttyACM* | head -n 1) --before=default_reset --after=no_reset write_flash --flash_mode dio --flash_size detect --flash_freq 80m 0x10000 build/midi_host_fw.bin && otatool.py -p $(ls /dev/ttyACM* | head -n 1) switch_ota_partition --slot 0
+clear && idf.py build && esptool.py --chip esp32s3 -p $(ls /dev/ttyACM* | head -n 1) --before=default_reset --after=no_reset write_flash --flash_mode dio --flash_size detect --flash_freq 80m 0x10000 build/midi_host_fw.bin && otatool.py -p $(ls /dev/ttyACM* | head -n 1) switch_ota_partition --slot 0