Description

When I try connecting to RIOT shell flashed at RPi-pico board, I cannot find any details concerning connection in board documentation. This could be a problem, especially for users not familiar with microcontrollers. After some investigation of documentation for dozen boards, I find that this information is inconsistent and, in many boards, missing. For example, sections that contain this kind of information are titled: Accessing STDIO via UART, Using UART, STDIO configuration or simply STDIO - to mention a few. Sometimes this title does not correspond to reality, for example, title Accessing STDIO via UART and the first sentence: "STDIO of RIOT is directly available over the USB port" ... where board uses CDC-ACM USB module. Only in the documentation of one board I find a connection baud rate, however few are used.

In this issue I would like to introduce and discuss some common style of such information. Of course, all information could be found in the Internet or simply checked/guessed, but such information, especially for people starting with RIOT would be beneficial.

Section title: Accessing RIOT shell

Necessarily information:

• default access method: UART, board UART-USB converter or RIOT USB CDC-ACM module,
• connection baud rate,
• if UART is used
• • TX/RX pins,
• • clear information if 5V TTL is acceptable or some logic level converter is needed.

This section should be placed just after the section describing the flashing procedure.

Useful links

Sample connection description using this style: PR #17454

I'm looking forward comments and suggestions.