LibXR::ESP32Watchdog Class Reference

Inheritance diagram for LibXR::ESP32Watchdog:

Collaboration diagram for LibXR::ESP32Watchdog:

Public Member Functions
	ESP32Watchdog (uint32_t timeout_ms=1000, uint32_t feed_ms=250)
ErrorCode	SetConfig (const Configuration &config) override
	初始化硬件并设置超时时间 Initialize hardware and set overflow time
ErrorCode	Feed () override
	立即手动喂狗 Feed the watchdog immediately
ErrorCode	Start () override
	启动看门狗 / Start the watchdog
ErrorCode	Stop () override
	停止看门狗 / Stop the watchdog
Public Member Functions inherited from LibXR::Watchdog
	Watchdog ()
	构造函数 / Constructor
virtual	~Watchdog ()
	虚析构函数 / Virtual destructor

Additional Inherited Members
Static Public Member Functions inherited from LibXR::Watchdog
static void	ThreadFun (Watchdog *wdg)
	Watchdog 自动喂狗线程函数 Watchdog thread function for auto-feeding.
static void	TaskFun (Watchdog *wdg)
	Watchdog 自动喂狗定时器任务函数 Watchdog timer task function for auto-feeding.
Public Attributes inherited from LibXR::Watchdog
uint32_t	timeout_ms_ = 3000
	溢出时间
uint32_t	auto_feed_interval_ms = 1000
	自动喂狗间隔
bool	auto_feed_ = false
	是否自动喂狗

Detailed Description

Definition at line 44 of file esp_watchdog.hpp.

Constructor & Destructor Documentation

ESP32Watchdog()

LibXR::ESP32Watchdog::ESP32Watchdog ( uint32_t timeout_ms = 1000, uint32_t feed_ms = 250 )

explicit

Definition at line 41 of file esp_watchdog.cpp.

{
  (void)SetConfig({timeout_ms, feed_ms});
  (void)Start();
}

Member Function Documentation

Feed()

ErrorCode LibXR::ESP32Watchdog::Feed ( )

overridevirtual

立即手动喂狗 Feed the watchdog immediately

Returns

操作结果的错误码 / Error code of the operation

Implements LibXR::Watchdog.

Definition at line 159 of file esp_watchdog.cpp.

{
  if (!initialized_ || !started_)
  {
    return ErrorCode::INIT_ERR;
  }
 
  wdt_hal_write_protect_disable(&hal_);
  wdt_hal_feed(&hal_);
  wdt_hal_write_protect_enable(&hal_);
  return ErrorCode::OK;
}

SetConfig()

ErrorCode LibXR::ESP32Watchdog::SetConfig ( const Configuration & config )

overridevirtual

初始化硬件并设置超时时间 Initialize hardware and set overflow time

Parameters

config

配置参数 / Configuration

Returns

操作结果的错误码 / Error code of the operation

Implements LibXR::Watchdog.

Definition at line 139 of file esp_watchdog.cpp.

{
  if ((config.timeout_ms == 0) || (config.feed_ms == 0) ||
      (config.feed_ms > config.timeout_ms))
  {
    return ErrorCode::ARG_ERR;
  }
 
  timeout_ms_ = config.timeout_ms;
  auto_feed_interval_ms = config.feed_ms;
 
  ErrorCode ret = InitializeHardware();
  if (ret != ErrorCode::OK)
  {
    return ret;
  }
 
  return ApplyConfiguration();
}

Start()

ErrorCode LibXR::ESP32Watchdog::Start ( )

overridevirtual

启动看门狗 / Start the watchdog

Implements LibXR::Watchdog.

Definition at line 172 of file esp_watchdog.cpp.

{
  ErrorCode ret = InitializeHardware();
  if (ret != ErrorCode::OK)
  {
    return ret;
  }
 
  ret = ApplyConfiguration();
  if (ret != ErrorCode::OK)
  {
    return ret;
  }
 
  wdt_hal_write_protect_disable(&hal_);
  wdt_hal_enable(&hal_);
  wdt_hal_feed(&hal_);
  wdt_hal_write_protect_enable(&hal_);
 
  auto_feed_ = true;
  started_ = true;
  return ErrorCode::OK;
}

Stop()

ErrorCode LibXR::ESP32Watchdog::Stop ( )

overridevirtual

停止看门狗 / Stop the watchdog

Implements LibXR::Watchdog.

Definition at line 196 of file esp_watchdog.cpp.

{
  if (!initialized_)
  {
    return ErrorCode::INIT_ERR;
  }
 
  wdt_hal_write_protect_disable(&hal_);
  wdt_hal_disable(&hal_);
  wdt_hal_write_protect_enable(&hal_);
 
  auto_feed_ = false;
  started_ = false;
  return ErrorCode::OK;
}

---

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

• driver/esp/esp_watchdog.hpp
• driver/esp/esp_watchdog.cpp