From 5cabba7712aacc2f54053961d08912e6627d2a65 Mon Sep 17 00:00:00 2001 From: Dave Allie Date: Mon, 15 Dec 2025 08:16:59 +1100 Subject: [PATCH 1/4] Add Github templates Added Github templates for PRs and bugs Also added one for funding, please do not feel obligated to donate to the project, this is not a for-profit endevour, I just had someone ask where they could send a few dollars so I have set it up --- .github/FUNDING.yml | 2 + .github/ISSUE_TEMPLATE/bug_report.yml | 54 +++++++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 9 +++++ 3 files changed, 65 insertions(+) create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..6859186 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: [daveallie] +ko_fi: daveallie diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..a4594e6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,54 @@ +name: Bug Report +description: Report an issue or unexpected behavior +title: "Short, descriptive title of the issue" +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report this bug! Please fill out the details below. + + - type: input + id: version + attributes: + label: Affected Version + description: What version of the project/library are you using? (e.g., v1.2.3, master branch commit SHA) + placeholder: Ex. v1.2.3 + validations: + required: true + + - type: textarea + id: bug-description + attributes: + label: Describe the Bug + description: A clear and concise description of what the bug is. + placeholder: + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to Reproduce + description: Clearly list the steps necessary to reproduce the unexpected behavior. + placeholder: | + 1. Go to '...' + 2. Select '...' + 3. Crash + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant Log Output/Screenshots + description: If applicable, error messages, or log output to help explain your problem. You can drag and drop images here. + render: shell diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c386601 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,9 @@ +## Summary + +* **What is the goal of this PR?** (e.g., Fixes a bug in the user authentication module, Implements the new feature for + file uploading.) +* **What changes are included?** + +## Additional Context + +* Add any other information that might be helpful for the reviewer (e.g., performance implications, potential risks, specific areas to focus on). From fdb5634ea6d0b72a5ba1869b8e96c3c7ee5029c8 Mon Sep 17 00:00:00 2001 From: Dave Allie Date: Mon, 15 Dec 2025 19:46:52 +1100 Subject: [PATCH 2/4] Add cppcheck and formatter to CI (#19) * Add cppcheck and formatter to CI * Checkout submodules * Install matching clang-format version in CI --- .github/workflows/ci.yml | 40 ++++++++++++++++++++++++++++++++++++++++ platformio.ini | 3 +++ 2 files changed, 43 insertions(+) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..015565f --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,40 @@ +name: CI +on: push + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v6 + with: + submodules: recursive + - uses: actions/cache@v5 + with: + path: | + ~/.cache/pip + ~/.platformio/.cache + key: ${{ runner.os }}-pio + - uses: actions/setup-python@v6 + with: + python-version: '3.14' + + - name: Install PlatformIO Core + run: pip install --upgrade platformio + + - name: Install clang-format-21 + run: | + wget https://apt.llvm.org/llvm.sh + chmod +x llvm.sh + sudo ./llvm.sh 21 + sudo apt-get update + sudo apt-get install -y clang-format-21 + + - name: Run cppcheck + run: pio check --fail-on-defect medium --fail-on-defect high + + - name: Run clang-format + run: PATH="/usr/lib/llvm-21/bin:$PATH" ./bin/clang-format-fix && git diff --exit-code || (echo "Please run 'bin/clang-format-fix' to fix formatting issues" && exit 1) + + - name: Build CrossPoint + run: pio run diff --git a/platformio.ini b/platformio.ini index 6918e34..7998dcb 100644 --- a/platformio.ini +++ b/platformio.ini @@ -8,6 +8,9 @@ board = esp32-c3-devkitm-1 framework = arduino monitor_speed = 115200 upload_speed = 921600 +check_tool = cppcheck +check_skip_packages = yes +check_severity = medium, high board_upload.flash_size = 16MB board_upload.maximum_size = 16777216 From 8c3576e39789093c96aa7dfc2f608563d6a1aa9a Mon Sep 17 00:00:00 2001 From: Dave Allie Date: Mon, 15 Dec 2025 20:00:34 +1100 Subject: [PATCH 3/4] Add Github Action to build release firmware on tag (#20) --- .github/workflows/release.yml | 40 +++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..c8d1c83 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,40 @@ +name: Compile Release +on: + push: + tags: + - '*' + +jobs: + build-release: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v6 + with: + submodules: recursive + - uses: actions/cache@v5 + with: + path: | + ~/.cache/pip + ~/.platformio/.cache + key: ${{ runner.os }}-pio + - uses: actions/setup-python@v6 + with: + python-version: '3.14' + + - name: Install PlatformIO Core + run: pip install --upgrade platformio + + - name: Build CrossPoint + run: pio run -e gh_release + + - name: Upload Artifacts + uses: actions/upload-artifact@v4 + with: + name: CrossPoint-${{ github.ref_name }} + path: | + .pio/build/gh_release/bootloader.bin + .pio/build/gh_release/firmware.bin + .pio/build/gh_release/firmware.elf + .pio/build/gh_release/firmware.map + .pio/build/gh_release/partitions.bin From 7a5719b46d415e8da76ededebfa4c97221c9f969 Mon Sep 17 00:00:00 2001 From: Dave Allie Date: Mon, 15 Dec 2025 22:27:27 +1100 Subject: [PATCH 4/4] Upgrade open-x4-sdk to fix white streaks on sleep screen (#21) https://github.com/open-x4-epaper/community-sdk/pull/6 fixes a power down issue with the display which was causing streaks to appear on the sleep screen --- open-x4-sdk | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/open-x4-sdk b/open-x4-sdk index 7e0dce9..4d0dcd5 160000 --- a/open-x4-sdk +++ b/open-x4-sdk @@ -1 +1 @@ -Subproject commit 7e0dce916706da7d80ec225fade191aea6b87fb6 +Subproject commit 4d0dcd5ff87fcd86eb2966a123e85b03284a03db