ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
esphome::ld2450::PolygonZone Class Reference

A zone with any polygon shape. More...

#include <polygon_zone.h>

Inheritance diagram for esphome::ld2450::PolygonZone:
esphome::text::Text esphome::EntityBase

Public Member Functions

 SUB_BINARY_SENSOR (presence) void setup()
 Config validation guarantees every zone gets exactly one presence binary sensor.
 
void dump_config ()
 
void update (bool target_inside, uint32_t now, bool timed_out)
 Publish presence for one radar frame.
 
void invalidate_presence ()
 Link lost: presence becomes unknown and the hold is cleared.
 
uint32_t get_last_inside_ms () const
 When a target was last inside the zone, in ms; 0 if never since the polygon was set.
 
bool contains (int16_t x, int16_t y) const
 
bool has_polygon () const
 
- Public Member Functions inherited from esphome::text::Text
void publish_state (const std::string &state)
 
void publish_state (const char *state)
 
void publish_state (const char *state, size_t len)
 
TextCall make_call ()
 Instantiate a TextCall object to modify this text component's state.
 
template<typename F >
void add_on_state_callback (F &&callback)
 
- Public Member Functions inherited from esphome::EntityBase
 ESPDEPRECATED ("Use get_name_to() or get_log_name() instead. Will be removed in ESPHome 2027.5.0", "2026.11.0") const StringRef &get_name() const
 The name is in flash here; the first call makes a RAM copy that is kept for the life of the device.
 
StringRef get_name_to (std::span< char, ENTITY_NAME_BUF_SIZE > buffer) const
 Get the name of this Entity, copied out of flash into buffer.
 
 ESPDEPRECATED ("Use get_name_to() or get_log_name() instead. Will be removed in ESPHome 2027.5.0", "2026.11.0") const StringRef &get_name() const
 
const StringRef & get_name_to (std::span< char, ENTITY_NAME_BUF_SIZE >) const
 
bool name_equals (const StringRef &other) const
 
const ProgmemStringRef & get_name_progmem () const
 The name as stored, for consumers that read flash themselves (e.g. API progmem fields).
 
size_t write_name_to (char *buf, size_t buf_size) const
 Copy the name into buf (null terminated), returns its length.
 
const LogString * get_log_name () const
 Get the name for a "%s" log argument (LOG_STR_ARG).
 
bool has_own_name () const
 
uint32_t get_object_id_hash () const
 
StringRef get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const
 Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.
 
size_t write_object_id_to (char *buf, size_t buf_size) const
 Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 
EntityCategory get_entity_category () const
 
const char * get_device_class_to (std::span< char, MAX_DEVICE_CLASS_LENGTH > buffer) const
 
ProgmemStringRef get_device_class_progmem () const
 The device class as stored (in flash on ESP8266), for consumers that read flash themselves.
 
StringRef get_unit_of_measurement_ref () const
 
const char * get_icon_to (std::span< char, MAX_ICON_LENGTH > buffer) const
 
ProgmemStringRef get_icon_progmem () const
 The icon as stored (in flash on ESP8266), for consumers that read flash themselves.
 
uint32_t get_device_id () const
 
Device * get_device () const
 
bool has_state () const
 
void set_has_state (bool state)
 
 ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash()
 Get a unique hash for storing preferences/settings for this entity.
 
template<typename T >
ESPPreferenceObject make_entity_preference (uint32_t version=0)
 Create a preference object for storing this entity's state/settings.
 
template<typename T >
ESPPreferenceObject make_entity_preference (uint32_t version, bool in_flash)
 As make_entity_preference(), stored in flash or RTC memory where the backend supports the choice.
 

Protected Member Functions

void control (const std::string &value) override
 
void publish_polygon_ ()
 
- Protected Member Functions inherited from esphome::text::Text
- Protected Member Functions inherited from esphome::EntityBase
friend void::setup ()
 
friend void::original_setup ()
 
void configure_entity_ (const char *name, uint32_t object_id_hash, uint32_t entity_fields)
 Combined entity setup from codegen: set name, object_id hash, entity string indices, and flags.
 
void set_device_ (Device *device)
 
ESPPreferenceObject make_entity_preference_ (size_t size, uint32_t version)
 Non-template helpers for make_entity_preference() to avoid code bloat.
 
ESPPreferenceObject make_entity_preference_ (size_t size, uint32_t version, bool in_flash)
 
uint32_t entity_preference_key_ (uint32_t version)
 Key for both helpers; preference hash migration goes here.
 

Protected Attributes

Polygon polygon_
 
ESPPreferenceObject pref_
 
uint32_t last_inside_ms_ {0}
 
- Protected Attributes inherited from esphome::text::Text
LazyCallbackManager< void(const std::string &)> state_callback_
 
- Protected Attributes inherited from esphome::EntityBase
ProgmemStringRef name_
 
uint32_t object_id_hash_ {}
 
Device * device_ {}
 
struct esphome::EntityBase::EntityFlags flags_
 
uint8_t device_class_idx_ {}
 
uint8_t uom_idx_ {}
 
uint8_t icon_idx_ {}
 

Additional Inherited Members

- Data Fields inherited from esphome::text::Text
std::string state
 
TextTraits traits
 

Detailed Description

A zone with any polygon shape.

The text state holds the polygon, so it can be edited and read back from HA.

The polygon is in the radar's raw coordinates (mm), and targets are checked against it as decoded from each radar frame, before any sensor filter. Filters on the target X/Y sensors change only what they publish, so a filter that changes their values (multiply, offset, lambda, ...) puts them in a different frame from the polygon.

Like the hub's has_target binary sensors, presence stays on until presence_timeout has passed since a target was last inside the zone.

Definition at line 22 of file polygon_zone.h.

Member Function Documentation

◆ contains()

bool esphome::ld2450::PolygonZone::contains ( int16_t x,
int16_t y ) const
inline

Definition at line 53 of file polygon_zone.h.

◆ control()

void esphome::ld2450::PolygonZone::control ( const std::string & value)
overrideprotectedvirtual

Implements esphome::text::Text.

Definition at line 33 of file polygon_zone.cpp.

◆ dump_config()

void esphome::ld2450::PolygonZone::dump_config ( )

Definition at line 25 of file polygon_zone.cpp.

◆ get_last_inside_ms()

uint32_t esphome::ld2450::PolygonZone::get_last_inside_ms ( ) const
inline

When a target was last inside the zone, in ms; 0 if never since the polygon was set.

Definition at line 52 of file polygon_zone.h.

◆ has_polygon()

bool esphome::ld2450::PolygonZone::has_polygon ( ) const
inline

Definition at line 54 of file polygon_zone.h.

◆ invalidate_presence()

void esphome::ld2450::PolygonZone::invalidate_presence ( )
inline

Link lost: presence becomes unknown and the hold is cleared.

Definition at line 47 of file polygon_zone.h.

◆ publish_polygon_()

void esphome::ld2450::PolygonZone::publish_polygon_ ( )
protected

Definition at line 54 of file polygon_zone.cpp.

◆ SUB_BINARY_SENSOR()

esphome::ld2450::PolygonZone::SUB_BINARY_SENSOR ( presence )

Config validation guarantees every zone gets exactly one presence binary sensor.

Load the saved polygon and publish it. Called from the hub's setup().

◆ update()

void esphome::ld2450::PolygonZone::update ( bool target_inside,
uint32_t now,
bool timed_out )
inline

Publish presence for one radar frame.

A zone without a polygon keeps presence unknown.

Parameters
target_insidewhether any target is inside the zone in this frame.
nowthe frame's time, in ms.
timed_outwhether presence_timeout has passed since get_last_inside_ms().

Definition at line 36 of file polygon_zone.h.

Field Documentation

◆ last_inside_ms_

uint32_t esphome::ld2450::PolygonZone::last_inside_ms_ {0}
protected

Definition at line 62 of file polygon_zone.h.

◆ polygon_

Polygon esphome::ld2450::PolygonZone::polygon_
protected

Definition at line 60 of file polygon_zone.h.

◆ pref_

ESPPreferenceObject esphome::ld2450::PolygonZone::pref_
protected

Definition at line 61 of file polygon_zone.h.


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