Skip to content

makefiles/tools: enhance miniterm path finding in serial.inc.mk#22208

Merged
AnnsAnns merged 3 commits into
RIOT-OS:masterfrom
crasbe:pr/miniterm
Apr 23, 2026
Merged

makefiles/tools: enhance miniterm path finding in serial.inc.mk#22208
AnnsAnns merged 3 commits into
RIOT-OS:masterfrom
crasbe:pr/miniterm

Conversation

@crasbe

@crasbe crasbe commented Apr 22, 2026

Copy link
Copy Markdown
Contributor

Contribution description

Apparently miniterm likes to change the executable name. In very old versions it was miniterm.py, then it was miniterm and now (version 3.5 and higher) it is pyserial-miniterm.

This change enhances the path discovery to select the right one.

Testing procedure

Make sure you have (a recent version of) pyserial installed:

cbuec@W11nMate:~/RIOTstuff/riot-vanilla/RIOT$ pip show pyserial
Name: pyserial
Version: 3.5
Summary: Python Serial Port Extension
Home-page: https://github.com/pyserial/pyserial
Author: Chris Liechti
Author-email: cliechti@gmx.net
License: BSD
Location: /usr/lib/python3/dist-packages
Requires: 
Required-by: adafruit-nrfutil

Run your favorite application with RIOT_TERMINAL=miniterm.

Behavior on master:

cbuec@W11nMate:~/RIOTstuff/riot-vanilla/RIOT$ RIOT_TERMINAL=miniterm BOARD=nrf52840dk make -C tests/sys/shell flash term -j
make: Entering directory '/home/cbuec/RIOTstuff/riot-vanilla/RIOT/tests/sys/shell'
Building application "tests_shell" for "nrf52840dk" with CPU "nrf52".

"make" -C /home/cbuec/RIOTstuff/riot-vanilla/RIOT/pkg/cmsis/ 
...
J-Link>exit

Script processing completed.

Terminal program miniterm is required but not found in PATH.  Aborting.
make: *** [/home/cbuec/RIOTstuff/riot-vanilla/RIOT/tests/sys/shell/../../../Makefile.include:869: term] Error 1
make: Leaving directory '/home/cbuec/RIOTstuff/riot-vanilla/RIOT/tests/sys/shell'

Behavior with this PR:

cbuec@W11nMate:~/RIOTstuff/riot-vanilla/RIOT$ RIOT_TERMINAL=miniterm BOARD=nrf52840dk make -C tests/sys/shell flash term -j
make: Entering directory '/home/cbuec/RIOTstuff/riot-vanilla/RIOT/tests/sys/shell'
Building application "tests_shell" for "nrf52840dk" with CPU "nrf52".

"make" -C /home/cbuec/RIOTstuff/riot-vanilla/RIOT/pkg/cmsis/ 
...
J-Link>exit

Script processing completed.

pyserial-miniterm --eol LF "/dev/ttyACM0" "115200"  
--- Miniterm on /dev/ttyACM0  115200,8,N,1 ---
--- Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H ---
main(): This is RIOT! (Version: 2026.04-devel-410-gecc128-pr/miniterm)
test_shell.
>

Issues/PRs references

Found while testing #22207.

Declaration of AI-Tools / LLMs usage:

AI-Tools / LLMs that were used are:

  • none

@crasbe
crasbe requested a review from AnnsAnns April 22, 2026 11:29
@crasbe crasbe added Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors) CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Apr 22, 2026
@github-actions github-actions Bot added Area: build system Area: Build system Area: tools Area: Supplementary tools labels Apr 22, 2026
Comment thread makefiles/tools/serial.inc.mk Outdated
@crasbe
crasbe requested review from aabadie and jia200x as code owners April 22, 2026 12:48
@github-actions github-actions Bot added the Area: doc Area: Documentation label Apr 22, 2026
@crasbe

crasbe commented Apr 22, 2026

Copy link
Copy Markdown
Contributor Author

I also added some information about the correct miniterm in the Guides now :)

@github-actions github-actions Bot added Area: tests Area: tests and testing framework Platform: ESP Platform: This PR/issue effects ESP-based platforms Area: cpu Area: CPU/MCU ports Area: examples Area: Example Applications labels Apr 22, 2026
@crasbe

crasbe commented Apr 22, 2026

Copy link
Copy Markdown
Contributor Author

Also unified the references to miniterm in other documents, some were outdated (like using miniterm.py).

@AnnsAnns AnnsAnns left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to squash after this change 👍

Comment thread doc/guides/misc/terminal_config.md Outdated
@riot-ci

riot-ci commented Apr 22, 2026

Copy link
Copy Markdown

Murdock results

✔️ PASSED

7f14beb treewide: update documentation regarding miniterm

Success Failures Total Runtime
1 0 1 02m:52s

Artifacts

Comment thread doc/guides/misc/terminal_config.md Outdated
@AnnsAnns
AnnsAnns enabled auto-merge April 23, 2026 09:56
@AnnsAnns
AnnsAnns added this pull request to the merge queue Apr 23, 2026
@AnnsAnns

AnnsAnns commented Apr 23, 2026

Copy link
Copy Markdown
Member

ty for looking into this 😄

Merged via the queue into RIOT-OS:master with commit cff0948 Apr 23, 2026
28 checks passed
@crasbe crasbe added the Process: needs backport Integration Process: The PR is required to be backported to a release or feature branch label Apr 28, 2026
@crasbe
crasbe deleted the pr/miniterm branch April 28, 2026 10:48
@MrKevinWeiss MrKevinWeiss added this to the Release 2026.07 milestone Jul 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: build system Area: Build system Area: cpu Area: CPU/MCU ports Area: doc Area: Documentation Area: examples Area: Example Applications Area: tests Area: tests and testing framework Area: tools Area: Supplementary tools CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Platform: ESP Platform: This PR/issue effects ESP-based platforms Process: needs backport Integration Process: The PR is required to be backported to a release or feature branch Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants