Commit Graph

885 Commits (51c1bd35a015590234924947bfac5facf211c822)

Author SHA1 Message Date
Martin Kojtal 82f5b58f4c
Merge pull request #5295 from pan-/GAP-platform-abstraction-layer
BLE: Gap platform abstraction layer
2017-11-09 16:54:11 +00:00
Amanda Butler 3dc28ce01b
Copy edit GattCharacteristic.h
Copy edit file.
2017-11-08 15:09:00 -06:00
Amanda Butler bdf0cbb3c9
Copy edit GapAdvertisingData.h
Copy edit file.
2017-11-08 14:58:38 -06:00
Amanda Butler 6f7f5ae57e
Copy edit GattClient.h
Make copy edits to file.
2017-11-08 14:14:04 -06:00
Amanda Butler 3a80f8b823
Copy edit Gap.h
Copy edit file.
2017-11-08 11:32:31 -06:00
Amanda Butler 6e20887724
Copy edit GattServer.h
Copy edit, mostly for consistent tense and hyphenation.
2017-11-07 17:56:44 -06:00
Amanda Butler 5178f89c8b
Copy edit GattCallbackParamTypes.h
Copy edit for active voice.
2017-11-07 17:42:40 -06:00
Amanda Butler 91fa78d980
Copy edit GapScanningParams.h
Copy edit, mostly for consistent tense across documents.
2017-11-07 17:33:16 -06:00
Amanda Butler 9052cf45c3
Copy edit GattAttribute.h
Make minor copy edits for active voice and phrasing.
2017-11-07 17:27:41 -06:00
Amanda Butler fcb50dd5c8
Copy edit ServiceDiscovery.h
Make minor copy edits, mostly for consistent tense.
2017-11-07 17:24:17 -06:00
Amanda Butler 1720a484dd
Copy edit UUID.h
Copy edit, mostly for consistent tense and consistent use of hyphens.
2017-11-07 17:00:34 -06:00
Amanda Butler 71bc3f74da
Copy edit blecommon.h
Copy edit, mostly for consistent punctuation.
2017-11-07 16:33:49 -06:00
Amanda Butler 4702ff2070
Copy edit GapAdvertisingParams.h
Make minor copy edits, mostly for active voice and comma use.
2017-11-07 16:31:09 -06:00
Amanda Butler 6e455417d3
Copy edit SafeBool.h
Make minor copy edits, mostly for nonrestrictive clauses.
2017-11-07 16:25:45 -06:00
Amanda Butler 739b59b598
Copy edit GattService.h
Change passive to active voice.
2017-11-07 16:20:36 -06:00
Amanda Butler 69a06a9f52
Copy edit GattServerEvents.h
Make minor copy edits for active voice, brevity and comma use.
2017-11-07 16:18:23 -06:00
Amanda Butler bd39a6eb75
Copy edit FunctionPointerWithContext.h
Make minor copy edits, mostly for consistent tense across documentation.
2017-11-07 16:10:29 -06:00
Amanda Butler 4bf95bc3f8
Copy edit DiscoveredService.h
Make minor copy edits, mostly for active voice and branding.
2017-11-07 15:59:37 -06:00
Amanda Butler 7a4ac93eb1
Copy edit DiscoveredCharacteristicDescriptor.h
Copy edit, mostly for active voice.
2017-11-07 15:56:05 -06:00
Amanda Butler 08ba159cf6
Copy edit DiscoveredCharacteristic.h
Make minor copy edits, mostly for active voice and American English.
2017-11-07 15:52:43 -06:00
Amanda Butler c9931f3643
Copy edit CharacteristicDescriptorDiscovery.h
Make minor copy edits, mostly for active voice.
2017-11-07 15:34:57 -06:00
Amanda Butler 0f91ea2b2a
Copy edit CallChainOfFunctionPointersWithContext.h
Make minor copy edits, mostly for typos.
2017-11-07 15:30:27 -06:00
Vincent Coubard 3cbe3918e7 BLE: Update BLE.h comments.
* processEvents: Remove reference to mbed OS 3.
* Clarify documentation of waitForEvent.
2017-11-06 14:37:58 +00:00
Jimmy Brisson a9b594b428
Merge pull request #5410 from pan-/deprecate-gap-events
BLE: Deprecate GapEvent
2017-11-02 10:44:15 -05:00
Vincent Coubard 1b7a3ffa02 BLE: Add generic GAP implementation.
Generic implementation of the GAP class. It allows porters to have a working Gap
implementation by implementing the following abstraction layer primitives:
- pal::Gap: Adaptation for GAP related primitives.
- pal::EventQueue: simple interface to the inner event queue of the stack.
  pal::SimpleEventQueue can also be used as an implementation.
- pal::GenericAccessService: Accessors to the Generic Access Service present in
  the GATT server.
2017-10-31 17:39:14 +00:00
Vincent Coubard 953739c026 BLE: Event Queue interface at the pal level.
To help generic code, an interface of an event queue at the PAL level has been
added. Implementation can either rely on the event mechanism internal to the
stack or use the SimpleEventQueue implementation provided by this patch.
2017-10-31 17:38:04 +00:00
Vincent Coubard 63668cb7d2 BLE: Add generic event filter.
This filter prevent events to be signaled multiple times to the upper layer. It
also signal events to a newly set event processor hook.
2017-10-31 17:37:05 +00:00
Vincent Coubard 0025b685ea BLE: Generic Access Service Adaptation layer
Add an abstraction which manage the state of the GAP service exposed by the GATT server.
2017-10-31 17:35:37 +00:00
Vincent Coubard 744abca8ff BLE: Adaptation interface of the GAP layer.
This interface expose the primitives needed to realize operations defined in
the GAP layer. Data types, event and function definitions follow closely HCI
commands and events defined in the Bluetooth specification.
2017-10-31 17:32:01 +00:00
Vincent Coubard 3ad3942810
BLE: Fix typos in iBeacon documentation. 2017-10-31 16:50:07 +00:00
Vincent Coubard 65bb642c81 BLE: Deprecate GapEvent
This class and its components are not used by BLE API and never been used in the
last two years.

This patch deprecate all the components in GapEvent.h and exclude its definitions
from the documentation process.
2017-10-31 16:39:24 +00:00
Amanda Butler 0042cd8751
Copy edit iBeacon.h
Make minor copy edits.
2017-10-31 11:27:23 -05:00
Vincent Coubard 5d26ea50f3 BLE: Fix conjugation and spelling of iBeacon documentation. 2017-10-31 13:19:16 +00:00
Vincent Coubard 699ad9c29c BLE: iBeacon minor edit. 2017-10-31 11:55:31 +00:00
Vincent Coubard 62e984bdb3 BLE: Update iBeacon documentation.
Provide detailled description of the purpose, general concepts and usage.
2017-10-31 11:43:16 +00:00
Amanda Butler 25ad0f3959
Copy edit BLEInstanceBase.h
Make minor copy edits.
2017-10-30 17:26:48 -05:00
Amanda Butler 96429c5212
Copy edit BLE.h
Make minor copy edits, mostly for active voice and consistent comma use across docs.
2017-10-30 14:26:55 -05:00
Amanda Butler 2038e72782
Copy edit ArrayView.h
Copy edit, mostly for active voice and agreement.
2017-10-30 11:03:15 -05:00
Vincent Coubard 3c3592a9d3 BLE: Update documentation.
Fix typos, spelling and conjugation.
2017-10-30 15:40:58 +00:00
Vincent Coubard 67b47cad87 BLE: Group GattServer documented elements 2017-10-27 14:37:57 -05:00
Vincent Coubard 1c2685c2ac BLE: Improve GattClient.h documentation. 2017-10-27 14:37:02 -05:00
Vincent Coubard 075e1dbdd9 BLE: Improve Gap.h documentation. 2017-10-27 14:35:51 -05:00
Vincent Coubard e4a097f4ee BLE: Imrpove deprecated.h documentation. 2017-10-27 14:34:51 -05:00
Vincent Coubard 7f22d25018 BLE: Improve GattServerEvents.h documentation. 2017-10-27 14:33:54 -05:00
Vincent Coubard a7b4d6accd BLE: Improve GattCallbackParamTypes.h documentation. 2017-10-27 14:32:53 -05:00
Vincent Coubard e3252da515 BLE: Improve ServiceDiscovery.h documentation. 2017-10-27 14:31:43 -05:00
Vincent Coubard a03192f625 BLE: Improve UUID.h documentation. 2017-10-27 14:30:41 -05:00
Vincent Coubard 76722fe30a BLE: Improve SafeBool.h documentation. 2017-10-27 14:29:39 -05:00
Vincent Coubard 4209e88b9e BLE: Improve GapScanningParams.h documentation. 2017-10-27 14:28:37 -05:00
Vincent Coubard 282740a1c5 BLE: Improve GapAdvertisingParams.h documentation. 2017-10-27 14:27:35 -05:00
Vincent Coubard ae7a5eef62 Update GapAdvertisingData.h 2017-10-27 14:27:09 -05:00
Vincent Coubard 95950ada43 BLE: Improve FunctionPointerWithContext.h documentation. 2017-10-27 14:26:14 -05:00
Vincent Coubard d7936e1df3 BLE: Improve DiscoveredService.h documentation. 2017-10-27 14:25:21 -05:00
Vincent Coubard b163f321ad BLE: Improve DiscoveredCharacteristicDescriptor.h documentation. 2017-10-27 14:24:21 -05:00
Vincent Coubard 9577735f7a BLE: Improve CharacteristicDescriptorDiscovery.h documentation. 2017-10-27 14:23:24 -05:00
Vincent Coubard b193f9bd64 BLE: Improce DiscoveredCharacteristic.h documentation. 2017-10-27 14:21:57 -05:00
Vincent Coubard 4a21b74685 BLE: Improve CallChainOfFunctionPointersWithContext.h documentation. 2017-10-27 12:23:43 -05:00
Vincent Coubard e0b28ea583 BLE: Update BLETypes.h documentation. 2017-10-27 12:21:43 -05:00
Vincent Coubard d0b57d7628 BLE: Update BLEProtocol documentation 2017-10-27 12:20:26 -05:00
Vincent Coubard fef7bf8bae BLE: Update BLEInstanceBase documentation. 2017-10-27 12:19:12 -05:00
Vincent Coubard c49c71ce5d BLE: Update blecommon documentation. 2017-10-27 12:16:13 -05:00
Vincent Coubard 37c26a2722 BLE: Improve BLE.h documentation.
- The class has been documented with a detailed example and explanation of its
responsabilities.
- Members have been reordered and regrouped logically.
- Deprecated annotation has been added to relevant members.
- BLE::BLE, BLE::waitForEvent has been deprecated to match with their existing
description.
2017-10-27 12:13:59 -05:00
Vincent Coubard 7254ceb01b BLE: Improve ArrayView documentation.
- Improve detailed description of the class.
- Add undefined params tparams and return documentation.
- Add pre and postcondition when valuable.
- Put the elements of the file in the ble.common group.
2017-10-27 12:11:06 -05:00
Vincent Coubard a917b90e0b BLE: Add safe Enum abstraction. 2017-10-15 16:37:38 +01:00
Akos Kiss 87a2b5bd6f Fix documentation of BLE GattCharacteristic
The constructor doc incorrectly suggested that only short (16-bit)
UUIDs were accepted. The same doc also referred to properties
instead of characteristics. (And to "value length", which seemed to
be completely out of place in the context of the current code.)
2017-10-05 11:15:30 +02:00
Jimmy Brisson f0a10750d7 Merge pull request #4990 from akosthekiss/ble-uart-flush
Add flush to the BLE UART Service
2017-09-28 14:01:15 -05:00
Vincent Coubard aa0b5d5a22 BLE: Fix space 2017-09-26 15:20:16 +01:00
Vincent Coubard 512dd8c387 BLE: Add collection of basic BLE types shared accross all layers. 2017-09-26 15:20:15 +01:00
Vincent Coubard daaa5b1977 BLE: Introduce GenericGattClient and platform abstraction over ATT/GATT.
This changes introduce a platform adaptation over ATT/GATT that can be implemented by porter.
Unlike the GattClient interface, the ATT/GATT adaptation is simple, follow closely the Bluetooth specification and won't change over time.
Implementation of the GattClient interface is realized by the class GenericGattClient which accept in input a pal::GattClient.

This change will also free design space once adopted by partners, addition to the GattClient interface won't require partner support.
2017-09-26 15:20:15 +01:00
Vincent Coubard 38bb6b4e52 BLE: Add error code management in Gatt read and write data structures.
Also fix wrong usage of designed initializer in CPP files.
2017-09-26 15:20:15 +01:00
Vincent Coubard 1fd953e33c BLE: Use shared type ble_attribute_handle_t in GattAttribute. 2017-09-26 15:20:15 +01:00
Vincent Coubard 4416ef6233 BLE: Add optionnal error_code CharacteristicDescriptorDiscovery::TerminationCallbackParams_t 2017-09-26 15:20:15 +01:00
Vincent Coubard 97995b8de9 BLE: Fix header inclusion of DiscoveredCharacteristicDescriptor. 2017-09-26 15:20:14 +01:00
Vincent Coubard c022c4a8f0 BLE: use common type ble::connection_handle_t as Handle_t. 2017-09-26 15:20:14 +01:00
Vincent Coubard dd303b7a91 BLE: Add ArrayView in utilities. 2017-09-26 15:20:14 +01:00
Vincent Coubard c58d7de93d BLE: Fix GattClient destructor by adding a virtual specifier. 2017-09-26 15:20:14 +01:00
Akos Kiss 90b326a664 Fix BLE API docs
Some misguidances, some typos, some stylistics, some doxygen misuses.
2017-08-30 11:15:39 +02:00
Akos Kiss 8035ddc36c Add flush to the BLE UART Service
If only buffer-full events and LF characters trigger the flush of
the send buffer then only line-based communication can be
implemented over the BLE UART Service. This patch extends the
service API by adding an explicit `flush` method to force sending
the buffer contents, thus enabling protocols with short (e.g.,
single character) messages.
2017-08-29 18:53:21 +02:00
Jimmy Brisson 17d5356dbb Merge pull request #4800 from Nodraak/fix/4799_ble_infinite_calling_loop
Fix infinite calling loop
2017-07-27 09:46:57 -05:00
Adrien Chardon 2a39019766 Fix infinite calling loop 2017-07-24 14:18:21 +02:00
Adrien Chardon 27901f24b9 BLE/GattCharacteristic: Add explanatory note for a parameter 2017-07-04 15:10:48 +02:00
Adrien Chardon 05c3ddf691 BLE/HRS: Fix #4661 2017-07-04 15:10:20 +02:00
Bartek Szatkowski b793a3fb89 Update codebase for CMSIS5/RTX5
Update all of mbed-os to use RTX5.
2017-05-30 18:55:52 +01:00
Vincent Coubard f490474bf2 BLE - Add end of line to deprecate.h 2016-09-26 13:29:07 +01:00
Vincent Coubard 2259e0d539 Move ARMmbed/feature/FEATURE_BLE into mbedmicro/mbed.
In the process, the path has been shortened and the unecessary ble
directory between FEATURE_BLE and the actual implementation has been
removed.

commit id of ARMmbed : 17728a824c7273e16b6b74fae871e2997c88ecd1
2016-07-20 22:10:36 +01:00