ESPHome  2024.6.6
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::dfplayer::DFPlayer Class Reference

#include <dfplayer.h>

Inheritance diagram for esphome::dfplayer::DFPlayer:
esphome::uart::UARTDevice esphome::Component

Public Member Functions

void loop () override
void next ()
void previous ()
void play_mp3 (uint16_t file)
void play_file (uint16_t file)
void play_file_loop (uint16_t file)
void play_folder (uint16_t folder, uint16_t file)
void play_folder_loop (uint16_t folder)
void volume_up ()
void volume_down ()
void set_device (Device device)
void set_volume (uint8_t volume)
void set_eq (EqPreset preset)
void sleep ()
void reset ()
void start ()
void pause ()
void stop ()
void random ()
bool is_playing ()
void dump_config () override
void add_on_finished_playback_callback (std::function< void()> callback)
- Public Member Functions inherited from esphome::uart::UARTDevice
 UARTDevice ()=default
 UARTDevice (UARTComponent *parent)
void set_uart_parent (UARTComponent *parent)
void write_byte (uint8_t data)
void write_array (const uint8_t *data, size_t len)
void write_array (const std::vector< uint8_t > &data)
template<size_t N>
void write_array (const std::array< uint8_t, N > &data)
void write_str (const char *str)
bool read_byte (uint8_t *data)
bool peek_byte (uint8_t *data)
bool read_array (uint8_t *data, size_t len)
template<size_t N>
optional< std::array< uint8_t, N > > read_array ()
int available ()
void flush ()
int read ()
size_t write (uint8_t data)
int peek ()
void check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning. More...
- 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 () 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. More...
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...

Protected Member Functions

void send_cmd_ (uint8_t cmd, uint16_t argument=0)
void send_cmd_ (uint8_t cmd, uint16_t high, uint16_t low)
- 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(uint8_t)> &&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(uint8_t)> &&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

uint8_t sent_cmd_ {0}
size_t read_pos_ {0}
bool is_playing_ {false}
bool ack_set_is_playing_ {false}
bool ack_reset_is_playing_ {false}
CallbackManager< void()> on_finished_playback_callback_
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponentparent_ {nullptr}
- 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 26 of file dfplayer.h.

Member Function Documentation

◆ add_on_finished_playback_callback()

void esphome::dfplayer::DFPlayer::add_on_finished_playback_callback ( std::function< void()>  callback)

Definition at line 88 of file dfplayer.h.

◆ dump_config()

void esphome::dfplayer::DFPlayer::dump_config ( )

Reimplemented from esphome::Component.

Definition at line 131 of file dfplayer.cpp.

◆ is_playing()

bool esphome::dfplayer::DFPlayer::is_playing ( )

Definition at line 85 of file dfplayer.h.

◆ loop()

void esphome::dfplayer::DFPlayer::loop ( )

Reimplemented from esphome::Component.

Definition at line 36 of file dfplayer.cpp.

◆ next()

void esphome::dfplayer::DFPlayer::next ( )

Definition at line 30 of file dfplayer.h.

◆ pause()

void esphome::dfplayer::DFPlayer::pause ( )

Definition at line 72 of file dfplayer.h.

◆ play_file()

void esphome::dfplayer::DFPlayer::play_file ( uint16_t  file)

Definition at line 42 of file dfplayer.h.

◆ play_file_loop()

void esphome::dfplayer::DFPlayer::play_file_loop ( uint16_t  file)

Definition at line 46 of file dfplayer.h.

◆ play_folder()

void esphome::dfplayer::DFPlayer::play_folder ( uint16_t  folder,
uint16_t  file 

Definition at line 9 of file dfplayer.cpp.

◆ play_folder_loop()

void esphome::dfplayer::DFPlayer::play_folder_loop ( uint16_t  folder)

Definition at line 51 of file dfplayer.h.

◆ play_mp3()

void esphome::dfplayer::DFPlayer::play_mp3 ( uint16_t  file)

Definition at line 38 of file dfplayer.h.

◆ previous()

void esphome::dfplayer::DFPlayer::previous ( )

Definition at line 34 of file dfplayer.h.

◆ random()

void esphome::dfplayer::DFPlayer::random ( )

Definition at line 80 of file dfplayer.h.

◆ reset()

void esphome::dfplayer::DFPlayer::reset ( )

Definition at line 64 of file dfplayer.h.

◆ send_cmd_() [1/2]

void esphome::dfplayer::DFPlayer::send_cmd_ ( uint8_t  cmd,
uint16_t  argument = 0 

Definition at line 21 of file dfplayer.cpp.

◆ send_cmd_() [2/2]

void esphome::dfplayer::DFPlayer::send_cmd_ ( uint8_t  cmd,
uint16_t  high,
uint16_t  low 

Definition at line 94 of file dfplayer.h.

◆ set_device()

void esphome::dfplayer::DFPlayer::set_device ( Device  device)

Definition at line 57 of file dfplayer.h.

◆ set_eq()

void esphome::dfplayer::DFPlayer::set_eq ( EqPreset  preset)

Definition at line 59 of file dfplayer.h.

◆ set_volume()

void esphome::dfplayer::DFPlayer::set_volume ( uint8_t  volume)

Definition at line 58 of file dfplayer.h.

◆ sleep()

void esphome::dfplayer::DFPlayer::sleep ( )

Definition at line 60 of file dfplayer.h.

◆ start()

void esphome::dfplayer::DFPlayer::start ( )

Definition at line 68 of file dfplayer.h.

◆ stop()

void esphome::dfplayer::DFPlayer::stop ( )

Definition at line 76 of file dfplayer.h.

◆ volume_down()

void esphome::dfplayer::DFPlayer::volume_down ( )

Definition at line 56 of file dfplayer.h.

◆ volume_up()

void esphome::dfplayer::DFPlayer::volume_up ( )

Definition at line 55 of file dfplayer.h.

Field Documentation

◆ ack_reset_is_playing_

bool esphome::dfplayer::DFPlayer::ack_reset_is_playing_ {false}

Definition at line 104 of file dfplayer.h.

◆ ack_set_is_playing_

bool esphome::dfplayer::DFPlayer::ack_set_is_playing_ {false}

Definition at line 103 of file dfplayer.h.

◆ is_playing_

bool esphome::dfplayer::DFPlayer::is_playing_ {false}

Definition at line 102 of file dfplayer.h.

◆ on_finished_playback_callback_

CallbackManager<void()> esphome::dfplayer::DFPlayer::on_finished_playback_callback_

Definition at line 106 of file dfplayer.h.

◆ read_buffer_

char esphome::dfplayer::DFPlayer::read_buffer_[DFPLAYER_READ_BUFFER_LENGTH]

Definition at line 99 of file dfplayer.h.

◆ read_pos_

size_t esphome::dfplayer::DFPlayer::read_pos_ {0}

Definition at line 100 of file dfplayer.h.

◆ sent_cmd_

uint8_t esphome::dfplayer::DFPlayer::sent_cmd_ {0}

Definition at line 97 of file dfplayer.h.

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