LibXR::ESP32PWM Class Reference

ESP32 PWM driver implementation. More...

#include <esp_pwm.hpp>

Inheritance diagram for LibXR::ESP32PWM:

Collaboration diagram for LibXR::ESP32PWM:

Public Member Functions
	ESP32PWM (int gpio_num, ledc_channel_t channel, ledc_timer_t timer=LEDC_TIMER_0, ledc_timer_bit_t resolution=static_cast< ledc_timer_bit_t >(static_cast< uint8_t >(LEDC_TIMER_BIT_MAX) - 1))
	Construct a PWM channel object.
ErrorCode	SetDutyCycle (float value) override
	Sets the duty cycle of the PWM signal. 设置 PWM 信号的占空比。
ErrorCode	SetConfig (Configuration config) override
	Configures the PWM settings. 配置 PWM 参数。
ErrorCode	Enable () override
	Enables the PWM output. 启用 PWM 输出。
ErrorCode	Disable () override
	Disables the PWM output. 禁用 PWM 输出。
Public Member Functions inherited from LibXR::PWM

Private Attributes
int	gpio_num_
ledc_channel_t	channel_
ledc_timer_t	timer_
ledc_mode_t	speed_mode_
ledc_hal_context_t	hal_ {}
ledc_timer_bit_t	resolution_
uint32_t	max_duty_

Detailed Description

ESP32 PWM driver implementation.

Definition at line 14 of file esp_pwm.hpp.

Constructor & Destructor Documentation

ESP32PWM()

LibXR::ESP32PWM::ESP32PWM ( int gpio_num, ledc_channel_t channel, ledc_timer_t timer = LEDC_TIMER_0, ledc_timer_bit_t resolution = static_cast<ledc_timer_bit_t>(               static_cast<uint8_t>(LEDC_TIMER_BIT_MAX) - 1) )

inline

Construct a PWM channel object.

Definition at line 18 of file esp_pwm.hpp.

      : gpio_num_(gpio_num),
        channel_(channel),
        timer_(timer),
        speed_mode_(LEDC_LOW_SPEED_MODE),
        resolution_(resolution),
        max_duty_((1U << static_cast<uint8_t>(resolution_)) - 1U)
  {
    ledc_hal_init(&hal_, speed_mode_);
 
    ledc_channel_config_t channel_conf = {};
    channel_conf.gpio_num = gpio_num_;
    channel_conf.speed_mode = speed_mode_;
    channel_conf.channel = channel_;
    channel_conf.intr_type = LEDC_INTR_DISABLE;
    channel_conf.timer_sel = timer_;
    channel_conf.duty = 0;
    channel_conf.hpoint = 0;
 
    const esp_err_t err = ledc_channel_config(&channel_conf);
    if (err != ESP_OK)
    {
      ASSERT(false);
    }
  }

Member Function Documentation

Disable()

ErrorCode LibXR::ESP32PWM::Disable ( )

inlineoverridevirtual

Disables the PWM output. 禁用 PWM 输出。

Returns

ErrorCode indicating success or failure. 返回操作结果的错误码。

Implements LibXR::PWM.

Definition at line 103 of file esp_pwm.hpp.

  {
    ledc_hal_set_idle_level(&hal_, channel_, 0);
    ledc_hal_set_sig_out_en(&hal_, channel_, false);
    ledc_hal_ls_channel_update(&hal_, channel_);
    return ErrorCode::OK;
  }

Enable()

ErrorCode LibXR::ESP32PWM::Enable ( )

inlineoverridevirtual

Enables the PWM output. 启用 PWM 输出。

Returns

ErrorCode indicating success or failure. 返回操作结果的错误码。

Implements LibXR::PWM.

Definition at line 96 of file esp_pwm.hpp.

  {
    ledc_hal_set_sig_out_en(&hal_, channel_, true);
    ledc_hal_ls_channel_update(&hal_, channel_);
    return ErrorCode::OK;
  }

SetConfig()

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

inlineoverridevirtual

Configures the PWM settings. 配置 PWM 参数。

Parameters

config

The configuration structure containing PWM settings. 配置结构体，包含 PWM 设置。

Returns

ErrorCode indicating success or failure. 返回操作结果的错误码。

Implements LibXR::PWM.

Definition at line 64 of file esp_pwm.hpp.

  {
    if (config.frequency == 0)
    {
      return ErrorCode::ARG_ERR;
    }
 
    for (int bits = static_cast<int>(resolution_);
         bits >= static_cast<int>(LEDC_TIMER_1_BIT); --bits)
    {
      ledc_timer_config_t timer_conf = {};
      timer_conf.speed_mode = speed_mode_;
      timer_conf.duty_resolution = static_cast<ledc_timer_bit_t>(bits);
      timer_conf.timer_num = timer_;
      timer_conf.freq_hz = config.frequency;
      timer_conf.clk_cfg = LEDC_AUTO_CLK;
 
      if (ledc_timer_config(&timer_conf) != ESP_OK)
      {
        continue;
      }
 
      resolution_ = static_cast<ledc_timer_bit_t>(bits);
      ledc_hal_bind_channel_timer(&hal_, channel_, timer_);
      ledc_hal_ls_timer_update(&hal_, timer_);
      max_duty_ = (1U << static_cast<uint8_t>(resolution_)) - 1U;
      return ErrorCode::OK;
    }
 
    return ErrorCode::INIT_ERR;
  }

SetDutyCycle()

ErrorCode LibXR::ESP32PWM::SetDutyCycle ( float value )

inlineoverridevirtual

Sets the duty cycle of the PWM signal. 设置 PWM 信号的占空比。

Parameters

value

The duty cycle as a floating-point value (0.0 to 1.0). 占空比，浮点值（0.0 到 1.0）。

Returns

ErrorCode indicating success or failure. 返回操作结果的错误码。

Implements LibXR::PWM.

Definition at line 46 of file esp_pwm.hpp.

  {
    if (value < 0.0f)
    {
      value = 0.0f;
    }
    else if (value > 1.0f)
    {
      value = 1.0f;
    }
 
    const uint32_t duty = static_cast<uint32_t>(max_duty_ * value);
    ledc_hal_set_duty_int_part(&hal_, channel_, duty);
    ledc_hal_set_duty_start(&hal_, channel_);
    ledc_hal_ls_channel_update(&hal_, channel_);
    return ErrorCode::OK;
  }

Field Documentation

channel_

ledc_channel_t LibXR::ESP32PWM::channel_

private

Definition at line 113 of file esp_pwm.hpp.

gpio_num_

int LibXR::ESP32PWM::gpio_num_

private

Definition at line 112 of file esp_pwm.hpp.

hal_

ledc_hal_context_t LibXR::ESP32PWM::hal_ {}

private

Definition at line 116 of file esp_pwm.hpp.

{};

max_duty_

uint32_t LibXR::ESP32PWM::max_duty_

private

Definition at line 118 of file esp_pwm.hpp.

resolution_

ledc_timer_bit_t LibXR::ESP32PWM::resolution_

private

Definition at line 117 of file esp_pwm.hpp.

speed_mode_

ledc_mode_t LibXR::ESP32PWM::speed_mode_

private

Definition at line 115 of file esp_pwm.hpp.

timer_

ledc_timer_t LibXR::ESP32PWM::timer_

private

Definition at line 114 of file esp_pwm.hpp.

---

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

• driver/esp/esp_pwm.hpp