readme and version script update

Author: Thomas Kopriva

README.md

@@ -1,8 +1,10 @@
-Extra examples and demos for **TI SimpleLink CC2640R2 SDK**
-===========================================================
+# Introduction
 
-This repository contains additional *Bluetooth®* 5 and *Bluetooth®* 4.2
-Low Energy sample applications for Texas Instruments' SimpleLink CC2640R2 SDK.
+These examples and demos are for **TI SimpleLink CC2640R2 SDK 1.35.00.33**
+
+This repository contains experimental *Bluetooth®* 5 and *Bluetooth®*
+4.2 Low Energy sample applications for Texas Instruments' SimpleLink CC2640R2
+SDK. These examples have not been validated as production-ready.
 
 To use the examples and tools in this repository, please download and install
 the [SimpleLink CC2640R2 SDK](http://www.ti.com/ble-stack) first, and if
@@ -12,8 +14,13 @@ For other hardware and software resources,
 [please visit our wiki](http://www.ti.com/ble-wiki). If you have any questions
 please refer to the [FAQ page](docs/faq.md).
 
-Installation
-============
+## Change Log
+
+### 1.35.00.00
+Initial offering of Simplelink CC2640R2 SDK examples.
+* BLE5-Stack: Throughput Demo (Central/Peripheral)
+
+## Installation
 
 This repository can be cloned and tracked using Git. For instructions on how to
 clone a repository from Github please refer to this guide:
@@ -38,8 +45,7 @@ If the Simplelink CC2640R2 SDK must be installed to a different location, then
 see the [FAQ page](docs/faq.md) for IDE specific instructions for changing
 environment variables.
 
-Required Tools
-==============
+## Required Tools
 
 Similar to the Simplelink CC2640R2 SDK, the examples in this repository support
 the CCS and IAR toolchains. Please pay careful attention to versions of these
@@ -52,14 +58,12 @@ untested and may result in unexpected behavior.
 For more information on toolchain setup, please refer to our
 [FAQ page](docs/faq.md).
 
-FAQ
-===
+## FAQ
 
 The [FAQ page](docs/faq.md) will try to address some of the common questions
 related to the ble_examples repo.
 
-Examples / Demo List
-====================
+## Examples / Demo List
 
 ### Bluetooth 5 Throughput Demo
 
@@ -76,8 +80,7 @@ and Coded PHYs.
     * [IAR Project Files](examples/rtos/CC2640R2_LAUNCHXL/ble5apps/throughput_peripheral/tirtos/iar)
     * [Source](examples/rtos/CC2640R2_LAUNCHXL/ble5apps/throughput_peripheral/src)
 
-References
-==========
+## References
 
 The following reference pages may be helpful during general Bluetooth Low
 Energy development. New users of the Simplelink CC2640R2 platform and Bluetooth

docs/faq.md

@@ -1,12 +1,12 @@
 ## Frequently Asked Questions
 
-* [What if I installed the SimpleLink CC2640R2 SDK at a non default location (e.g. ``C:\ti\simplelink_cc2640r2_sdk_1_35_00_33M_mm_pp_bb``)?](#default)
+* [What if I installed the SimpleLink CC2640R2 SDK at a non default location (e.g. Not at ``C:\ti\simplelink_cc2640r2_sdk_1_35_00_33``)?](#default)
 * [Why am I getting an error when I am trying to run a Python script from the /tools folder?](#python)
 * [How can I setup my toolchain for use with the ble\_examples repo?](#toolchain)
 * [I am using a LaunchPad device, how can I view display data?](#display)
 ---
 
-### <a name="default"></a>What if I installed the SimpleLink CC2640R2 SDK at a non default location (e.g. ``C:\ti\simplelink_cc2640r2_sdk_1_35_00_33M_mm_pp_bb``)?
+### <a name="default"></a>What if I installed the SimpleLink CC2640R2 SDK at a non default location (e.g. Not at ``C:\ti\simplelink_cc2640r2_sdk_1_35_00_33``)?
 
 All projects reference files from the BLE stack using environment variables, you
 can change this in your IDE's project files.
@@ -79,7 +79,7 @@ To setup your PC to receive this data please follow the steps below:
 1. Install PuTTY or another serial terminal emulator
 1. Use the Windows Device Manager (Start &rarr; Run &rarr; `mmc devmgmt.msc`
     &rarr; Ok) to determine which COM port you should connect to:
-    
+
     ![Device Manager](resources/dev_mgr_xds110.png)
     * Note the COM port number of the `XDS110 Class Application/User UART` listed.
 1. Configure putty as a serial console with 115200 8N1.

examples/rtos/CC2640R2_LAUNCHXL/ble5apps/throughput_central/readme.md

@@ -1,19 +1,19 @@
-BLE5 Throughput Central
-=======================
+# BLE5-Stack Throughput Central
 
 ## Functional Overview
 
-This project is meant to be utilized with BLE5 Throughput Peripheral to demonstrate
-BLE5 features.
+This project is meant to be utilized with BLE5-Stack Throughput Peripheral to
+demonstrate Bluetooth™ 5 features.
 
-This project is based on the Simple Central sample application from the SDK.
+This project is based on the Simple Central sample application from the
+BLE5-Stack component of the SDK.
 
-BLE5 Throughput Peripheral Project should be used in order to do a full
+BLE5-Stack Throughput Peripheral Project should be used in order to do a full
 throughput demo. However, this project can function standalone to demonstrate
 the Data Length Extension, 2 Megabit, or Coded PHYs when connected to a peer
 device supporting these features.
 
-The following changes are done:
+This list contains the changes from the standard Simple Central example:
 - Added Support for a custom profile called Throughput Profile
 - Modified existing menu system to utilize the Two Button Menu
 - Changed Service and Characteristic Discover Behavior
@@ -26,87 +26,105 @@ The following changes are done:
 ### Two Button Menu
 
 The Two Button Menu system is designed to utilize the two push buttons available
-on the CC2640R2 Launchpad. The left button (BTN1) is always used to cycle between options.
-The right button (BTN2) is used to activate the selected action or item.
+on the CC2640R2 Launchpad. The left button (BTN1) is always used to cycle
+between options. The right button (BTN2) is used to activate the selected action
+or item.
 
-The Two Button Menu is set up by default to utilize the back channel UART present
-on the launchpad as it's display.
+The Two Button Menu is set up by default to utilize the back channel UART
+present on the launchpad as it's display.
 
 ### Running the Demo
 
-1. Compile and load the projects:
+1.  Compile and load the projects:
     - First build and load `ble5_throughput_central_cc2640r2lp_stack`
     - Next build and load `ble5_throughput_central_cc2640r2lp_app`
 
-2. Connect to the LaunchPad via PuTTY (or other serial console emulator). For
-instructions on connecting via PuTTY, please see our [FAQ page](faq.md).
-
-3. After connecting to PuTTY, you will be presented with the Two Button Menu system
-prompting you for actions. Select 'Scan/Connect Menu' by pressing the right button (BTN2).
-
-        *Texas Instruments Bluetooth 5 Demo
-
-        +Scan/Connect Menu >
-
-4. Then select "Scan For Devices" menu option by pressing the right button (BTN2).
-
-        *Scan/Connect Menu
-        < Next Item
-          Scan for Devices >
-         +Upper Menu
-
-5. After Scanning is Performed, choose the desired device to connect to by pressing
-the right button (BTN2). Note: If the peer device supports the Throughput Profile,
-below the peer device's address will contain the text: "-- Throughput Profile Supported --"
-
-        *Scan/Connect Menu
-        < Next Item
-          Select Next Device >
-          Connect to Selected Device
-          Scan for Devices
-         +Upper Menu
-        2 Devices Found
-
-        Scanned Device 1
-        0x98072DAA4E5E
-        -- Throughput Profile Supported --
-
-5. Press the left button (BTN1) to move to the next action, "Connect to Selected Device". Then
-use the right button (BTN2) to begin connecting to the displayed device.
-
-After a connection is successful, you will be presented with new menu options:
-
-        *Texas Instruments Bluetooth 5 Demo
-        < Next Item
-         +Set PHY >
-         +Set PDU
-          Toggle RSSI Readings
-          Disconnect
-
-As well as connection details in the UART display:
-
-        Peer Device : 0x98072DAA4E5E
-        PHY: 1 Mbps
-        Instant Rate (kb/s): 247.904
-        Average Rate (kb/s): 264.104 over 10 Samples
-        RSSI -dBm: 44
-
-As shown, if the Throughput Profile is supported on the peer, throughput information will be displayed.
-
-6. As desired, BLE5 Throughput Central can modify the PHY and DLE PDU size of the
-connection. Use left button (BTN1) to change selected action, and right button (BTN2) to
-invoke the selected action. The display will update if connection PDU or PHY is changed.
-
-        Peer Device : 0x98072DAA4E5E
-        Current PHY: 2 Mbps
-        Instant Rate (kb/s): 1366.400
-        Average Rate (kb/s): 1219.408 over 10 Samples
-        RSSI -dBm: 32
-
-        This Device's BDADDR : 0x00124B005220
-        Device GAP Role: Central
-        Device RX PDU Size: 251B
-        MTU Size: 247B
-
-If Throughput Profile is supported on the peer, the displayed throughput will update in
-real time.
+1.  Connect to the LaunchPad via PuTTY (or other serial console emulator). For
+    instructions on connecting via PuTTY, please see our [FAQ page](faq.md).
+
+1.  After connecting to PuTTY, you will be presented with the Two Button Menu
+    system prompting you for actions. Select 'Scan/Connect Menu' by pressing the
+    right button (BTN2).
+
+    ```
+    *Texas Instruments Bluetooth 5 Demo
+
+    +Scan/Connect Menu >
+    ```
+
+1.  Then select "Scan For Devices" menu option by pressing the right button (BTN2).
+
+    ```
+    *Scan/Connect Menu
+    < Next Item
+      Scan for Devices >
+     +Upper Menu
+    ```
+
+1.  After Scanning is Performed, choose the desired device to connect to by pressing
+    the right button (BTN2). Note: If the peer device supports the Throughput Profile,
+    below the peer device's address will contain the text:
+    ``-- Throughput Profile Supported --``
+
+    ```
+    *Scan/Connect Menu
+    < Next Item
+      Select Next Device >
+      Connect to Selected Device
+      Scan for Devices
+     +Upper Menu
+    2 Devices Found
+
+    Scanned Device 1
+    0x98072DAA4E5E
+    -- Throughput Profile Supported --
+    ```
+
+1.  Press the left button (BTN1) to move to the next action, "Connect to
+    Selected Device". Then use the right button (BTN2) to begin connecting to
+    the displayed device.
+
+    After a connection is successful, you will be presented with new menu
+    options:
+
+    ```
+    *Texas Instruments Bluetooth 5 Demo
+    < Next Item
+     +Set PHY >
+     +Set PDU
+      Toggle RSSI Readings
+      Disconnect
+    ```
+
+    As well as connection details in the UART display:
+
+    ```
+    Peer Device : 0x98072DAA4E5E
+    PHY: 1 Mbps
+    Instant Rate (kb/s): 247.904
+    Average Rate (kb/s): 264.104 over 10 Samples
+    RSSI -dBm: 44
+    ```
+
+    As shown, if the Throughput Profile is supported on the peer, throughput information will be displayed.
+
+1.  As desired, BLE5-Stack Throughput Central can modify the PHY and DLE PDU
+    size of the connection. Use left button (BTN1) to change selected action,
+    and right button (BTN2) to invoke the selected action. The display will
+    update if connection PDU or PHY is changed.
+
+    ```
+    Peer Device : 0x98072DAA4E5E
+    Current PHY: 2 Mbps
+    Instant Rate (kb/s): 1366.400
+    Average Rate (kb/s): 1366.400 over 10 Samples
+    RSSI -dBm: 32
+
+    This Device's BDADDR : 0x00124B005220
+    Device GAP Role: Central
+    Device RX PDU Size: 251B
+    MTU Size: 247B
+    ```
+
+    If Throughput Profile is supported on the peer, the displayed throughput
+    will update in real time.