Skip to content

Conversation

@BartMassey
Copy link
Member

The description of serial ports and serial communication was pretty confusing: now it's much cleaner. The new chapter name Serial Port should help, as it unambiguously describes the thing we will actually be working with.

closes #78

@BartMassey BartMassey requested a review from a team as a code owner November 27, 2025 18:57
@BartMassey BartMassey force-pushed the serial-intro branch 3 times, most recently from ef9ff3e to d3b8c4e Compare December 1, 2025 17:56
the text UI will *not* echo back what you type. If you pay attention to the yellow LED
on top of the MB2 though, you will notice that it blinks whenever you type something.

## `minicom` commands
Copy link
Contributor

Choose a reason for hiding this comment

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

I've never quite understood why people use minicom. 🤷🏻‍♂️ screen is much easier and nicer to use and more readily available on a lot of systems, including macOS.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not a huge minicom fan either, but I decided not to fight that battle yet. I haven't tried using screen as a serial terminal: if you wanted to write a tutorial for that (or know of where a good one is) that would be cool.

Copy link
Contributor

Choose a reason for hiding this comment

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

Supporting a small tutorial / section on screen as well. I've only used it once, and it was neat.

<a href="https://en.wikipedia.org/wiki/I2C#/media/File:I2C_controller-target.svg">
<p align="center">
<img class="white_bg" height="360" title="I2C bus" src="../assets/i2c-bus.svg" />
<img height="360" title="I2C Controller and Targets" src="https://en.wikipedia.org/wiki/I2C#/media/File:I2C_controller-target.svg" />
Copy link
Contributor

@iampi31415 iampi31415 Dec 2, 2025

Choose a reason for hiding this comment

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

A few issues here:

  • If you save as PDF, at least in my browser, the image is missing, only the link remains.

  • So I recommend keeping "../assets/i2c-bus.svg", which works fine.

    • This option needs class="white_bg" or it will break again.
  • And here is the alt attribute (taken from Wikipedia's image footer.):

    alt="The schematic shows controller (a microcontroller), three target nodes (an ADC, a DAC, and a  microcontroller), and pull-up resistors Rp."
    
  • Also, <p align="center"> does not exist to my knowledge? (I mean the attribute=value)

Copy link
Member Author

Choose a reason for hiding this comment

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

I want to handle all the Wikipedia/Wikimedia links in the Book the same way; I'll try to figure out what the best plan is.

<p align="center"> is standard pre-CSS HTML that still works. I will probably replace it with CSS styling for images shortly, but would like to get this PR finished before I go hacking at this stuff again.

@BartMassey BartMassey force-pushed the serial-intro branch 2 times, most recently from 6533752 to 9f123a9 Compare December 3, 2025 22:50
The description of serial ports and serial communication was
pretty confusing: now it's much cleaner. The new chapter
name `Serial Port` should help, as it unambiguously
describes the thing we will actually be working with.

The I2C chapter had some slightly weird stuff going on that
was fixed up a bit.

The handling of figures was cleaned up. A Wikimedia Commons
diagram that was incorrectly copied instead of linked was
fixed. Figure background was added and slightly darkened
with additional CSS to work reasonably with dark-mode
reading.

Thanks much to Github @iampi31 for contributions and
feedback that became part of this PR.

closes #78, closes #79, closes #81
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Clarify section on Serial Communication?

3 participants