Skip to content

Conversation

froscon2024
Copy link
Contributor

@froscon2024 froscon2024 commented Mar 19, 2025

I would like to point to the company name. Its FOSS-ASIA, not closed-source-binary-ASIA ;) So please do not point to some closed source software when there is already the open source software linked that is working also on some closed source platform named Windows (wchisp-v0.3.0-win-x64.zip) . I removed the link to closed source software and added to description, that the open source tool wchisp work on Unix and Windows. https://github.com/ch32-rs/wchisp/releases/tag/v0.3.0

Summary by Sourcery

Remove instructions for installing and using wchisp studio, a closed-source tool for flashing the badge firmware on Windows. Update the installation instructions to indicate that the open source wchisp tool works on both Unix and Windows.

I would like to point to the company name. Its FOSS-ASIA, not closed-source-binary-ASIA ;)
So please do not point to some closed source software when there is already the open source software linked that is working also on some closed source platform named Windows (wchisp-v0.3.0-win-x64.zip) . I removed the link to closed source software and added to description, that the open source tool wchisp work on Unix and Windows.
https://github.com/ch32-rs/wchisp/releases/tag/v0.3.0
Copy link
Contributor

sourcery-ai bot commented Mar 19, 2025

Reviewer's Guide by Sourcery

This pull request removes the instructions for installing and using the closed-source wchisp studio on Windows, and clarifies that the open-source wchisp tool works on both Unix and Windows. This change ensures that the documentation points to open-source solutions.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Removed instructions for installing and using wchisp studio on Windows, and updated the installation instructions to indicate that wchisp works on both Unix and Windows.
  • Removed the 'Windows' installation section.
  • Removed the link to wchisp studio.
  • Added '(Unix and Windows)' to the 'Installation' section heading.
  • Updated the description to indicate that wchisp works on Unix and Windows.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @froscon2024 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Thanks for keeping the documentation focused on open-source tools.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@kienvo
Copy link
Member

kienvo commented Mar 27, 2025

I tried Zadig yesterday and found it really hard to install WinUSB because the ISP mode (bootloader) of the chip will last only 10 seconds, I have to do it really fast. It also happened to people using Windows at the event, that's why I told them to use WCHISPStudio. Perhaps we should have some way to install the driver automatically instead of using Zadig.

FWIW: I have never touched Windows for years. It's frying my laptop.

@kienvo
Copy link
Member

kienvo commented Mar 27, 2025

I just tried. Zadig is the best option out there =]

@froscon2024
Copy link
Contributor Author

froscon2024 commented Apr 8, 2025

If you really want to add the ability for the people to use closed source driver instead of the open source one on windows, then also this tool could be used: https://github.com/ch32-rs/wlink

To hardly simplify: The currently used wchisp can also flash for example 8bit chips. But the CH58* used on the badge is more modern one with 32bit. That is why you can also use on linux and windows wlink software instead of wchisp software. For windows the difference would be that the people could use opensource and also their closed source driver. On Linux there would be no change in the flash functionality.

The bad thing: You would loose the chance to push the people into using open source drivers on their closed source windows systems. I see it as a benefit having to push windows users in installing open source things on their systems.

Merging this PR or asking me to write a different one that instead points everyone to use wlink to flash the badge on windows and linux would be both better then now. Then currently there is advertisement on the main page that push people into closed source software instead.

@kienvo , you have used wlink with the additional external programmer to debug the badge here: #79 (comment)
Did flashing the firmware worked for you over USB with no external WCH-linkE required?

@kienvo
Copy link
Member

kienvo commented Apr 8, 2025

To use wlink users have to:

  • own a WCH-Link* dongle,
  • enable the debug port by either using wchisp or WCHISPStudio,
  • connect the WCH-Link dongle to the debug port.

So, enabling the debug port is still a problem on Windows anyway.

Did flashing the firmware worked for you over USB with no external WCH-linkE required?

No, that is impossible.

Merging this PR or asking me to write a different one that instead points everyone to use wlink to flash the badge on windows and linux would be both better then now. Then currently there is advertisement on the main page that push people into closed source software instead.

I'm ok with this but not sure @mariobehling @Jhalakupadhyay what do you think?

This upgrading fw has been a headache subject since we started this project. I've been working on these #37 and #38 issues and found this interesting MCUBoot and its client tools that could solve this problem if one own a badge that has the foss fw installed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants