SPP Class Reference

#include <SPP.h>

Inheritance diagram for SPP:

Collaboration diagram for SPP:

Public Member Functions
	SPP (BTD *p, const char *name="Arduino", const char *pin="0000")
	operator bool ()
BluetoothService implementation
virtual void	ACLData (uint8_t *ACLData)
virtual void	Run ()
virtual void	Reset ()
virtual void	disconnect ()
Serial port profile (SPP) Print functions
virtual int	available (void)
virtual void	flush (void)
virtual int	peek (void)
virtual int	read (void)
virtual size_t	write (uint8_t data)
virtual size_t	write (const uint8_t *data, size_t size)
void	discard (void)
void	send (void)

Public Attributes
bool	connected

Detailed Description

This BluetoothService class implements the Serial Port Protocol (SPP). It inherits the Arduino Stream class. This allows it to use all the standard Arduino print and stream functions.

Definition at line 61 of file SPP.h.

Constructor & Destructor Documentation

SPP::SPP	(	BTD *	p,
		const char *	name = "Arduino",
		const char *	pin = "0000"
	)

Constructor for the SPP class.

Parameters

p	Pointer to BTD class instance.
name	Set the name to BTD::btdName. If argument is omitted, then "Arduino" will be used.
pin	Write the pin to BTD::btdPin. If argument is omitted, then "0000" will be used.

Definition at line 45 of file SPP.cpp.

Member Function Documentation

SPP::operator bool ( )

inline

Used to provide Boolean tests for the class.

Returns

Return true if SPP communication is connected.

Definition at line 75 of file SPP.h.

void SPP::ACLData ( uint8_t *  ACLData )

virtual

Used to pass acldata to the services.

Parameters

ACLData

Incoming acldata.

Reimplemented from BluetoothService.

Definition at line 86 of file SPP.cpp.

void SPP::Run ( )

virtual

Used to establish the connection automatically.

Reimplemented from BluetoothService.

Definition at line 428 of file SPP.cpp.

void SPP::Reset ( )

virtual

Use this to reset the service.

Reimplemented from BluetoothService.

Definition at line 63 of file SPP.cpp.

void SPP::disconnect ( )

virtual

Used this to disconnect the virtual serial port.

Reimplemented from BluetoothService.

Definition at line 74 of file SPP.cpp.

int SPP::available ( void  )

virtual

Get number of bytes waiting to be read.

Returns

Return the number of bytes ready to be read.

Definition at line 783 of file SPP.cpp.

virtual void SPP::flush ( void  )

inlinevirtual

Send out all bytes in the buffer.

Definition at line 103 of file SPP.h.

int SPP::peek ( void  )

virtual

Used to read the next value in the buffer without advancing to the next one.

Returns

Return the byte. Will return -1 if no bytes are available.

Definition at line 791 of file SPP.cpp.

int SPP::read ( void  )

virtual

Used to read the buffer.

Returns

Return the byte. Will return -1 if no bytes are available.

Definition at line 797 of file SPP.cpp.

size_t SPP::write ( uint8_t  data )

virtual

Writes the byte to send to a buffer. The message is send when either send() or after Usb.Task() is called.

Parameters

data	The byte to write.

Returns

Return the number of bytes written.

Definition at line 728 of file SPP.cpp.

size_t SPP::write ( const uint8_t *  data, size_t  size  )

virtual

Writes the bytes to send to a buffer. The message is send when either send() or after Usb.Task() is called.

Parameters

data	The data array to send.
size	Size of the data.

Returns

Return the number of bytes written.

Definition at line 740 of file SPP.cpp.

void SPP::discard

(

void

)

Discard all the bytes in the buffer.

Definition at line 787 of file SPP.cpp.

void SPP::send

(

void

)

This will send all the bytes in the buffer. This is called whenever Usb.Task() is called, but can also be called via this function.

Definition at line 755 of file SPP.cpp.

Member Data Documentation

bool SPP::connected

Variable used to indicate if the connection is established.

Definition at line 79 of file SPP.h.

---

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

• SPP.h
• SPP.cpp