mbed-os
Dependents: cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more
features/FEATURE_BLE/targets/TARGET_CORDIO/README.md@0:b74591d5ab33, 2017-12-11 (annotated)
- Committer:
- be_bryan
- Date:
- Mon Dec 11 17:54:04 2017 +0000
- Revision:
- 0:b74591d5ab33
motor ++
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
be_bryan | 0:b74591d5ab33 | 1 | # BLE API Cordio Implementation |
be_bryan | 0:b74591d5ab33 | 2 | |
be_bryan | 0:b74591d5ab33 | 3 | The BLE API Cordio implementation allows Cordio licensee to easily deliver a |
be_bryan | 0:b74591d5ab33 | 4 | complete and up to date implementation of mbed BLE to their custommers using |
be_bryan | 0:b74591d5ab33 | 5 | mbed OS. |
be_bryan | 0:b74591d5ab33 | 6 | |
be_bryan | 0:b74591d5ab33 | 7 | To deliver a BLE port, vendors simply have to provide an HCI driver taillored |
be_bryan | 0:b74591d5ab33 | 8 | for the BLE module present on the board they want to support. |
be_bryan | 0:b74591d5ab33 | 9 | |
be_bryan | 0:b74591d5ab33 | 10 | ## Source Organization |
be_bryan | 0:b74591d5ab33 | 11 | |
be_bryan | 0:b74591d5ab33 | 12 | The root contains the public header of the classes implementing BLE API public |
be_bryan | 0:b74591d5ab33 | 13 | interface. |
be_bryan | 0:b74591d5ab33 | 14 | |
be_bryan | 0:b74591d5ab33 | 15 | * `doc`: Documentation such as the HCI extension guide and the |
be_bryan | 0:b74591d5ab33 | 16 | porting guide. |
be_bryan | 0:b74591d5ab33 | 17 | * `driver`: HCI driver and transport interfaces. Also contains standard driver |
be_bryan | 0:b74591d5ab33 | 18 | implementation. |
be_bryan | 0:b74591d5ab33 | 19 | * `sources`: BLE API Implementation files |
be_bryan | 0:b74591d5ab33 | 20 | * `stack`: Cordio stack |
be_bryan | 0:b74591d5ab33 | 21 | * `cordio_stack`: Headerd of the cordio stack |
be_bryan | 0:b74591d5ab33 | 22 | * `lib`: precompiled libraries of the cordio stack |
be_bryan | 0:b74591d5ab33 | 23 | * `mbed_os_adaptation`: Headers of the interface responsible for the bridge |
be_bryan | 0:b74591d5ab33 | 24 | between BLE API and the Cordio stack. |
be_bryan | 0:b74591d5ab33 | 25 | |
be_bryan | 0:b74591d5ab33 | 26 | ## Documentation |
be_bryan | 0:b74591d5ab33 | 27 | |
be_bryan | 0:b74591d5ab33 | 28 | * [HCI architecture](doc/HCIAbstraction.md) |
be_bryan | 0:b74591d5ab33 | 29 | * [Porting guide](doc/PortingGuide.md) |