Skip to main content

bb-eco

BB Eco: discover, monitor, and configure Brainboxes devices

Usage​

bb-eco [command] [options]

Options​

OptionDescription
--csvOutput in CSV format
--jsonOutput in JSON format
--timeout <timeout>Override default timeout in milliseconds
--verboseEnable verbose/debug output
--versionShow version information
-?, -h, --helpShow help and usage information

Subcommands​

CommandDescription
config <device> <key> <value>Read or write device configuration
diagnosticsCollect system and network diagnostic information
discoverDiscover Brainboxes devices on the network
featuresShow the app-capability compatibility matrix per device class
firewallInspect or configure host firewall rules for bb-eco
firmwareInspect firmware state on Brainboxes devices
listList saved Brainboxes devices
locate <device>Flash the device's status LED to physically locate it
productsBrowse the Brainboxes product catalogue
reboot <device>Reboot a Brainboxes device
resetDelete all app data: saved devices, template/drift history, and logs. Keeps the firmware cache.
routeReach a device on an address outside your network (e.g. 192.168.127.254)
scan <cidr>Scan a subnet for network devices (TCP port probe + HTTP enrichment)
soakRoulette-flash random compatible firmware onto every device in an inventory file, repeatedly. DESTRUCTIVE bench tool; requires BB_ECO_SOAK_ITERATIONS.
telemetry <action>Opt in to or out of anonymous firmware-update diagnostics shared with Brainboxes, or inspect what is sent.
templateManage device configuration templates
upgrade <device> <firmware-file>Upgrade firmware on a Brainboxes device

Examples​

A typical first session finds every Brainboxes device on the network, saves the results, then checks one device's firmware:

bb-eco discover
bb-eco list
bb-eco firmware status 192.168.1.101
Model: ED-549
Current Version: 8.25
Update Available: No

Every command accepts --json or --csv for machine-readable output, --verbose for diagnostic detail, and --timeout <ms> to bound network waits. See the option tables on each command page.

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.