FlexBLE 1.0.0: merge upstream CrossInk v1.2.11.1 + BLE-friendly heap budgeting

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -8,6 +8,18 @@ body:
       value: |
         Thanks for taking the time to report this bug! Please fill out the details below.
 
+  - type: dropdown
+    id: device-type
+    attributes:
+      label: Device
+      description: Which device is this affecting?
+      options:
+        - X4
+        - X3
+        - Both
+    validations:
+      required: true
+
   - type: input
     id: version
     attributes:

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,3 +1,5 @@
 ## Summary
 
-- **What changes are included?**
+### **What changes are included?**
+
+

.github/workflows/release-fonts.yml

@@ -0,0 +1,106 @@
+name: Build & Publish SD Card Fonts
+
+# Fonts change rarely — run manually when font sources or the conversion
+# pipeline are updated.  Publishes .cpfont files + fonts.json manifest as
+# GitHub Release assets on the crosspoint-fonts repo so font releases don't
+# clutter the firmware releases page.
+#
+# Requires a repository secret FONTS_REPO_TOKEN — a fine-grained PAT (or
+# classic PAT) with contents:write permission on the target fonts repo.
+on:
+  workflow_dispatch:
+
+env:
+  FONTS_REPO: crosspoint-reader/crosspoint-fonts
+
+jobs:
+  build-fonts:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          submodules: recursive
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+
+      - name: Install font tools
+        run: pip install freetype-py fonttools pyyaml
+
+      - name: Install system dependencies
+        run: sudo apt-get update && sudo apt-get install -y libfreetype6-dev
+
+      - name: Read version constants
+        id: versions
+        run: |
+          cd lib/EpdFont/scripts
+          echo "binary=$(python3 -c 'from cpfont_version import CPFONT_VERSION; print(CPFONT_VERSION)')" >> "$GITHUB_OUTPUT"
+          echo "metadata=$(python3 -c 'from cpfont_version import FONTS_MANIFEST_VERSION; print(FONTS_MANIFEST_VERSION)')" >> "$GITHUB_OUTPUT"
+
+      - name: Build SD card fonts
+        run: python3 lib/EpdFont/scripts/build-sd-fonts.py --clean --verbose -j 1
+
+      - name: Flatten output for release assets
+        run: |
+          mkdir -p dist
+          find lib/EpdFont/scripts/output -name '*.cpfont' -exec cp {} dist/ \;
+
+      - name: Compute release tags
+        id: tags
+        env:
+          GH_TOKEN: ${{ secrets.FONTS_REPO_TOKEN }}
+        run: |
+          BASE="sd-fonts-m${{ steps.versions.outputs.metadata }}-b${{ steps.versions.outputs.binary }}"
+          echo "base=$BASE" >> "$GITHUB_OUTPUT"
+
+          # Find the highest existing revision for this m/b pair
+          LAST=$(gh release list --repo "${{ env.FONTS_REPO }}" \
+            --json tagName --jq \
+            '[.[] | select(.tagName | startswith("'"${BASE}-r"'")) | .tagName | split("-r")[1] | tonumber] | max // 0')
+          NEXT=$((LAST + 1))
+          echo "revision=$NEXT" >> "$GITHUB_OUTPUT"
+          echo "versioned=${BASE}-r${NEXT}" >> "$GITHUB_OUTPUT"
+
+      - name: Generate manifest
+        run: |
+          python3 scripts/generate-font-manifest.py \
+            --input dist \
+            --base-url "https://github.com/${{ env.FONTS_REPO }}/releases/download/${{ steps.tags.outputs.base }}/" \
+            --output dist/fonts.json \
+            --descriptions-from lib/EpdFont/scripts/sd-fonts.yaml
+
+      - name: Publish versioned release to fonts repo
+        env:
+          GH_TOKEN: ${{ secrets.FONTS_REPO_TOKEN }}
+        run: |
+          VERSIONED="${{ steps.tags.outputs.versioned }}"
+          TITLE="SD Card Fonts (${VERSIONED#sd-fonts-})"
+
+          gh release create "$VERSIONED" dist/* \
+            --repo "${{ env.FONTS_REPO }}" \
+            --title "$TITLE" \
+            --notes "Pre-built \`.cpfont\` font files for CrossPoint Reader.
+
+          Download individual files or use **Settings > System > Manage Fonts** on the device.
+
+          See [SD Card Fonts documentation](https://github.com/${{ github.repository }}/blob/main/docs/sd-card-fonts.md) for details."
+
+      - name: Update stable tag for device downloads
+        env:
+          GH_TOKEN: ${{ secrets.FONTS_REPO_TOKEN }}
+        run: |
+          BASE="${{ steps.tags.outputs.base }}"
+
+          # Delete the old stable release for this m/b pair (the versioned releases are kept)
+          gh release delete "$BASE" --repo "${{ env.FONTS_REPO }}" --yes 2>/dev/null || true
+
+          gh release create "$BASE" dist/* \
+            --repo "${{ env.FONTS_REPO }}" \
+            --title "SD Card Fonts (${BASE#sd-fonts-})" \
+            --notes "Current font build for manifest v${{ steps.versions.outputs.metadata }}, binary format v${{ steps.versions.outputs.binary }}. Devices with this firmware version download from this release.
+
+          This is revision **${{ steps.tags.outputs.revision }}** — see [\`${{ steps.tags.outputs.versioned }}\`](https://github.com/${{ env.FONTS_REPO }}/releases/tag/${{ steps.tags.outputs.versioned }}) for the immutable copy.
+
+          Download individual files or use **Settings > System > Manage fonts** on the device."

.github/workflows/release.yml

@@ -3,12 +3,12 @@ on:
   workflow_dispatch:
     inputs:
       version:
-        description: "Release version, without the leading v. Example: 1.2.9.1"
+        description: "Compile release builds"
         required: true
         type: string
   push:
     tags:
-      - "v*"
+      - 'v[0-9]+.[0-9]+.[0-9]+'
 
 permissions:
   contents: write
@@ -20,6 +20,14 @@ jobs:
       - uses: actions/checkout@v6
         with:
           submodules: recursive
+          fetch-depth: 0
+
+      - name: Verify release tag is on main
+        if: github.event_name == 'push'
+        run: |
+          git fetch origin main:refs/remotes/origin/main
+          TAG_COMMIT="$(git rev-list -n 1 "$GITHUB_REF_NAME")"
+          git merge-base --is-ancestor "$TAG_COMMIT" origin/main
 
       - uses: actions/setup-python@v6
         with:
@@ -53,26 +61,47 @@ jobs:
           echo "RELEASE_VERSION=$VERSION" >> "$GITHUB_ENV"
           sed -i "s/crossink_version = .*/crossink_version = $VERSION/" platformio.ini
 
-      - name: Build CrossInk-Carousel
+      - name: Build CrossPoint
         env:
           CROSSPOINT_RELEASE_VERSION: ${{ env.RELEASE_VERSION }}
         run: pio run -e tiny -e xlarge -e no_emoji
 
-      - name: Rename binaries with carousel prefix
+      - name: Generate release catalog
+        run: |
+          python3 scripts/generate_release_catalog.py \
+            --version "${{ env.RELEASE_VERSION }}" \
+            --repo "${{ github.repository }}" \
+            --firmware ".pio/build/tiny/firmware-tiny-v${{ env.RELEASE_VERSION }}.bin" \
+            --firmware ".pio/build/xlarge/firmware-xlarge-v${{ env.RELEASE_VERSION }}.bin" \
+            --firmware ".pio/build/no_emoji/firmware-no_emoji-v${{ env.RELEASE_VERSION }}.bin" \
+            --output ".pio/build/catalog"
+
+      - name: Publish catalog to GitHub Pages source
+        env:
+          DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
         run: |
-          for v in tiny xlarge no_emoji; do
-            cp ".pio/build/$v/firmware-$v-v${RELEASE_VERSION}.bin" \
-               ".pio/build/$v/carousel-firmware-$v-v${RELEASE_VERSION}.bin"
-          done
+          git config user.name "uxjulia"
+          git config user.email "julia@uxj.io"
+          git fetch origin "$DEFAULT_BRANCH"
+          git worktree add ../crossink-pages "origin/$DEFAULT_BRANCH"
+          cp ".pio/build/catalog" "../crossink-pages/docs/catalog"
+          cd ../crossink-pages
+          if git diff --quiet -- docs/catalog; then
+            echo "docs/catalog is already current"
+            exit 0
+          fi
+          git add docs/catalog
+          git commit -m "Update release catalog for v${RELEASE_VERSION}"
+          git push origin "HEAD:$DEFAULT_BRANCH"
 
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v3
         with:
+          token: ${{ secrets.RELEASE_PAT }}
           tag_name: v${{ env.RELEASE_VERSION }}
           target_commitish: ${{ github.sha }}
           draft: true
-          generate_release_notes: true
           files: |
-            .pio/build/tiny/carousel-firmware-tiny-v${{ env.RELEASE_VERSION }}.bin
-            .pio/build/xlarge/carousel-firmware-xlarge-v${{ env.RELEASE_VERSION }}.bin
-            .pio/build/no_emoji/carousel-firmware-no_emoji-v${{ env.RELEASE_VERSION }}.bin
+            .pio/build/tiny/firmware-tiny-v${{ env.RELEASE_VERSION }}.bin
+            .pio/build/xlarge/firmware-xlarge-v${{ env.RELEASE_VERSION }}.bin
+            .pio/build/no_emoji/firmware-no_emoji-v${{ env.RELEASE_VERSION }}.bin

.github/workflows/release_candidate.yml

@@ -93,6 +93,7 @@ jobs:
       - name: Create GitHub RC Prerelease
         uses: softprops/action-gh-release@v3
         with:
+          token: ${{ secrets.RELEASE_PAT }}
           tag_name: ${{ env.RC_TAG }}
           target_commitish: ${{ github.sha }}
           name: RC ${{ env.RC_BRANCH_SAFE }} ${{ env.RC_HASH_SHORT }}

.gitignore

@@ -19,4 +19,8 @@ fs_/
 releases/
 
 # scratchpad used as release notes for next crossink version
-release.md
+release.md
+*.cpfont
+lib/EpdFont/scripts/downloaded_fonts/
+lib/EpdFont/scripts/instanced_fonts/
+lib/EpdFont/scripts/output/

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "open-x4-sdk"]
 	path = open-x4-sdk
-	url = https://github.com/open-x4-epaper/community-sdk.git
+	url = https://github.com/crosspoint-reader/community-sdk.git

AGENTS.md

@@ -37,6 +37,7 @@ Project: Open-source e-reader firmware for Xteink X4 (ESP32-C3).
 6. Prefer `constexpr` for compile-time constants.
 7. Reserve `std::vector` capacity before push loops.
 8. Debounce persistent writes. Do not write progress on every page turn.
+9. `new` is not nothrow on ESP32. With exceptions disabled, bare `new` calls `abort()` on allocation failure instead of returning `nullptr`. Use `new (std::nothrow)` or `makeUniqueNoThrow<T>()` from `lib/Memory/Memory.h` for fallible allocations.
 
 ## HAL And Platform Rules
 
@@ -84,11 +85,21 @@ Project: Open-source e-reader firmware for Xteink X4 (ESP32-C3).
 
 ## Changelog
 
-When new features are added or issues are fixed, make sure to add an entry to `CHANGELOG.md`. Types of changes should have their own section:
+When new features are added or issues are fixed, make sure to add an entry to `CHANGELOG.md` with the user-facing description of the change. Types of changes should have their own section.
 
-Added - for new features.
-Changed - for changes in existing functionality.
-Deprecated - for soon-to-be removed features.
-Removed - for now removed features.
-Fixed - for any bug fixes.
-Security - in case of vulnerabilities.
+### Changelog Guiding Principles
+
+- Changelogs are _for humans_, not machines.
+- There should be an entry for every single version.
+- The same types of changes should be grouped.
+- Versions and sections should be linkable.
+- The latest version comes first.
+- The release date of each version is displayed.
+
+### Types of Changelog Changes
+- Added - for new features.
+- Changed - for changes in existing functionality.
+- Deprecated - for soon-to-be removed features.
+- Removed - for now removed features.
+- Fixed - for any bug fixes.
+- Security - in case of vulnerabilities.