BLESerialServerArduinoBLE Class Reference

A BLE server that implements a serial protocol, so that it can be used to send and receive audio. In BLE terminology this is a Peripheral. This implementation uses the ArduinoBLE library. More...

#include <BLESerialServerArduinoBLE.h>

Inheritance diagram for BLESerialServerArduinoBLE:

Collaboration diagram for BLESerialServerArduinoBLE:

Public Member Functions
	BLESerialServerArduinoBLE (int mtu=242)
	~BLESerialServerArduinoBLE ()
virtual void	addNotifyAudioChange (AudioInfoSupport &bi)
	Adds target to be notified about audio changes.
virtual AudioInfo	audioInfo () override
	provides the actual input AudioInfo
virtual AudioInfo	audioInfoOut ()
int	available () override
int	availableForWrite () override
virtual bool	begin ()
bool	begin (const char *name) override
	starts a BLE server with the indicated name
virtual void	clearNotifyAudioChange ()
	Deletes all change notify subscriptions.
bool	connected () override
	Returns true if we are connected with the other side.
void	end () override
virtual void	flush () override
bool	isNotifyActive ()
	Checks if the automatic AudioInfo update is active.
	operator bool () override
int	packetSize ()
size_t	readBytes (uint8_t *data, size_t len) override
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.
void	setAudioInfo (AudioInfo newInfo) override
void	setAudioInfoActive (bool flag)
	Activates the exchange of the audio info.
void	setAudioInfoUUID (const char *uuid)
	Defines the UUID of the audio info characteristic.
void	setFramed (bool flag)
	Keeps the write sizes: each write is one BLE packet.
void	setMTU (int mtu)
	Defines the requested MTU (must be called before begin)
void	setNotifyActive (bool flag)
	Deactivate/Reactivate automatic AudioInfo updates: (default is active)
void	setRxBufferSize (int bytes, int packets=100)
void	setRxUUID (const char *uuid)
	Defines the UUID of the characteristic which is written by the client.
void	setServiceUUID (const char *uuid)
	Defines the service UUID.
void	setTxBufferSize (int bytes, int packets=100)
void	setTxUUID (const char *uuid)
	Defines the UUID of the characteristic which is read by the client.
void	setWriteBufferSize (int size)
AudioInfo	toInfo (const uint8_t *data, size_t len)
	Converts the string from the info characteristic to the audio info.
StrView	toStr (AudioInfo info)
size_t	write (const uint8_t *data, size_t len) override
virtual size_t	write (uint8_t ch) override
virtual void	writeSilence (size_t len)
	Writes len bytes of silence (=0).

Protected Member Functions
virtual int	getMTU ()
	Effective MTU.
virtual int	not_supported (int out, const char *msg="")
void	notifyAudioChange (AudioInfo info)
void	onDisconnected ()
	Called by the implementation when the client has disconnected.
void	poll () override
	Process the BLE events (if necessary)
int	provideData (uint8_t *packet, int maxLen)
void	receiveAudioInfo (const uint8_t *data, size_t size)
	Process the audio info which was received from the other side.
void	receiveData (const uint8_t *data, size_t len)
	Called by the implementation when the client has written data.
void	refillReadBuffer ()
	Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()
void	release ()
void	setupBLEService ()
void	setupBuffers ()
void	writeAudioInfo (StrView str) override
	Provides the audio info to the other side.

Static Protected Member Functions
static int	getHeader (const uint8_t *packet, int packetLen)
	Determines the payload length from the 2 byte header.
static void	onConnectCB (BLEDevice device)
static void	onDisconnectCB (BLEDevice device)
static void	onInfoWriteCB (BLEDevice device, BLECharacteristic characteristic)
static void	onReadCB (BLEDevice device, BLECharacteristic characteristic)
	provide the next batch of data
static void	onWriteCB (BLEDevice device, BLECharacteristic characteristic)
	store the received data
static BLESerialServerArduinoBLE *&	selfBLESerialServerArduinoBLE ()
static void	setHeader (uint8_t *packet, int len)
	Copies the payload length into the 2 byte header.

Protected Attributes
int	_timeout = 10
char	audio_info_str [40]
const char *	BLE_CH1_UUID = "6e400002-b5a3-f393-e0a9-e50e24dcca9e"
const char *	BLE_CH2_UUID = "6e400003-b5a3-f393-e0a9-e50e24dcca9e"
const char *	BLE_INFO_UUID = "6e400004-b5a3-f393-e0a9-e50e24dcca9e"
const char *	BLE_SERIAL_SERVICE_UUID = "6e400001-b5a3-f393-e0a9-e50e24dcca9e"
AudioInfo	info
bool	is_audio_info_active = false
bool	is_audio_info_defined = false
bool	is_framed = false
bool	is_notify_active = true
int	max_transfer_size = 0
Vector< AudioInfoSupport * >	notify_vector
BLECharacteristic *	p_ch01_char = nullptr
BLECharacteristic *	p_ch02_char = nullptr
BLECharacteristic *	p_info_char = nullptr
BLEService *	p_service = nullptr
Vector< uint8_t >	packet {0}
int	receive_timeout_ms = 0
	max time in ms to wait for free space in the receive buffer
BLESerialPacketBuffer	rx_buffer
int	rx_buffer_size = 4096
int	rx_packet_count = 100
RingBuffer< uint8_t >	tmp_in {0}
RingBuffer< uint8_t >	tmp_out {0}
BLESerialPacketBuffer	tx_buffer
int	tx_buffer_size = 4096
int	tx_packet_count = 100
int	write_buffer_size = MAX_SINGLE_CHARS

Detailed Description

A BLE server that implements a serial protocol, so that it can be used to send and receive audio. In BLE terminology this is a Peripheral. This implementation uses the ArduinoBLE library.

The data is exchanged with the client when BLE.poll() is called: this is done automatically in readBytes(), available(), write() and availableForWrite().

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

BLESerialServerArduinoBLE()

BLESerialServerArduinoBLE ( int  mtu = 242 )

inline

~BLESerialServerArduinoBLE()

~BLESerialServerArduinoBLE ( )

inline

Member Function Documentation

addNotifyAudioChange()

virtual void addNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Adds target to be notified about audio changes.

Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.

audioInfo()

virtual AudioInfo audioInfo ( )

inlineoverridevirtualinherited

provides the actual input AudioInfo

Implements AudioInfoSupport.

Reimplemented in JupyterAudioT< T >, MozziStream, TimerCallbackAudioStream, EncodedAudioStream, PureDataStream, AdapterAudioOutputToAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and InputMerge< T >.

audioInfoOut()

virtual AudioInfo audioInfoOut ( )

inlinevirtualinherited

provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream

Reimplemented in MP3EncoderShine, PureDataStream, PWMAudioOutput< PWMDriverT >, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, ResampleStreamT< TInterpolator >, and SupportedRatesStream.

available()

int available ( )

inlineoverridevirtualinherited

Reimplemented from BaseStream.

availableForWrite()

int availableForWrite ( )

inlineoverridevirtualinherited

Reimplemented from BaseStream.

begin() [1/2]

virtual bool begin ( )

inlinevirtualinherited

Reimplemented in AudioOutputWithCallback, AudioMP34DT05, I2SCodecStream, MozziStream, PureDataStream, SPDIFOutput, VS1053Stream, WM8960Stream, AdaptiveResamplingStream, AudioLoRa, ESPNowStream, USBAudioDeviceBase, USBAudioHostBase, VBANStream, FrequencyDetectorAutoCorrelation, GoertzelStream, AudioEffectStreamT< T >, AudioEffectStream, Equalizer3BandsT< T >, Equalizer3BandsPerChannelT< T >, I2SStream, AudioTimeSourceStream, AudioStreamWrapper, TimerCallbackAudioStream, ResampleStreamT< TInterpolator >, FileLoopT< FileType >, FileLoopT< File >, EncodedAudioStream, AudioBoardStream, AudioKitStream, MiniAudioStream, PortAudioStream, StdioStream, HLSStreamT< URLStream >, NRF24Stream, ReedSolomonFEC< bytecount, additional_bytes >, AutomaticGainControlStream, MeasuringStream, QualityAnalysisStream, VolumeStream, AnalogAudioStream, AdapterAudioOutputToAudioStream, TimedStream, MemoryStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, ProgressStream, Throttle, InputMerge< T >, CallbackStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, VolumeMeter, AudioInputMonitor, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, CatStream, QueueStream< T >, QueueStream< uint8_t >, DynamicMemoryStream, Pipeline, Pipeline::ModifyingStreamAdapter, ResampleStream, SupportedRatesStream, AudioFFTBase, and EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >.

begin() [2/2]

bool begin ( const char *  name )

inlineoverridevirtual

starts a BLE server with the indicated name

Implements BLESerialServerBase.

clearNotifyAudioChange()

virtual void clearNotifyAudioChange ( )

inlinevirtualinherited

Deletes all change notify subscriptions.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

connected()

bool connected ( )

inlineoverridevirtual

Returns true if we are connected with the other side.

Implements BLESerialStream.

end()

void end ( )

inlineoverridevirtual

Implements BLESerialStream.

flush()

virtual void flush ( )

inlineoverridevirtualinherited

Reimplemented from Print.

Reimplemented in PureDataStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, ReformatBaseStream, AudioStreamWrapper, ResampleStream, EncodedAudioStream, BLESerialClientBase, URLStream, BufferedTaskStream, AutomaticGainControlStream, MeasuringStream, QualityAnalysisStream, VolumeStream, AudioEffectStreamT< T >, AudioEffectStream, Equalizer3BandsT< T >, Equalizer3BandsPerChannelT< T >, I2SStream, TimedStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, BufferedStream, FilteredStream< T, TF >, FilteredStream< int16_t, int16_t >, QueueStream< T >, QueueStream< uint8_t >, FadeStream, Pipeline::ModifyingStreamAdapter, SupportedRatesStream, and EqualizerNBands< SampleT, AccT, NUM_TAPS, NUM_BANDS >.

getHeader()

static int getHeader ( const uint8_t *  packet, int  packetLen  )

inlinestaticprotectedinherited

Determines the payload length from the 2 byte header.

getMTU()

virtual int getMTU ( )

inlineprotectedvirtualinherited

Effective MTU.

Reimplemented in BLESerialClientESP32, and BLESerialServerESP32.

isNotifyActive()

bool isNotifyActive ( )

inlineinherited

Checks if the automatic AudioInfo update is active.

not_supported()

virtual int not_supported ( int  out, const char *  msg = ""  )

inlineprotectedvirtualinherited

notifyAudioChange()

void notifyAudioChange ( AudioInfo  info )

inlineprotectedinherited

onConnectCB()

static void onConnectCB ( BLEDevice  device )

inlinestaticprotected

onDisconnectCB()

static void onDisconnectCB ( BLEDevice  device )

inlinestaticprotected

onDisconnected()

void onDisconnected ( )

inlineprotectedinherited

Called by the implementation when the client has disconnected.

onInfoWriteCB()

static void onInfoWriteCB ( BLEDevice  device, BLECharacteristic  characteristic  )

inlinestaticprotected

onReadCB()

static void onReadCB ( BLEDevice  device, BLECharacteristic  characteristic  )

inlinestaticprotected

provide the next batch of data

onWriteCB()

static void onWriteCB ( BLEDevice  device, BLECharacteristic  characteristic  )

inlinestaticprotected

store the received data

operator bool()

operator bool ( )

inlineoverridevirtualinherited

Reimplemented from AudioStream.

packetSize()

int packetSize ( )

inlineinherited

Max number of payload bytes in one BLE packet: the packets read by the client also contain the length header and a value can not be longer than 512 bytes

poll()

void poll ( )

inlineoverrideprotectedvirtual

Process the BLE events (if necessary)

Reimplemented from BLESerialServerBase.

provideData()

int provideData ( uint8_t *  packet, int  maxLen  )

inlineprotectedinherited

Called by the implementation to fill the next packet which is read by the client: the result contains the length header

readBytes()

size_t readBytes ( uint8_t *  data, size_t  len  )

inlineoverridevirtualinherited

Reimplemented from AudioStream.

readSilence()

virtual size_t readSilence ( uint8_t *  buffer, size_t  length  )

inlinevirtualinherited

Source to generate silence: just sets the buffer to 0.

receiveAudioInfo()

void receiveAudioInfo ( const uint8_t *  data, size_t  size  )

inlineprotectedinherited

Process the audio info which was received from the other side.

receiveData()

void receiveData ( const uint8_t *  data, size_t  len  )

inlineprotectedinherited

Called by the implementation when the client has written data.

refillReadBuffer()

void refillReadBuffer ( )

inlineprotectedinherited

Refill small read buffer (e.g. 8 bytes) to avoid single byte reads when calling read()

release()

void release ( )

inlineprotected

removeNotifyAudioChange()

virtual bool removeNotifyAudioChange ( AudioInfoSupport &  bi )

inlinevirtualinherited

Removes a target in order not to be notified about audio changes.

Reimplemented in RTSPClient< TcpClient, UdpSocket >.

selfBLESerialServerArduinoBLE()

static BLESerialServerArduinoBLE *& selfBLESerialServerArduinoBLE ( )

inlinestaticprotected

setAudioInfo()

void setAudioInfo ( AudioInfo  newInfo )

inlineoverridevirtualinherited

Defines the audio info and informs the other side if setAudioInfoActive(true) was called

Reimplemented from AudioStream.

setAudioInfoActive()

void setAudioInfoActive ( bool  flag )

inlineinherited

Activates the exchange of the audio info.

setAudioInfoUUID()

void setAudioInfoUUID ( const char *  uuid )

inlineinherited

Defines the UUID of the audio info characteristic.

setFramed()

void setFramed ( bool  flag )

inlineinherited

Keeps the write sizes: each write is one BLE packet.

setHeader()

static void setHeader ( uint8_t *  packet, int  len  )

inlinestaticprotectedinherited

Copies the payload length into the 2 byte header.

setMTU()

void setMTU ( int  mtu )

inlineinherited

Defines the requested MTU (must be called before begin)

setNotifyActive()

void setNotifyActive ( bool  flag )

inlineinherited

Deactivate/Reactivate automatic AudioInfo updates: (default is active)

setRxBufferSize()

void setRxBufferSize ( int  bytes, int  packets = 100  )

inlineinherited

Defines the size of the receive buffer and (in framed mode) the max number of packets: must be called before begin

setRxUUID()

void setRxUUID ( const char *  uuid )

inlineinherited

Defines the UUID of the characteristic which is written by the client.

setServiceUUID()

void setServiceUUID ( const char *  uuid )

inlineinherited

Defines the service UUID.

setTxBufferSize()

void setTxBufferSize ( int  bytes, int  packets = 100  )

inlineinherited

Defines the size of the transmit buffer and (in framed mode) the max number of packets: must be called before begin

setTxUUID()

void setTxUUID ( const char *  uuid )

inlineinherited

Defines the UUID of the characteristic which is read by the client.

setupBLEService()

void setupBLEService ( )

inlineprotected

setupBuffers()

void setupBuffers ( )

inlineprotectedinherited

setWriteBufferSize()

void setWriteBufferSize ( int  size )

inlineinherited

toInfo()

AudioInfo toInfo ( const uint8_t *  data, size_t  len  )

inlineinherited

Converts the string from the info characteristic to the audio info.

toStr()

StrView toStr ( AudioInfo  info )

inlineinherited

Converts the audio info to the string which is used in the info characteristic

write() [1/2]

size_t write ( const uint8_t *  data, size_t  len  )

inlineoverridevirtualinherited

Reimplemented from AudioStream.

write() [2/2]

virtual size_t write ( uint8_t  ch )

inlineoverridevirtualinherited

Reimplemented in MemoryStream, AudioStreamWrapper, BufferedTaskStream, RingBufferStream, BufferedStream, and URLStream.

writeAudioInfo()

void writeAudioInfo ( StrView  info )

inlineoverrideprotectedvirtual

Provides the audio info to the other side.

Implements BLESerialStream.

writeSilence()

virtual void writeSilence ( size_t  len )

inlinevirtualinherited

Writes len bytes of silence (=0).

Member Data Documentation

_timeout

int _timeout = 10

protectedinherited

audio_info_str

char audio_info_str[40]

protectedinherited

BLE_CH1_UUID

const char* BLE_CH1_UUID = "6e400002-b5a3-f393-e0a9-e50e24dcca9e"

protectedinherited

BLE_CH2_UUID

const char* BLE_CH2_UUID = "6e400003-b5a3-f393-e0a9-e50e24dcca9e"

protectedinherited

BLE_INFO_UUID

const char* BLE_INFO_UUID = "6e400004-b5a3-f393-e0a9-e50e24dcca9e"

protectedinherited

BLE_SERIAL_SERVICE_UUID

const char* BLE_SERIAL_SERVICE_UUID = "6e400001-b5a3-f393-e0a9-e50e24dcca9e"

protectedinherited

info

AudioInfo info

protectedinherited

is_audio_info_active

bool is_audio_info_active = false

protectedinherited

is_audio_info_defined

bool is_audio_info_defined = false

protectedinherited

is_framed

bool is_framed = false

protectedinherited

is_notify_active

bool is_notify_active = true

protectedinherited

max_transfer_size

int max_transfer_size = 0

protectedinherited

notify_vector

Vector<AudioInfoSupport*> notify_vector

protectedinherited

p_ch01_char

BLECharacteristic* p_ch01_char = nullptr

protected

p_ch02_char

BLECharacteristic* p_ch02_char = nullptr

protected

p_info_char

BLECharacteristic* p_info_char = nullptr

protected

p_service

BLEService* p_service = nullptr

protected

packet

Vector<uint8_t> packet {0}

protected

receive_timeout_ms

int receive_timeout_ms = 0

protectedinherited

max time in ms to wait for free space in the receive buffer

rx_buffer

BLESerialPacketBuffer rx_buffer

protectedinherited

rx_buffer_size

int rx_buffer_size = 4096

protectedinherited

rx_packet_count

int rx_packet_count = 100

protectedinherited

tmp_in

RingBuffer<uint8_t> tmp_in {0}

protectedinherited

tmp_out

RingBuffer<uint8_t> tmp_out {0}

protectedinherited

tx_buffer

BLESerialPacketBuffer tx_buffer

protectedinherited

tx_buffer_size

int tx_buffer_size = 4096

protectedinherited

tx_packet_count

int tx_packet_count = 100

protectedinherited

write_buffer_size

int write_buffer_size = MAX_SINGLE_CHARS

protectedinherited

---

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

• src/AudioTools/Communication/BLESerial/BLESerialServerArduinoBLE.h