fossasia / pslab-firmware

Firmware for PSLab Open Hardware Platform https://pslab.io
Apache License 2.0
1.56k stars 75 forks source link

Change command for flashing firmware #181

Closed marcnause closed 1 month ago

marcnause commented 1 month ago

Flashing via pslab flash does not work currently, but using mcbootflash as a fallback works.

Summary by Sourcery

Documentation:

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request updates the firmware flashing instructions in the README.md file, replacing the use of 'pslab flash' command with 'mcbootflash' command. It also adds information about the mcbootflash tool and its installation.

User journey diagram for firmware flashing process

journey
    title Firmware Flashing Process
    section Preparation
      User: Press 'BOOT' button
      User: Release 'BOOT' button
    section Flashing
      User: Run `mcbootflash --port <portname> -b 460800 firmware.hex`
    section Completion
      User: Reset or power cycle the device

File-Level Changes

Change Details Files
Update firmware flashing instructions
  • Replace 'pslab flash' command with 'mcbootflash' command
  • Add information about mcbootflash tool and its installation
  • Update baud rate in the flashing command to 460800
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. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a 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. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) 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 - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).
bessman commented 1 month ago

Thank you!