LibXR::ESP32GPIO Class Reference

Inheritance diagram for LibXR::ESP32GPIO:

Collaboration diagram for LibXR::ESP32GPIO:

Public Member Functions
	ESP32GPIO (gpio_num_t gpio_num)
bool	Read () override
	读取 GPIO 引脚状态。Reads the GPIO pin state.
ErrorCode	Write (bool value) override
	写入 GPIO 引脚状态。Writes the GPIO pin state.
ErrorCode	EnableInterrupt () override
	使能 GPIO 引脚中断。Enables the GPIO pin interrupt.
ErrorCode	DisableInterrupt () override
	禁用 GPIO 引脚中断。Disables the GPIO pin interrupt.
ErrorCode	SetConfig (Configuration config) override
	配置 GPIO 引脚参数。Configures the GPIO pin settings.
Public Member Functions inherited from LibXR::GPIO
	GPIO ()
	默认构造函数。Default constructor.
ErrorCode	RegisterCallback (Callback callback)
	注册 GPIO 事件回调函数。Registers a callback function for GPIO events.

Static Public Member Functions
static void IRAM_ATTR	InterruptDispatcher (void *arg)

Private Attributes
gpio_num_t	gpio_num_

Static Private Attributes
static bool	isr_service_installed_ = false
static ESP32GPIO *	map_ [GPIO_NUM_MAX]

Additional Inherited Members
Public Types inherited from LibXR::GPIO
enum class	Direction : uint8_t {   INPUT , OUTPUT_PUSH_PULL , OUTPUT_OPEN_DRAIN , FALL_INTERRUPT ,   RISING_INTERRUPT , FALL_RISING_INTERRUPT }
	定义 GPIO 引脚的方向类型。Defines the direction types for GPIO pins. More...
enum class	Pull : uint8_t { NONE , UP , DOWN }
	定义 GPIO 引脚的上拉/下拉模式。Defines the pull-up/pull-down configurations for GPIO pins. More...
using	Callback = LibXR::Callback<>
Data Fields inherited from LibXR::GPIO
Callback	callback_
	GPIO 事件的回调函数。Callback function for GPIO events.

Detailed Description

Definition at line 9 of file esp_gpio.hpp.

Constructor & Destructor Documentation

ESP32GPIO()

LibXR::ESP32GPIO::ESP32GPIO ( gpio_num_t  gpio_num )

inlineexplicit

Definition at line 12 of file esp_gpio.hpp.

: gpio_num_(gpio_num) { map_[gpio_num_] = this; }

Member Function Documentation

DisableInterrupt()

ErrorCode LibXR::ESP32GPIO::DisableInterrupt ( )

inlineoverridevirtual

禁用 GPIO 引脚中断。Disables the GPIO pin interrupt.

Returns

操作结果的错误码。Error code indicating the result of the operation.

Implements LibXR::GPIO.

Definition at line 35 of file esp_gpio.hpp.

  {
    gpio_intr_disable(gpio_num_);
    gpio_isr_handler_remove(gpio_num_);
    return ErrorCode::OK;
  }

EnableInterrupt()

ErrorCode LibXR::ESP32GPIO::EnableInterrupt ( )

inlineoverridevirtual

使能 GPIO 引脚中断。Enables the GPIO pin interrupt.

Returns

操作结果的错误码。Error code indicating the result of the operation.

Implements LibXR::GPIO.

Definition at line 22 of file esp_gpio.hpp.

  {
    if (!isr_service_installed_)
    {
      gpio_install_isr_service(0);
      isr_service_installed_ = true;
    }
 
    gpio_isr_handler_add(gpio_num_, ESP32GPIO::InterruptDispatcher, (void*)gpio_num_);
    gpio_intr_enable(gpio_num_);
    return ErrorCode::OK;
  }

InterruptDispatcher()

static void IRAM_ATTR LibXR::ESP32GPIO::InterruptDispatcher ( void *  arg )

inlinestatic

Definition at line 93 of file esp_gpio.hpp.

  {
    auto gpio_num = static_cast<gpio_num_t>(reinterpret_cast<uintptr_t>(arg));
    auto gpio = map_[gpio_num];
    if (gpio)
    {
      gpio->callback_.Run(true);
    }
  }

Read()

bool LibXR::ESP32GPIO::Read ( )

inlineoverridevirtual

读取 GPIO 引脚状态。Reads the GPIO pin state.

Returns

返回引脚状态，true 表示高电平，false 表示低电平。Returns the pin state, true for high, false for low.

Implements LibXR::GPIO.

Definition at line 14 of file esp_gpio.hpp.

{ return gpio_get_level(gpio_num_) != 0; }

SetConfig()

ErrorCode LibXR::ESP32GPIO::SetConfig ( Configuration  config )

inlineoverridevirtual

配置 GPIO 引脚参数。Configures the GPIO pin settings.

Parameters

config

需要应用的 GPIO 配置。The GPIO configuration to apply.

Returns

操作结果的错误码。Error code indicating the result of the operation.

Implements LibXR::GPIO.

Definition at line 42 of file esp_gpio.hpp.

  {
    gpio_config_t io_conf = {};
    io_conf.pin_bit_mask = 1ULL << gpio_num_;
 
    switch (config.direction)
    {
      case Direction::INPUT:
        io_conf.mode = GPIO_MODE_INPUT;
        break;
      case Direction::OUTPUT_PUSH_PULL:
        io_conf.mode = GPIO_MODE_OUTPUT;
        break;
      case Direction::OUTPUT_OPEN_DRAIN:
        io_conf.mode = GPIO_MODE_OUTPUT_OD;
        break;
      case Direction::FALL_INTERRUPT:
        io_conf.mode = GPIO_MODE_INPUT;
        io_conf.intr_type = GPIO_INTR_NEGEDGE;
        break;
      case Direction::RISING_INTERRUPT:
        io_conf.mode = GPIO_MODE_INPUT;
        io_conf.intr_type = GPIO_INTR_POSEDGE;
        break;
      case Direction::FALL_RISING_INTERRUPT:
        io_conf.mode = GPIO_MODE_INPUT;
        io_conf.intr_type = GPIO_INTR_ANYEDGE;
        break;
    }
 
    switch (config.pull)
    {
      case Pull::NONE:
        io_conf.pull_down_en = GPIO_PULLDOWN_DISABLE;
        io_conf.pull_up_en = GPIO_PULLUP_DISABLE;
        break;
      case Pull::UP:
        io_conf.pull_up_en = GPIO_PULLUP_ENABLE;
        io_conf.pull_down_en = GPIO_PULLDOWN_DISABLE;
        break;
      case Pull::DOWN:
        io_conf.pull_down_en = GPIO_PULLDOWN_ENABLE;
        io_conf.pull_up_en = GPIO_PULLUP_DISABLE;
        break;
    }
 
    gpio_config(&io_conf);
 
    return ErrorCode::OK;
  }

Write()

ErrorCode LibXR::ESP32GPIO::Write ( bool  value )

inlineoverridevirtual

写入 GPIO 引脚状态。Writes the GPIO pin state.

Parameters

value

要写入的状态，true 表示高电平，false 表示低电平。The value to write, true for high, false for low.

Returns

操作结果的错误码。Error code indicating the result of the operation.

Implements LibXR::GPIO.

Definition at line 16 of file esp_gpio.hpp.

  {
    gpio_set_level(gpio_num_, value ? 1 : 0);
    return ErrorCode::OK;
  }

Field Documentation

gpio_num_

gpio_num_t LibXR::ESP32GPIO::gpio_num_

private

Definition at line 104 of file esp_gpio.hpp.

isr_service_installed_

bool LibXR::ESP32GPIO::isr_service_installed_ = false

inlinestaticprivate

Definition at line 105 of file esp_gpio.hpp.

map_

ESP32GPIO* LibXR::ESP32GPIO::map_[GPIO_NUM_MAX]

inlinestaticprivate

Definition at line 106 of file esp_gpio.hpp.

---

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

• driver/esp/esp_gpio.hpp