Skip to content

cargo-embedprobe-rs documentation change #82

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

Open
wants to merge 6 commits into
base: development
Choose a base branch
from

Conversation

BobAdamsEE
Copy link

@BobAdamsEE BobAdamsEE commented May 5, 2025

Attempting to install cargo-embed with instructions from the current boards/atsamv71_xult/README.md lead to the following:

  `cargo-embed` is now a part of `probe-rs`. To install it, run the following PowerShell command:

  irm https://github.com/probe-rs/probe-rs/releases/latest/download/probe-rs-tools-installer.ps1 | iex

  Once installed, you can use the "cargo embed" command just like before, although there might be minor changes in the API. For more information, please refer to the documentation at https://probe.rs/docs/tools/cargo-embed/.

Updated boards/atsamv71_xult/README.md with the relevant instructions for probe-rs for Windows / Linux.

BobAdamsEE added 2 commits May 5, 2025 10:27
`cargo-embed` is now a part of `probe-rs`.
Updating per suggestion in contribution guide
@BobAdamsEE BobAdamsEE changed the title Patch 1 cargo-embed -> probe-rs documentation change May 5, 2025
@BobAdamsEE BobAdamsEE marked this pull request as draft May 5, 2025 15:20
@BobAdamsEE
Copy link
Author

This will need further work - probe-rs has issues with the Embed.toml from changes from the initial cargo-embed. Will submit again once I get flashing working.

Copy link
Collaborator

@michalfita michalfita left a comment

Choose a reason for hiding this comment

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

I'm not author of this demo and I don't use it, hence missed the change that seem to happen in 2023. Thanks for efforts to improve the documentation.

@michalfita michalfita changed the title cargo-embed -> probe-rs documentation change cargo-embedprobe-rs documentation change May 5, 2025
@BobAdamsEE BobAdamsEE closed this May 6, 2025
@BobAdamsEE BobAdamsEE deleted the patch-1 branch May 6, 2025 12:05
@BobAdamsEE BobAdamsEE restored the patch-1 branch May 6, 2025 12:15
Fixed errors that cause cargo embed to not work including show_timestamps as a general default.rtt setting (now per up_channel), halt_afterwards in the default.flashing section, and the channels parameter of default.rtt was split into up_channels and down_channels.
@BobAdamsEE BobAdamsEE reopened this May 6, 2025
BobAdamsEE and others added 3 commits May 6, 2025 08:20
Remove windows style of paths

Co-authored-by: Michał Fita <[email protected]>
Per recommendation removed curl | sh notes - users can reference current documentation from probe-rs site directly
@BobAdamsEE
Copy link
Author

Resolved review comments and updated Embed.TOML to handle some changes from probe-rs:

@BobAdamsEE BobAdamsEE marked this pull request as ready for review May 6, 2025 12:31
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.

3 participants