tasks Namespace Reference

Functions
	_find_esp_port ()
	build (c, board="lolinS2mini")
	flash (c, port=None)
	monitor (c, port=None)
	release (c)
	clean (c)
	config (c)
	saveconfig (c)
	update (c)
	reset (c)
	format (c)
	docs (c, o=False)
	docs_coverage (c)

Variables
dict	TARGET_BOARDS
	Dictionary mapping supported target boards to their respective sdkconfig.defaults files.

Function Documentation

_find_esp_port()

tasks._find_esp_port ( )

protected

Finds the first matching USB port based on known ESP VIDs/PIDs.

Definition at line 17 of file tasks.py.

Referenced by flash(), and monitor().

Here is the caller graph for this function:

build()

tasks.build	(		c,
			board = "lolinS2mini" )

Build the project for a specific board (default: lolinS2mini)

Definition at line 40 of file tasks.py.

clean()

tasks.clean

(

c

)

Clean build artifacts

Definition at line 109 of file tasks.py.

config()

tasks.config

(

c

)

Open menuconfig to edit project settings

Definition at line 115 of file tasks.py.

docs()

tasks.docs	(		c,
			o = False )

Generate Doxygen documentation.

Definition at line 166 of file tasks.py.

docs_coverage()

tasks.docs_coverage

(

c

)

List doxygen coverage of documentation.

Definition at line 179 of file tasks.py.

flash()

tasks.flash	(		c,
			port = None )

Flash the project to device

Definition at line 54 of file tasks.py.

References _find_esp_port().

Here is the call graph for this function:

format()

tasks.format

(

c

)

Format all source files using pre-commit hooks

Definition at line 160 of file tasks.py.

monitor()

tasks.monitor	(		c,
			port = None )

Monitor serial output from device

Definition at line 62 of file tasks.py.

References _find_esp_port().

Here is the call graph for this function:

release()

tasks.release

(

c

)

Build single binaries for release across all targets

Definition at line 70 of file tasks.py.

reset()

tasks.reset

(

c

)

Reset project to clean state: remove build, config, and managed components

Definition at line 134 of file tasks.py.

saveconfig()

tasks.saveconfig

(

c

)

Save current config as sdkconfig.defaults

Definition at line 121 of file tasks.py.

update()

tasks.update

(

c

)

Update project dependencies

Definition at line 127 of file tasks.py.

Variable Documentation

TARGET_BOARDS

dict tasks.TARGET_BOARDS

Initial value:

=  {
    "lolinS2mini": "sdkconfig.defaults",
    # "lolinS3mini": "sdkconfig.defaults.lolinS3mini", <-- can be added automatically for releases
}

Dictionary mapping supported target boards to their respective sdkconfig.defaults files.

Definition at line 11 of file tasks.py.