Doc updates for 2.2.1 release

TexasInstruments · Nov 17, 2016 · b4c3afb · b4c3afb
1 parent 8b7d0a1
commit b4c3afb
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -59,69 +59,73 @@ The following examples are currently supported:
 ### beacon\_rfdriver
 &nbsp;&nbsp;&nbsp;&nbsp;Send BLE advertisements directly using the RF driver
 
-&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/beacon_rfdriver.md) | [Launchpad project files](examples/cc2650lp/beacon_rfdriver) | [src](src/examples/beacon_rfdriver)
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/beacon_rfdriver.md) | [project files](examples/cc2650lp/beacon_rfdriver) | [src](src/examples/beacon_rfdriver)
 
 ### hid\_adv\_remote\_privacy
 &nbsp;&nbsp;&nbsp;&nbsp;Taking the BLE SDK HID advanced remote example and enableing Privacy 1.2
 
-&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/hid_adv_remote_privacy.md) | [CC2650RC project files](examples/cc2650rc/hid_adv_remote_privacy) | [src](src/examples/hid_adv_remote_privacy)
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/hid_adv_remote_privacy.md) | [project files](examples/cc2650rc/hid_adv_remote_privacy) | [src](src/examples/hid_adv_remote_privacy)
 
 ### hid\_emu\_kbd
 &nbsp;&nbsp;&nbsp;&nbsp;Emulate emulate a HID keyboard using the LaunchPad
 
-&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/hid_emu_kbd.md) | [Launchpad project files](examples/cc2650lp/hid_emu_kbd) | [src](src/examples/hid_emu_kbd)
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/hid_emu_kbd.md) | [project files](examples/cc2650lp/hid_emu_kbd) | [src](src/examples/hid_emu_kbd)
 
 ### multi\_role
-&nbsp;&nbsp;&nbsp;&nbsp;Implement multiple GAP roles on a single device. Note there are both LaunchPad and EM versions of this demo.
+&nbsp;&nbsp;&nbsp;&nbsp;Implement multiple GAP roles on a single device.
 
-&nbsp;&nbsp;&nbsp;&nbsp;[EM docs](docs/multi_role.md) | [LaunchPad docs](docs/multi_role_lp.md) | [EM project files](examples/cc2650em/multi_role) | [LP project files](examples/cc2650lp/multi_role) | [src](src/examples/multi_role)
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/multi_role.md) | [project files](examples/cc2650lp/multi_role) | [src](src/examples/multi_role)
 
 ### security\_examples
 &nbsp;&nbsp;&nbsp;&nbsp;Demonstrate BLE 4.2 Security Features on CC2650
 
-&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/security_examples.md) | [EM central project files](examples/cc2650em/security_examples_central) | [EM peripheral project files](examples/cc2650em/security_examples_peripheral) | [central src](src/examples/security_examples_central) | [peripheral src](src/examples/security_examples_central)
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/security_examples.md) | [central project files](examples/cc2650em/security_examples_central) | [peripheral project files](examples/cc2650em/security_examples_peripheral) | [central src](src/examples/security_examples_central) | [peripheral src](src/examples/security_examples_central)
 
 ### simple\_beacon
 &nbsp;&nbsp;&nbsp;&nbsp;Demonstrate an implementation of a beacon that uses iBeacon technology
 
-&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/simple_beacon.md) | [Launchpad project files ](examples/cc2650lp/simple_beacon) | [src](src/examples/simple_beacon)
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/simple_beacon.md) | [project files ](examples/cc2650lp/simple_beacon) | [src](src/examples/simple_beacon)
 
 ### simple\_central\_audio\_receiver
 &nbsp;&nbsp;&nbsp;&nbsp;Receive and decode a voice stream over BLE using CC2650 central device and SensorTag or <br>
 &nbsp;&nbsp;&nbsp;&nbsp;HID Advanced Remote peripheral device
 
-&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/simple_central_audio_receiver.md) | [Launchpad project files](examples/cc2650lp/simple_central_audio_receiver) | [src](src/examples/simple_central_audio_receiver)
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/simple_central_audio_receiver.md) | [project files](examples/cc2650lp/simple_central_audio_receiver) | [src](src/examples/simple_central_audio_receiver)
 
 ### simple\_eddystone
 &nbsp;&nbsp;&nbsp;&nbsp;Demonstrate an implementation of a beacon that uses the Eddystone beacon format
 
-&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/simple_eddystone.md) | [Launchpad project files ](examples/cc2650lp/simple_eddystone) | [src](src/examples/simple_eddystone)
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/simple_eddystone.md) | [project files ](examples/cc2650lp/simple_eddystone) | [src](src/examples/simple_eddystone)
 
 ### simple\_peripheral\_observer
 &nbsp;&nbsp;&nbsp;&nbsp;Demo Peripheral and observer roles on CC2650
 
-&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/simple_peripheral_observer.md) | [Launchpad project files](examples/cc2650lp/simple_peripheral_observer) | [src](src/examples/simple_peripheral_observer)
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/simple_peripheral_observer.md) | [project files](examples/cc2650lp/simple_peripheral_observer) | [src](src/examples/simple_peripheral_observer)
 
 ### simple\_proprietary\_beacon
 &nbsp;&nbsp;&nbsp;&nbsp;Demonstrate an implementation of a beacon that uses a potential proprietary beacon format
 
-&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/simple_proprietary_beacon.md) | [Launchpad project files ](examples/cc2650lp/simple_proprietary_beacon) | [src](src/examples/simple_proprietary_beacon)
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/simple_proprietary_beacon.md) | [project files ](examples/cc2650lp/simple_proprietary_beacon) | [src](src/examples/simple_proprietary_beacon)
 
 ### spp\_over\_ble
 &nbsp;&nbsp;&nbsp;&nbsp;Send bidirectional UART data over BLE, similar to Serial Port Profile (SPP) in Bluetooth Classic
 
-&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/spp_ble.md) | [Launchpad client project files](examples/cc2650lp/spp_ble_client) | [Launchpad server project files](examples/cc2650lp/spp_ble_server) | [client src](src/examples/spp_ble_client) | [server src](src/examples/spp_ble_server)
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/spp_ble.md) | [client project files](examples/cc2650lp/spp_ble_client) | [server project files](examples/cc2650lp/spp_ble_server) | [client src](src/examples/spp_ble_client) | [server src](src/examples/spp_ble_server)
 
 ### throughput\_example
 &nbsp;&nbsp;&nbsp;&nbsp;Demonstrate the maximum theoretical throughput of a BLE link using the 2x CC2650 devices. <br>
 &nbsp;&nbsp;&nbsp;&nbsp;These projects include a demo of 4.2 Data Length Extension, which improves throughput.
 
-&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/throughput_example.md) | [EM central project files](examples/cc2650em/throughput_example_central) | [EM peripheral project files](examples/cc2650em/throughput_example_peripheral) | [Launchpad central project files](examples/cc2650lp/throughput_example_central) <br>
-&nbsp;&nbsp;&nbsp;&nbsp;[Launchpad peripheral project files](examples/cc2650lp/throughput_example_peripheral) | [central src](src/examples/throughput_example_central) | [peripheral src](src/examples/throughput_example_peripheral)
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/throughput_example.md) | [central project files](examples/cc2650lp/throughput_example_central) <br>
+&nbsp;&nbsp;&nbsp;&nbsp;[peripheral project files](examples/cc2650lp/throughput_example_peripheral) | [central src](src/examples/throughput_example_central) | [peripheral src](src/examples/throughput_example_peripheral)
 
 ### serial\_bootloader
 &nbsp;&nbsp;&nbsp;&nbsp;Show implementation of the ROM Bootloader running from Flash memory. <br>
-&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/serial_bootloader.md) | [Project files](examples/util/serial_bootloader) | [src](src/util/serial_bootloader)
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/serial_bootloader.md) | [project files](examples/util/serial_bootloader) | [src](src/util/serial_bootloader)
+
+### central\_to\_multiperiperipheral
+&nbsp;&nbsp;&nbsp;&nbsp;Demonstrate a central device disovering and connecting to multiple peripherals. <br>
+&nbsp;&nbsp;&nbsp;&nbsp;[docs](docs/central_to_multiperipheral.md) | [project files](examples/cc2650em/central_to_multiperipheral) | [src](src/examples/central_to_multiperipheral)
 
 References
 ==========

diff --git a/docs/central_to_multiperipheral.md b/docs/central_to_multiperipheral.md
@@ -2,7 +2,7 @@
 Purpose / Scope
 ===============
 
-This purpose of this example is to demonstrate connecting multiple peripherals with a central application. 
+This purpose of this example is to demonstrate connecting multiple peripherals with a central application.
 The project is based on the simple_central project and has been enhanced to include connections up to 3 peripherals.
 
 Prerequisites
@@ -33,11 +33,11 @@ Running the demo is as simple and compiling and loading the code, interacting wi
 2. Connect CC2650DK #1 with three other boards
  - Press UP button to start discovery
  - Press LEFT button to browse through the discovered BLE devices with addresses
- - Press SELECT to connect, verify it is connected with message on the LCD display 
+ - Press SELECT to connect, verify it is connected with message on the LCD display
  - Repeat until up to 3 devices are connected **Note that discovery step can be skipped if the device to be connected was already found in the first discovery**
 
 3. Send some test data to multiple simple_peripheral devices
- - Browse through the connected devices with the RIGHT button 
- - Press the DOWN button to read/write to Characteristic 1 of the currently selected connected device 
+ - Browse through the connected devices with the RIGHT button
+ - Press the DOWN button to read/write to Characteristic 1 of the currently selected connected device
  - Repeat for each of the connected devices
- - To disconnect, press the RIGHT key to select from connected device(s) then press the SELECT key. 
+ - To disconnect, press the RIGHT key to select from connected device(s) then press the SELECT key.
diff --git a/docs/faq.md b/docs/faq.md
@@ -38,7 +38,7 @@ Frequently Asked Questions
 
  **CCS**
 
- 1. Please refer to section 2.6.3 of the [Software Developer's Guide](http://ti.com/lit/pdf/swru393). Version 6.1.3 is supported.
+ 1. Please refer to section 2.6.3 of the [Software Developer's Guide](http://ti.com/lit/pdf/swru393). Version 6.2.0 is supported.
  - Note that if your CCS install doesn't include TI ARM Compiler v5.2.6, refer to section 2.6.3.2 of the [Software Developer's Guide](http://ti.com/lit/pdf/swru393)
 
 4. Q: I am using a LaunchPad device, how can I view display data?

diff --git a/docs/security_examples.md b/docs/security_examples.md
@@ -4,20 +4,22 @@ Security Examples
 This project will demonstrate the various security methods available using the BLE v2.2.0 stack.
 
 This demo is comprised of two projects, representing both sides of a connection:
- - security_examples_central
- - security_examples_peripheral
+ - security\_examples\_central
+ - security\_examples\_peripheral
 
 Note that there are both CCS and IAR projects for both of theses.
 
 ### Instructions
 The projects are controlled in the same method as the simpleBLEPeripheral and simpleBLECentral projects. For more information on the user interface, see the "Sample Applications" section of the software developer's guide.
 
 The different security types can be chosen by setting the PAIRING define in security_examples_central.h / security_examples_peripheral.h. The options are:
+```c
 #define OOB_LE  0x01 // out of band legacy
 #define OOB_SC  0x02 // out of band secure connections
 #define JUSTWORKS  0x03 // just works
 #define PASSCODE  0x04 // passcode
 #define NUMCOMP  0x05 // numeric comparison
+```
 
 The STATIC_PASSCODE define can be set to:
 - 0: passcode will be entered using the keypad