bladeRF-install-firmware(1)

πŸ’– bladeRF-install-firmware β€” Nuand's BladeRF Firmware Utility πŸ’–

okay so bestie, welcome to bladeRF-install-firmware(1) β€” section 1 of the manual, Nuand's very own BladeRF Firmware Utility. she's giving "help me get the right firmware onto my board without me crying". let's get into it πŸ¦‹


✨ NAME ✨

bladeRF-install-firmware β€” BladeRF Firmware Utility. that's it, that's the name, short and iconic πŸ’…


🌸 SYNOPSIS 🌸

bladeRF-install-firmware [-h] [show help] [-i imagedir]
[image_directory] [-f fpgaimage] [fpkg_image_file] [-u usbimage]
[fx3_image_file]

look at her, all flags and brackets. so many options for a program that (spoiler) works best with, like, none of them 😭


πŸŽ€ OPTIONS πŸŽ€

ngl the real tea here is: this program works best without any arguments. like, just run it. that's the whole vibe.

but if you already have the firmware tarball and you're wanting to install it on a system that has no Internet access (no wifi, no ethernet, nothing, tragic), then you can run this script with that file as an argument. periodt.

the flags from the synopsis, laid out for you:

  • -h β€” [show help]
  • -i imagedir β€” [image_directory]
  • -f fpgaimage β€” [fpkg_image_file]
  • -u usbimage β€” [fx3_image_file]

iykyk. that's the whole option menu, babes πŸ“


πŸ’œ DESCRIPTION πŸ’œ

okay so here's the situation, and it's a little messy:

the FPGA image is built using non-free software and is not distributed by Debian. yeah. so this program exists to make it easier for the end user (you, hi πŸ’–) to get the recommended images from Nuand.com.

the bladeRF-cli application is what's actually used to load the FX3 firmware and the FPGA firmware. she's the workhorse, this script is just the cute little helper holding her coffee β˜•

here's the part you need to remember, and I'm saying it with my whole chest:

  • the FX3 firmware only needs to be loaded once β€” it's stored in flash, and it survives power cycling. so like, load it and forget it, she's settled ✨
  • the FPGA image needs to be loaded every single time. every time. no exceptions. it's giving high-maintenance and we respect her for it πŸ’…
and now the part you actually came for β€” the recommended firmware and FPGA images to use:

πŸ‘‘ AUTHOR πŸ‘‘

this manual page was written by Maitland Bottoms for the Debian project (but may be used by others). we love a humble legend 🫢


Copyright (c) 2013 A. Maitland Bottoms <bottoms@debian.org>

and now the full legal text, verbatim, because we do not mess with license wording, no cap:

 Permission is hereby granted, free of charge, to any person obtaining a
copy
 of this software and associated documentation files (the "Software"), to
deal
 in the Software without restriction, including without limitation the
rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included
in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN
 THE SOFTWARE.
so basically: do whatever you want with it, just keep the notice, and if it breaks, that's on you bestie 😭

πŸ¦‹ SEE ALSO πŸ¦‹


and that's the page!! this one's from BLADERF, version 3.7.1, and yeah she's literally called bladeRF-install-firmware(1) down at the bottom of the original too. go load that firmware, you've got this πŸ’–βœ¨πŸŽ€πŸŒΈπŸ§šβ€β™€οΈ