#include <sound_level.h>

Inheritance diagram for esphome::sound_level::SoundLevelComponent:

Public Member Functions
void	dump_config () override

void	setup () override

void	loop () override

float	get_setup_priority () const override

void	set_measurement_duration (uint32_t measurement_duration_ms)

void	set_microphone_source (microphone::MicrophoneSource *microphone_source)

void	set_peak_sensor (sensor::Sensor *peak_sensor)

void	set_rms_sensor (sensor::Sensor *rms_sensor)

void	start ()
	Starts the MicrophoneSource to start measuring sound levels.

void	stop ()
	Stops the MicrophoneSource.

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

void	set_setup_priority (float priority)

virtual float	get_loop_priority () const
	priority of loop().

void	call ()

virtual void	on_shutdown ()

virtual void	on_safe_shutdown ()

uint32_t	get_component_state () const

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

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 (const char *message="unspecified")

void	status_set_error (const char *message="unspecified")

void	status_clear_warning ()

void	status_clear_error ()

void	status_momentary_warning (const std::string &name, uint32_t length=5000)

void	status_momentary_error (const std::string &name, uint32_t length=5000)

bool	has_overridden_loop () const

void	set_component_source (const char *source)
	Set where this component was loaded from for some debug messages.

const char *	get_component_source () const
	Get the integration where this component was declared as a string.

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Member Functions
void	stop_ ()
	Internal start command that, if necessary, allocates `audio_buffer_` and a ring buffer which / `audio_buffer_` owns and `ring_buffer_` points to.

Protected Member Functions inherited from esphome::Component
virtual void	call_loop ()

virtual void	call_setup ()

virtual void	call_dump_config ()

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

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

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

void	set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
	Set an retry function with a unique name.

void	set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)

bool	cancel_retry (const std::string &name)
	Cancel a retry function.

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

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

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

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

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

bool	cancel_defer (const std::string &name)
	Cancel a defer callback using the specified name, name must not be empty.

Protected Attributes
microphone::MicrophoneSource *	microphone_source_ {nullptr}

sensor::Sensor *	peak_sensor_ {nullptr}

sensor::Sensor *	rms_sensor_ {nullptr}

std::unique_ptr< audio::AudioSourceTransferBuffer >	audio_buffer_

std::weak_ptr< RingBuffer >	ring_buffer_

int32_t	squared_peak_ {0}

uint64_t	squared_samples_sum_ {0}

uint32_t	sample_count_ {0}

uint32_t	measurement_duration_ms_

Protected Attributes inherited from esphome::Component
uint32_t	component_state_ {0x0000}
	State of this component.

float	setup_priority_override_ {NAN}

const char *	component_source_ {nullptr}

uint32_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}

std::string	error_message_ {}

Detailed Description

Definition at line 15 of file sound_level.h.

Member Function Documentation

◆ dump_config()

void esphome::sound_level::SoundLevelComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 21 of file sound_level.cpp.

◆ get_setup_priority()

float esphome::sound_level::SoundLevelComponent::get_setup_priority ( ) const

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 21 of file sound_level.h.

◆ loop()

void esphome::sound_level::SoundLevelComponent::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 44 of file sound_level.cpp.

◆ set_measurement_duration()

void esphome::sound_level::SoundLevelComponent::set_measurement_duration ( uint32_t measurement_duration_ms )

inline

Definition at line 23 of file sound_level.h.

◆ set_microphone_source()

void esphome::sound_level::SoundLevelComponent::set_microphone_source ( microphone::MicrophoneSource * microphone_source )

inline

Definition at line 26 of file sound_level.h.

◆ set_peak_sensor()

void esphome::sound_level::SoundLevelComponent::set_peak_sensor ( sensor::Sensor * peak_sensor )

inline

Definition at line 29 of file sound_level.h.

◆ set_rms_sensor()

void esphome::sound_level::SoundLevelComponent::set_rms_sensor ( sensor::Sensor * rms_sensor )

inline

Definition at line 30 of file sound_level.h.

◆ setup()

void esphome::sound_level::SoundLevelComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 29 of file sound_level.cpp.

◆ start()

void esphome::sound_level::SoundLevelComponent::start ( )

Starts the MicrophoneSource to start measuring sound levels.

Definition at line 143 of file sound_level.cpp.

◆ stop()

void esphome::sound_level::SoundLevelComponent::stop ( )

Stops the MicrophoneSource.

Definition at line 151 of file sound_level.cpp.

◆ stop_()

void esphome::sound_level::SoundLevelComponent::stop_ ( )

protected

Internal start command that, if necessary, allocates audio_buffer_ and a ring buffer which / audio_buffer_ owns and ring_buffer_ points to.

Returns true if allocations were successful. bool start_();

/ Internal stop command the deallocates audio_buffer_ (which automatically deallocates its ring buffer)

Definition at line 189 of file sound_level.cpp.

Field Documentation

◆ audio_buffer_

std::unique_ptr<audio::AudioSourceTransferBuffer> esphome::sound_level::SoundLevelComponent::audio_buffer_

protected

Definition at line 51 of file sound_level.h.

◆ measurement_duration_ms_

uint32_t esphome::sound_level::SoundLevelComponent::measurement_duration_ms_

protected

Definition at line 58 of file sound_level.h.

◆ microphone_source_

microphone::MicrophoneSource* esphome::sound_level::SoundLevelComponent::microphone_source_ {nullptr}

protected

Definition at line 46 of file sound_level.h.

◆ peak_sensor_

sensor::Sensor* esphome::sound_level::SoundLevelComponent::peak_sensor_ {nullptr}

protected

Definition at line 48 of file sound_level.h.

◆ ring_buffer_

std::weak_ptr<RingBuffer> esphome::sound_level::SoundLevelComponent::ring_buffer_

protected

Definition at line 52 of file sound_level.h.

◆ rms_sensor_

sensor::Sensor* esphome::sound_level::SoundLevelComponent::rms_sensor_ {nullptr}

protected

Definition at line 49 of file sound_level.h.

◆ sample_count_

uint32_t esphome::sound_level::SoundLevelComponent::sample_count_ {0}

protected

Definition at line 56 of file sound_level.h.

◆ squared_peak_

int32_t esphome::sound_level::SoundLevelComponent::squared_peak_ {0}

protected

Definition at line 54 of file sound_level.h.

◆ squared_samples_sum_

uint64_t esphome::sound_level::SoundLevelComponent::squared_samples_sum_ {0}

protected

Definition at line 55 of file sound_level.h.

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

esphome/components/sound_level/sound_level.h
esphome/components/sound_level/sound_level.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ dump_config()

◆ get_setup_priority()

◆ loop()

◆ set_measurement_duration()

◆ set_microphone_source()

◆ set_peak_sensor()

◆ set_rms_sensor()

◆ setup()

◆ start()

◆ stop()

◆ stop_()

Field Documentation

◆ audio_buffer_

◆ measurement_duration_ms_

◆ microphone_source_

◆ peak_sensor_

◆ ring_buffer_

◆ rms_sensor_

◆ sample_count_

◆ squared_peak_

◆ squared_samples_sum_