Interface LoaderOptions

Options to configure ESPLoader. LoaderOptions

interface LoaderOptions {
    baudrate: number;
    debugLogging?: boolean;
    enableTracing?: boolean;
    port?: SerialPort;
    resetConstructors?: ResetConstructors;
    romBaudrate?: number;
    serialOptions?: SerialOptions;
    terminal?: IEspLoaderTerminal;
    transport: Transport;
}

Properties

baudrate debugLogging? enableTracing? port? resetConstructors? romBaudrate? serialOptions? terminal? transport

Properties

baudrate

baudrate: number

The baud rate to be used for communication with the device.

Optional debugLogging

debugLogging?: boolean

Flag indicating whether to enable debug logging for the loader (optional).

Optional enableTracing

enableTracing?: boolean

Indicate if trace messages should be enabled or not.

Optional port

port?: SerialPort

The port to initialize the transport class.

Optional resetConstructors

resetConstructors?: ResetConstructors

Reset functions for connection. If undefined will use default ones.

Optional romBaudrate

romBaudrate?: number

Baud rate used to talk to the ROM bootloader before the stub is running. Set equal to baudrate to skip the port reopen entirely, which avoids rebooting boards whose EN/IO0 lines are disturbed by reopening the port.

Optional serialOptions

serialOptions?: SerialOptions

Set of options for SerialPort class.

Optional terminal

terminal?: IEspLoaderTerminal

An optional terminal interface to interact with the loader during the process.

transport

transport: Transport

The transport mechanism to communicate with the device.

Settings

Member Visibility

Theme

On This Page

baudratedebugLoggingenableTracingportresetConstructorsromBaudrateserialOptionsterminaltransport