flashthing-wasm
v0.4.2
Published
webusb bindings for flashthing
Maintainers
Readme
FlashThing
FlashThing is a tool for quickly and easily flashing the Spotify Car Thing (Superbird). FlashThing is composed of four parts:
- FlashThing: Rust crate for flashing superbird.
- FlashThing CLI: Command line interface for FlashThing.
- FlashThing Node: N-API bindings for FlashThing.
- FlashThing Wasm: WebUSB bindings for FlashThing, for flashing from a browser.
FlashThing currently supports flashing the Stock partition tables as well as custom partition tables using a subset of the Terbium meta.json standard. Read more about that standard in the docs.
Installation
Rust Crate
cargo add flashthingCLI
cargo install flashthing-cliNode Module Installation
npm install flashthing
yarn add flashthing
pnpm add flashthing
bun add flashthingPlatform Specific Notes
Linux
FlashThing requires libusb to be installed, and a udev rule must be set up to access the Car Thing. To install the udev rule, run the following command:
sudo flashthing-cli --udevmacOS
FlashThing requires libusb to be installed. You can install it using Homebrew:
brew install libusbWindows
FlashThing may require special drivers (I don't have a Windows machine to test on). If you have issues, try running the Terbium driver script.
irm https://driver.terbium.app/get | iexUsage
Rust Crate Usage
See docs.rs and the cli for more information.
Note: The documentation is very basic, sorry!
CLI Usage
❯ flashthing-cli --help
cli for flashing the Spotify Car Thing
Usage: flashthing-cli [OPTIONS] [PATH]
Arguments:
[PATH] Path to a zip file or a directory. Defaults to the current working directory if omitted
Options:
-s, --stock Whether the directory or archive contains a stock dump with no `meta.json` file
--unbrick Whether to unbrick the device
--setup setup host - this currently only sets up udev rules on Linux
-h, --help Print help
-V, --version Print versionNode Module Usage
import { FlashThing, type FlashEvent } from 'flashthing';
const callback = (event: FlashEvent) => {
console.log('Flash event:', event);
};
const flasher = new FlashThing(callback);
await flasher.openArchive('path/to/archive.zip');
console.log(`Total flashing steps: ${flasher.getNumSteps()}`);
await flasher.flash();Browser Usage
cd wasm && wasm-pack build --target webThe browser owns device permission and archive handling, so the page supplies them as callbacks. requestDevice
resolves with a connected Car Thing and is called again after a BL2 boot resets the SoC; readAll and open
resolve payload paths out of the flash archive, with open returning { size, read(n) } for streaming.
import init, { FlashThing } from './pkg/flashthing_wasm.js';
await init();
const flasher = new FlashThing(requestDevice, readAll, open, (event) => console.log(event));
await flasher.connect(bl2, bootloader);
flasher.openJson(metaJson);
console.log(`Total flashing steps: ${flasher.getNumSteps()}`);
await flasher.flash();Project Structure
.
├── bindings # N-API bindings
├── cli # command line interface
├── lib # main library - has all the logic
└── wasm # WebUSB bindings