Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Raspbian Stretch Lite could use a warning about its nonfunctional serial console #819

Closed
marshallpierce opened this issue Feb 8, 2018 · 16 comments

Comments

@marshallpierce
Copy link

https://www.raspberrypi.org/downloads/raspbian/ makes no mention of the fact that the serial console doesn't work out of the box on a RPi 3, and that you need to do the config.txt shenanigans in https://learn.adafruit.com/adafruits-raspberry-pi-lesson-5-using-a-console-cable/enabling-serial-console to get it working.

Better still, the .img could ship in a functioning state by default... As a new user of Raspbian (but not linux), this was pretty surprising: a distro that has a preconfigured user, but literally no way to log in as that user by default. Is this actually a desirable state for some arcane reason I'm not seeing?

@lurch
Copy link
Contributor

lurch commented Feb 9, 2018

IIRC the UART normally used for the serial console, is used by the bluetooth interface on the RPi 3 and Zero W.
https://www.raspberrypi.org/documentation/configuration/raspi-config.md has an easy-to-use option for enabling the serial console (which of course assumes that you're able to login using a locally-attached keyboard and monitor).

ISTR that there was lots of discussion about the UART being disabled-by-default when the RPi 3 first came out.

@marshallpierce
Copy link
Author

OK, I don't need to reopen the UART discussion. My point is that given the loads of tutorials out there indicating that you can turn on a RPi and use its serial port (and the history of this working with previous models), it would be good to provide an easier path to the relevant change.

@lurch
Copy link
Contributor

lurch commented Feb 9, 2018

Adding a single line to the bottom of a text file isn't really that difficult is it? This documentation repo isn't really the place to be discussing this, but what kind of "easier path to the relevant change" did you have in mind? Perhaps http://pibakery.org/ is the kind of easy-to-use setup interface you're looking for?

I assume you must be aware of how small a minority of RPi users will ever want to connect to the serial console?

@marshallpierce
Copy link
Author

marshallpierce commented Feb 9, 2018

I didn't say it was difficult. I'm saying that the need to add it is effectively hidden from anyone who doesn't already know to search for enabling UART on a Raspberry Pi 3.

If breaking a formerly commonplace method of initial setup without so much as a pointer that "hey, if you're used to doing X, you need to make change Y" seems like a good thing to do to you, then I guess I give up; I don't know how to explain any more plainly that that's poor impression to leave a user with.

Edit: to be clear, what I'm suggesting is adding a note to, say, https://www.raspberrypi.org/downloads/raspbian/ or https://www.raspberrypi.org/documentation/installation/installing-images/README.md that there are model-specific steps that need to be taken to get the serial console working, otherwise the myriad tutorials out there about using a serial console with RPi will get you nowhere.

@lurch
Copy link
Contributor

lurch commented Feb 9, 2018

Apologies if I gave the wrong impression, but I'm also only a community member like yourself, and my views may not reflect the views of the Raspberry Pi Foundation, etc. etc. 😃

@Doug-Wyman
Copy link

Doug-Wyman commented Feb 9, 2018 via email

@lurch
Copy link
Contributor

lurch commented Feb 9, 2018

This is an old topic that has been covered several times previously, see e.g. RPi-Distro/repo#22
(I'm not disagreeing that this could be better documented, but for the small minority if users this affects I don't think https://www.raspberrypi.org/downloads/raspbian/ is the right place to mention it IMHO)
*shrug*

@JamesH65
Copy link
Contributor

JamesH65 commented Feb 9, 2018 via email

@marshallpierce
Copy link
Author

I think this particular bit of knowledge fits into a bit of a hole in the current layout of the documentation. Perhaps it will help to see the path I took to get here.

Context: Got Sparkfun's RPi 3 starter kit. This is my 3rd RPi (but my first RPi 3 w/ Raspbian), and I've been using Linux for many years. All I wanted to do was enable ssh so I could then forget about being physically proximal to the hardware. So, some quick searching confirmed (via many many people describing how to do it) that the FTDI UART/USB thing should be all I needed to easily perform that task.

Starting from the [root of Documentation](root of Documentation, https://www.raspberrypi.org/documentation/), I check out Setup. Nothing too surprising there -- I'm using Stretch Lite instead of Noobs because this RPi will be headless, and of course no keyboard or monitor because the internet tells me this serial dongle should work fine.

Next, Installation. Easy enough. I write stretch lite to the card, put it in the appropriate slot, and boot it up. I can see the appropriate LEDs come on, and it gets an IP from my DHCP server (via Ethernet). Of course, serial doesn't work. I go back and look carefully at tutorials that showed serial being easy and painless, and double check that hardware flow control is off, etc. Eventually I give up searching and go ask in IRC, where someone connects the dots and explains the UART boot config situation.

This is why I think that https://www.raspberrypi.org/documentation/installation/ is probably a good place to put such a warning. Verifying that the install boots and functions normally is a pretty typical part of installation, and it's where I would have expected to find any post-SD-card-copying instructions on getting a working system. The next section, Usage, implicitly requires that you be able to log in, so there does seem to be a gap there.

@lurch
Copy link
Contributor

lurch commented Feb 9, 2018

All I wanted to do was enable ssh so I could then forget about being physically proximal to the hardware.

Ah, so I guess you must have missed the Option 3 on https://www.raspberrypi.org/documentation/remote-access/ssh/README.md then? ;-)

Eventually I give up searching and go ask in IRC, where someone connects the dots and explains the UART boot config situation.

There's also https://www.raspberrypi.org/documentation/configuration/uart.md which didn't seem too hard to find?

@marshallpierce
Copy link
Author

Ah, so I guess you must have missed the Option 3 on https://www.raspberrypi.org/documentation/remote-access/ssh/README.md then? ;-)

That's clever that you can do it without ever actually having local access, but given that 99.9999% of all configuration for a system requires local access, I claim that my assumption of "get local access, then proceed to ssh" is reasonable. Be that as it may, it's orthogonal to the issue here...

There's also https://www.raspberrypi.org/documentation/configuration/uart.md which didn't seem too hard to find?

It's easy to find if you already know that the problem is UART related, which I did not, and I think it's reasonable to assume most people will not.

@JamesH65
Copy link
Contributor

Are you saying that because of the use of phrases serial console and UART, people are getting confused?

Technically the Pi has a UART which can be used as a serial console.

I'm still not sure what people want to change here, happy to look at PR's should people have an idea of how this can be improved.

@marshallpierce
Copy link
Author

I'll make a PR with some hopefully clarifying notes when I have a moment.

@JamesH65
Copy link
Contributor

@marshallpierce Did you ever have the chance to knock up something? I do not remember seeing anything coming through as a PR.

@marshallpierce
Copy link
Author

Sorry, I never got around to it. It's still on my todo list, but if you understandably feel like closing this to tidy up the issue tracker, that's fine -- I'll get to it eventually one way or another.

@JamesH65
Copy link
Contributor

JamesH65 commented Oct 1, 2018

Closing this issue as questions answered/issue resolved.

@JamesH65 JamesH65 closed this as completed Oct 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants