arduino-audio-tools
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
ESPNowStream Class Reference

ESPNow as Arduino Stream. More...

#include <ESPNowStream.h>

Inheritance diagram for ESPNowStream:
AudioStream Stream AudioInfoSupport AudioInfoSource Print

Public Member Functions

virtual void addNotifyAudioChange (AudioInfoSupport &bi)
 Adds target to be notified about audio changes.
 
bool addPeer (const char *address)
 Adds a peer to which we can send info or from which we can receive info.
 
bool addPeer (esp_now_peer_info_t &peer)
 Adds a peer to which we can send info or from which we can receive info.
 
template<size_t size>
bool addPeers (const char *(&array)[size])
 Adds an array of.
 
virtual AudioInfo audioInfo () override
 provides the actual input AudioInfo
 
virtual AudioInfo audioInfoOut ()
 provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
 
int available () override
 
int availableForWrite () override
 
bool begin ()
 Initialization of ESPNow.
 
bool begin (ESPNowStreamConfig cfg)
 Initialization of ESPNow incl WIFI.
 
virtual void clearNotifyAudioChange ()
 Deletes all change notify subscriptions.
 
ESPNowStreamConfig defaultConfig ()
 
void end ()
 DeInitialization.
 
virtual void flush () override
 
bool isNotifyActive ()
 Checks if the automatic AudioInfo update is active.
 
const char * macAddress ()
 Returns the mac address of the current ESP32.
 
 operator bool ()
 
size_t readBytes (uint8_t *data, size_t len) override
 Reeds the data from the peers.
 
virtual size_t readSilence (uint8_t *buffer, size_t length)
 Source to generate silence: just sets the buffer to 0.
 
virtual bool removeNotifyAudioChange (AudioInfoSupport &bi)
 Removes a target in order not to be notified about audio changes.
 
virtual void setAudioInfo (AudioInfo newInfo) override
 Defines the input AudioInfo.
 
void setNotifyActive (bool flag)
 Deactivate/Reactivate automatic AudioInfo updates: (default is active)
 
void setReceiveCallback (esp_now_recv_cb_t cb)
 
void setSendCallback (esp_now_send_cb_t cb)
 Defines an alternative send callback.
 
size_t write (const uint8_t *data, size_t len) override
 Writes the data - sends it to all the peers.
 
virtual size_t write (uint8_t ch) override
 
virtual void writeSilence (size_t len)
 Writes len bytes of silence (=0).
 

Protected Member Functions

wifi_interface_t getInterface ()
 
bool isEncrypted ()
 
const char * mac2str (const uint8_t *array)
 
virtual int not_supported (int out, const char *msg="")
 
void notifyAudioChange (AudioInfo info)
 
void refillReadBuffer ()
 
void resetAvailableToWrite ()
 
bool setup ()
 Initialization.
 
void setupReceiveBuffer ()
 
bool str2mac (const char *mac, uint8_t *values)
 

Static Protected Member Functions

static int bufferAvailableForWrite ()
 
static void default_recv_cb (const esp_now_recv_info *info, const uint8_t *data, int data_len)
 
static void default_send_cb (const uint8_t *mac_addr, esp_now_send_status_t status)
 

Protected Attributes

int _timeout = 10
 
volatile size_t available_to_write
 
ESPNowStreamConfig cfg
 
AudioInfo info
 
bool is_init = false
 
bool is_notify_active = true
 
bool is_write_ok = false
 
Vector< AudioInfoSupport * > notify_vector
 
BaseBuffer< uint8_t > * p_buffer = nullptr
 
esp_now_recv_cb_t receive = default_recv_cb
 
esp_now_send_cb_t send = default_send_cb
 
RingBuffer< uint8_t > tmp_in {0}
 
RingBuffer< uint8_t > tmp_out {0}
 
_lock_t write_lock
 

Detailed Description

ESPNow as Arduino Stream.

Author
Phil Schatzmann

Member Function Documentation

◆ setReceiveCallback()

void setReceiveCallback ( esp_now_recv_cb_t  cb)
inline

Defines the Receive Callback - Deactivates the readBytes and available() methods!


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