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

Change command for flashing firmware #181

Merged
merged 2 commits into from
Oct 22, 2024
Merged

Conversation

marcnause
Copy link
Contributor

@marcnause marcnause commented Oct 21, 2024

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

Summary by Sourcery

Documentation:

  • Update the README to reflect the change in the command for flashing firmware from pslab flash to mcbootflash.

Copy link

sourcery-ai bot commented Oct 21, 2024

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
Loading

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 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

@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 @marcnause - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Could you provide more context on why pslab flash doesn't work and whether this change with mcbootflash is intended to be a temporary workaround or a permanent solution?
  • Please elaborate on the implications of introducing mcbootflash as a new dependency. Are there any compatibility issues to consider, and have you tested this method across different environments and devices?
  • There's a typo in the PR title ('fiormware' instead of 'firmware'). Please correct it for clarity.
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: 1 issue found

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.

README.md Outdated Show resolved Hide resolved
@marcnause marcnause changed the title Change command for flashing fiormware Change command for flashing firmware Oct 21, 2024
@bessman bessman merged commit edf8d7a into fossasia:main Oct 22, 2024
2 checks passed
@bessman
Copy link
Collaborator

bessman commented Oct 22, 2024

Thank you!

@marcnause marcnause deleted the docs/flashing branch October 23, 2024 18:46
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