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
	设置 PWM 信号的占空比 / Sets the duty cycle of the PWM signal.
ErrorCode	SetConfig (Configuration config) override
	配置 PWM 参数 / Configures the PWM settings.
ErrorCode	Enable () override
	启用 PWM 输出 / Enables the PWM output.
ErrorCode	Disable () override
	禁用 PWM 输出 / Disables the PWM output.
Public Member Functions inherited from LibXR::PWM

Detailed Description

ESP32 PWM driver implementation.

Definition at line 13 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 17 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)
    {
      REQUIRE(false);
    }
  }

Member Function Documentation

Disable()

ErrorCode LibXR::ESP32PWM::Disable ( )

inlineoverridevirtual

禁用 PWM 输出 / Disables the PWM output.

Returns

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

Implements LibXR::PWM.

Definition at line 102 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

启用 PWM 输出 / Enables the PWM output.

Returns

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

Implements LibXR::PWM.

Definition at line 95 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

配置 PWM 参数 / Configures the PWM settings.

Parameters

config

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

Returns

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

Implements LibXR::PWM.

Definition at line 63 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

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

Parameters

value

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

Returns

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

Implements LibXR::PWM.

Definition at line 45 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;
  }

---

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

• driver/esp/esp_pwm.hpp