bb-eco upgrade
Upgrade firmware on a Brainboxes device
Usage
bb-eco upgrade [<device> [<firmware-file>]] [options]
Arguments
| Name | Description |
|---|---|
<device> | IP address, MAC address, or device name |
<firmware-file> | Path to the .efw firmware file |
Options
| Option | Description |
|---|---|
--check | Check for updates without applying |
--csv | Output in CSV format |
--download | Download firmware to local cache (no sudo required) |
--download-all | Download ALL firmware from manifest for air-gapped prep |
--force | Skip confirmation prompt |
--json | Output in JSON format |
--latest | Upgrade to the latest cached firmware (requires sudo) |
--preserve-config | Preserve device config during upgrade [default: True] |
--probe | With --recover: answer BOOTP and report what the stuck device asks for, WITHOUT sending firmware |
--recover | Enter recovery mode for stuck devices; pass the .efw path to skip the prompt |
--timeout | Override default timeout in milliseconds |
--vendor-identity | With --recover: identity string (e.g. F0001V08.33ED588T) offered to an ED device whose BOOTP request has a blank vendor area (identity block erased). Overrides the .efw-derived fallback; never overrides an identity the device reports itself |
--verbose | Enable verbose/debug output |
-?, -h, --help | Show help and usage information |
Examples
Check whether a newer firmware exists for a device (no changes are made):
bb-eco upgrade 192.168.0.63 --check
Device is up to date (v8.25).
Upgrade a device to the latest published firmware for its model. The transfer uses BOOTP/TFTP on UDP ports 67/69, which needs elevated privileges:
sudo bb-eco upgrade 192.168.0.63 --latest
Upgrade from a specific firmware file instead of the online manifest:
sudo bb-eco upgrade 192.168.0.63 ED-549_V8.25.efw
Pre-download firmware for every known model into the local cache — useful before visiting an air-gapped site:
bb-eco upgrade --download-all
Recovering a stuck device
If an upgrade was interrupted, the device sits in its bootloader broadcasting BOOTP requests. Ask a stuck device what it wants without sending anything:
sudo bb-eco upgrade --probe
Then re-flash it (the firmware file must match the model and MCU class):
sudo bb-eco upgrade --recover ED-549_V8.25.efw
See the device recovery guide for the full walkthrough, including the --vendor-identity option for ED devices whose identity block was erased.
Never interrupt a running upgrade — power loss or a killed transfer leaves the device in its bootloader until it is recovered.
This page is auto-generated from the live CLI help text. Do not edit by hand — re-run node scripts/gen-cli-reference.mjs after changes. Example sections are maintained in docs/cli-examples/ in the bb-eco repo.