Improve readability with getHandle inline
Fork of BLE_API by
services/UARTService.h@198:933961a2ac6f, 2014-11-28 (annotated)
- Committer:
- rgrover1
- Date:
- Fri Nov 28 14:11:25 2014 +0000
- Revision:
- 198:933961a2ac6f
- Parent:
- 197:5551036f054b
- Child:
- 199:6b57874115f6
Synchronized with git rev 1c37781d
Author: Rohit Grover
Release 0.2.5
=============
Features
~~~~~~~~
* Introduce the URIBeacon2 service.
* Add helper API Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(); this can then be
used in calls to setAdvertisingInterval().
* Remove Stream as a base class for UARTService. Instantiating Stream() was
causing the C library to initialize the serial console UART implicitly;
which caused a constant drain of around 1mA. This change means that we can
no longer benefit from the APIs offered by Stream, and we can no longer re-
target STDOUT to UARTService like before; but that's not worth losing 1mA.
* Remove some un-necessary header files from BLEDevice.h.
Bugfixes
~~~~~~~~
Compatibility
~~~~~~~~~~~~~
This release is backward compatible with 0.2.4.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
Rohit Grover |
118:620d28e7a1ba | 1 | /* mbed Microcontroller Library |
Rohit Grover |
118:620d28e7a1ba | 2 | * Copyright (c) 2006-2013 ARM Limited |
Rohit Grover |
118:620d28e7a1ba | 3 | * |
Rohit Grover |
118:620d28e7a1ba | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
Rohit Grover |
118:620d28e7a1ba | 5 | * you may not use this file except in compliance with the License. |
Rohit Grover |
118:620d28e7a1ba | 6 | * You may obtain a copy of the License at |
Rohit Grover |
118:620d28e7a1ba | 7 | * |
Rohit Grover |
118:620d28e7a1ba | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
Rohit Grover |
118:620d28e7a1ba | 9 | * |
Rohit Grover |
118:620d28e7a1ba | 10 | * Unless required by applicable law or agreed to in writing, software |
Rohit Grover |
118:620d28e7a1ba | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
Rohit Grover |
118:620d28e7a1ba | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
Rohit Grover |
118:620d28e7a1ba | 13 | * See the License for the specific language governing permissions and |
Rohit Grover |
118:620d28e7a1ba | 14 | * limitations under the License. |
Rohit Grover |
118:620d28e7a1ba | 15 | */ |
Rohit Grover |
118:620d28e7a1ba | 16 | |
Rohit Grover |
118:620d28e7a1ba | 17 | #ifndef __BLE_UART_SERVICE_H__ |
Rohit Grover |
118:620d28e7a1ba | 18 | #define __BLE_UART_SERVICE_H__ |
Rohit Grover |
118:620d28e7a1ba | 19 | |
rgrover1 | 198:933961a2ac6f | 20 | #include "mbed.h" |
Rohit Grover |
118:620d28e7a1ba | 21 | #include "Stream.h" |
Rohit Grover |
118:620d28e7a1ba | 22 | |
Rohit Grover |
118:620d28e7a1ba | 23 | #include "UUID.h" |
Rohit Grover |
118:620d28e7a1ba | 24 | #include "BLEDevice.h" |
Rohit Grover |
118:620d28e7a1ba | 25 | |
Rohit Grover |
118:620d28e7a1ba | 26 | extern const uint8_t UARTServiceBaseUUID[LENGTH_OF_LONG_UUID]; |
Rohit Grover |
118:620d28e7a1ba | 27 | extern const uint16_t UARTServiceShortUUID; |
Rohit Grover |
118:620d28e7a1ba | 28 | extern const uint16_t UARTServiceTXCharacteristicShortUUID; |
Rohit Grover |
118:620d28e7a1ba | 29 | extern const uint16_t UARTServiceRXCharacteristicShortUUID; |
Rohit Grover |
118:620d28e7a1ba | 30 | |
Rohit Grover |
118:620d28e7a1ba | 31 | extern const uint8_t UARTServiceUUID[LENGTH_OF_LONG_UUID]; |
Rohit Grover |
118:620d28e7a1ba | 32 | extern const uint8_t UARTServiceUUID_reversed[LENGTH_OF_LONG_UUID]; |
Rohit Grover |
118:620d28e7a1ba | 33 | |
Rohit Grover |
118:620d28e7a1ba | 34 | extern const uint8_t UARTServiceTXCharacteristicUUID[LENGTH_OF_LONG_UUID]; |
Rohit Grover |
118:620d28e7a1ba | 35 | extern const uint8_t UARTServiceRXCharacteristicUUID[LENGTH_OF_LONG_UUID]; |
Rohit Grover |
118:620d28e7a1ba | 36 | |
rgrover1 | 197:5551036f054b | 37 | class UARTService { |
Rohit Grover |
118:620d28e7a1ba | 38 | public: |
Rohit Grover |
118:620d28e7a1ba | 39 | /**< Maximum length of data (in bytes) that can be transmitted by the UART service module to the peer. */ |
rgrover1 | 197:5551036f054b | 40 | static const unsigned GATT_MTU_SIZE_DEFAULT = 23; |
Rohit Grover |
118:620d28e7a1ba | 41 | static const unsigned BLE_UART_SERVICE_MAX_DATA_LEN = (GATT_MTU_SIZE_DEFAULT - 3); |
Rohit Grover |
118:620d28e7a1ba | 42 | |
Rohit Grover |
118:620d28e7a1ba | 43 | public: |
Rohit Grover |
118:620d28e7a1ba | 44 | UARTService(BLEDevice &_ble) : |
Rohit Grover |
118:620d28e7a1ba | 45 | ble(_ble), |
Rohit Grover |
118:620d28e7a1ba | 46 | receiveBuffer(), |
Rohit Grover |
118:620d28e7a1ba | 47 | sendBuffer(), |
Rohit Grover |
118:620d28e7a1ba | 48 | sendBufferIndex(0), |
Rohit Grover |
118:620d28e7a1ba | 49 | numBytesReceived(0), |
Rohit Grover |
118:620d28e7a1ba | 50 | receiveBufferIndex(0), |
Rohit Grover |
118:620d28e7a1ba | 51 | txCharacteristic(UARTServiceTXCharacteristicUUID, receiveBuffer, 1, BLE_UART_SERVICE_MAX_DATA_LEN, |
Rohit Grover |
118:620d28e7a1ba | 52 | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE_WITHOUT_RESPONSE), |
Rohit Grover |
118:620d28e7a1ba | 53 | rxCharacteristic(UARTServiceRXCharacteristicUUID, sendBuffer, 1, BLE_UART_SERVICE_MAX_DATA_LEN, GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_NOTIFY) { |
Rohit Grover |
118:620d28e7a1ba | 54 | GattCharacteristic *charTable[] = {&txCharacteristic, &rxCharacteristic}; |
Rohit Grover |
118:620d28e7a1ba | 55 | GattService uartService(UARTServiceUUID, charTable, sizeof(charTable) / sizeof(GattCharacteristic *)); |
Rohit Grover |
118:620d28e7a1ba | 56 | |
Rohit Grover |
118:620d28e7a1ba | 57 | ble.addService(uartService); |
Rohit Grover |
118:620d28e7a1ba | 58 | ble.onDataWritten(this, &UARTService::onDataWritten); |
Rohit Grover |
118:620d28e7a1ba | 59 | } |
Rohit Grover |
118:620d28e7a1ba | 60 | |
Rohit Grover |
118:620d28e7a1ba | 61 | /** |
Rohit Grover |
118:620d28e7a1ba | 62 | * Note: TX and RX characteristics are to be interpreted from the viewpoint of the GATT client using this service. |
Rohit Grover |
118:620d28e7a1ba | 63 | */ |
Rohit Grover |
118:620d28e7a1ba | 64 | uint16_t getTXCharacteristicHandle() { |
Rohit Grover |
118:620d28e7a1ba | 65 | return txCharacteristic.getValueAttribute().getHandle(); |
Rohit Grover |
118:620d28e7a1ba | 66 | } |
Rohit Grover |
118:620d28e7a1ba | 67 | |
Rohit Grover |
118:620d28e7a1ba | 68 | /** |
Rohit Grover |
118:620d28e7a1ba | 69 | * Note: TX and RX characteristics are to be interpreted from the viewpoint of the GATT client using this service. |
Rohit Grover |
118:620d28e7a1ba | 70 | */ |
Rohit Grover |
118:620d28e7a1ba | 71 | uint16_t getRXCharacteristicHandle() { |
Rohit Grover |
118:620d28e7a1ba | 72 | return rxCharacteristic.getValueAttribute().getHandle(); |
Rohit Grover |
118:620d28e7a1ba | 73 | } |
Rohit Grover |
118:620d28e7a1ba | 74 | |
Rohit Grover |
118:620d28e7a1ba | 75 | /** |
Rohit Grover |
118:620d28e7a1ba | 76 | * Override for Stream::write(). |
Rohit Grover |
118:620d28e7a1ba | 77 | * |
Rohit Grover |
118:620d28e7a1ba | 78 | * We attempt to collect bytes before pushing them to the UART RX |
Rohit Grover |
118:620d28e7a1ba | 79 | * characteristic--writing to the RX characteristic will then generate |
Rohit Grover |
118:620d28e7a1ba | 80 | * notifications for the client. Updates made in quick succession to a |
Rohit Grover |
118:620d28e7a1ba | 81 | * notification-generating characteristic will result in data being buffered |
Rohit Grover |
118:620d28e7a1ba | 82 | * in the bluetooth stack as notifications are sent out. The stack will have |
Rohit Grover |
118:620d28e7a1ba | 83 | * its limits for this buffering; typically a small number under 10. |
Rohit Grover |
118:620d28e7a1ba | 84 | * Collecting data into the sendBuffer buffer helps mitigate the rate of |
Rohit Grover |
118:620d28e7a1ba | 85 | * updates. But we shouldn't buffer a large amount of data before updating |
Rohit Grover |
118:620d28e7a1ba | 86 | * the characteristic otherwise the client will need to turn around and make |
Rohit Grover |
118:620d28e7a1ba | 87 | * a long read request; this is because notifications include only the first |
Rohit Grover |
118:620d28e7a1ba | 88 | * 20 bytes of the updated data. |
Rohit Grover |
118:620d28e7a1ba | 89 | * |
Rohit Grover |
118:620d28e7a1ba | 90 | * @param buffer The received update |
Rohit Grover |
118:620d28e7a1ba | 91 | * @param length Amount of characters to be appended. |
Rohit Grover |
118:620d28e7a1ba | 92 | * @return Amount of characters appended to the rxCharacteristic. |
Rohit Grover |
118:620d28e7a1ba | 93 | */ |
rgrover1 | 197:5551036f054b | 94 | ssize_t write(const void* _buffer, size_t length) { |
Rohit Grover |
118:620d28e7a1ba | 95 | size_t origLength = length; |
Rohit Grover |
118:620d28e7a1ba | 96 | const uint8_t *buffer = static_cast<const uint8_t *>(_buffer); |
Rohit Grover |
118:620d28e7a1ba | 97 | |
Rohit Grover |
118:620d28e7a1ba | 98 | if (ble.getGapState().connected) { |
Rohit Grover |
118:620d28e7a1ba | 99 | unsigned bufferIndex = 0; |
Rohit Grover |
118:620d28e7a1ba | 100 | while (length) { |
Rohit Grover |
118:620d28e7a1ba | 101 | unsigned bytesRemainingInSendBuffer = BLE_UART_SERVICE_MAX_DATA_LEN - sendBufferIndex; |
Rohit Grover |
118:620d28e7a1ba | 102 | unsigned bytesToCopy = (length < bytesRemainingInSendBuffer) ? length : bytesRemainingInSendBuffer; |
Rohit Grover |
118:620d28e7a1ba | 103 | |
Rohit Grover |
118:620d28e7a1ba | 104 | /* copy bytes into sendBuffer */ |
Rohit Grover |
118:620d28e7a1ba | 105 | memcpy(&sendBuffer[sendBufferIndex], &buffer[bufferIndex], bytesToCopy); |
Rohit Grover |
118:620d28e7a1ba | 106 | length -= bytesToCopy; |
Rohit Grover |
118:620d28e7a1ba | 107 | sendBufferIndex += bytesToCopy; |
Rohit Grover |
118:620d28e7a1ba | 108 | bufferIndex += bytesToCopy; |
Rohit Grover |
118:620d28e7a1ba | 109 | |
Rohit Grover |
118:620d28e7a1ba | 110 | /* have we collected enough? */ |
Rohit Grover |
118:620d28e7a1ba | 111 | if ((sendBufferIndex == BLE_UART_SERVICE_MAX_DATA_LEN) || |
Rohit Grover |
118:620d28e7a1ba | 112 | // (sendBuffer[sendBufferIndex - 1] == '\r') || |
Rohit Grover |
118:620d28e7a1ba | 113 | (sendBuffer[sendBufferIndex - 1] == '\n')) { |
Rohit Grover |
118:620d28e7a1ba | 114 | ble.updateCharacteristicValue(getRXCharacteristicHandle(), static_cast<const uint8_t *>(sendBuffer), sendBufferIndex); |
Rohit Grover |
118:620d28e7a1ba | 115 | sendBufferIndex = 0; |
Rohit Grover |
118:620d28e7a1ba | 116 | } |
Rohit Grover |
118:620d28e7a1ba | 117 | } |
Rohit Grover |
118:620d28e7a1ba | 118 | } |
Rohit Grover |
118:620d28e7a1ba | 119 | |
Rohit Grover |
118:620d28e7a1ba | 120 | return origLength; |
Rohit Grover |
118:620d28e7a1ba | 121 | } |
Rohit Grover |
118:620d28e7a1ba | 122 | |
Rohit Grover |
118:620d28e7a1ba | 123 | /** |
Rohit Grover |
118:620d28e7a1ba | 124 | * Override for Stream::_putc() |
Rohit Grover |
118:620d28e7a1ba | 125 | * @param c |
Rohit Grover |
118:620d28e7a1ba | 126 | * This function writes the character c, cast to an unsigned char, to stream. |
Rohit Grover |
118:620d28e7a1ba | 127 | * @return |
Rohit Grover |
118:620d28e7a1ba | 128 | * The character written as an unsigned char cast to an int or EOF on error. |
Rohit Grover |
118:620d28e7a1ba | 129 | */ |
rgrover1 | 197:5551036f054b | 130 | int _putc(int c) { |
Rohit Grover |
118:620d28e7a1ba | 131 | return (write(&c, 1) == 1) ? 1 : EOF; |
Rohit Grover |
118:620d28e7a1ba | 132 | } |
Rohit Grover |
118:620d28e7a1ba | 133 | |
rgrover1 | 197:5551036f054b | 134 | int _getc() { |
Rohit Grover |
118:620d28e7a1ba | 135 | if (receiveBufferIndex == numBytesReceived) { |
Rohit Grover |
118:620d28e7a1ba | 136 | return EOF; |
Rohit Grover |
118:620d28e7a1ba | 137 | } |
Rohit Grover |
118:620d28e7a1ba | 138 | |
Rohit Grover |
118:620d28e7a1ba | 139 | return receiveBuffer[receiveBufferIndex++]; |
Rohit Grover |
118:620d28e7a1ba | 140 | } |
Rohit Grover |
118:620d28e7a1ba | 141 | |
rgrover1 | 197:5551036f054b | 142 | private: |
rgrover1 | 197:5551036f054b | 143 | /** |
rgrover1 | 197:5551036f054b | 144 | * This callback allows the UART service to receive updates to the |
rgrover1 | 197:5551036f054b | 145 | * txCharacteristic. The application should forward the call to this |
rgrover1 | 197:5551036f054b | 146 | * function from the global onDataWritten() callback handler; or if that's |
rgrover1 | 197:5551036f054b | 147 | * not used, this method can be used as a callback directly. |
rgrover1 | 197:5551036f054b | 148 | */ |
rgrover1 | 197:5551036f054b | 149 | void onDataWritten(const GattCharacteristicWriteCBParams *params) { |
rgrover1 | 197:5551036f054b | 150 | if (params->charHandle == getTXCharacteristicHandle()) { |
rgrover1 | 197:5551036f054b | 151 | uint16_t bytesRead = params->len; |
rgrover1 | 197:5551036f054b | 152 | if (bytesRead <= BLE_UART_SERVICE_MAX_DATA_LEN) { |
rgrover1 | 197:5551036f054b | 153 | numBytesReceived = bytesRead; |
rgrover1 | 197:5551036f054b | 154 | receiveBufferIndex = 0; |
rgrover1 | 197:5551036f054b | 155 | memcpy(receiveBuffer, params->data, numBytesReceived); |
rgrover1 | 197:5551036f054b | 156 | } |
rgrover1 | 197:5551036f054b | 157 | } |
Rohit Grover |
118:620d28e7a1ba | 158 | } |
Rohit Grover |
118:620d28e7a1ba | 159 | |
Rohit Grover |
118:620d28e7a1ba | 160 | private: |
Rohit Grover |
118:620d28e7a1ba | 161 | BLEDevice &ble; |
Rohit Grover |
118:620d28e7a1ba | 162 | |
Rohit Grover |
118:620d28e7a1ba | 163 | uint8_t receiveBuffer[BLE_UART_SERVICE_MAX_DATA_LEN]; /**< The local buffer into which we receive |
Rohit Grover |
118:620d28e7a1ba | 164 | * inbound data before forwarding it to the |
Rohit Grover |
118:620d28e7a1ba | 165 | * application. */ |
Rohit Grover |
118:620d28e7a1ba | 166 | |
Rohit Grover |
118:620d28e7a1ba | 167 | uint8_t sendBuffer[BLE_UART_SERVICE_MAX_DATA_LEN]; /**< The local buffer into which outbound data is |
Rohit Grover |
118:620d28e7a1ba | 168 | * accumulated before being pushed to the |
Rohit Grover |
118:620d28e7a1ba | 169 | * rxCharacteristic. */ |
Rohit Grover |
118:620d28e7a1ba | 170 | uint8_t sendBufferIndex; |
Rohit Grover |
118:620d28e7a1ba | 171 | uint8_t numBytesReceived; |
Rohit Grover |
118:620d28e7a1ba | 172 | uint8_t receiveBufferIndex; |
Rohit Grover |
118:620d28e7a1ba | 173 | |
Rohit Grover |
118:620d28e7a1ba | 174 | GattCharacteristic txCharacteristic; /**< From the point of view of the external client, this is the characteristic |
Rohit Grover |
118:620d28e7a1ba | 175 | * they'd write into in order to communicate with this application. */ |
Rohit Grover |
118:620d28e7a1ba | 176 | GattCharacteristic rxCharacteristic; /**< From the point of view of the external client, this is the characteristic |
Rohit Grover |
118:620d28e7a1ba | 177 | * they'd read from in order to receive the bytes transmitted by this |
Rohit Grover |
118:620d28e7a1ba | 178 | * application. */ |
Rohit Grover |
118:620d28e7a1ba | 179 | }; |
Rohit Grover |
118:620d28e7a1ba | 180 | |
Rohit Grover |
118:620d28e7a1ba | 181 | #endif /* #ifndef __BLE_UART_SERVICE_H__*/ |