Package org.emrick.project

Class BoardDriverInstaller

java.lang.Object

org.emrick.project.BoardDriverInstaller

public final class BoardDriverInstaller
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final record	BoardDriverInstaller.CommandResult
private static final record	BoardDriverInstaller.DeviceProbe
private static final record	BoardDriverInstaller.InstallOutcome
private static enum	BoardDriverInstaller.OperatingSystem
private static final record	BoardDriverInstaller.ProgressUpdate

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	DRIVER_INFO_URL
private static final String	MAC_DRIVER_URL
private static final Duration	POST_INSTALL_VERIFY_TIMEOUT
private static final String	WINDOWS_DRIVER_SHA256
private static final String	WINDOWS_DRIVER_URL

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BoardDriverInstaller()

Method Summary

Modifier and Type	Method	Description
private static boolean	commandShowsDevice(List<String> command)
private static void	download(String url, Path destination)
private static Path	downloadAndExtract(String url, String folderName, Consumer<BoardDriverInstaller.ProgressUpdate> progressConsumer)
private static String	escapeForPowerShell(String value)
private static List<String>	findCp210SerialPorts()
private static Path	findFirstMatching(Path root, Predicate<Path> predicate)
static void	installBoardDriver(JFrame owner, HardwareStatusIndicator hardwareStatusIndicator, Consumer<String> sysMsgWriter)
private static void	installLinuxDriver(Consumer<BoardDriverInstaller.ProgressUpdate> progressConsumer)
private static void	installMacDriver(Consumer<BoardDriverInstaller.ProgressUpdate> progressConsumer)
private static void	installWindowsDriver(Consumer<BoardDriverInstaller.ProgressUpdate> progressConsumer)
private static String	joinOutput(BoardDriverInstaller.CommandResult... results)
private static IOException	manualInstallNeeded(IOException cause)	The automatic download didn't work (no internet, or the server refused it), so send the user to the Silicon Labs driver page, which only allows downloads from a web browser.
private static BoardDriverInstaller.DeviceProbe	probeForDevice(BoardDriverInstaller.OperatingSystem os)
private static String	readOutput(InputStream inputStream)
private static void	refreshHardwareIndicator(HardwareStatusIndicator hardwareStatusIndicator)
private static BoardDriverInstaller.CommandResult	runCommand(List<String> command)
private static String	safe(String value)
private static String	sha256(Path file)
private static void	sleep(long millis)
private static void	unzip(Path zipPath, Path destinationDir)
private static BoardDriverInstaller.DeviceProbe	waitForDevice(BoardDriverInstaller.OperatingSystem os, Duration timeout, Consumer<BoardDriverInstaller.ProgressUpdate> progressConsumer)

Methods inherited from class java.lang.Object

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

Field Details

WINDOWS_DRIVER_URL

private static final String WINDOWS_DRIVER_URL

See Also:

• Constant Field Values

WINDOWS_DRIVER_SHA256

private static final String WINDOWS_DRIVER_SHA256

See Also:

• Constant Field Values

MAC_DRIVER_URL

private static final String MAC_DRIVER_URL

See Also:

• Constant Field Values

DRIVER_INFO_URL

private static final String DRIVER_INFO_URL

See Also:

• Constant Field Values

POST_INSTALL_VERIFY_TIMEOUT

private static final Duration POST_INSTALL_VERIFY_TIMEOUT

Constructor Details

BoardDriverInstaller

private BoardDriverInstaller()

Method Details

installBoardDriver

public static void installBoardDriver(JFrame owner,
 HardwareStatusIndicator hardwareStatusIndicator,
 Consumer<String> sysMsgWriter)

waitForDevice

private static BoardDriverInstaller.DeviceProbe waitForDevice(BoardDriverInstaller.OperatingSystem os,
 Duration timeout,
 Consumer<BoardDriverInstaller.ProgressUpdate> progressConsumer)

installWindowsDriver

private static void installWindowsDriver(Consumer<BoardDriverInstaller.ProgressUpdate> progressConsumer)
                                  throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

installMacDriver

private static void installMacDriver(Consumer<BoardDriverInstaller.ProgressUpdate> progressConsumer)
                              throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

installLinuxDriver

private static void installLinuxDriver(Consumer<BoardDriverInstaller.ProgressUpdate> progressConsumer)
                                throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

probeForDevice

private static BoardDriverInstaller.DeviceProbe probeForDevice(BoardDriverInstaller.OperatingSystem os)

commandShowsDevice

private static boolean commandShowsDevice(List<String> command)

findCp210SerialPorts

private static List<String> findCp210SerialPorts()

downloadAndExtract

private static Path downloadAndExtract(String url,
 String folderName,
 Consumer<BoardDriverInstaller.ProgressUpdate> progressConsumer)
                                throws IOException

Throws:

IOException

download

private static void download(String url,
 Path destination)
                      throws IOException

Throws:

IOException

sha256

private static String sha256(Path file)
                      throws IOException

Throws:

IOException

manualInstallNeeded

private static IOException manualInstallNeeded(IOException cause)

The automatic download didn't work (no internet, or the server refused it), so send the user to the Silicon Labs driver page, which only allows downloads from a web browser.

unzip

private static void unzip(Path zipPath,
 Path destinationDir)
                   throws IOException

Throws:

IOException

findFirstMatching

private static Path findFirstMatching(Path root,
 Predicate<Path> predicate)
                               throws IOException

Throws:

IOException

runCommand

private static BoardDriverInstaller.CommandResult runCommand(List<String> command)
                                                      throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

readOutput

private static String readOutput(InputStream inputStream)
                          throws IOException

Throws:

IOException

refreshHardwareIndicator

private static void refreshHardwareIndicator(HardwareStatusIndicator hardwareStatusIndicator)

sleep

private static void sleep(long millis)

safe

private static String safe(String value)

escapeForPowerShell

private static String escapeForPowerShell(String value)

joinOutput

private static String joinOutput(BoardDriverInstaller.CommandResult... results)