esphome::api::SerialPort Class Reference

A single serial-proxy instance bound to its index — the instance-aware, ergonomic front end to SerialProxy (no instance argument on every call). More...

#include <serial_proxy.hpp>

Public Member Functions
	SerialPort (SerialProxy &proxy, const std::uint32_t instance)
std::uint32_t	index () const noexcept
void	subscribe () const
void	unsubscribe () const
void	flush () const
void	configure (SerialProxyConfig config) const
void	write (const std::string &data) const
void	get_modem_pins (SerialProxy::ModemPinsHandler once={}) const
void	set_modem_pins (const SerialProxyLineStates lines) const
void	on_data (SerialProxy::DataHandler handler) const
	Receive data for this instance only.

Detailed Description

A single serial-proxy instance bound to its index — the instance-aware, ergonomic front end to SerialProxy (no instance argument on every call).

Constructor & Destructor Documentation

SerialPort()

esphome::api::SerialPort::SerialPort ( SerialProxy &  proxy, const std::uint32_t  instance  )

inline

Member Function Documentation

configure()

void esphome::api::SerialPort::configure ( SerialProxyConfig  config ) const

inline

flush()

void esphome::api::SerialPort::flush ( ) const

inline

get_modem_pins()

void esphome::api::SerialPort::get_modem_pins ( SerialProxy::ModemPinsHandler  once = {} ) const

inline

index()

std::uint32_t esphome::api::SerialPort::index ( ) const

inlinenoexcept

on_data()

void esphome::api::SerialPort::on_data ( SerialProxy::DataHandler  handler ) const

inline

Receive data for this instance only.

set_modem_pins()

void esphome::api::SerialPort::set_modem_pins ( const SerialProxyLineStates  lines ) const

inline

subscribe()

void esphome::api::SerialPort::subscribe ( ) const

inline

unsubscribe()

void esphome::api::SerialPort::unsubscribe ( ) const

inline

write()

void esphome::api::SerialPort::write ( const std::string &  data ) const

inline

---

The documentation for this class was generated from the following file:

• include/esphome/api/subsystems/serial_proxy.hpp