device: dierya-dk68se

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,8 @@
+---
+name: Bug Report
+about: For reporting an encountered issue
+title: "[bug] Manufacturer Model"
+labels: bug
+assignees: ''
+
+---

.github/ISSUE_TEMPLATE/device-report.md

@@ -0,0 +1,73 @@
+---
+name: Device Report
+about: For reporting operation with a particular device
+title: "[device-report] Manufacturer Model"
+labels: device-report
+assignees: ''
+
+---
+
+## Device Info
+
+- Sinowealth Device: _example `SH68F90A`_
+- IC Label: _example `BYK916`_
+- Product Page: _example https://nuphy.com/products/air60_
+
+## Part Info
+
+```
+plarform: sh68f90
+vendor_id: 0xdead
+product_id: 0xcafe
+firmware_size: 61440 # necessary if not default, otherwise remove this line
+bootloader_size: 4096 # necessary if not default, otherwise remove this line
+page_size: 2048 # necessary if not default, otherwise remove this line
+isp_iface_num: 1 # necessary if not default, otherwise remove this line
+isp_report_id: 5 # necessary if not default, otherwise remove this line
+reboot: false # necessary if not default, otherwise remove this line
+```
+
+## Operations Tested
+
+- [ ] Read
+- [ ] Write
+
+## Platforms Tested
+
+- [ ] linux
+- [ ] macos
+- [ ] windows
+
+## Checksums
+
+- Stock Firmware MD5: `deadbeefdeadbeefdeadbeefdeadbeef`
+- Bootloader MD5: `beefcafebeefcafebeefcafebeefcafe` _(shown when running `sinowealth-kb-tool read -s bootloader ...`)_
+
+## Device Info (HID Reports)
+
+Output when running `sinowealth-kb-tool list --vendor_id=<PID> --product_id=<PID>`
+
+<details>
+<summary>Output</summary>
+
+```
+sinowealth-kb-tool list --vendor_id=0x05ac --product_id=0x024f
+ID 05ac:024f manufacturer="contact@carlossless.io" product="SMK Keyboard"
+    path="DevSrvsID:4294974930" interface_number=0
+    report_descriptor=[05 01 09 06 A1 01 05 07 19 E0 29 E7 15 00 25 01 75 01 95 08 81 02 75 08 95 01 81 01 05 07 19 00 29 FF 15 00 26 FF 00 75 08 95 06 81 00 05 08 19 01 29 05 15 00 25 01 75 01 95 05 91 02 75 03 95 01 91 01 C0]
+    feature_report_ids=[]
+        usage_page=0x0001 usage=0x0006
+    path="DevSrvsID:4294974929" interface_number=1
+    report_descriptor=[05 01 09 80 A1 01 85 01 19 81 29 83 15 00 25 01 75 01 95 03 81 02 95 05 81 01 C0 05 0C 09 01 A1 01 85 02 19 00 2A 3C 02 15 00 26 3C 02 75 10 95 01 81 00 C0 06 00 FF 09 01 A1 01 85 05 19 01 29 02 15 00 26 FF 00 75 08 95 05 B1 02 C0 05 01 09 06 A1 01 85 06 05 07 19 E0 29 E7 15 00 25 01 75 01 95 08 81 02 05 07 19 00 29 9F 15 00 25 01 75 01 95 A0 81 02 C0]
+    feature_report_ids=[5]
+        usage_page=0x0001 usage=0x0006
+        usage_page=0x0001 usage=0x0080
+        usage_page=0x000c usage=0x0001
+        usage_page=0xff00 usage=0x0001
+```
+
+</details>
+
+## PCB Photos
+
+_If possible, include photos of your device PCB clearly showing MCU and wireless IC labels_

.github/workflows/push.yml

@@ -1,19 +1,142 @@
+name: Test & Build
+
 on: [push]
 
-name: CI
+env:
+  CARGO_TERM_COLOR: always
+
+defaults:
+  run:
+    # necessary for windows
+    shell: bash
 
 jobs:
-  build_and_test:
-    name: Rust project
+  nix-build:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - uses: cachix/install-nix-action@v31
+      with:
+        github_access_token: ${{ secrets.GITHUB_TOKEN }}
+    - uses: cachix/cachix-action@v14
+      with:
+        name: sinowealth-kb-tool
+        authToken: ${{ secrets.CACHIX_AUTH_TOKEN }}
+    - name: Build
+      run: nix build
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Cargo cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ./target
+          key: test-cargo-registry
+      - name: Lint
+        run: cargo fmt -- --check
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Cargo cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ./target
+          key: test-cargo-registry
+      - name: Install and configure dependencies
+        run: |
+          sudo apt-get install -qq libusb-1.0.0-dev
+      - name: Run tests
+        run: cargo test --bins --verbose
+
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - TARGET: x86_64-unknown-linux-gnu
+            OS: ubuntu-latest
+          - TARGET: x86_64-apple-darwin
+            OS: macos-latest
+          - TARGET: x86_64-pc-windows-msvc
+            OS: windows-latest
+    needs: test
+    runs-on: ${{ matrix.OS }}
+    env:
+      NAME: sinowealth-kb-tool
+      TARGET: ${{ matrix.TARGET }}
+      OS: ${{ matrix.OS }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Cargo cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ~/.cargo/registry
+            ./target
+          key: build-cargo-registry-${{matrix.TARGET}}
+      - name: Install and configure dependencies
+        run: |
+          # dependencies are only needed on ubuntu as that's the only place where
+          # we make cross-compilation
+          if [[ $OS =~ ^ubuntu.*$ ]]; then
+            sudo apt-get install -qq libusb-1.0-0-dev
+          fi
+      - name: Install rust target
+        run: rustup target add $TARGET
+      - name: Run build
+        run: cargo build --release --verbose --target $TARGET
+      - name: Compress
+        run: |
+          mkdir -p ./artifacts
+          # windows is the only OS using a different convention for executable file name
+          if [[ $OS =~ ^windows.*$ ]]; then
+              EXEC=$NAME.exe
+          else
+              EXEC=$NAME
+          fi
+          if [[ $GITHUB_REF_TYPE =~ ^tag$ ]]; then
+            TAG=$GITHUB_REF_NAME
+          else
+            TAG=$GITHUB_SHA
+          fi
+          mv ./target/$TARGET/release/$EXEC ./$EXEC
+          tar -czf ./artifacts/$NAME-$TARGET-$TAG.tar.gz $EXEC
+      - name: Archive artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: result-${{ matrix.TARGET }}
+          path: |
+            ./artifacts
+
+  release:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: build
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
-      - uses: actions/checkout@v2
-      - name: Install libudev
-        run: sudo apt-get install -y libudev-dev
-      - uses: actions-rs/toolchain@v1
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
         with:
-          toolchain: stable
-      - uses: actions-rs/cargo@v1
+          pattern: result-*
+          merge-multiple: true
+          path: ./artifacts
+      - name: Release
+        uses: softprops/action-gh-release@v2
         with:
-          command: build
-          args: --release --all-features
+          draft: true
+          generate_release_notes: true
+          files: ./artifacts/*.tar.gz

.gitignore

@@ -1,7 +1,9 @@
 .DS_Store
 
-/.direnv/
+/.direnv
+/result
 
 /private
-
 /target
+
+*.hex