Connecting to Yellow via serial console can be helpful for troubleshooting, for example to export a log.
-
Make sure GNU Screen is installed on your system.
- On Linux, use your distribution's package manager (e.g.
sudo apt install screen
). - On macOS, use Homebrew:
brew install screen
.
- On Linux, use your distribution's package manager (e.g.
- On your desktop/laptop, open a terminal.
-
List the USB port numbers:
- On Linux, use
ls /dev/ttyUSB*
- On macOS, use
If the Silicon Labs CP2102N driver is installed, you will see bothls /dev/cu.*
/dev/cu.SLAB_USBtoUART
and/dev/cu.usbserial-110
(/dev/cu.usbserial-210
, depending on which port the Yellow is plugged in to).
- On Linux, use
-
Connect the Yellow with USB C to your computer.
Note: Since Yellow is not powered on yet, it is normal for no lights to be on.
-
List the USB port numbers again (see step List the USB port numbers). The new entry is for Yellow.
Troubleshooting: In case no new entry appears, make sure JP1 is at the right position (UART) and your USB-C cable supports at least USB 2.0 signals (try using a different USB-C cable if in doubt).
-
Start GNU Screen and point it to this USB port. E.g.:
screen /dev/ttyUSB0 115200
Troubleshooting: If your account does not have permission to access serial ports, you may have to run the command with
sudo
. If Screen immediately prints[screen is terminating]
, this is likely the problem.Note: Screen typically doesn't display anything on startup. You see only the cursor in the top left corner of the window.
- Troubleshooting: If the device doesn't appear, check if the jumper JP1 is in the right position. It should be set to UART:
- Power off and unplug Yellow. Open the case.
- Make sure JP1 is set to UART.
- Close the case.
- Connect Yellow to your router again via Ethernet and make sure there is an internet connection.
- Power the Yellow back on with either the DC adapter or Power over Ethernet (if supported).
-
After the Yellow finishes booting, hit the Enter key until prompted for credentials.
- Homeassistant login:
root
- No password is required. Hit the Enter key.
- Homeassistant login:
-
The console offers the Home Assistant CLI under the command
ha
. The command allows to get information about the state of the system. Typically useful commands are:- To print the supervisor logs, type
ha supervisor logs
- To print out the network info, type
ha network info
- To print the supervisor logs, type
- To save the boot log into a file, perform the following steps:
- Power off Yellow.
- Perform steps 1–11.
- Power up Yellow.
- To save the bootlogs, press Ctrl+A and then type
:hardcopy -h /tmp/boot.log
- To exit GNU Screen, press Ctrl+A and then D.
Resources: