1
0
mirror of https://github.com/esphome/esphome.git synced 2025-09-06 21:32:21 +01:00

UART component support added for host platform (#6912)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
Co-authored-by: Pavlo Dudnytskyi <pdudnytskyi@astrata.eu>
This commit is contained in:
Pavlo Dudnytskyi
2024-07-11 03:30:55 +02:00
committed by GitHub
parent 2873c6bbaf
commit aa8c963c50
4 changed files with 410 additions and 2 deletions

View File

@@ -1,5 +1,5 @@
from typing import Optional
import re
import esphome.codegen as cg
import esphome.config_validation as cv
import esphome.final_validate as fv
@@ -11,6 +11,7 @@ from esphome.const import (
CONF_NUMBER,
CONF_RX_PIN,
CONF_TX_PIN,
CONF_PORT,
CONF_UART_ID,
CONF_DATA,
CONF_RX_BUFFER_SIZE,
@@ -27,6 +28,7 @@ from esphome.const import (
CONF_DUMMY_RECEIVER,
CONF_DUMMY_RECEIVER_ID,
CONF_LAMBDA,
PLATFORM_HOST,
)
from esphome.core import CORE
@@ -45,6 +47,7 @@ RP2040UartComponent = uart_ns.class_("RP2040UartComponent", UARTComponent, cg.Co
LibreTinyUARTComponent = uart_ns.class_(
"LibreTinyUARTComponent", UARTComponent, cg.Component
)
HostUartComponent = uart_ns.class_("HostUartComponent", UARTComponent, cg.Component)
NATIVE_UART_CLASSES = (
str(IDFUARTComponent),
@@ -54,6 +57,39 @@ NATIVE_UART_CLASSES = (
str(LibreTinyUARTComponent),
)
HOST_BAUD_RATES = [
50,
75,
110,
134,
150,
200,
300,
600,
1200,
1800,
2400,
4800,
9600,
19200,
38400,
57600,
115200,
230400,
460800,
500000,
576000,
921600,
1000000,
1152000,
1500000,
2000000,
2500000,
3000000,
3500000,
4000000,
]
UARTDevice = uart_ns.class_("UARTDevice")
UARTWriteAction = uart_ns.class_("UARTWriteAction", automation.Action)
UARTDebugger = uart_ns.class_("UARTDebugger", cg.Component, automation.Action)
@@ -95,6 +131,20 @@ def validate_invert_esp32(config):
return config
def validate_host_config(config):
if CORE.is_host:
if CONF_TX_PIN in config or CONF_RX_PIN in config:
raise cv.Invalid(
"TX and RX pins are not supported for UART on host platform."
)
if config[CONF_BAUD_RATE] not in HOST_BAUD_RATES:
raise cv.Invalid(
f"Host platform doesn't support baud rate {config[CONF_BAUD_RATE]}",
path=[CONF_BAUD_RATE],
)
return config
def _uart_declare_type(value):
if CORE.is_esp8266:
return cv.declare_id(ESP8266UartComponent)(value)
@@ -107,6 +157,8 @@ def _uart_declare_type(value):
return cv.declare_id(RP2040UartComponent)(value)
if CORE.is_libretiny:
return cv.declare_id(LibreTinyUARTComponent)(value)
if CORE.is_host:
return cv.declare_id(HostUartComponent)(value)
raise NotImplementedError
@@ -149,6 +201,12 @@ def maybe_empty_debug(value):
return DEBUG_SCHEMA(value)
def validate_port(value):
if not re.match(r"^/(?:[^/]+/)[^/]+$", value):
raise cv.Invalid("Port must be a valid device path")
return value
DEBUG_SCHEMA = cv.Schema(
{
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(UARTDebugger),
@@ -181,6 +239,7 @@ CONFIG_SCHEMA = cv.All(
cv.Required(CONF_BAUD_RATE): cv.int_range(min=1),
cv.Optional(CONF_TX_PIN): pins.internal_gpio_output_pin_schema,
cv.Optional(CONF_RX_PIN): validate_rx_pin,
cv.Optional(CONF_PORT): cv.All(validate_port, cv.only_on(PLATFORM_HOST)),
cv.Optional(CONF_RX_BUFFER_SIZE, default=256): cv.validate_bytes,
cv.Optional(CONF_STOP_BITS, default=1): cv.one_of(1, 2, int=True),
cv.Optional(CONF_DATA_BITS, default=8): cv.int_range(min=5, max=8),
@@ -193,8 +252,9 @@ CONFIG_SCHEMA = cv.All(
cv.Optional(CONF_DEBUG): maybe_empty_debug,
}
).extend(cv.COMPONENT_SCHEMA),
cv.has_at_least_one_key(CONF_TX_PIN, CONF_RX_PIN),
cv.has_at_least_one_key(CONF_TX_PIN, CONF_RX_PIN, CONF_PORT),
validate_invert_esp32,
validate_host_config,
)
@@ -236,6 +296,8 @@ async def to_code(config):
if CONF_RX_PIN in config:
rx_pin = await cg.gpio_pin_expression(config[CONF_RX_PIN])
cg.add(var.set_rx_pin(rx_pin))
if CONF_PORT in config:
cg.add(var.set_name(config[CONF_PORT]))
cg.add(var.set_rx_buffer_size(config[CONF_RX_BUFFER_SIZE]))
cg.add(var.set_stop_bits(config[CONF_STOP_BITS]))
cg.add(var.set_data_bits(config[CONF_DATA_BITS]))