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.

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

feat, docs: WB32 flashing #21217

Merged
merged 1 commit into from
Jul 7, 2023
Merged

feat, docs: WB32 flashing #21217

merged 1 commit into from
Jul 7, 2023

Conversation

lesshonor
Copy link
Contributor

@lesshonor lesshonor commented Jun 11, 2023

Description

Attempts to make qmk flash path/to/binary.bin work for WB32, and adds documentation about flashing source code through the CLI (...as it will not work for non-MSYS users OOTB)

There are also some very minor formatting changes to flashers.py.

I do not own any WB32 boards and cannot fully test this.
Perhaps @itarze, @jonylee1986 or one of the users who has run into this problem can provide feedback/test.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

#21216

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@itarze
Copy link
Contributor

itarze commented Jun 12, 2023

@lesshonor okay, I'll test it. Wait for my feedback.
Do you mean that it only works when using flashing cli in msys.

@lesshonor
Copy link
Contributor Author

@lesshonor okay, I'll test it. Wait for my feedback. Do you mean that it only works when using flashing cli in msys.

I understand that the wb32-dfu-updater_cli is only included in MSYS CLI, so I added that to the documentation. That is one part of this PR.

The second part is that for other MCUs, it is possible to flash a precompiled firmware binary—so not building the code yourself—using qmk flash path/to/binary.bin.
If you can help make this work for WB32, it would be appreciated.

@drashna drashna requested a review from a team June 12, 2023 01:30
@itarze
Copy link
Contributor

itarze commented Jun 12, 2023

@lesshonor I have tested it on gmmk/numpad, gmmk/pro/rev2/ansi keyboard and it works well, in ubuntu linux.

@lesshonor
Copy link
Contributor Author

@lesshonor I have tested it on gmmk/numpad, gmmk/pro/rev2/ansi keyboard and it works well, in ubuntu linux.

Thank you for testing!

@drashna
Copy link
Member

drashna commented Jun 12, 2023

To be blunt, if the flashing tools are not included with the installation scripts, there is a low chance that this will be merged.

@lesshonor
Copy link
Contributor Author

lesshonor commented Jun 12, 2023

To be blunt, if the flashing tools are not included with the installation scripts, there is a low chance that this will be merged.

The flashing tools are part of the QMK MSYS install, and incorporated into Glorious's build of QMK Toolbox. (...while also available in the latest beta, I am reluctant to point a general audience in that direction)

Right now for a subset of Windows and Mac users performing a subset of actions, things will Just Work; the others will see nothing at all or .sh: line 1: wb32-dfu-updater_cli: command not found in a loop. IMO, documentation of what's going on, why, and what can be done outside of Discord messages is a net improvement even if it isn't parity.

@dexter93
Copy link
Contributor

this should probably target develop

@lesshonor lesshonor changed the base branch from master to develop June 15, 2023 12:40
@drashna drashna requested a review from a team July 3, 2023 18:31
@tzarc tzarc merged commit a0ea7a6 into qmk:develop Jul 7, 2023
@lesshonor lesshonor deleted the wb32-flashing branch August 29, 2023 18:57
jesperhellberg pushed a commit to jesperhellberg/qmk_firmware that referenced this pull request Sep 9, 2023
thismarvin pushed a commit to thismarvin/qmk_firmware that referenced this pull request Sep 27, 2023
akeep pushed a commit to akeep/qmk_firmware that referenced this pull request Oct 2, 2023
csolje pushed a commit to csolje/qmk_firmware that referenced this pull request Oct 21, 2023
autoferrit pushed a commit to SpaceRockMedia/bastardkb-qmk that referenced this pull request Dec 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants