Package org.emrick.project.dev

Class Esptool

java.lang.Object

org.emrick.project.dev.Esptool

public final class Esptool
extends Object

Locates (or downloads once) Espressif's esptool and uses it to flash receivers. Order of preference: the esptool bundled with an existing PlatformIO install (no download), then a standalone esptool previously downloaded into the Emrick Designer folder, then a one-time download of the standalone build from Espressif's GitHub releases. Downloads are pinned to a version and checked against Espressif's published SHA-256 digests.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	Esptool.Asset	Standalone esptool builds for each platform: asset name and its published SHA-256.

Field Summary

Fields

Modifier and Type	Field	Description
private static List<String>	cachedCommand
private static final Esptool.Asset	LINUX_AMD64
private static final Esptool.Asset	LINUX_ARM64
private static final Esptool.Asset	MAC_AMD64
private static final Esptool.Asset	MAC_ARM64
private static final Pattern	PROGRESS
private static final String	RELEASE_URL
private static final String	VERSION
private static final Esptool.Asset	WINDOWS

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Esptool()

Method Summary

Modifier and Type	Method	Description
private static Esptool.Asset	assetForPlatform()
static List<String>	command(Consumer<String> status)
private static void	download(File dir, Consumer<String> status)
private static File	findExecutable(File dir)
static boolean	flash(String systemPortName, FirmwareRelease release, Consumer<Integer> progress, Consumer<String> log)	Flashes a release to one receiver.
private static List<String>	fromPlatformIO()
static boolean	isWindows()
private static String	portPath(String systemPortName)	esptool wants a device path on macOS/Linux (e.g.
private static void	unzip(File zip, File dir)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VERSION

private static final String VERSION

See Also:

• Constant Field Values

RELEASE_URL

private static final String RELEASE_URL

See Also:

• Constant Field Values

WINDOWS

private static final Esptool.Asset WINDOWS

LINUX_AMD64

private static final Esptool.Asset LINUX_AMD64

LINUX_ARM64

private static final Esptool.Asset LINUX_ARM64

MAC_ARM64

private static final Esptool.Asset MAC_ARM64

MAC_AMD64

private static final Esptool.Asset MAC_AMD64

PROGRESS

private static final Pattern PROGRESS

cachedCommand

private static List<String> cachedCommand

Constructor Details

Esptool

private Esptool()

Method Details

isWindows

public static boolean isWindows()

command

public static List<String> command(Consumer<String> status)
                            throws IOException

Parameters:

status - receives short progress messages (e.g. while downloading)

Returns:

the command prefix that runs esptool (e.g. [path/esptool.exe] or [python, esptool.py])

Throws:

IOException

fromPlatformIO

private static List<String> fromPlatformIO()

Returns:

the esptool that ships with PlatformIO, if PlatformIO is installed

findExecutable

private static File findExecutable(File dir)

assetForPlatform

private static Esptool.Asset assetForPlatform()
                                       throws IOException

Throws:

IOException

download

private static void download(File dir,
 Consumer<String> status)
                      throws IOException

Throws:

IOException

unzip

private static void unzip(File zip,
 File dir)
                   throws IOException

Throws:

IOException

flash

public static boolean flash(String systemPortName,
 FirmwareRelease release,
 Consumer<Integer> progress,
 Consumer<String> log)
                     throws IOException

Flashes a release to one receiver. Only the app, bootloader, and partition table regions are written, so the unit's stored data (board ID, label, show) is kept.

Parameters:

progress - receives 0-100 for the firmware image

log - receives every line esptool prints

Returns:

true if esptool reported success

Throws:

IOException

portPath

private static String portPath(String systemPortName)

esptool wants a device path on macOS/Linux (e.g. /dev/cu.usbserial-0001) and the plain name on Windows.