Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mikee47 committed Jun 5, 2024
1 parent d4c0231 commit d6f2549
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Sming/Arch/Rp2040/Components/uf2/component.mk
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ DEBUG_VARS += UF2CONV_PY
UF2CONV_PY := $(COMPONENT_PATH)/uf2conv.py


# Invoke uf2conf utility
# Invoke uf2conv utility
# $1 -> Parameters
ifdef WSL_ROOT
Uf2Conv = powershell.exe -Command "$(PYTHON) $(UF2CONV_PY) $(if $V,--verbose) $1"
Expand Down
1 change: 1 addition & 0 deletions Sming/Components/terminal/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Options
.. envvar:: TERMINAL

Command line to use when running ``make terminal``.
This is normally empty (undefined) which causes the default python terminal application to run.
Redefine if you want to use a different terminal application.

.. envvar:: KILL_TERM
Expand Down
13 changes: 12 additions & 1 deletion docs/source/getting-started/windows/wsl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,25 @@ This will ensure that the build system can run python scripts either in WSL2 or
Flashing devices
----------------

WSL2 does not currently support access to USB serial devices, so the Sming build system runs
WSL2 does not natively support access to USB serial devices, so the Sming build system runs
the appropriate application directly under Windows using ``powershell.exe``.

Therefore, use the normal Windows COM port name rather than the linux ones (such as /dev/ttyUSB0)::

make flash COM_PORT=COM4


Some USB serial adapters are supported by the `usbipd <https://github.com/dorssel/usbipd-win>`__ project.
If so, then devices such as ``/dev/ttyUSB0``, etc. will be present as usual.
If Sming sees that ``COM_PORT`` actually exists when running in WSL2 then the above powershell workaround
will not be used.

.. note::

The :envvar:`TERMINAL` environment variable is cached by Sming so if the terminal isn't running as expected
try ``make config-clean`` to clear the cached value.


Serial debugging
----------------

Expand Down

0 comments on commit d6f2549

Please sign in to comment.