boards/arduino-mega2560: add TTY_BOARD_FILTER #19012

maribu · 2022-12-05T10:16:42Z

Contribution description

This allows automatically selecting TTY actually belonging to an
Arduino Mega2560 if MOST_RECENT_PORT=1 is set.

Testing procedure

make BOARD=arduino-mega2560 MOST_RECENT_PORT=1 -C examples/default flash term

Should automatically select the TTY of the most recently connected Arduino Mega2560, even if a board of a different type is connect more recently.

Issues/PRs references

depends on (and includes) dist/tools/usb-serial: fix exception on missing entries #19011

maribu · 2022-12-05T10:17:25Z

(This should be super quick in Murdock, as can_fast_ci_run.py should detect that only one board was changed. Hence, no harm in already having this in the CI.)

riot-ci · 2022-12-05T13:29:58Z

Murdock results

✔️ PASSED

dadf22f boards/arduino-mega2560: add TTY_BOARD_FILTER

Success	Failures	Total	Runtime
2006	0	2006	04m:41s

Artifacts

Documentation preview

gschorcht · 2022-12-07T16:04:44Z

The test fails for me. First I thought that I had to install pyudev. But also with pyudev, I get the following error:

avrdude -c stk500v2 -p m2560 -P  -D -U flash:w:examples/default/bin/arduino-mega2560/default.h

avrdude: ser_open(): can't open device "-D": No such file or directory

It seems that the port isn't defined.

gschorcht · 2022-12-07T16:05:42Z

Ah ok, maybe I have to try it on top of PR #19011

gschorcht · 2022-12-07T16:09:00Z

Ah ok, maybe I have to try it on top of PR #19011

No, same error.

maribu · 2022-12-07T16:41:57Z

Hmm, what is the output of make list-ttys?

gschorcht · 2022-12-07T17:47:58Z

Hmm, what is the output of make list-ttys?

path         | driver | vendor       | model                                | model_db                                             | serial | ctime    | iface_num
-------------|--------|--------------|--------------------------------------|------------------------------------------------------|--------|----------|----------
/dev/ttyUSB1 | ch341  | 1a86         | USB2.0-Serial                        | HL-340 USB-Serial adapter                            | None   | 16:58:16 | 0        
/dev/ttyUSB0 | cp210x | Silicon Labs | CP2102 USB to UART Bridge Controller | CP2102/CP2109 UART Bridge Controller [CP210x family] | 0001   | 16:57:27 | 0

Obviously my Arduino MEGA 2560 board is a Chineese clone that doesn't use an ATMEGA16U2 for the USB interface but an CH341 USB-Serial adapter 😟 No wonder that the board isn't detected. I had anywhere an original Arduino MEGA ADK, but I don't know where.

If no TTY serial (matching the given filters, if any) was found, use the exit code `1`. The idea is that simple shell scripts falling back to alternative variants of a board can be used via ```.sh ttys.py --most-recent --model Fooboard --vendor Footronic || \ ttys.py --most-recent --model Barboard --vendor Bartronic ``` Just adding a regex that would accept both vendors and models would have different semantics: If both a Fooboard and a Barboard are attached, it would pick the most recently connected of both. The shell expression above would always prefer a Fooboard over a Borboard. The use case cheap Arduino clones that replace the ATmega16U2 used as USB UART bridge with cheap single purpose chips. The original ATmega16U2 has the advantage that it provides identification data unique the specific Arduino board, while the clones cannot be told apart from standalone USB UART bridges or Arduino clones of other models. Hence, we want to pick the genuine Arduino board if connected, and only fall back to matching cheap USB UART bridges if no genuine Arduino board is connected.

maribu · 2022-12-09T12:07:37Z

I updated the PR a bit to also allow adding custom commands to detect the TTYs instead of just a TTY_BOARD_FILTER and extended the ttys.py to return an error code if no TTY was found. This allows chaining the ttys.py command in shell e.g. like

ttys.py --filter-genuine || ttys.py --filter-clones

And for the Arduino Mega 2560 I now overwrite the shell command to fall back to detecting cheap USB UART bridges when no genuine Arduino Mega 2560 board was found. I think this is the best compromise, as it still reliably detects a genuine Arduino Mega 2560 (which we can tell apart by the UDEV data from other USB UART bridges), but won't break usage for clone boards.

doc/doxygen/src/flashing.md

gschorcht · 2022-12-11T15:34:58Z

And for the Arduino Mega 2560 I now overwrite the shell command to fall back to detecting cheap USB UART bridges when no genuine Arduino Mega 2560 board was found. I think this is the best compromise, as it still reliably detects a genuine Arduino Mega 2560 (which we can tell apart by the UDEV data from other USB UART bridges), but won't break usage for clone boards.

But of course this only works if the Arduino Mega 2560 Clone was connected last.

doc/doxygen/src/flashing.md

gschorcht · 2022-12-11T17:41:23Z

bors merge

19012: boards/arduino-mega2560: add TTY_BOARD_FILTER r=gschorcht a=maribu ### Contribution description This allows automatically selecting TTY actually belonging to an Arduino Mega2560 if `MOST_RECENT_PORT=1` is set. ### Testing procedure ``` make BOARD=arduino-mega2560 MOST_RECENT_PORT=1 -C examples/default flash term ``` Should automatically select the TTY of the most recently connected Arduino Mega2560, even if a board of a different type is connect more recently. ### Issues/PRs references - [x] depends on (and includes) #19011 Co-authored-by: Marian Buschsieweke <marian.buschsieweke@ovgu.de> Co-authored-by: Marian Buschsieweke <maribu@users.noreply.github.com>

Allow overriding the shell command used to auto-detect the TTY of a board with `MOST_RECENT_PORT=1` via the `TTY_SELECT_CMD` variable. The use case is to also detect Arduino Mega 2560 clones with cheap USB UART bridges (for which the filter command may yield false positives) while preferring genuine Arduino Mega 2560 boards (if found) over the clones (as the filter for genuine boards does not yield false positives).

This allows automatically selecting TTY actually belonging to an Arduino Mega2560 if `MOST_RECENT_PORT=1` is set. Note: Unless `ARDUINO_MEGA2560_COMPAT_WITH_CLONES` is set to `0`, this will fall back to detecting any cheap USB UART bridge typically found in Arduino Mega 2560 clones if no genuine Arduino Mega is found.

bors · 2022-12-11T17:58:40Z

Canceled.

maribu · 2022-12-11T18:01:09Z

Squashed.

bors retry

bors · 2022-12-11T18:01:13Z

🕐 Waiting for PR status (GitHub check) to be set, probably by CI. Bors will automatically try to run when all required PR statuses are set.

maribu · 2022-12-11T18:20:23Z

bors retry

bors · 2022-12-11T20:03:14Z

Build succeeded:

maribu · 2022-12-11T20:54:49Z

Thx :)

gschorcht · 2022-12-12T06:24:53Z

Oops, I accidentally restarted a full build in the wrong browser window for this PR.

github-actions bot added Area: boards Area: Board ports Area: tools Area: Supplementary tools labels Dec 5, 2022

maribu force-pushed the boards/arduino-mega2560 branch from 9168057 to f74c332 Compare December 5, 2022 10:19

benpicco added State: waiting for other PR State: The PR requires another PR to be merged first and removed State: waiting for other PR State: The PR requires another PR to be merged first labels Dec 5, 2022

benpicco removed the State: waiting for other PR State: The PR requires another PR to be merged first label Dec 7, 2022

maribu force-pushed the boards/arduino-mega2560 branch from f74c332 to b341952 Compare December 8, 2022 15:27

github-actions bot removed the Area: tools Area: Supplementary tools label Dec 8, 2022

maribu force-pushed the boards/arduino-mega2560 branch from b341952 to d42faef Compare December 9, 2022 12:03

maribu requested review from aabadie and jia200x as code owners December 9, 2022 12:03

github-actions bot added Area: build system Area: Build system Area: doc Area: Documentation Area: tools Area: Supplementary tools labels Dec 9, 2022

maribu requested a review from chrysn December 9, 2022 12:04

gschorcht requested changes Dec 11, 2022

View reviewed changes

doc/doxygen/src/flashing.md Outdated Show resolved Hide resolved

gschorcht requested changes Dec 11, 2022

View reviewed changes

doc/doxygen/src/flashing.md Outdated Show resolved Hide resolved

gschorcht approved these changes Dec 11, 2022

View reviewed changes

maribu added 2 commits December 11, 2022 18:58

maribu force-pushed the boards/arduino-mega2560 branch from e6b440d to dadf22f Compare December 11, 2022 17:58

bors bot merged commit 268e931 into RIOT-OS:master Dec 11, 2022

maribu deleted the boards/arduino-mega2560 branch December 11, 2022 20:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

boards/arduino-mega2560: add TTY_BOARD_FILTER #19012

boards/arduino-mega2560: add TTY_BOARD_FILTER #19012

maribu commented Dec 5, 2022 •

edited by benpicco

Loading

maribu commented Dec 5, 2022

riot-ci commented Dec 5, 2022 •

edited

Loading

gschorcht commented Dec 7, 2022

gschorcht commented Dec 7, 2022

gschorcht commented Dec 7, 2022

maribu commented Dec 7, 2022

gschorcht commented Dec 7, 2022 •

edited

Loading

maribu commented Dec 9, 2022

gschorcht commented Dec 11, 2022

gschorcht commented Dec 11, 2022

bors bot commented Dec 11, 2022

maribu commented Dec 11, 2022

bors bot commented Dec 11, 2022

maribu commented Dec 11, 2022

bors bot commented Dec 11, 2022

maribu commented Dec 11, 2022

gschorcht commented Dec 12, 2022

boards/arduino-mega2560: add TTY_BOARD_FILTER #19012

boards/arduino-mega2560: add TTY_BOARD_FILTER #19012

Conversation

maribu commented Dec 5, 2022 • edited by benpicco Loading

Contribution description

Testing procedure

Issues/PRs references

maribu commented Dec 5, 2022

riot-ci commented Dec 5, 2022 • edited Loading

Murdock results

Artifacts

gschorcht commented Dec 7, 2022

gschorcht commented Dec 7, 2022

gschorcht commented Dec 7, 2022

maribu commented Dec 7, 2022

gschorcht commented Dec 7, 2022 • edited Loading

maribu commented Dec 9, 2022

gschorcht commented Dec 11, 2022

gschorcht commented Dec 11, 2022

bors bot commented Dec 11, 2022

maribu commented Dec 11, 2022

bors bot commented Dec 11, 2022

maribu commented Dec 11, 2022

bors bot commented Dec 11, 2022

maribu commented Dec 11, 2022

gschorcht commented Dec 12, 2022

maribu commented Dec 5, 2022 •

edited by benpicco

Loading

riot-ci commented Dec 5, 2022 •

edited

Loading

gschorcht commented Dec 7, 2022 •

edited

Loading