Skip to content

Firmware Image Download

The highdra images download command will connect to GitHub, scan the starcopter-firmware repository for releases and download all attached firmware images matching the filename pattern.

Prerequisites

As the images are downloaded from the private starcopter-firmware repository, you need to be authenticated with GitHub. You should already have done this when installing the highdra CLI, but if you haven't, follow the steps in the installation instructions.

When the GitHub CLI is not authenticated, the command will exit with an error and a message to run gh auth login.

Usage

There are no configuration options for this command: just run it!

Note

The highdra CLI will not automatically check for new releases in the background. You will need to run this command manually to update the firmware images.

PS C:\Users\lasse> highdra images download
▸ 32 matching images found in 8 releases for starcopter/starcopter-firmware.
✓ Downloaded 32 images.

$ highdra images download
▸ 32 matching images found in 8 releases for starcopter/starcopter-firmware.
✓ Downloaded 32 images.

It will then print a table of the downloaded images, just like in the list command.

Filename Pattern

Only images with the following filename pattern will be downloaded:

<name>-<hardware_version>-<software_version>[.<git_hash>].[crc].app.bin
  • <name> is the name of the application that the image is for, e.g. com.starcopter.highdra.bms.
  • <hardware_version> is the hardware version (major.minor) the image is for, e.g. 4.1.
  • <software_version> is the software version the image is for. All PEP 440 version specifiers are supported.
  • <git_hash> (optional) is the shortened Git hash of the release.
  • <crc> (optional) is the CRC or SHA256 of the image.

Only the application name and hardware version are taken from the filename. The software version is extracted from the release title, the Git hash is taken from the release tag, and the CRC (SHA256) is extracted from the MCUBoot trailer in the image file itself.