ESPHome 2026.2.1
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
esphome::GPIOPin Class Referenceabstract

#include <gpio.h>

Inheritance diagram for esphome::GPIOPin:
esphome::InternalGPIOPin esphome::ch422g::CH422GGPIOPin esphome::ch423::CH423GPIOPin esphome::max6956::MAX6956GPIOPin esphome::mcp23016::MCP23016GPIOPin esphome::mcp23xxx_base::MCP23XXXGPIOPin< N > esphome::mpr121::MPR121GPIOPin esphome::pca6416a::PCA6416AGPIOPin esphome::pca9554::PCA9554GPIOPin esphome::pcf8574::PCF8574GPIOPin esphome::pi4ioe5v6408::PI4IOE5V6408GPIOPin esphome::sn74hc165::SN74HC165GPIOPin esphome::sn74hc595::SN74HC595GPIOPin esphome::spi::NullPin esphome::sx1509::SX1509GPIOPin esphome::tca9555::TCA9555GPIOPin esphome::weikai::WeikaiGPIOPin esphome::xl9535::XL9535GPIOPin

Public Member Functions

virtual void setup ()=0
 
virtual void pin_mode (gpio::Flags flags)=0
 
virtual gpio::Flags get_flags () const =0
 Retrieve GPIO pin flags.
 
virtual bool digital_read ()=0
 
virtual void digital_write (bool value)=0
 
virtual size_t dump_summary (char *buffer, size_t len) const
 Write a summary of this pin to the provided buffer.
 

Data Fields

virtual ESPDEPRECATED("Override dump_summary(char*, size_t) instead. Will be removed in 2026.7.0.", "2026.1.0") virtual std boo is_internal )()
 Get a summary of this pin as a string.
 

Detailed Description

Definition at line 59 of file gpio.h.

Member Function Documentation

◆ digital_read()

virtual bool esphome::GPIOPin::digital_read ( )
pure virtual

Implemented in esphome::ch422g::CH422GGPIOPin, esphome::ch423::CH423GPIOPin, esphome::esp32::ESP32InternalGPIOPin, esphome::esp8266::ESP8266GPIOPin, esphome::host::HostGPIOPin, esphome::libretiny::ArduinoInternalGPIOPin, esphome::max6956::MAX6956GPIOPin, esphome::mcp23016::MCP23016GPIOPin, esphome::mcp23xxx_base::MCP23XXXGPIOPin< N >, esphome::mpr121::MPR121GPIOPin, esphome::pca6416a::PCA6416AGPIOPin, esphome::pca9554::PCA9554GPIOPin, esphome::pcf8574::PCF8574GPIOPin, esphome::pi4ioe5v6408::PI4IOE5V6408GPIOPin, esphome::rp2040::RP2040GPIOPin, esphome::sn74hc165::SN74HC165GPIOPin, esphome::sn74hc595::SN74HC595GPIOPin, esphome::spi::NullPin, esphome::sx1509::SX1509GPIOPin, esphome::tca9555::TCA9555GPIOPin, esphome::weikai::WeikaiGPIOPin, esphome::xl9535::XL9535GPIOPin, and esphome::zephyr::ZephyrGPIOPin.

◆ digital_write()

virtual void esphome::GPIOPin::digital_write ( bool value)
pure virtual

Implemented in esphome::ch422g::CH422GGPIOPin, esphome::ch423::CH423GPIOPin, esphome::esp32::ESP32InternalGPIOPin, esphome::esp8266::ESP8266GPIOPin, esphome::host::HostGPIOPin, esphome::libretiny::ArduinoInternalGPIOPin, esphome::max6956::MAX6956GPIOPin, esphome::mcp23016::MCP23016GPIOPin, esphome::mcp23xxx_base::MCP23XXXGPIOPin< N >, esphome::mpr121::MPR121GPIOPin, esphome::pca6416a::PCA6416AGPIOPin, esphome::pca9554::PCA9554GPIOPin, esphome::pcf8574::PCF8574GPIOPin, esphome::pi4ioe5v6408::PI4IOE5V6408GPIOPin, esphome::rp2040::RP2040GPIOPin, esphome::sn74hc165::SN74HC165GPIOPin, esphome::sn74hc595::SN74HC595GPIOPin, esphome::spi::NullPin, esphome::sx1509::SX1509GPIOPin, esphome::tca9555::TCA9555GPIOPin, esphome::weikai::WeikaiGPIOPin, esphome::xl9535::XL9535GPIOPin, and esphome::zephyr::ZephyrGPIOPin.

◆ dump_summary()

std::string esphome::GPIOPin::dump_summary ( char * buffer,
size_t len ) const
inlinevirtual

Write a summary of this pin to the provided buffer.

Parameters
bufferThe buffer to write to
lenThe size of the buffer (must be > 0)
Returns
The number of characters that would be written (excluding null terminator), which may exceed len-1 if truncation occurred (snprintf semantics)

Reimplemented in esphome::ch422g::CH422GGPIOPin, esphome::ch423::CH423GPIOPin, esphome::esp32::ESP32InternalGPIOPin, esphome::esp8266::ESP8266GPIOPin, esphome::host::HostGPIOPin, esphome::libretiny::ArduinoInternalGPIOPin, esphome::max6956::MAX6956GPIOPin, esphome::mcp23016::MCP23016GPIOPin, esphome::mcp23xxx_base::MCP23XXXGPIOPin< N >, esphome::mpr121::MPR121GPIOPin, esphome::pca6416a::PCA6416AGPIOPin, esphome::pca9554::PCA9554GPIOPin, esphome::pcf8574::PCF8574GPIOPin, esphome::pi4ioe5v6408::PI4IOE5V6408GPIOPin, esphome::rp2040::RP2040GPIOPin, esphome::sn74hc165::SN74HC165GPIOPin, esphome::sn74hc595::SN74HC595GPIOPin, esphome::spi::NullPin, esphome::sx1509::SX1509GPIOPin, esphome::tca9555::TCA9555GPIOPin, esphome::weikai::WeikaiGPIOPin, esphome::xl9535::XL9535GPIOPin, and esphome::zephyr::ZephyrGPIOPin.

Definition at line 129 of file gpio.h.

◆ get_flags()

virtual gpio::Flags esphome::GPIOPin::get_flags ( ) const
pure virtual

Retrieve GPIO pin flags.

Returns
The GPIO flags describing the pin mode and properties.

Implemented in esphome::ch422g::CH422GGPIOPin, esphome::ch423::CH423GPIOPin, esphome::esp32::ESP32InternalGPIOPin, esphome::esp8266::ESP8266GPIOPin, esphome::host::HostGPIOPin, esphome::libretiny::ArduinoInternalGPIOPin, esphome::max6956::MAX6956GPIOPin, esphome::mcp23016::MCP23016GPIOPin, esphome::mcp23xxx_base::MCP23XXXGPIOPin< N >, esphome::mpr121::MPR121GPIOPin, esphome::pca6416a::PCA6416AGPIOPin, esphome::pca9554::PCA9554GPIOPin, esphome::pcf8574::PCF8574GPIOPin, esphome::pi4ioe5v6408::PI4IOE5V6408GPIOPin, esphome::rp2040::RP2040GPIOPin, esphome::sn74hc165::SN74HC165GPIOPin, esphome::sn74hc595::SN74HC595GPIOPin, esphome::spi::NullPin, esphome::sx1509::SX1509GPIOPin, esphome::tca9555::TCA9555GPIOPin, esphome::weikai::WeikaiGPIOPin, esphome::xl9535::XL9535GPIOPin, and esphome::zephyr::ZephyrGPIOPin.

◆ pin_mode()

virtual void esphome::GPIOPin::pin_mode ( gpio::Flags flags)
pure virtual

Implemented in esphome::ch422g::CH422GGPIOPin, esphome::ch423::CH423GPIOPin, esphome::esp32::ESP32InternalGPIOPin, esphome::esp8266::ESP8266GPIOPin, esphome::host::HostGPIOPin, esphome::libretiny::ArduinoInternalGPIOPin, esphome::max6956::MAX6956GPIOPin, esphome::mcp23016::MCP23016GPIOPin, esphome::mcp23xxx_base::MCP23XXXGPIOPin< N >, esphome::mpr121::MPR121GPIOPin, esphome::pca6416a::PCA6416AGPIOPin, esphome::pca9554::PCA9554GPIOPin, esphome::pcf8574::PCF8574GPIOPin, esphome::pi4ioe5v6408::PI4IOE5V6408GPIOPin, esphome::rp2040::RP2040GPIOPin, esphome::sn74hc165::SN74HC165GPIOPin, esphome::sn74hc595::SN74HC595GPIOPin, esphome::spi::NullPin, esphome::sx1509::SX1509GPIOPin, esphome::tca9555::TCA9555GPIOPin, esphome::weikai::WeikaiGPIOPin, esphome::xl9535::XL9535GPIOPin, and esphome::zephyr::ZephyrGPIOPin.

◆ setup()

virtual void esphome::GPIOPin::setup ( )
pure virtual

Implemented in esphome::ch422g::CH422GGPIOPin, esphome::ch423::CH423GPIOPin, esphome::esp32::ESP32InternalGPIOPin, esphome::esp8266::ESP8266GPIOPin, esphome::host::HostGPIOPin, esphome::libretiny::ArduinoInternalGPIOPin, esphome::max6956::MAX6956GPIOPin, esphome::mcp23016::MCP23016GPIOPin, esphome::mcp23xxx_base::MCP23XXXGPIOPin< N >, esphome::mpr121::MPR121GPIOPin, esphome::pca6416a::PCA6416AGPIOPin, esphome::pca9554::PCA9554GPIOPin, esphome::pcf8574::PCF8574GPIOPin, esphome::pi4ioe5v6408::PI4IOE5V6408GPIOPin, esphome::rp2040::RP2040GPIOPin, esphome::sn74hc165::SN74HC165GPIOPin, esphome::sn74hc595::SN74HC595GPIOPin, esphome::spi::NullPin, esphome::sx1509::SX1509GPIOPin, esphome::tca9555::TCA9555GPIOPin, esphome::weikai::WeikaiGPIOPin, esphome::xl9535::XL9535GPIOPin, and esphome::zephyr::ZephyrGPIOPin.

Field Documentation

◆ is_internal

virtual ESPDEPRECATED("Override dump_summary(char*, size_t) instead. Will be removed in 2026.7.0.", "2026.1.0") virtual std boo esphome::GPIOPin::is_internal) ()
inline

Get a summary of this pin as a string.

Definition at line 88 of file gpio.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.12.0