Skip to content

About

YAML configurations for known, tested devices that can serve as Serial Proxies for Home Assistant

Resources

Code of conduct

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

ESPHome Serial Proxies

This repo hosts YAML configurations for a curated selection of known, tested devices that can serve as Serial Proxies for Home Assistant.

If a device is not included here it may have a suitable configuration in the ESPHome Device Configuration Repository.

Devices

M5Stack AtomS3U

The AtomS3U uses the data lines of its USB-A plug as a 3.3V TTL UART, not as a USB device. TX is on D+ and RX is on D-. Turn on the Swap TX and RX switch to swap them.

Until it has Wi-Fi credentials, the AtomS3U stays a USB serial device, so you can set up Wi-Fi over USB with Improv serial and read its logs. Once it is provisioned, the USB data lines become the UART and it no longer shows up as a USB device. Update it over the air from then on, or put it into download mode to flash it over USB.

Connecting to the serial port

Home Assistant finds the serial port on its own. It shows the port wherever an integration asks you to pick a serial device.

Other software must address the port with a URL:

esphome://<host>[:<api-port>]/?port_name=<serial-port>
  • <host> is the hostname or IP address of the device.
  • <api-port> is the ESPHome API port. It defaults to 6053.
  • <serial-port> is the serial port name listed above.

Add &noise_psk=<key> if the device uses API encryption. Add &password=<password> if the device uses an API password.

Percent-encode the key and the password. A URL reads + as a space, and a base64 key often contains +, so write each one as %2B.

For example, an Atom Lite RS485 with hostname atom-lite-rs485-a1b2c3:

esphome://atom-lite-rs485-a1b2c3.local/?port_name=RS-485

About

YAML configurations for known, tested devices that can serve as Serial Proxies for Home Assistant

Resources

Code of conduct

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors