Skip to content
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
merged 14 commits into from
Oct 31, 2024
Merged

docs: Add a hardware issues page under troubleshooting #2360

merged 14 commits into from
Oct 31, 2024

Conversation

Nick-Munnich
Copy link
Contributor

@Nick-Munnich 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 caksoylar added enhancement New feature or request documentation Improvements or additions to documentation labels Jul 3, 2024
@Nick-Munnich Nick-Munnich changed the title Initial creation of hardware issues page. feat(docs) Adding a hardware issues page under troubleshooting Aug 15, 2024
@Nick-Munnich Nick-Munnich marked this pull request as ready for review August 15, 2024 14:07
@Nick-Munnich Nick-Munnich requested a review from a team as a code owner August 15, 2024 14:07
@Nick-Munnich
Copy link
Contributor Author

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

caksoylar
caksoylar reviewed Aug 17, 2024
View reviewed changes
Copy link
Contributor

@caksoylar caksoylar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
caksoylar
caksoylar reviewed Sep 2, 2024
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
Copy link
Contributor

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

lesshonor
lesshonor suggested changes Oct 7, 2024
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 Nick-Munnich mentioned this pull request Oct 20, 2024
Merged
caksoylar
caksoylar reviewed Oct 31, 2024
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
@caksoylar caksoylar changed the title feat(docs) Adding a hardware issues page under troubleshooting docs: Add a hardware issues page under troubleshooting Oct 31, 2024
@caksoylar caksoylar merged commit 80df319 into zmkfirmware:main Oct 31, 2024
14 checks passed
@Nick-Munnich Nick-Munnich deleted the hardware-issues branch October 31, 2024 18:00
ssbb added a commit to ssbb/zmk that referenced this pull request Nov 2, 2024
@ssbb
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 Nov 2, 2024
@ssbb
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 Nov 6, 2024
@Nick-Munnich @caksoylar
@thazhemadam @lesshonor @EnotionZ
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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lesshonor lesshonor lesshonor requested changes

@thazhemadam thazhemadam thazhemadam left review comments

@caksoylar caksoylar caksoylar approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Feature request: Hardware troubleshooting shield
4 participants
@Nick-Munnich @caksoylar @thazhemadam @lesshonor