yahiro07 / uf2gen

A CLI tool to generate UF2 firmware, written in TypeScript.

uf2gen

Generate UF2 firmware file from bin or hex format.

A partial function porting of uf2conv.py.

Only support for converting bin or hex to uf2.

CLI usage

installation

npm install -g uf2gen

command example

uf2gen firmware.bin --family SAMD21 --base 0x2000 -o output.uf2

arguments

CLI arguments are similar to uf2conv.

flag	description	default
-f, --family	MCU family	blank family
-b, --base	base address	0x00
-o, --output	output file path	<inputFilePath>.uf2

Families are specified in id (like 0x68ed2b88) or shortName (like SAMD21).

Available MCU Families are listed here.
uf2families.ts

The default value of the base address is 0x00, note that this is different from that of uf2conv (0x2000).

check version

uf2gen --version

Library usage

import { getUf2FamilyId, convertBinToUf2 } from "uf2gen";

const inputFilePath = "firmware.bin"
const outputFilePath = "firmware.uf2"
const baseAddress = 0x2000
const familyId = getUf2FamilyId("SAMD21");
const buffer = await fs.readFile(inputFilePath);
const binFileBytes = new Uint8Array(buffer);
const uf2FileBytes = convertBinToUf2(binFileBytes, baseAddress, familyId);
await fs.writeFile(outputFilePath, uf2FileBytes);