add "LE Device Address" 0x1B to advertising data types
Fork of BLE_API by
Diff: ble/services/UARTService.h
- Revision:
- 1042:21a86ac7f5b1
- Parent:
- 1029:a5d0fec3b17c
- Child:
- 1053:ec4a5b9b254e
diff -r bfc5b9b6ecf5 -r 21a86ac7f5b1 ble/services/UARTService.h --- a/ble/services/UARTService.h Thu Dec 10 09:15:05 2015 +0000 +++ b/ble/services/UARTService.h Mon Jan 11 08:51:25 2016 +0000 @@ -40,12 +40,12 @@ extern const uint8_t UARTServiceRXCharacteristicUUID[UUID::LENGTH_OF_LONG_UUID]; /** -* @class UARTService. -* @brief BLE Service to enable UART over BLE. +* @class UARTService +* @brief BLE Service to enable UART over BLE */ class UARTService { public: - /**< Maximum length of data (in bytes) that the UART service module can transmit to the peer. */ + /**< Maximum length of data (in bytes) that can be transmitted by the UART service module to the peer. */ static const unsigned BLE_UART_SERVICE_MAX_DATA_LEN = (BLE_GATT_MTU_SIZE_DEFAULT - 3); public: @@ -87,20 +87,20 @@ /** * We attempt to collect bytes before pushing them to the UART RX - * characteristic; writing to the RX characteristic then generates + * characteristic--writing to the RX characteristic will then generate * notifications for the client. Updates made in quick succession to a - * notification-generating characteristic result in data being buffered - * in the Bluetooth stack as notifications are sent out. The stack has - * its limits for this buffering - typically a small number under 10. + * notification-generating characteristic will result in data being buffered + * in the bluetooth stack as notifications are sent out. The stack will have + * its limits for this buffering; typically a small number under 10. * Collecting data into the sendBuffer buffer helps mitigate the rate of * updates. But we shouldn't buffer a large amount of data before updating - * the characteristic, otherwise the client needs to turn around and make + * the characteristic otherwise the client will need to turn around and make * a long read request; this is because notifications include only the first * 20 bytes of the updated data. * - * @param buffer The received update. - * @param length Number of characters to be appended. - * @return Number of characters appended to the rxCharacteristic. + * @param buffer The received update + * @param length Amount of characters to be appended. + * @return Amount of characters appended to the rxCharacteristic. */ size_t write(const void *_buffer, size_t length) { size_t origLength = length; @@ -112,13 +112,13 @@ unsigned bytesRemainingInSendBuffer = BLE_UART_SERVICE_MAX_DATA_LEN - sendBufferIndex; unsigned bytesToCopy = (length < bytesRemainingInSendBuffer) ? length : bytesRemainingInSendBuffer; - /* Copy bytes into sendBuffer. */ + /* copy bytes into sendBuffer */ memcpy(&sendBuffer[sendBufferIndex], &buffer[bufferIndex], bytesToCopy); length -= bytesToCopy; sendBufferIndex += bytesToCopy; bufferIndex += bytesToCopy; - /* Have we collected enough? */ + /* have we collected enough? */ if ((sendBufferIndex == BLE_UART_SERVICE_MAX_DATA_LEN) || // (sendBuffer[sendBufferIndex - 1] == '\r') || (sendBuffer[sendBufferIndex - 1] == '\n')) { @@ -134,14 +134,14 @@ /** * Helper function to write out strings. * @param str The received string. - * @return Number of characters appended to the rxCharacteristic. + * @return Amount of characters appended to the rxCharacteristic. */ size_t writeString(const char *str) { return write(str, strlen(str)); } /** - * Override for Stream::_putc(). + * Override for Stream::_putc() * @param c * This function writes the character c, cast to an unsigned char, to stream. * @return @@ -152,7 +152,7 @@ } /** - * Override for Stream::_getc(). + * Override for Stream::_getc() * @return * The character read. */ @@ -168,7 +168,7 @@ /** * This callback allows the UART service to receive updates to the * txCharacteristic. The application should forward the call to this - * function from the global onDataWritten() callback handler; if that's + * function from the global onDataWritten() callback handler; or if that's * not used, this method can be used as a callback directly. */ void onDataWritten(const GattWriteCallbackParams *params) {