specchioriflesso/USB_Host_Shield_2.0
1
Fork 0
mirror of https://github.com/felis/USB_Host_Shield_2.0.git synced 2024-03-22 11:31:26 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fixed some comments

Browse source
This commit is contained in:
Kristian Sloth Lauszus 2013-05-07 01:01:55 +02:00
parent 1dc75ae89f
commit 0e2ae2c8b7
1 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
SPP.h
View file

@ -100,6 +100,16 @@ public:
*/ */
SPP(BTD *p, const char* name = "Arduino", const char* pin = "1234"); SPP(BTD *p, const char* name = "Arduino", const char* pin = "1234");
/**
* Used to provide Boolean tests for the class.
* @return Return true if SPP communication is connected.
*/
operator bool() {
return connected;
}
/** Variable used to indicate if the connection is established. */
bool connected;
/** @name BluetoothService implementation */ /** @name BluetoothService implementation */
/** /**
* Used to pass acldata to the services. * Used to pass acldata to the services.
@ -114,9 +124,6 @@ public:
virtual void disconnect(); virtual void disconnect();
/**@}*/ /**@}*/
/** Variable used to indicate if the connection is established. */
bool connected;
/** @name Serial port profile (SPP) Print functions */ /** @name Serial port profile (SPP) Print functions */
/** /**
* Get number of bytes waiting to be read. * Get number of bytes waiting to be read.
@ -127,22 +134,22 @@ public:
virtual void flush(void); virtual void flush(void);
/** /**
* Used to read the next value in the buffer without advancing to the next one. * Used to read the next value in the buffer without advancing to the next one.
* @return Return the byte. Will return -1 if no byte is available. * @return Return the byte. Will return -1 if no bytes are available.
*/ */
virtual int peek(void); virtual int peek(void);
/** /**
* Used to read the buffer. * Used to read the buffer.
* @return Return the byte. Will return -1 if no byte is available. * @return Return the byte. Will return -1 if no bytes are available.
*/ */
virtual int read(void); virtual int read(void);
/** /**
* Writes the byte to send to a buffer. The message is send when either send(const uint8_t* data, size_t size) or after Usb.Task() is called. * Writes the byte to send to a buffer. The message is send when either send() or after Usb.Task() is called.
* @param data The byte to write. * @param data The byte to write.
* @return Return the number of bytes written. * @return Return the number of bytes written.
*/ */
virtual size_t write(uint8_t data); virtual size_t write(uint8_t data);
/** /**
* Writes the bytes to send to a buffer. The message is send when either send(const uint8_t* data, size_t size) or after Usb.Task() is called. * Writes the bytes to send to a buffer. The message is send when either send() or after Usb.Task() is called.
* @param data The data array to send. * @param data The data array to send.
* @param size Size of the data. * @param size Size of the data.
* @return Return the number of bytes written. * @return Return the number of bytes written.
@ -156,13 +163,6 @@ public:
* but can also be called via this function. * but can also be called via this function.
*/ */
void send(void); void send(void);
/**
* Used to provide Boolean tests for the class.
* @return Return true if SPP communication is connected.
*/
operator bool() {
return connected;
}
/**@}*/ /**@}*/
private: private: