New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add a hardware issues page under troubleshooting #2360

Merged

caksoylar merged 14 commits into zmkfirmware:main from Nick-Munnich:hardware-issues

Oct 31, 2024

Contributor

Nick-Munnich commented Jul 3, 2024 •

edited

Loading

This PR adds a "hardware issues" page under troubleshooting. It discusses:

Identifying problems with pins
Firmware changes needed after soldering a bodge wire
Common physical problems with antennas
Advice for troubleshooting the physical problems

In the process, there are also two new shields to help with troubleshooting: tester_pro_micro and tester_xiao. This partially resolves #2410, though I would really like a more general solution eventually.

caksoylar added enhancement documentation labels

Nick-Munnich force-pushed the hardware-issues branch from 1a8de49 to 8899edb Compare

August 14, 2024 14:04

Nick-Munnich changed the title ~~Initial creation of hardware issues page.~~ feat(docs) Adding a hardware issues page under troubleshooting

Nick-Munnich marked this pull request as ready for review

August 15, 2024 14:07

Nick-Munnich requested a review from a team as a code owner

August 15, 2024 14:07

Contributor Author

Nick-Munnich commented Aug 15, 2024

Did a big overhaul of this, updated the title and description accordingly.

caksoylar reviewed

View reviewed changes

Contributor

caksoylar left a comment

Some mostly high level thoughts; FWIW I think this is a pretty large undertaking.

app/boards/shields/tester_pro_micro/Kconfig.defconfig Outdated Show resolved Hide resolved

app/boards/shields/tester_pro_micro/tester_pro_micro.keymap Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Show resolved Hide resolved

app/boards/shields/tester_pro_micro/tester_pro_micro.overlay Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

Nick-Munnich commented

View reviewed changes

app/boards/shields/tester_pro_micro/Kconfig.defconfig Outdated Show resolved Hide resolved

Nick-Munnich commented

View reviewed changes

app/boards/shields/tester_xiao/Kconfig.defconfig Outdated Show resolved Hide resolved

caksoylar reviewed

View reviewed changes

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

caksoylar approved these changes

View reviewed changes

Contributor

caksoylar commented Sep 3, 2024

Oh, I think this needs to be rebased to fix the broken link in build.

Nick-Munnich and others added 2 commits

September 3, 2024 08:42


          feat(shields): Added tester shields for pro micro and xiao form factors

83c102e


          feat(docs): Added a page on troubleshooting hardware issues.

d6f34bb

Co-authored-by: Cem Aksoylar <[email protected]>

Nick-Munnich force-pushed the hardware-issues branch from ab77156 to d6f34bb Compare

September 3, 2024 06:46

thazhemadam reviewed

View reviewed changes

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

Nick-Munnich and others added 3 commits

September 9, 2024 11:09


          Update docs/docs/troubleshooting/hardware-issues.mdx

aeca7d7

Co-authored-by: Anant Thazhemadam <[email protected]>


          Added pinouts to tester shield section for better reference

878204f


          Merge branch 'hardware-issues' of github.com:Nick-Munnich/zmk into ha…

9dac026

…rdware-issues

lesshonor suggested changes

View reviewed changes

app/boards/shields/tester_pro_micro/tester_pro_micro.overlay Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

Nick-Munnich and others added 2 commits

October 7, 2024 22:55


          Apply suggestions from code review

2bb7f0a

Co-authored-by: Less/Rikki <[email protected]>


          Further suggestions from code review

ba17001

Nick-Munnich mentioned this pull request

docs(feat): further generalize RGB information #2485

Merged


          Added design flaw bit to antenna

a487fc2

lesshonor reviewed

View reviewed changes

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved


          docs:additional feedback

0b53d42

caksoylar reviewed

View reviewed changes

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

docs/docs/troubleshooting/hardware-issues.mdx Outdated Show resolved Hide resolved

Nick-Munnich and others added 2 commits

October 31, 2024 09:28


          Code review changes

db4743d


          Merge branch 'main' into hardware-issues

2d4456d

Nick-Munnich added 3 commits

October 31, 2024 18:32


          Split keyboards keymap note

dbc6b41


          Merge branch 'hardware-issues' of github.com:Nick-Munnich/zmk into ha…

6bf429d

…rdware-issues


          note

9b0397a

caksoylar approved these changes

View reviewed changes

caksoylar changed the title ~~feat(docs) Adding a hardware issues page under troubleshooting~~ docs: Add a hardware issues page under troubleshooting

caksoylar merged commit 80df319 into zmkfirmware:main

14 checks passed

Nick-Munnich deleted the hardware-issues branch

October 31, 2024 18:00

ssbb added a commit to ssbb/zmk that referenced this pull request


          PR 2477: mouse support

f87cfb8

Squashed commit of the following:

commit 9c5b9e3
Author: Peter Johanson <[email protected]>
Date:   Fri Nov 1 15:37:48 2024 -0600

    docs: Add initial pointer docs.

commit 4edf568
Author: Peter Johanson <[email protected]>
Date:   Wed Oct 30 11:29:42 2024 -0600

    SQUASH CORE: Drop default scroll value again.

    * Drop the default scroll value again. In theory you only want the
      higher value *IF* you enable the smooth scrolling Kconfig setting.

commit 35b0b21
Author: Peter Johanson <[email protected]>
Date:   Wed Oct 30 10:59:43 2024 -0600

    SQUASH SPLIT: tweaks for dedicated input split init priority

commit 6291cbb
Author: Peter Johanson <[email protected]>
Date:   Tue Oct 15 13:53:00 2024 -0600

    feat: Add input split support.

commit 0306d8e
Author: Cem Aksoylar <[email protected]>
Date:   Wed Nov 15 21:11:41 2023 -0800

    feat(mouse): Add mouse move and scroll support

    * Use Zephyr input subsystem for all pointers.
    * Input processors for modifying events, e.g. scaling, swapping
      codes, temporary (mouse) layers, etc.
    * Mouse move/scroll behaviors.
    * Infrastructure in place for physical pointer input devices.

    Co-authored-by: Alexander Krikun <[email protected]>
    Co-authored-by: Robert U <[email protected]>
    Co-authored-by: Shawn Meier <[email protected]>

commit 249ecbc
Author: Peter Johanson <[email protected]>
Date:   Fri Nov 1 12:40:20 2024 -0600

    fix(studio): Bump nanopb version with build fixes.

    * Pull in fixes for prefering generator/protoc instead of the
      host protoc, for better compatibility.

commit 158bb31
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Fri Nov 1 09:50:53 2024 +0100

    chore(deps-dev): bump webpack from 5.95.0 to 5.96.0 in /docs (zmkfirmware#2600)

    Bumps [webpack](https://github.com/webpack/webpack) from 5.95.0 to 5.96.0.
    - [Release notes](https://github.com/webpack/webpack/releases)
    - [Commits](webpack/webpack@v5.95.0...v5.96.0)

    ---
    updated-dependencies:
    - dependency-name: webpack
      dependency-type: direct:development
      update-type: version-update:semver-minor
    ...

    Signed-off-by: dependabot[bot] <[email protected]>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

commit 80df319
Author: Nicolas Munnich <[email protected]>
Date:   Thu Oct 31 18:42:00 2024 +0100

    docs: Add a hardware issues page under troubleshooting (zmkfirmware#2360)

    Co-authored-by: Cem Aksoylar <[email protected]>
    Co-authored-by: Anant Thazhemadam <[email protected]>
    Co-authored-by: Less/Rikki <[email protected]>

ssbb added a commit to ssbb/zmk that referenced this pull request


          PR 2477: mouse support

5faefb0

Squashed commit of the following:

commit 9c5b9e3
Author: Peter Johanson <[email protected]>
Date:   Fri Nov 1 15:37:48 2024 -0600

    docs: Add initial pointer docs.

commit 4edf568
Author: Peter Johanson <[email protected]>
Date:   Wed Oct 30 11:29:42 2024 -0600

    SQUASH CORE: Drop default scroll value again.

    * Drop the default scroll value again. In theory you only want the
      higher value *IF* you enable the smooth scrolling Kconfig setting.

commit 35b0b21
Author: Peter Johanson <[email protected]>
Date:   Wed Oct 30 10:59:43 2024 -0600

    SQUASH SPLIT: tweaks for dedicated input split init priority

commit 6291cbb
Author: Peter Johanson <[email protected]>
Date:   Tue Oct 15 13:53:00 2024 -0600

    feat: Add input split support.

commit 0306d8e
Author: Cem Aksoylar <[email protected]>
Date:   Wed Nov 15 21:11:41 2023 -0800

    feat(mouse): Add mouse move and scroll support

    * Use Zephyr input subsystem for all pointers.
    * Input processors for modifying events, e.g. scaling, swapping
      codes, temporary (mouse) layers, etc.
    * Mouse move/scroll behaviors.
    * Infrastructure in place for physical pointer input devices.

    Co-authored-by: Alexander Krikun <[email protected]>
    Co-authored-by: Robert U <[email protected]>
    Co-authored-by: Shawn Meier <[email protected]>

commit 249ecbc
Author: Peter Johanson <[email protected]>
Date:   Fri Nov 1 12:40:20 2024 -0600

    fix(studio): Bump nanopb version with build fixes.

    * Pull in fixes for prefering generator/protoc instead of the
      host protoc, for better compatibility.

commit 158bb31
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Fri Nov 1 09:50:53 2024 +0100

    chore(deps-dev): bump webpack from 5.95.0 to 5.96.0 in /docs (zmkfirmware#2600)

    Bumps [webpack](https://github.com/webpack/webpack) from 5.95.0 to 5.96.0.
    - [Release notes](https://github.com/webpack/webpack/releases)
    - [Commits](webpack/webpack@v5.95.0...v5.96.0)

    ---
    updated-dependencies:
    - dependency-name: webpack
      dependency-type: direct:development
      update-type: version-update:semver-minor
    ...

    Signed-off-by: dependabot[bot] <[email protected]>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

commit 80df319
Author: Nicolas Munnich <[email protected]>
Date:   Thu Oct 31 18:42:00 2024 +0100

    docs: Add a hardware issues page under troubleshooting (zmkfirmware#2360)

    Co-authored-by: Cem Aksoylar <[email protected]>
    Co-authored-by: Anant Thazhemadam <[email protected]>
    Co-authored-by: Less/Rikki <[email protected]>

EnotionZ pushed a commit to EnotionZ/zmk that referenced this pull request


          docs: Add a hardware issues page under troubleshooting (zmkfirmware#2360

a425356

)

Co-authored-by: Cem Aksoylar <[email protected]>
Co-authored-by: Anant Thazhemadam <[email protected]>
Co-authored-by: Less/Rikki <[email protected]>

earwin pushed a commit to earwin/zmk that referenced this pull request


          docs: Add a hardware issues page under troubleshooting (zmkfirmware#2360

66d89d2

)

Co-authored-by: Cem Aksoylar <[email protected]>
Co-authored-by: Anant Thazhemadam <[email protected]>
Co-authored-by: Less/Rikki <[email protected]>

ssbb added a commit to ssbb/zmk that referenced this pull request


          PR 2477: mouse support

476dd6c

Squashed commit of the following:

commit 9c5b9e3
Author: Peter Johanson <[email protected]>
Date:   Fri Nov 1 15:37:48 2024 -0600

    docs: Add initial pointer docs.

commit 4edf568
Author: Peter Johanson <[email protected]>
Date:   Wed Oct 30 11:29:42 2024 -0600

    SQUASH CORE: Drop default scroll value again.

    * Drop the default scroll value again. In theory you only want the
      higher value *IF* you enable the smooth scrolling Kconfig setting.

commit 35b0b21
Author: Peter Johanson <[email protected]>
Date:   Wed Oct 30 10:59:43 2024 -0600

    SQUASH SPLIT: tweaks for dedicated input split init priority

commit 6291cbb
Author: Peter Johanson <[email protected]>
Date:   Tue Oct 15 13:53:00 2024 -0600

    feat: Add input split support.

commit 0306d8e
Author: Cem Aksoylar <[email protected]>
Date:   Wed Nov 15 21:11:41 2023 -0800

    feat(mouse): Add mouse move and scroll support

    * Use Zephyr input subsystem for all pointers.
    * Input processors for modifying events, e.g. scaling, swapping
      codes, temporary (mouse) layers, etc.
    * Mouse move/scroll behaviors.
    * Infrastructure in place for physical pointer input devices.

    Co-authored-by: Alexander Krikun <[email protected]>
    Co-authored-by: Robert U <[email protected]>
    Co-authored-by: Shawn Meier <[email protected]>

commit 249ecbc
Author: Peter Johanson <[email protected]>
Date:   Fri Nov 1 12:40:20 2024 -0600

    fix(studio): Bump nanopb version with build fixes.

    * Pull in fixes for prefering generator/protoc instead of the
      host protoc, for better compatibility.

commit 158bb31
Author: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Date:   Fri Nov 1 09:50:53 2024 +0100

    chore(deps-dev): bump webpack from 5.95.0 to 5.96.0 in /docs (zmkfirmware#2600)

    Bumps [webpack](https://github.com/webpack/webpack) from 5.95.0 to 5.96.0.
    - [Release notes](https://github.com/webpack/webpack/releases)
    - [Commits](webpack/webpack@v5.95.0...v5.96.0)

    ---
    updated-dependencies:
    - dependency-name: webpack
      dependency-type: direct:development
      update-type: version-update:semver-minor
    ...

    Signed-off-by: dependabot[bot] <[email protected]>
    Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

commit 80df319
Author: Nicolas Munnich <[email protected]>
Date:   Thu Oct 31 18:42:00 2024 +0100

    docs: Add a hardware issues page under troubleshooting (zmkfirmware#2360)

    Co-authored-by: Cem Aksoylar <[email protected]>
    Co-authored-by: Anant Thazhemadam <[email protected]>
    Co-authored-by: Less/Rikki <[email protected]>

mechlovin pushed a commit to mechlovin/zmk that referenced this pull request


          docs: Add a hardware issues page under troubleshooting (zmkfirmware#2360

c9cfdb5

)

Co-authored-by: Cem Aksoylar <[email protected]>
Co-authored-by: Anant Thazhemadam <[email protected]>
Co-authored-by: Less/Rikki <[email protected]>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation enhancement