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

Link to pslab-firmware release page #9

Merged
merged 1 commit into from
Jan 30, 2025

Conversation

bessman
Copy link
Contributor

@bessman bessman commented Jan 30, 2025

The UART2-as-primary firmware version is now included in pslab-firmware releases.

Summary by Sourcery

Documentation:

  • Update the README with a link to the latest pslab-firmware release page and instructions on how to flash it.

Copy link

sourcery-ai bot commented Jan 30, 2025

Reviewer's Guide by Sourcery

This pull request updates the documentation to reflect the new location of the UART2-as-primary firmware and clarifies the flashing process.

Sequence diagram for PSLab communication modes

sequenceDiagram
    participant User
    participant PSLab
    participant ESP01
    participant Computer

    Note over PSLab: After flashing UART2 firmware
    User->>PSLab: Connect ESP-01
    PSLab->>ESP01: Communicate via UART2
    ESP01->>Computer: Wireless communication

    Note over PSLab: After flashing USB firmware
    User->>PSLab: Connect USB
    PSLab->>Computer: Direct USB communication
Loading

State diagram for PSLab firmware modes

stateDiagram-v2
    [*] --> Bootloader
    Bootloader --> UART2_Mode: Flash UART2 firmware
    Bootloader --> USB_Mode: Flash USB firmware

    state UART2_Mode {
        [*] --> ESP01_Communication
        ESP01_Communication --> Wireless_Operation
    }

    state USB_Mode {
        [*] --> USB_Communication
        USB_Communication --> Direct_Operation
    }

    note right of UART2_Mode: pslab-firmware_v6_esp01.hex
    note right of USB_Mode: pslab-firmware_v6.hex
Loading

File-Level Changes

Change Details Files
Updated the firmware link to point to the release page and clarified the flashing instructions.
  • Changed the firmware link to point to the release page.
  • Updated the flashing instructions to refer to the firmware repository's flashing guide.
  • Added a note about the change in communication method after flashing the UART2 firmware.
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

@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 @bessman - I've reviewed your changes and they look great!

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.

@bessman bessman merged commit 8f6ee0c into fossasia:main Jan 30, 2025
2 checks passed
@bessman bessman deleted the doc/readme-pslab-firmware-url branch January 30, 2025 12:42
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.

1 participant