#include <espectre.h>

Inheritance diagram for esphome::espectre::ESPectreComponent:

Public Member Functions
void	setup () override

void	loop () override

void	dump_config () override

void	on_shutdown () override

float	get_setup_priority () const override

void	set_detection_algorithm (::espectre::DetectionAlgorithm value)

void	set_csi_capture_profile (::espectre::CsiCapturePolicy value)

void	set_traffic_generator_mode (::espectre::TrafficGeneratorMode value)

void	set_traffic_generator_target_ip (const std::string &value)

void	set_csi_traffic_multicast_group (const std::string &value)

void	set_motion_on_hits (uint8_t value)

void	set_motion_off_hits (uint8_t value)

void	set_wifi_band_policy (::espectre::WifiBandPolicy value)

void	recalibrate ()

void	set_traffic_mode_select (select::Select *value)

void	request_traffic_generator_mode (::espectre::TrafficGeneratorMode mode)

void	request_traffic_generator_mode (const char *name)
	Request a mode by its traffic_generator_mode YAML name; unknown names are ignored.

SUB_BINARY_SENSOR(motion) SUB_BINARY_SENSOR(calibrating) SUB_SENSOR(movement) const void	on_runtime_fault (const char *message) override
	Latest one-second runtime diagnostics sample, or nullptr before the runtime starts.

void	start_runtime_ ()

void	schedule_restart_ ()

void	invalidate_sensing_ ()

void	stop_ ()

void	restore_traffic_mode_ ()

void	apply_pending_traffic_mode_ ()

void	publish_traffic_mode_ ()

Public Member Functions inherited from esphome::Component
float	get_actual_setup_priority () const

void	set_setup_priority (float priority)

void	call ()

virtual void	on_safe_shutdown ()

virtual bool	teardown ()
	Called during teardown to allow component to gracefully finish operations.

virtual void	on_powerdown ()
	Called after teardown is complete to power down hardware.

uint8_t	get_component_state () const

void	reset_to_construction_state ()
	Reset this component back to the construction state to allow setup to run again.

bool	is_in_loop_state () const
	Check if this component has completed setup and is in the loop state.

bool	is_idle () const
	Check if this component is idle.

void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const LogString *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

bool	is_failed () const

bool	is_ready () const

virtual bool	can_proceed ()

bool	status_has_warning () const

bool	status_has_error () const

void	status_set_warning ()

void	status_set_warning (const char *message)

void	status_set_warning (const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

	ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name

void	status_momentary_warning (uint32_t length=5000)
	Set warning status flag and clear it after `length` ms.

void	status_momentary_warning (const LogString *message, uint32_t length=5000)

	ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name

void	status_momentary_error (uint32_t length=5000)
	Set error status flag and clear it after `length` ms.

void	status_momentary_error (const LogString *message, uint32_t length=5000)

bool	has_overridden_loop () const

const LogString *	get_component_log_str () const ESPHOME_ALWAYS_INLINE
	Get the integration where this component was declared as a LogString for logging.

bool	should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)

Data Fields
::espectre::RuntimeFrontendController	runtime_

uint32_t	restart_requested_ms_ {0}

select::Select *	traffic_mode_select_ {nullptr}

ESPPreferenceObject	traffic_mode_pref_

optional<::espectre::TrafficGeneratorMode >	pending_traffic_mode_

bool	recalibrate_pending_ {false}

bool	movement_pending_ {false}

bool	ready_ {false}

bool	motion_state_ {false}

bool	calibrating_state_ {false}

bool	calibrating_published_ {false}

bool	runtime_fault_ {false}

bool	running_ {false}

bool	restart_pending_ {false}

bool	calibrated_ {false}

bool	roaming_suppressed_ {false}

Data Fields inherited from esphome::Component
uint32_t	length = 5000)

Static Public Attributes
static constexpr uint32_t	RESTART_DELAY_MS = 30000

Additional Inherited Members
Protected Member Functions inherited from esphome::Component
friend	void::setup ()

friend	void::original_setup ()

void	set_component_source_ (uint8_t index)
	Set where this component was loaded from for some debug messages.

virtual void	call_setup ()

void	call_dump_config_ ()

void	enable_loop_slow_path_ ()

void	set_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

bool	set_status_flag_ (uint8_t flag)
	Helper to set a status LED flag on both this component and the app.

bool	set_error_flag_ (const LogString *message)
	Set the error flag and log it; true when it was not set before.

void	set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a numeric ID (zero heap allocation).

void	set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const char *name)
	Cancel an interval function.

bool	cancel_interval (uint32_t id)

bool	cancel_interval (InternalSchedulerID id)

void	set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a numeric ID (zero heap allocation).

void	set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const char *name)
	Cancel a timeout function.

bool	cancel_timeout (uint32_t id)

bool	cancel_timeout (InternalSchedulerID id)

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

void	defer (std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (uint32_t id, std::function< void()> &&f)
	Defer a callback with a numeric ID (zero heap allocation)

bool	cancel_defer (const char *name)
	Cancel a defer callback using the specified name, name must not be empty.

bool	cancel_defer (uint32_t id)

void	status_clear_warning_slow_path_ ()

void	status_clear_error_slow_path_ ()

Protected Attributes inherited from esphome::Component
uint8_t	component_source_index_ {0}
	Index into component source PROGMEM lookup table (0 = not set)

uint8_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
	Warn threshold in centiseconds (max 2550ms)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

ComponentRuntimeStats	runtime_stats_

Detailed Description

Definition at line 25 of file espectre.h.

Member Function Documentation

◆ apply_pending_traffic_mode_()

void esphome::espectre::ESPectreComponent::apply_pending_traffic_mode_ ( )

Definition at line 139 of file espectre.cpp.

◆ dump_config()

void esphome::espectre::ESPectreComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 278 of file espectre.cpp.

◆ get_setup_priority()

float esphome::espectre::ESPectreComponent::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 32 of file espectre.h.

◆ invalidate_sensing_()

void esphome::espectre::ESPectreComponent::invalidate_sensing_ ( )

Definition at line 223 of file espectre.cpp.

◆ loop()

void esphome::espectre::ESPectreComponent::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 162 of file espectre.cpp.

◆ on_runtime_fault()

void esphome::espectre::ESPectreComponent::on_runtime_fault ( const char * message )

override

Latest one-second runtime diagnostics sample, or nullptr before the runtime starts.

Definition at line 248 of file espectre.cpp.

◆ on_shutdown()

void esphome::espectre::ESPectreComponent::on_shutdown ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 273 of file espectre.cpp.

◆ publish_traffic_mode_()

void esphome::espectre::ESPectreComponent::publish_traffic_mode_ ( )

Definition at line 153 of file espectre.cpp.

◆ recalibrate()

void esphome::espectre::ESPectreComponent::recalibrate ( )

inline

Definition at line 53 of file espectre.h.

◆ request_traffic_generator_mode() [1/2]

void esphome::espectre::ESPectreComponent::request_traffic_generator_mode ( ::espectre::TrafficGeneratorMode mode )

inline

Definition at line 56 of file espectre.h.

◆ request_traffic_generator_mode() [2/2]

void esphome::espectre::ESPectreComponent::request_traffic_generator_mode ( const char * name )

Request a mode by its traffic_generator_mode YAML name; unknown names are ignored.

Definition at line 51 of file espectre.cpp.

◆ restore_traffic_mode_()

void esphome::espectre::ESPectreComponent::restore_traffic_mode_ ( )

Definition at line 123 of file espectre.cpp.

◆ schedule_restart_()

void esphome::espectre::ESPectreComponent::schedule_restart_ ( )

Definition at line 113 of file espectre.cpp.

◆ set_csi_capture_profile()

void esphome::espectre::ESPectreComponent::set_csi_capture_profile ( ::espectre::CsiCapturePolicy value )

inline

Definition at line 37 of file espectre.h.

◆ set_csi_traffic_multicast_group()

void esphome::espectre::ESPectreComponent::set_csi_traffic_multicast_group ( const std::string & value )

inline

Definition at line 46 of file espectre.h.

◆ set_detection_algorithm()

void esphome::espectre::ESPectreComponent::set_detection_algorithm ( ::espectre::DetectionAlgorithm value )

inline

Definition at line 34 of file espectre.h.

◆ set_motion_off_hits()

void esphome::espectre::ESPectreComponent::set_motion_off_hits ( uint8_t value )

inline

Definition at line 50 of file espectre.h.

◆ set_motion_on_hits()

void esphome::espectre::ESPectreComponent::set_motion_on_hits ( uint8_t value )

inline

Definition at line 49 of file espectre.h.

◆ set_traffic_generator_mode()

void esphome::espectre::ESPectreComponent::set_traffic_generator_mode ( ::espectre::TrafficGeneratorMode value )

inline

Definition at line 40 of file espectre.h.

◆ set_traffic_generator_target_ip()

void esphome::espectre::ESPectreComponent::set_traffic_generator_target_ip ( const std::string & value )

inline

Definition at line 43 of file espectre.h.

◆ set_traffic_mode_select()

void esphome::espectre::ESPectreComponent::set_traffic_mode_select ( select::Select * value )

inline

Definition at line 55 of file espectre.h.

◆ set_wifi_band_policy()

void esphome::espectre::ESPectreComponent::set_wifi_band_policy ( ::espectre::WifiBandPolicy value )

inline

Definition at line 51 of file espectre.h.

◆ setup()

void esphome::espectre::ESPectreComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 76 of file espectre.cpp.

◆ start_runtime_()

void esphome::espectre::ESPectreComponent::start_runtime_ ( )

Definition at line 85 of file espectre.cpp.

◆ stop_()

void esphome::espectre::ESPectreComponent::stop_ ( )

Definition at line 253 of file espectre.cpp.

Field Documentation

◆ calibrated_

bool esphome::espectre::ESPectreComponent::calibrated_ {false}

Definition at line 104 of file espectre.h.

◆ calibrating_published_

bool esphome::espectre::ESPectreComponent::calibrating_published_ {false}

Definition at line 100 of file espectre.h.

◆ calibrating_state_

bool esphome::espectre::ESPectreComponent::calibrating_state_ {false}

Definition at line 99 of file espectre.h.

◆ motion_state_

bool esphome::espectre::ESPectreComponent::motion_state_ {false}

Definition at line 98 of file espectre.h.

◆ movement_pending_

bool esphome::espectre::ESPectreComponent::movement_pending_ {false}

Definition at line 96 of file espectre.h.

◆ pending_traffic_mode_

optional<::espectre::TrafficGeneratorMode> esphome::espectre::ESPectreComponent::pending_traffic_mode_

Definition at line 93 of file espectre.h.

◆ ready_

bool esphome::espectre::ESPectreComponent::ready_ {false}

Definition at line 97 of file espectre.h.

◆ recalibrate_pending_

bool esphome::espectre::ESPectreComponent::recalibrate_pending_ {false}

Definition at line 95 of file espectre.h.

◆ RESTART_DELAY_MS

uint32_t esphome::espectre::ESPectreComponent::RESTART_DELAY_MS = 30000

staticconstexpr

Definition at line 86 of file espectre.h.

◆ restart_pending_

bool esphome::espectre::ESPectreComponent::restart_pending_ {false}

Definition at line 103 of file espectre.h.

◆ restart_requested_ms_

uint32_t esphome::espectre::ESPectreComponent::restart_requested_ms_ {0}

Definition at line 89 of file espectre.h.

◆ roaming_suppressed_

bool esphome::espectre::ESPectreComponent::roaming_suppressed_ {false}

Definition at line 105 of file espectre.h.

◆ running_

bool esphome::espectre::ESPectreComponent::running_ {false}

Definition at line 102 of file espectre.h.

◆ runtime_

::espectre::RuntimeFrontendController esphome::espectre::ESPectreComponent::runtime_

Definition at line 88 of file espectre.h.

◆ runtime_fault_

bool esphome::espectre::ESPectreComponent::runtime_fault_ {false}

Definition at line 101 of file espectre.h.

◆ traffic_mode_pref_

ESPPreferenceObject esphome::espectre::ESPectreComponent::traffic_mode_pref_

Definition at line 92 of file espectre.h.

◆ traffic_mode_select_

select::Select* esphome::espectre::ESPectreComponent::traffic_mode_select_ {nullptr}

Definition at line 91 of file espectre.h.

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

esphome/components/espectre/espectre.h
esphome/components/espectre/espectre.cpp

Public Member Functions

Data Fields

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ apply_pending_traffic_mode_()

◆ dump_config()

◆ get_setup_priority()

◆ invalidate_sensing_()

◆ loop()

◆ on_runtime_fault()

◆ on_shutdown()

◆ publish_traffic_mode_()

◆ recalibrate()

◆ request_traffic_generator_mode() [1/2]

◆ request_traffic_generator_mode() [2/2]

◆ restore_traffic_mode_()

◆ schedule_restart_()

◆ set_csi_capture_profile()

◆ set_csi_traffic_multicast_group()

◆ set_detection_algorithm()

◆ set_motion_off_hits()

◆ set_motion_on_hits()

◆ set_traffic_generator_mode()

◆ set_traffic_generator_target_ip()

◆ set_traffic_mode_select()

◆ set_wifi_band_policy()

◆ setup()

◆ start_runtime_()

◆ stop_()

Field Documentation

◆ calibrated_

◆ calibrating_published_

◆ calibrating_state_

◆ motion_state_

◆ movement_pending_

◆ pending_traffic_mode_

◆ ready_

◆ recalibrate_pending_

◆ RESTART_DELAY_MS

◆ restart_pending_

◆ restart_requested_ms_

◆ roaming_suppressed_

◆ running_

◆ runtime_

◆ runtime_fault_

◆ traffic_mode_pref_

◆ traffic_mode_select_