Release v1.0.0

We are happy to announce the v1.0.0 first stable release of Black Magic Probe Utility!

This is the first full release of the tool, and comes with pre-built binaries available in the release assets below, and is compatible with cargo binstall.

Installation

You can find the installation instructions in the project README.

Usage

Please refer to our website for usage instructions.

Command Line Interface improvements

In this release we introduce a big Command Line Interface (aka. CLI) change. The program was renamed from bmputil to bmputil-cli to allow us to expand application types in the future without having to break the interface in the future.

The existing functions of bmputil-cli are moved into probe command namespace, and we reserved additional target, server, debug namespaces for future use. This change is also in service of future proofing the CLI. We have mid term plans to add a bunch more functionality to bmputil and we want to avoid breaking the interface while doing that.

The behaviour of probe update and probe switch have also changed slightly.

probe update is now automatically checking the active firmware version on the attached Black Magic Probe and executes an update if there is a new version available. It can still flash an arbitrary firmware binary by passing the firmware file name to the command. It also can update to a release candidate of the firmware by providing a --use-rc override, and an update can be forced with --force even if the tool considers the probe as being fully up to date.

The probe switch command now only functions as a firmware variant selector. firmware variants are being introduced in Black Magic Firmware V2.0 series allowing the partitioning of firmware functionality to work around the flash size limitation of the Black Magic Probe hardware.

Following is a screenshot of the tool called without any parameters to illustrate what namespaces mean.

In this release

• Updated the dependencies to mitigate a few having become outdated and fix build issues that arose [dragonmux]
• Implemented automated firmware download, using the new summon-blackmagic metadata service [dragonmux]
• Switched USB implementations from rusb to nusb - this should improve the reliability of the tool [dragonmux]
• Switched error handlers to color-eyre, providing much richer and coloured error reports you can provide to us [dragonmux]
• Implemented a guided firmware selection system to improve management of the firmware on a probe [dragonmux]
• Improved the UX for the tool in general, making things more polished and easier to work with [dragonmux]
• Fixed a spurious STALL error being emitted under Linux by the utility when it should be suppressed [dragonmux]
  • The STALL condition is real, but also not erroneous so should not prevent forward progress from the tool
• Overhauled the project's README and updated it to more accurate reflect what tool does and is [dragonmux]
• Fixed a spurious disconnect error being emitted under Windows by the utility [dragonmux]
  • The STALL condition is real, but also not erroneous so should not prevent forward progress from the tool
• Fixed the parsing of the firmware's identity string as it was breaking the string down slightly incorrectly [P-Storm]
• Restructured the tool's CLI, converting the style of the parser and moving commands around for better consistency and structure [dragonmux]
• Fixed several clippy lints and the code base formatting using rustfmt nightly [dragonmux/lethalbit]
• Implemented handling for probe info --list-targets and introduced BMD remote serial protocol support
• Implemented better probe update control, allowing a user to force a firmware change and ask the tool to consider using RC's as well as full releases [dragonmux]
• Implemented better upgrade diagnostics following on from the better probe update controls [dragonmux]
• Fixed an issue with product string parsing on bootloader strings, resulting in errors/crashes in those cases [dragonmux]
• Moved the suppressions to a more suitable layer and applied them + fixed reboot behaviour across all places DFU_DETACH can be generated [dragonmux]
• Unit tested and reworked some of the logic for the URI building for the firmware index machinary [P-Storm]
• Reconfigured the releases for use with cargo binstall and switch the install instructions over to that from cargo install [esden]
• Fixed an error in the USB DFU machinery that had it using the wrong byte of a descriptor in an error [P-Storm]
• Improved the help displays to include the tool version information, as well as crash error displays to help users with reporting issues [dragonmux]
• Reorganised the probe matching machinery into its own file, and cleaned up the implementation [P-Storm]

Contributors to v1.0.0

We have had 3 individuals contribute 309 commits since the v0.1.3 release.

Contributor (Contributions)
dragonmux (281)
P-Storm (22)
Piotr Esden-Tempski (6)

Sponsors

This project is sponsored in parts by:

• 1BitSquared - Design, Manufacture and distribution of open source embedded hardware development tools and platforms, as well as educational electronics. Thank you everyone who buys Black Magic Probes from 1BitSquared directly through our stores or indirectly through Adafruit. The hardware sales allow us to continue supporting the Black Magic Debug project.
• All the generous Patrons and GitHub Sponsors supporting esden’s work
• All the generous GitHub Sponsors supporting dragonmux’s work

Release Candidate v1.0.0-rc.2

We are happy to announce the second v1.0.0 release candidate of the Black Magic Probe Utility.

This is the first full release of the tool, and comes with pre-built binaries available in the release assets below.

Usage

The tool is self contained in a single binary file. All you need to do is download the zip/archive file, decompress it, and run the bmputil-cli from the command line of your operating system. Running the program without any parameters will provide usage help.

Alternatively you can install bmputil from source using cargo install bmputil@v1.0.0-rc.2. An up-to-date installation of Rust via rustup is required.

bmputil-cli does not offer a graphical UI at this time, and needs to be run from the command line interface.

For more information about the usage refer to our website: https://black-magic.org/upgrade.html

CLI API improvements

In this release we introduce a big CLI API change. Most existing functions are moved into probe namespace, and we reserve additional target, server, debug namespaces for future use. We reserve those namespaces so that we don't have to fully break the CLI API right after releasing V1.0 of the tool, as adding new functionality will not break semver rules.

While we were changing the API the function of probe update and probe switch have changed slightly.

probe update is now automatically checking the active firmware version on the attached Black Magic Probe and executes an update if there is a new version available. It can still flash an arbitrary firmware binary by passing the firmware file name to the command. It also can update to a release candidate of the firmware by providing a --use-rc override, and an update can be forced with --force even if the tool considers the probe as being fully up to date.

The probe switch command now only functions as a firmware variant selector. firmware variants are being introduced in Black Magic Firmware V2.0 series allowing the partitioning of firmware functionality to work around the flash size limitation of the Black Magic Probe hardware.

Following is a screenshot of the tool called without any parameters to illustrate what namespaces mean.

In this release

• Fixed a spurious STALL error being emitted under Linux by the utility when it should be suppressed [dragonmux]
  • The STALL condition is real, but also not erroneous so should not prevent forward progress from the tool
• Overhauled the project's README and updated it to more accurate reflect what tool does and is [dragonmux]
• Fixed a spurious disconnect error being emitted under Windows by the utility [dragonmux]
  • The STALL condition is real, but also not erroneous so should not prevent forward progress from the tool
• Fixed the parsing of the firmware's identity string as it was breaking the string down slightly incorrectly [P-Storm]
• Restructured the tool's CLI, converting the style of the parser and moving commands around for better consistency and structure [dragonmux]
• Fixed several clippy lints and the code base formatting using rustfmt nightly [dragonmux/lethalbit]
• Implemented handling for probe info --list-targets and introduced BMD remote serial protocol support
• Implemented better probe update control, allowing a user to force a firmware change and ask the tool to consider using RC's as well as full releases [dragonmux]
• Implemented better upgrade diagnostics following on from the better probe update controls [dragonmux]
• Fixed an issue with product string parsing on bootloader strings, resulting in errors/crashes in those cases [dragonmux]
• Moved the suppressions to a more suitable layer and applied them + fixed reboot behaviour across all places DFU_DETACH can be generated [dragonmux]

Contributors to v1.0.0-rc.2

We have had 2 individuals contribute 148 commits since the v1.0.0-rc.1 release candidate.

Contributor (Contributions)
dragonmux (142)
P-Storm (6)

Sponsors

This project is sponsored in parts by:

• 1BitSquared - Design, Manufacture and distribution of open source embedded hardware development tools and platforms, as well as educational electronics. Thank you everyone who buys Black Magic Probes from 1BitSquared directly through our stores or indirectly through Adafruit. The hardware sales allow us to continue supporting the Black Magic Debug project.
• All the generous Patrons and GitHub Sponsors supporting esden’s work
• All the generous GitHub Sponsors supporting dragonmux’s work

Release Candidate v1.0.0-rc.1

We are happy to announce the first v1.0.0 release candidate of the Black Magic Probe Utility.

This is the first full release of the tool, and comes with pre-built binaries available in the release assets below.

Usage

The tool is self contained in a single binary file. All you need to do is download the zip/archive file, decompress it, and run the bmputil-cli from the command line of your operating system. Running the program without any parameters will provide usage help.

Alternatively you can install bmputil from source using cargo install bmputil@v1.0.0-rc.1. An up-to-date installation of Rust via rustup is required.

bmputil-cli does not offer a graphical UI at this time, and needs to be run from the command line interface.

For more information about the usage refer to our website: https://black-magic.org/upgrade.html

In this release

• Updated the dependencies to mitigate a few having become outdated and fix build issues that arose [dragonmux]
• Implemented automated firmware download, using the new summon-blackmagic metadata service [dragonmux]
• Switched USB implementations from rusb to nusb - this should improve the reliability of the tool [dragonmux]
• Switched error handlers to color-eyre, providing much richer and coloured error reports you can provide to us [dragonmux]
• Implemented a guided firmware selection system to improve management of the firmware on a probe [dragonmux]
• Improved the UX for the tool in general, making things more polished and easier to work with [dragonmux]

Contributors to v1.0.0-rc.1

We have had 2 individuals contribute 137 commits since the v0.1.3 release.

Contributor (Contributions)
dragonmux (134)
Piotr Esden-Tempski (3)

Sponsors

This project is sponsored in parts by:

• 1BitSquared - Design, Manufacture and distribution of open source embedded hardware development tools and platforms, as well as educational electronics. Thank you everyone who buys Black Magic Probes from 1BitSquared directly through our stores or indirectly through Adafruit. The hardware sales allow us to continue supporting the Black Magic Debug project.
• All the generous Patrons and GitHub Sponsors supporting esden’s work
• All the generous GitHub Sponsors supporting dragonmux’s work

Release v0.1.3

We are happy to announce the v0.1.3 point release of the Black Magic Probe Utility.

This is the fourth beta release of the tool. With this release we are continuing to provide various pre-built binaries of the tool.

Usage

The tool is self contained in a single binary file. All you need to do is download the zip file, decompress it, and run the bmputil from the command line of your operating system. Running the program without any parameters will provide usage help.

bmputil does not offer a graphical UI, and needs to be run from the command line interface.

For more information about the usage refer to our website: https://black-magic.org/upgrade.html

In this release

• Fixed the Cargo.toml and Cargo.lock being out of sync with one another [perigoso]
• Updated the dependencies to mitigate a few having become outdated [dragonmux]

Contributors to v0.1.3

We have had 2 individuals contribute 3 commits since the v0.1.2 release.

Contributor (Contributions)
dragonmux (2)
perigoso (1)

Sponsors

This project is sponsored in parts by:

• 1BitSquared - Design, Manufacture and distribution of open source embedded hardware development tools and platforms, as well as educational electronics. Thank you everyone who buys Black Magic Probes from 1BitSquared directly through our stores or indirectly through Adafruit. The hardware sales allow us to continue supporting the Black Magic Debug project.
• All the generous Patrons and GitHub Sponsors supporting esden’s work
• All the generous GitHub Sponsors supporting dragonmux’s work

Release v0.1.2

We are happy to announce the v0.1.2 point release of the Black Magic Probe Utility.

This is the third beta release of the tool. With this release we are also providing various pre-built binaries of the tool.

Usage

The tool is self contained in a single binary file. All you need to do is download the zip file, decompress it, and run the bmputil from the command line of your operating system. Running the program without any parameters will provide usage help.

bmputil does not offer a graphical UI, and needs to be run from the command line interface.

For more information about the usage refer to our website: https://black-magic.org/upgrade.html

In this release

• Fixes to the README to reflect publication and release of the tool [desertsagebrush]
• Updated the dependencies to mitigate a few having become outdated [dragonmux]

Contributors to v0.1.2

We have had 2 individuals contribute 2 commits since the v0.1.1 release.

Contributor (Contributions)
desertsagebrush (1)
dragonmux (1)

Sponsors

This project is sponsored in parts by:

• 1BitSquared - Design, Manufacture and distribution of open source embedded hardware development tools and platforms, as well as educational electronics. Thank you everyone who buys Black Magic Probes from 1BitSquared directly through our stores or indirectly through Adafruit. The hardware sales allow us to continue supporting the Black Magic Debug project.
• All the generous Patrons and GitHub Sponsors supporting esden’s work
• All the generous GitHub Sponsors supporting dragonmux’s work

Release v0.1.1

We are happy to announce the v0.1.1 point release of the Black Magic Probe Utility.

This is the second beta release of the tool. With this release we are also providing various pre-built binaries of the tool.

Usage

The tool is self contained in a single binary file. All you need to do is download the zip file, decompress it, and run the bmputil from the command line of your operating system. Running the program without any parameters will provide usage help.

bmputil does not offer a graphical UI, and needs to be run from the command line interface.

For more information about the usage refer to our website: https://black-magic.org/upgrade.html

In this release

• Fixed a command line options handling issue that stopped automatic driver installation under Windows from working [dragonmux]

Contributors to v0.1.1

We have had 1 individual contribute 2 commits since the v0.1.0 release.

Contributor (Contributions)
dragonmux (2)

Sponsors

This project is sponsored in parts by:

• 1BitSquared - Design, Manufacture and distribution of open source embedded hardware development tools and platforms, as well as educational electronics. Thank you everyone who buys Black Magic Probes from 1BitSquared directly through our stores or indirectly through Adafruit. The hardware sales allow us to continue supporting the Black Magic Debug project.
• All the generous Patrons and GitHub Sponsors supporting esden’s work
• All the generous GitHub Sponsors supporting dragonmux’s work

Release v0.1.0

We are happy to announce the v0.1.0 release of Black Magic Probe Utility.

This is the first beta release of the tool. With this first release we are also providing various pre-built binaries of the tool.

Usage

The tool is self contained in a single binary file. All you need to do is download the zip file, decompress it, and run the bmputil from the command line of your operating system. Running the program without any parameters will provide usage help.

bmputil does not offer a graphical UI, and needs to be run from the command line interface.

For more information about the usage refer to our website: https://black-magic.org/upgrade.html

Contributors to V0.1.0

We have had 5 individuals contribute 78 commits since the beginning of time.

Contributor (Contributions)
Qyriad (51)
dragonmux (22)
Amy (3)
Sean Cross (1)
Piotr Esden-Tempski (1)

Sponsors

This project is sponsored in parts by:

• 1BitSquared - Design, Manufacture and distribution of open source embedded hardware development tools and platforms, as well as educational electronics. Thank you everyone who buys Black Magic Probes from 1BitSquared directly through our stores or indirectly through Adafruit. The hardware sales allow us to continue supporting the Black Magic Debug project.
• All the generous Patrons and GitHub Sponsors supporting esden’s work
• All the generous GitHub Sponsors supporting dragonmux’s work