Merge pull request #91 in SA/ble_examples from feature_sss-2.40 to develop

Squashed commit of the following:

commit cc9064bc3abfd1e627f3e803e6888625683c559c
Author: Max Wennerfeldt <[email protected]>
Date:   Tue Feb 19 09:15:56 2019 +0100

    Removed stale files

commit 96aaefe6a8a6bf9253f290d489d4a70726134eff
Author: Max Wennerfeldt <[email protected]>
Date:   Tue Feb 19 09:10:18 2019 +0100

    Added SSS example, removed audio examples

Author: Sean Lyons

README.md

@@ -12,18 +12,18 @@
 
 # Introduction
 
-These examples and demos are for **TI SimpleLink CC26x2 SDK 2.30.00.34**
+These examples and demos are for **TI SimpleLink CC13x2 / CC26x2 SDK 2.40.00.XX**
 
 This repository contains *Bluetooth®* 5 sample applications for
-Texas Instruments' SimpleLink CC26x2 SDK. These examples have not been
+Texas Instruments' SimpleLink CC13x2 / CC26x2 SDK. These examples have not been
 validated as production-ready.
 
 **Do not** use GitHub's bug tracking feature for support. For inquiries, see the
 [Bluetooth® low energy Forum](https://e2e.ti.com/support/wireless_connectivity/bluetooth_low_energy/f/538).
 
 To use the examples and tools in this repository, please download and install
-the [SimpleLink CC26x2 SDK](http://www.ti.com/tool/SIMPLELINK-CC26X2-SDK) **first**, and if
-necessary [buy an evaluation kit](http://www.ti.com/tool/LAUNCHXL-CC26X2R1).
+the [SimpleLink CC13x2 / CC26x2 SDK](http://www.ti.com/tool/SIMPLELINK-CC13X2-26X2-SDK) **first**, and if
+necessary [buy an CC26X2](http://www.ti.com/tool/LAUNCHXL-CC26X2R1) or [CC1352](http://www.ti.com/tool/LAUNCHXL-CC1352R1) evaluation kit].
 
 If you have any questions please refer to the [FAQ page](docs/faq.md).
 For examples for other SDK versions and platforms, see table below.
@@ -36,13 +36,23 @@ For examples for other SDK versions and platforms, see table below.
     </tr>
     <tr>
       <td>
-        <a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_sdk-2.30">TI SimpleLink CC26x2 SDK 2.30.00.34 (current)</a>
+        <a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_sdk-2.40">TI SimpleLink CC13x2 / CC26x2 SDK 2.40.00.81 (current)</a>
       </td>
       <td>
         <ul>
-          <li><a href="#full-duplex-bidirectional-audio-demo">Full Duplex Bidirectional Audio Demo (Central/Peripheral)</li>
-          <li><a href="#i2s-echo">I2S Echo</li>
-          <li><a href="#bluetooth-5-throughput-demo">Bluetooth 5 Throughput Demo</li>
+          <li><a href="#simple-serial-socket">Simple Serial Socket</li>
+        </ul>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_sdk-2.30">TI SimpleLink CC26x2 SDK 2.30.00.34</a>
+      </td>
+      <td>
+        <ul>
+          <li>Full Duplex Bidirectional Audio Demo (Central/Peripheral)</li>
+          <li>I2S Echo</li>
+          <li>Serial Port Profile</li>
         </ul>
       </td>
     </tr>
@@ -184,8 +194,8 @@ The numbering scheme is in the form of M.mm.pp.bb. The fields pp.bb are incremen
 as GitHub examples are released, M.mm will map a GitHub release to a SimpleLink
 SDK release.
 
-### 2.30.00.00
-Initial offering of SimpleLink CC26x2 SDK 2.30.00.34 examples.
+### 2.40.00.00
+Initial offering of SimpleLink CC13x2 / CC26x2 SDK 2.40.00.81 examples.
 
 ## Installation
 
@@ -204,17 +214,17 @@ This repository can be cloned/download anywhere on your computer. There is a
 dependency between this repository and the SimpleLink CC26x2 SDK install
 location.
 
-By default the SimpleLink CC26x2 SDK will install to:
+By default the SimpleLink CC13x2 / CC26x2 SDK will install to:
 
-    C:\ti\simplelink_cc26x2_sdk_2_30_00_34
+    C:\ti\simplelink_cc13x2_26x2_sdk_2_40_00_81
 
-If the SimpleLink CC26x2 SDK must be installed to a different location, then
+If the SimpleLink CC13x2 / CC26x2 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
 
-Similar to the SimpleLink CC26x2 SDK, the examples in this repository support
+Similar to the SimpleLink CC13x2 / CC26x2 SDK, the examples in this repository support
 the CCS and IAR toolchains. Please pay careful attention to versions of these
 tools, please refer to the release notes for supported versions.
 
@@ -228,62 +238,51 @@ related to the ble_examples repo.
 
 ## Examples / Demo List
 
-### Full Duplex Bidirectional Audio Demo
-
-**Note: These examples will be deprecated as of the 2.40 SDKs.**
-
-Encode and transmit a full duplex bidirectional audio stream over BLE using two
-CC26x2 LaunchPads with CC3200AUDBOOST.
-
-* central\_bidirectional\_audio
-    * [Documentation](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/central_bidirectional_audio/readme.md)
-    * [CCS Project Files](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/central_bidirectional_audio/tirtos/ccs)
-    * [IAR Project Files](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/central_bidirectional_audio/tirtos/iar)
-    * [Source](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/central_bidirectional_audio/src)
-
-* peripheral\_bidirectional\_audio
-    * [Documentation](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/peripheral_bidirectional_audio/readme.md)
-    * [CCS Project Files](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/peripheral_bidirectional_audio/tirtos/ccs)
-    * [IAR Project Files](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/peripheral_bidirectional_audio/tirtos/iar)
-    * [Source](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/peripheral_bidirectional_audio/src)
-
-### I2S Echo
-
-**Note: These examples will be deprecated as of the 2.40 SDKs.**
-
-Read audio frames in from an external codec and loop them back using I2S.
-
-* i2secho
-    * [Documentation](examples/rtos/CC26X2R1_LAUNCHXL/drivers/i2secho/README.md)
-    * [CCS Project Files](examples/rtos/CC26X2R1_LAUNCHXL/drivers/i2secho/tirtos/ccs)
-    * [IAR Project Files](examples/rtos/CC26X2R1_LAUNCHXL/drivers/i2secho/tirtos/iar)
-    * [GCC Project Files](examples/rtos/CC26X2R1_LAUNCHXL/drivers/i2secho/tirtos/gcc)
-    * [Source](examples/rtos/CC26X2R1_LAUNCHXL/drivers/i2secho/)
-
-### Bluetooth 5 Throughput Demo
-
-Showcase a high (near theoretical max) data throughput over Bluetooth 5. The demo
-can be run with two CC26x2 Launchpads, or one CC26x2 Launchpad and one smartphone
-with the Simplelink Starter app.
-
-* throughput\_peripheral
-    * [Documentation](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/throughput_peripheral/readme.md)
-    * [CCS Project Files](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/throughput_peripheral/tirtos/ccs)
-    * [Source](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/throughput_peripheral/src)
-* throughput\_central
-    * [Documentation](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/throughput_central/readme.md)
-    * [CCS Project Files](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/throughput_central/tirtos/ccs)
-    * [Source](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/throughput_central/src)
+### Simple Serial Socket
+
+This is a UART over BLE bridge example where a Simple Serial Socket Client
+(SSSC) and Simple Serial Socket Server (SSSS) connect with one another and
+exchange UART data over the air. An generic Simple Stream Service is used
+making it easy to exchange data sink and source to create a custom serial
+socket over BLE implementation.
+
+**Note: this example replaces the SPP over BLE example**
+
+#### For CC1352
+
+* Simple Serial Socket Client
+    * [Documentation](examples/rtos/CC1352R1_LAUNCHXL/ble5apps/simple_serial_socket_client/readme.md)
+    * [IAR Project Files](examples/rtos/CC1352R1_LAUNCHXL/ble5apps/simple_serial_socket_client/tirtos/iar)
+    * [CCS Project Files](examples/rtos/CC1352R1_LAUNCHXL/ble5apps/simple_serial_socket_client/tirtos/ccs)
+    * [Source](examples/rtos/CC1352R1_LAUNCHXL/ble5apps/simple_serial_socket_client/src)
+* Simple Serial Socket Server
+    * [Documentation](examples/rtosCC1352R1_LAUNCHXL/ble5apps/simple_serial_socket_server/readme.md)
+    * [IAR Project Files](examples/rtos/CC1352R1_LAUNCHXL/ble5apps/simple_serial_socket_server/tirtos/iar)
+    * [CCS Project Files](examples/rtos/CC1352R1_LAUNCHXL/ble5apps/simple_serial_socket_server/tirtos/ccs)
+    * [Source](examples/rtos/CC1352R1_LAUNCHXL/ble5apps/simple_serial_socket_server/src)
+
+#### For CC26x2
+
+* Simple Serial Socket Client
+    * [Documentation](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/simple_serial_socket_client/readme.md)
+    * [IAR Project Files](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/simple_serial_socket_client/tirtos/iar)
+    * [CCS Project Files](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/simple_serial_socket_client/tirtos/ccs)
+    * [Source](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/simple_serial_socket_client/src)
+* Simple Serial Socket Server
+    * [Documentation](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/simple_serial_socket_server/readme.md)
+    * [IAR Project Files](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/simple_serial_socket_server/tirtos/iar)
+    * [CCS Project Files](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/simple_serial_socket_server/tirtos/ccs)
+    * [Source](examples/rtos/CC26X2R1_LAUNCHXL/ble5apps/simple_serial_socket_server/src)
 
 ## References
 
 The following reference pages may be helpful during general Bluetooth Low
 Energy development. New users of the SimpleLink CC26x2 platform and Bluetooth
 5 development are encouraged to read the
-[BLE5-Stack User's Guide](http://dev.ti.com/tirex/#/?link=Software%2FSimpleLink%20CC26X2%20SDK%2FDocuments%2FBLE5-Stack%2FBLE5-Stack%20User's%20Guide).
+[BLE5-Stack User's Guide](http://dev.ti.com/tirex/#/?link=Software%2FSimpleLink%20CC13x2%2026x2%20SDK%2FDocuments%2FBLE5-Stack%2FBLE5-Stack%20User's%20Guide).
 
 As an additional resource, users are encouraged to complete the
-[SimpleLink Academy](http://dev.ti.com/tirex/#/?link=Software%2FSimpleLink%20CC26X2%20SDK%2FSimpleLink%20Academy)
+[SimpleLink Academy](http://dev.ti.com/tirex/#/?link=Software%2FSimpleLink%20CC13x2%2026x2%20SDK%2FSimpleLink%20Academy)
 training.
 
 Other resources can be found below:

examples/rtos/CC1352R1_LAUNCHXL/ble5apps/simple_serial_socket_client/readme.md

@@ -0,0 +1,147 @@
+
+Purpose / Scope
+===============
+
+This purpose of this example is to demonstrate a simple serial socket using
+TI's Simple Stream Server profile. The example showcase an simple UART over
+BLE implementation, the project is designed to allow the actual data sink and
+source to be easily exchanged for the purpose of creating a generic simple
+stream application.
+
+Prerequisites
+=============
+
+#### Hardware Requirements
+
+Before running the demo, the user will need the following components:
+
+- 2x [CC13x2 Launchpad](http://www.ti.com/tool/LAUNCHXL-CC1352R1)
+- 2x Micro USB cable
+
+#### Firmware Requirements
+
+- [CC13x2 / CC26x2 SDK](http://www.ti.com/tool/SIMPLELINK-CC13X2-26X2-SDK)
+
+Simple Stream Server service
+============================
+
+The simple stream service is made to implement a bi-directional data stream
+connection over the BLE protocol. The service uses a 128 bit UUID:
+F000C0C0-0451-4000-B000-00000000-0000. simple stream server service contains
+two characteristics, they are listed below.
+
+| Characteristic    | UUID                                      |
+|:-----------------:|:-----------------------------------------:|
+|DataIn             | F000C0C1-0451-4000-B000-00000000-0000     |
+|DataOut            | F000C0C2-0451-4000-B000-00000000-0000     |
+
+The `DataIn` characteristic implies data coming from client to server while
+`DataOut` is data outgoing from server to client.
+
+For more information on the service, see the Simple Serial Socket Server example readme.
+
+Simple Stream Client profile
+============================
+
+The simple stream client profile provides an easy to use interface, similar to
+that of the simple stream server service, for interaction with a connected
+Simple Stream Server peripheral. Following a connection, the service table
+provided by the profile has to be populated with service handles before any
+data can be sent from the client to the server.
+
+The service table can be easily populated by utilizing the simple service
+discovery API available in the example. To see how this API is used during the
+discovery process, refer to the `SimpleSerialSocketClient_processGATTDiscEvent`
+function found inside `simple_serial_socket_client`.
+
+The profile provided APIs:
+* SimpleStreamClient_sendData(uint16_t* data, uint16_t len)
+* SimpleStreamClient_processStream()
+* SimpleStreamClient_disconnectStream()
+* SimpleStreamClient_enableNotifications(uint16_t connHandle)
+
+The Simple Serial Client keeps an internal FIFO list for data sent to the
+profile using `SimpleStreamClient_sendData()`. When new data is sent to the
+profile, the internal queue will be processed and as much data as possible
+will be sent to the server using writes commands (no-respond).
+
+> Note: The Simple Serial Client profile relies on dynamic memory allocated and
+> will use the application ICall heap to store the queued data.
+
+If the profile is unable to send all data inside the current connection event,
+`SimpleStreamClient_processStream()` can be called in application space to
+process the internal queue again at another time.
+
+If the client disconnects from the server, the internal queue can be flushed
+by calling `SimpleStreamClient_disconnectStream()`.
+
+To receive incoming data, the client has to enable notifications. To do this,
+the `SimpleStreamClient_enableNotifications()` API can be used to enable
+notifications given the connection handle.
+
+Running the Demo
+================
+
+Running the demo is as simple and compiling and loading the code, then hooking
+up to your PC to send a receive data over UART. Please see the steps below:
+
+1. Compile and load the code
+ - Build LaunchPad #1 with the `simple_serial_socket_client`
+ cc13x2r1lp_stack-FlashROM_Library project
+ - Build and load LaunchPad #1 with the `simple_serial_socket_client`
+ cc13x2r1lp_app-FlashROM_StackLibrary project
+ - Build LaunchPad #2 with the `simple_serial_socket_server`
+ cc13x2r1lp_stack-FlashROM_Library project
+ - Build and load LaunchPad #2 with the `simple_serial_socket_server`
+ cc13x2r1lp_app-FlashROM_StackLibrary project
+
+2. Connect the Boards to the PC terminal
+ - You can use the terminal to send data from your PC to the LaunchPad, and
+ also display the info sent from one device to another.
+ - You will need to open two instances of the terminal program to, one to
+ communicate with each board.
+ - Follow the steps from our [FAQ](faq.md) to connect to the LaunchPad boards
+ - **Please note that the Simple Serial Socket project uses the default baud
+ rate of 115200**
+
+3. Power the boards individually and verify they are initialized
+ - The client will auto connect to the server by looking for an advertisement
+ containing the SSS service together with a
+   matching manufacturer ID. The manufacturer ID can be changed in both
+   projects to allow for multiple devices to run
+   alongside each other.
+ - Upon connecting the client and server will light the red LED. When
+ notifications has been enabled and the stream is ready
+   for use, the green LED will also be lit.
+ - At this point you can type into either terminal window and watch it being
+ echoed to the other terminal via BLE.
+
+Improving UART performance for large data transfers
+===================================================
+
+The default board file configures the size of the internal UART ring buffer to
+32 bytes. If the amount of data sent over UART to the device exceeds
+UART_MAX_READ_SIZE plus the size of the ring buffer, data loss is probable.
+This is due to the internal UART ring buffer wrapping before the application
+has the chance to process the previous UART buffer. To be able to handle
+larger chunks of data, the size of the ring buffer can be increased inside the
+board file.
+
+In order to modify the size of the board file, the `board.c` file found inside
+the `Startup`  folder need to be replaced with copies of the actual board
+files. This can be done by performing the following steps:
+
+- Remove the `board.c` file found inside the `Startup` folder.
+- Copy the following files from `<SDK DIR>/source/ti/blestack/boards/CC1352R1_LAUNCHXL` directory into the projects `Startup` folder:
+    - Board.h
+    - CC1352R1_LAUNCHXL.h
+    - CC1352R1_LAUNCHXL.c
+    - CC1352R1_LAUNCHXL_fxns.c
+
+The ring buffer size can now be changed by resizing the uartCC26XXRingBuffer
+array found inside `CC1352R1_LAUNCHXL.c`.
+
+It is also possible to modify the shared `CC1352R1_LAUNCHXL.c` file that
+`board.c` imports directly instead of coping the board files into the project.
+This is however not recommended as changes will propagate to all BLE examples
+that depend on the shared file.