Page MenuHomeFreeBSD

Added a new tutorial for connecting to a serial port through a usb-to-uart converter, as is the cases with most SoC's
Needs ReviewPublic

Authored by arshankhanifar_gmail.com on Jan 18 2018, 3:59 PM.
Tags
None
Referenced Files
Unknown Object (File)
Mar 14 2024, 10:33 PM
Unknown Object (File)
Dec 22 2023, 11:35 PM
Unknown Object (File)
Dec 20 2023, 10:24 PM
Unknown Object (File)
Dec 18 2023, 8:53 AM
Unknown Object (File)
Dec 12 2023, 4:44 AM
Unknown Object (File)
Dec 2 2023, 12:16 PM
Unknown Object (File)
Nov 14 2023, 6:30 PM
Unknown Object (File)
Nov 12 2023, 8:44 AM
Subscribers

Details

Reviewers
emaste

Diff Detail

Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

arshankhanifar_gmail.com added a subscriber: bcr.

Applied the changes suggested by @bcr.
Also, expanded the explanation with a brief tutorial on how to communicate with the device through the cu command.

A few more suggestions.

book.withusb.xml
6359

You should mark this up with replaceable tags around the X, so that it is clear that this is the part the user has to change:
<filename>ttyU<replaceable>X</replaceable></filename>

6360

the number of the device.

6362

It's simpler to write:
Use <command>cu</command> to establish a connection through USB to UART.

6367

I would also markup speed in <replaceable> tags here. Examples should be something a user could enter at the prompt and it would work, even though the speed is not the correct one. Having replaceable tags, you can reference it in the sentence following the example to change the speed to the one fitting the device.
For example, you can write: The following example connects to a Beaglebone Black using a baud-rate of 115,200: (example follows with that number in the example, surrounded by <replaceable> tags) Next paragraph: For other devices, replace the baud-rate with the one typically found on the device vendor documentation or website.

arshankhanifar_gmail.com marked 4 inline comments as done.

applied the changes as suggested by @bcr

book.withusb.xml
6367

done

One small nit.

book.withusb.new.xml
6363 ↗(On Diff #38322)

Needs a space between "Use" and <command>.

arshankhanifar_gmail.com added inline comments.
book.withusb.new.xml
6363 ↗(On Diff #38322)

fixed

arshankhanifar_gmail.com marked an inline comment as done.

tiny space between cu and command