#include <rtttl.h>

Inheritance diagram for esphome::rtttl::Rtttl:

Public Member Functions
void	set_output (output::FloatOutput *output)

void	set_speaker (speaker::Speaker *speaker)

float	get_gain ()

void	set_gain (float gain)

void	play (std::string rtttl)

void	stop ()

void	dump_config () override

bool	is_playing ()

void	loop () override

void	add_on_finished_playback_callback (std::function< void()> callback)

Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen.

virtual float	get_setup_priority () const
	priority of setup().

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 ()

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.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *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 (const char *message=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

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 LogString *source)
	Set where this component was loaded from for some debug messages.

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

bool	should_warn_of_blocking (uint32_t blocking_time)

Protected Member Functions
uint8_t	get_integer_ ()

void	finish_ ()
	Finalizes the playback of the RTTTL string.

void	set_state_ (State state)

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

virtual void	call_setup ()

virtual void	call_dump_config ()

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

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 (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

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

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

bool	cancel_interval (const char *name)

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 (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

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

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

bool	cancel_timeout (const char *name)

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

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.

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

Protected Attributes
std::string	rtttl_ {""}
	The RTTTL string to play.

size_t	position_ {0}
	The current position in the RTTTL string.

uint16_t	wholenote_
	The duration of a whole note in milliseconds.

uint16_t	default_duration_
	The default duration of a note (e.g. 4 for a quarter note).

uint16_t	default_octave_
	The default octave for a note.

uint32_t	last_note_
	The time the last note was started.

uint16_t	note_duration_
	The duration of the current note in milliseconds.

uint32_t	output_freq_
	The frequency of the current note in Hz.

float	gain_ {0.6f}
	The gain of the output.

State	state_ {State::STATE_STOPPED}
	The current state of the RTTTL player.

output::FloatOutput *	output_
	The output to write the sound to.

speaker::Speaker *	speaker_ {nullptr}
	The speaker to write the sound to.

int	sample_rate_ {16000}
	The sample rate of the speaker.

int	samples_per_wave_ {0}
	The number of samples for one full cycle of a note's waveform, in Q10 fixed-point format.

int	samples_sent_ {0}
	The number of samples sent.

int	samples_count_ {0}
	The total number of samples to send.

int	samples_gap_ {0}
	The number of samples for the gap between notes.

CallbackManager< void()>	on_finished_playback_callback_
	The callback to call when playback is finished.

Protected Attributes inherited from esphome::Component
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

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 Bits 5-7: Unused - reserved for future expansion.

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

Detailed Description

Definition at line 34 of file rtttl.h.

Member Function Documentation

◆ add_on_finished_playback_callback()

void esphome::rtttl::Rtttl::add_on_finished_playback_callback ( std::function< void()> callback )

inline

Definition at line 51 of file rtttl.h.

◆ dump_config()

void esphome::rtttl::Rtttl::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 29 of file rtttl.cpp.

◆ finish_()

void esphome::rtttl::Rtttl::finish_ ( )

protected

Finalizes the playback of the RTTTL string.

This method is called internally when the end of the RTTTL string is reached or when a parsing error occurs. It stops the output, sets the component state, and triggers the on_finished_playback_callback_.

Definition at line 144 of file rtttl.cpp.

◆ get_gain()

float esphome::rtttl::Rtttl::get_gain ( )

inline

Definition at line 42 of file rtttl.h.

◆ get_integer_()

uint8_t esphome::rtttl::Rtttl::get_integer_ ( )

inlineprotected

Definition at line 56 of file rtttl.h.

◆ is_playing()

bool esphome::rtttl::Rtttl::is_playing ( )

inline

Definition at line 48 of file rtttl.h.

◆ loop()

void esphome::rtttl::Rtttl::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 169 of file rtttl.cpp.

◆ play()

void esphome::rtttl::Rtttl::play ( std::string rtttl )

Definition at line 36 of file rtttl.cpp.

◆ set_gain()

void esphome::rtttl::Rtttl::set_gain ( float gain )

inline

Definition at line 43 of file rtttl.h.

◆ set_output()

void esphome::rtttl::Rtttl::set_output ( output::FloatOutput * output )

inline

Definition at line 37 of file rtttl.h.

◆ set_speaker()

void esphome::rtttl::Rtttl::set_speaker ( speaker::Speaker * speaker )

inline

Definition at line 40 of file rtttl.h.

◆ set_state_()

void esphome::rtttl::Rtttl::set_state_ ( State state )

protected

Definition at line 395 of file rtttl.cpp.

◆ stop()

void esphome::rtttl::Rtttl::stop ( )

Definition at line 125 of file rtttl.cpp.

Field Documentation

◆ default_duration_

uint16_t esphome::rtttl::Rtttl::default_duration_

protected

The default duration of a note (e.g. 4 for a quarter note).

Definition at line 80 of file rtttl.h.

◆ default_octave_

uint16_t esphome::rtttl::Rtttl::default_octave_

protected

The default octave for a note.

Definition at line 82 of file rtttl.h.

◆ gain_

float esphome::rtttl::Rtttl::gain_ {0.6f}

protected

The gain of the output.

Definition at line 91 of file rtttl.h.

◆ last_note_

uint32_t esphome::rtttl::Rtttl::last_note_

protected

The time the last note was started.

Definition at line 84 of file rtttl.h.

◆ note_duration_

uint16_t esphome::rtttl::Rtttl::note_duration_

protected

The duration of the current note in milliseconds.

Definition at line 86 of file rtttl.h.

◆ on_finished_playback_callback_

CallbackManager<void()> esphome::rtttl::Rtttl::on_finished_playback_callback_

protected

The callback to call when playback is finished.

Definition at line 117 of file rtttl.h.

◆ output_

output::FloatOutput* esphome::rtttl::Rtttl::output_

protected

The output to write the sound to.

Definition at line 97 of file rtttl.h.

◆ output_freq_

uint32_t esphome::rtttl::Rtttl::output_freq_

protected

The frequency of the current note in Hz.

Definition at line 89 of file rtttl.h.

◆ position_

size_t esphome::rtttl::Rtttl::position_ {0}

protected

The current position in the RTTTL string.

Definition at line 76 of file rtttl.h.

◆ rtttl_

std::string esphome::rtttl::Rtttl::rtttl_ {""}

protected

The RTTTL string to play.

Definition at line 74 of file rtttl.h.

◆ sample_rate_

int esphome::rtttl::Rtttl::sample_rate_ {16000}

protected

The sample rate of the speaker.

Definition at line 104 of file rtttl.h.

◆ samples_count_

int esphome::rtttl::Rtttl::samples_count_ {0}

protected

The total number of samples to send.

Definition at line 110 of file rtttl.h.

◆ samples_gap_

int esphome::rtttl::Rtttl::samples_gap_ {0}

protected

The number of samples for the gap between notes.

Definition at line 112 of file rtttl.h.

◆ samples_per_wave_

int esphome::rtttl::Rtttl::samples_per_wave_ {0}

protected

The number of samples for one full cycle of a note's waveform, in Q10 fixed-point format.

Definition at line 106 of file rtttl.h.

◆ samples_sent_

int esphome::rtttl::Rtttl::samples_sent_ {0}

protected

The number of samples sent.

Definition at line 108 of file rtttl.h.

◆ speaker_

speaker::Speaker* esphome::rtttl::Rtttl::speaker_ {nullptr}

protected

The speaker to write the sound to.

Definition at line 102 of file rtttl.h.

◆ state_

State esphome::rtttl::Rtttl::state_ {State::STATE_STOPPED}

protected

The current state of the RTTTL player.

Definition at line 93 of file rtttl.h.

◆ wholenote_

uint16_t esphome::rtttl::Rtttl::wholenote_

protected

The duration of a whole note in milliseconds.

Definition at line 78 of file rtttl.h.

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

esphome/components/rtttl/rtttl.h
esphome/components/rtttl/rtttl.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_on_finished_playback_callback()

◆ dump_config()

◆ finish_()

◆ get_gain()

◆ get_integer_()

◆ is_playing()

◆ loop()

◆ play()

◆ set_gain()

◆ set_output()

◆ set_speaker()

◆ set_state_()

◆ stop()

Field Documentation

◆ default_duration_

◆ default_octave_

◆ gain_

◆ last_note_

◆ note_duration_

◆ on_finished_playback_callback_

◆ output_

◆ output_freq_

◆ position_

◆ rtttl_

◆ sample_rate_

◆ samples_count_

◆ samples_gap_

◆ samples_per_wave_

◆ samples_sent_

◆ speaker_

◆ state_

◆ wholenote_