mirror of
https://github.com/esphome/esphome.git
synced 2026-06-24 13:45:15 +00:00
ec6cc105f4
Add the C++ `final` specifier to leaf, user-configurable component classes and automation action/trigger/condition primitives so that classes meant to be terminal cannot be subclassed by external components. Only classes never used as a base anywhere in the tree are marked. Part 19 of 21, split alphabetically by component (uart .. wl_134).
53 lines
1.6 KiB
C++
53 lines
1.6 KiB
C++
#pragma once
|
|
|
|
#include "esphome/core/component.h"
|
|
#include "esphome/core/gpio.h"
|
|
#include "esphome/components/sensor/sensor.h"
|
|
|
|
#include <cinttypes>
|
|
|
|
namespace esphome::ultrasonic {
|
|
|
|
struct UltrasonicSensorStore {
|
|
static void gpio_intr(UltrasonicSensorStore *arg);
|
|
|
|
volatile uint32_t measurement_start_us{0};
|
|
volatile uint32_t echo_start_us{0};
|
|
volatile uint32_t echo_end_us{0};
|
|
volatile bool echo_start{false};
|
|
volatile bool echo_end{false};
|
|
};
|
|
|
|
class UltrasonicSensorComponent final : public sensor::Sensor, public PollingComponent {
|
|
public:
|
|
void set_trigger_pin(InternalGPIOPin *trigger_pin) { this->trigger_pin_ = trigger_pin; }
|
|
void set_echo_pin(InternalGPIOPin *echo_pin) { this->echo_pin_ = echo_pin; }
|
|
|
|
void setup() override;
|
|
void loop() override;
|
|
void dump_config() override;
|
|
void update() override;
|
|
|
|
/// Set the maximum time in µs to wait for the echo to return
|
|
void set_timeout_us(uint32_t timeout_us) { this->timeout_us_ = timeout_us; }
|
|
/// Set the time in µs the trigger pin should be enabled for in µs, defaults to 10µs (for HC-SR04)
|
|
void set_pulse_time_us(uint32_t pulse_time_us) { this->pulse_time_us_ = pulse_time_us; }
|
|
|
|
protected:
|
|
/// Helper function to convert the specified echo duration in µs to meters.
|
|
static float us_to_m(uint32_t us);
|
|
void send_trigger_pulse_();
|
|
|
|
InternalGPIOPin *trigger_pin_;
|
|
ISRInternalGPIOPin trigger_pin_isr_;
|
|
InternalGPIOPin *echo_pin_;
|
|
UltrasonicSensorStore store_;
|
|
uint32_t timeout_us_{};
|
|
uint32_t pulse_time_us_{};
|
|
|
|
uint32_t measurement_start_us_{0};
|
|
bool measurement_pending_{false};
|
|
};
|
|
|
|
} // namespace esphome::ultrasonic
|