esphome::api::SerialProxyLineStates Struct Reference

Typed view of the modem control/status lines exchanged with the proxy. More...

#include <serial_proxy.hpp>

Public Member Functions
std::uint32_t	to_bits () const

Static Public Member Functions
static SerialProxyLineStates	from_bits (const std::uint32_t bits)

Public Attributes
bool	rts = false
	Request To Send (bit 0)
bool	dtr = false
	Data Terminal Ready (bit 1)

Static Public Attributes
static constexpr std::uint32_t	rts_bit = 1U << 0
static constexpr std::uint32_t	dtr_bit = 1U << 1

Detailed Description

Typed view of the modem control/status lines exchanged with the proxy.

Bit positions are stable API (ESPHome SerialProxyLineStateFlag); only RTS and DTR are defined today.

Member Function Documentation

from_bits()

static SerialProxyLineStates esphome::api::SerialProxyLineStates::from_bits ( const std::uint32_t  bits )

inlinestatic

to_bits()

std::uint32_t esphome::api::SerialProxyLineStates::to_bits ( ) const

inline

Member Data Documentation

dtr

bool esphome::api::SerialProxyLineStates::dtr = false

Data Terminal Ready (bit 1)

dtr_bit

constexpr std::uint32_t esphome::api::SerialProxyLineStates::dtr_bit = 1U << 1

staticconstexpr

rts

bool esphome::api::SerialProxyLineStates::rts = false

Request To Send (bit 0)

rts_bit

constexpr std::uint32_t esphome::api::SerialProxyLineStates::rts_bit = 1U << 0

staticconstexpr

---

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

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