ESPHome  2022.11.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::rtttl::Rtttl Class Reference

#include <rtttl.h>

Inheritance diagram for esphome::rtttl::Rtttl:
esphome::Component

Public Member Functions

void set_output (output::FloatOutput *output)
 
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. More...
 
virtual float get_setup_priority () const
 priority of setup(). More...
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
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. More...
 
bool is_failed ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Member Functions

uint8_t get_integer_ ()
 
- 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. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult()> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Protected Attributes

std::string rtttl_
 
size_t position_
 
uint16_t wholenote_
 
uint16_t default_duration_
 
uint16_t default_octave_
 
uint32_t last_note_
 
uint16_t note_duration_
 
uint32_t output_freq_
 
output::FloatOutputoutput_
 
CallbackManager< void()> on_finished_playback_callback_
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Detailed Description

Definition at line 10 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 23 of file rtttl.h.

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 18 of file rtttl.cpp.

◆ get_integer_()

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

Definition at line 28 of file rtttl.h.

◆ is_playing()

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

Definition at line 20 of file rtttl.h.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 88 of file rtttl.cpp.

◆ play()

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

Definition at line 20 of file rtttl.cpp.

◆ set_output()

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

Definition at line 12 of file rtttl.h.

◆ stop()

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

Definition at line 14 of file rtttl.h.

Field Documentation

◆ default_duration_

uint16_t esphome::rtttl::Rtttl::default_duration_
protected

Definition at line 39 of file rtttl.h.

◆ default_octave_

uint16_t esphome::rtttl::Rtttl::default_octave_
protected

Definition at line 40 of file rtttl.h.

◆ last_note_

uint32_t esphome::rtttl::Rtttl::last_note_
protected

Definition at line 41 of file rtttl.h.

◆ note_duration_

uint16_t esphome::rtttl::Rtttl::note_duration_
protected

Definition at line 42 of file rtttl.h.

◆ on_finished_playback_callback_

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

Definition at line 47 of file rtttl.h.

◆ output_

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

Definition at line 45 of file rtttl.h.

◆ output_freq_

uint32_t esphome::rtttl::Rtttl::output_freq_
protected

Definition at line 44 of file rtttl.h.

◆ position_

size_t esphome::rtttl::Rtttl::position_
protected

Definition at line 37 of file rtttl.h.

◆ rtttl_

std::string esphome::rtttl::Rtttl::rtttl_
protected

Definition at line 36 of file rtttl.h.

◆ wholenote_

uint16_t esphome::rtttl::Rtttl::wholenote_
protected

Definition at line 38 of file rtttl.h.


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