Skip to content

Commit c16914d

Browse files
jan-TIjan-TI
committed
Updated readme
1 parent 564c7e9 commit c16914d

File tree

1 file changed

+90
-125
lines changed

1 file changed

+90
-125
lines changed

‎README.md‎

Lines changed: 90 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,28 @@
88
* [Tools](#tools)
99
* [References](#references)
1010
* [FAQ](docs/faq.md)
11-
* [Suggested Work Flow](docs/suggested_workflow.md)
11+
* [Versioning BLE-Stack Projects](docs/suggested_workflow.md)
1212

1313
# Introduction
1414

15-
These examples and demos are for **TI SimpleLink CC2640R2 SDK 4.10.00.00**
15+
These examples and demos are for **TI SimpleLink Low Power F3 SDK 7.20.xx.xx**
1616

17-
This repository contains *Bluetooth®* Low Energy sample applications for
18-
Texas Instruments' SimpleLink CC2640R2 SDK. These examples have not been
19-
validated as production-ready. Services and profiles in this repository have not
20-
been validated or certified.
17+
This repository contains *Bluetooth® Low Energy* sample applications for
18+
Texas Instruments' SimpleLink CC13xx / CC26xx SDK, SimpleLink CC2640R2 SDK, and SimpleLink Low Power F3 SDK.
19+
Please reference the table below to find examples for each of these SDKSs.
20+
21+
These examples have not been validated as production-ready.
2122

2223
**Do not** use GitHub's bug tracking feature for support. For inquiries, see the
2324
[Bluetooth® low energy Forum](https://e2e.ti.com/support/wireless_connectivity/bluetooth_low_energy/f/538).
2425

2526
To use the examples and tools in this repository, please download and install
26-
the [SimpleLink CC2640R2 SDK](http://www.ti.com/ble-stack) **first**, and if
27-
necessary [buy an evaluation kit](http://www.ti.com/tool/launchxl-cc2640r2).
27+
the [SimpleLink Low Power F3 SDK](https://www.ti.com/tool/download/SIMPLELINK-LOWPOWER-F3-SDK) **first**, and if
28+
necessary the required evaluation kit:
2829

29-
If you have any questions please refer to the [FAQ page](docs/faq.md).
30+
* [LP-EM-CC2340R5](https://www.ti.com/tool/LP-EM-CC2340R5)
3031

32+
If you have any questions please refer to the [FAQ page](docs/faq.md).
3133
For examples for other SDK versions and platforms, see table below.
3234

3335
<table>
@@ -38,54 +40,51 @@ For examples for other SDK versions and platforms, see table below.
3840
</tr>
3941
<tr>
4042
<td>
41-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_cc2640r2_sdk-4.10">TI SimpleLink CC2640R2 SDK 4.10.00.00 (current)</a>
43+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_low_power_f3_sdk-7.20">TI SimpleLink Low Power F3 SDK 7.20.00.00</a>
4244
</td>
4345
<td>
4446
<ul>
45-
<li><a href="#heart-rate">Heart Rate Sensor</a></li>
46-
<li><a href="#glucose">Glucose Sensor</a></li>
47-
<li><a href="#blood-pressure-monitor">Blood Pressure Monitor</li>
47+
<li>Data Stream UART over BLE example</li>
48+
<li>Basic BLE GATT Client example</li>
49+
<li>Serial Boot Loader Tool v1.0.0 (SDK version independent)</li>
4850
</ul>
4951
</td>
5052
</tr>
51-
<tr>
53+
<tr>
5254
<td>
53-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_cc13x2_26x2_sdk-4.10">TI SimpleLink CC13x2 / CC26x2 SDK 4.10.00.00</a>
55+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_cc13xx_26xx_sdk-6.40">TI SimpleLink CC13xx / CC26xx SDK 6.4x.xx.xx</a>
5456
</td>
5557
<td>
5658
<ul>
57-
<li>Simple Serial Socket</li>
58-
<li>Bluetooth 5 Throughput Demo</li>
59+
<li>Simple Serial Socket (for CC2651R3SIPA only)</li>
5960
</ul>
6061
</td>
6162
</tr>
6263
<tr>
6364
<td>
64-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_cc2640r2_sdk-3.40">TI SimpleLink CC2640R2 SDK 3.40.00.10</a>
65+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_cc13x2_26x2_sdk-5.10">TI SimpleLink CC13x2 / CC26x2 SDK 5.10.00.00</a>
6566
</td>
6667
<td>
6768
<ul>
68-
<li><a href="#simple-serial-socket">Simple Serial Socket</a></li>
69-
<li><a href="#simple-serial-socket">Bluetooth 5 Simple Serial Socket</li>
70-
<li><a href="#simple-peripheral-observer">Simple Peripheral Observer</li>
71-
<li><a href="#blood-pressure-monitor">Blood Pressure Monitor</li>
69+
<li>Simple Serial Socket</li>
70+
<li>Bluetooth 5 Throughput Demo</li>
7271
</ul>
7372
</td>
7473
</tr>
7574
<tr>
7675
<td>
77-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_cc2640r2_sdk-3.30">TI SimpleLink CC2640R2 SDK 3.30.00.20</a>
76+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_cc13xx_26xx_sdk-4.10">TI SimpleLink CC13x2 / CC26x2 SDK 4.10.00.00</a>
7877
</td>
7978
<td>
8079
<ul>
81-
<li>Simple Serial Socket</a></li>
82-
<li>Bluetooth 5 Simple Serial Socket</li>
80+
<li>Simple Serial Socket</li>
81+
<li>Bluetooth 5 Throughput Demo</li>
8382
</ul>
8483
</td>
8584
</tr>
8685
<tr>
8786
<td>
88-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_sdk-3.20">TI SimpleLink CC13x2 / CC26x2 SDK 3.20.00.67</a>
87+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_cc13xx_26xx_sdk-3.20">TI SimpleLink CC13x2 / CC26x2 SDK 3.20.00.67</a>
8988
</td>
9089
<td>
9190
<ul>
@@ -97,7 +96,7 @@ For examples for other SDK versions and platforms, see table below.
9796
</tr>
9897
<tr>
9998
<td>
100-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_sdk-2.40">TI SimpleLink CC13x2 / CC26x2 SDK 2.40.00.81</a>
99+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_cc13xx_26xx_sdk-2.40">TI SimpleLink CC13x2 / CC26x2 SDK 2.40.00.81</a>
101100
</td>
102101
<td>
103102
<ul>
@@ -107,7 +106,7 @@ For examples for other SDK versions and platforms, see table below.
107106
</tr>
108107
<tr>
109108
<td>
110-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_sdk-2.30">TI SimpleLink CC26x2 SDK 2.30.00.34</a>
109+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_cc26x2_sdk-2.30">TI SimpleLink CC26x2 SDK 2.30.00.34</a>
111110
</td>
112111
<td>
113112
<ul>
@@ -121,7 +120,7 @@ For examples for other SDK versions and platforms, see table below.
121120
</tr>
122121
<tr>
123122
<td>
124-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_sdk-2.10">TI SimpleLink CC26x2 SDK 2.10.00.44</a>
123+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_cc26x2_sdk-2.10">TI SimpleLink CC26x2 SDK 2.10.00.44</a>
125124
</td>
126125
<td>
127126
<ul>
@@ -133,7 +132,7 @@ For examples for other SDK versions and platforms, see table below.
133132
</tr>
134133
<tr>
135134
<td>
136-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_sdk-1.60">TI SimpleLink CC26x2 SDK 1.60.00.43</a>
135+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_sdk-1.60">TI SimpleLink CC26x2 SDK 1.60.00.43</a>
137136
</td>
138137
<td>
139138
<ul>
@@ -145,21 +144,21 @@ For examples for other SDK versions and platforms, see table below.
145144
</tr>
146145
<tr>
147146
<td>
148-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_cc2640r2_sdk-2.20">TI SimpleLink CC2640R2 SDK 2.20.00.49</a>
147+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_cc2640r2_sdk-2.20">TI SimpleLink CC2640R2 SDK 2.20.00.49</a>
149148
</td>
150149
<td>
151150
<ul>
152-
<li><a href="#simple-serial-socket">Simple Serial Socket</a></li>
153-
<li><a href="#micro-ble-stack-broadcaster-observer">Micro BLE Stack Broadcaster Observer</li>
154-
<li><a href="#bidirectional-audio">Bidirectional Audio</li>
155-
<li><a href="#simple-peripheral-observer">Simple Peripheral Observer</li>
156-
<li><a href="#apple-notification-center-service">Apple Notification Center Service</li>
151+
<li>Simple Serial Socket</li>
152+
<li>Micro BLE Stack Broadcaster Observer</li>
153+
<li>Bidirectional Audio</li>
154+
<li>Simple Peripheral Observer</li>
155+
<li>Apple Notification Center Service</li>
157156
</ul>
158157
</td>
159158
</tr>
160159
<tr>
161160
<td>
162-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_sdk-1.50">TI SimpleLink CC2640R2 SDK 1.50.00.58</a>
161+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_sdk-1.50">TI SimpleLink CC2640R2 SDK 1.50.00.58</a>
163162
</td>
164163
<td>
165164
<ul>
@@ -173,7 +172,7 @@ For examples for other SDK versions and platforms, see table below.
173172
</tr>
174173
<tr>
175174
<td>
176-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_sdk-1.40">TI SimpleLink CC2640R2 SDK 1.40.00.45</a>
175+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_sdk-1.40">TI SimpleLink CC2640R2 SDK 1.40.00.45</a>
177176
</td>
178177
<td>
179178
<ul>
@@ -188,7 +187,7 @@ For examples for other SDK versions and platforms, see table below.
188187
</tr>
189188
<tr>
190189
<td>
191-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/simplelink_sdk-1.35">TI SimpleLink CC2640R2 SDK 1.35.00.33</a>
190+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_sdk-1.35">TI SimpleLink CC2640R2 SDK 1.35.00.33</a>
192191
</td>
193192
<td>
194193
<ul>
@@ -200,7 +199,7 @@ For examples for other SDK versions and platforms, see table below.
200199
</tr>
201200
<tr>
202201
<td>
203-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/ble_examples-2.2">TI BLE-Stack SDK v2.2.x</a>
202+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/ble_examples-2.2">TI BLE-Stack SDK v2.2.x</a>
204203
</td>
205204
<td>
206205
<ul>
@@ -225,7 +224,7 @@ For examples for other SDK versions and platforms, see table below.
225224
</tr>
226225
<tr>
227226
<td>
228-
<a href = "https://github.com/ti-simplelink/ble_examples/tree/ble_examples-2.1">TI BLE-Stack SDK v2.1.x</a>
227+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/ble_examples-2.1">TI BLE-Stack SDK v2.1.x</a>
229228
</td>
230229
<td>
231230
<ul>
@@ -250,47 +249,39 @@ Older releases can be accessed by checking out/downloading their corresponding
250249
branch. For more information on supported examples
251250
please consult the readme.md of the desired branch/release.
252251

253-
For for more information about different SDK components, please consult the
254-
BLE-stack User's Guide.
255-
256252
## Change Log
257253

258254
Note: The version numbers below are related to GitHub ble_examples releases.
259255
The numbering scheme is in the form of M.mm.pp.bb. The fields pp.bb are incremented
260256
as GitHub examples are released, M.mm will map a GitHub release to a SimpleLink
261257
SDK release.
262258

263-
### 4.10.00.00
264-
Initial offering of select SimpleLink CC2640R2 SDK 4.10.00.00 examples.
259+
### 7.20.00.00
260+
First release of the examples for SimpleLinK Low Power F3 SDK (CC23XX) & Serial Boot Loader tool.
261+
262+
### 6.40.00.00
263+
First release of the examples for CC2651R3SIPA.
265264

266-
### 3.40.00.00
267-
Initial offering of select SimpleLink CC2640R2 SDK 3.40.00.10 examples and one
268-
new example added:
269-
* Blood Pressure Monitor: This sample project implements the Blood Pressure
270-
profiles in a Bluetooth Low Energy peripheral device to provide an example
271-
blood pressure monitor (BPM) using simulated measurement data.
265+
### 5.10.00.00
266+
Update of the examples to CC13x2 / CC26x2 SDK 5.10.00.00.
267+
Only supports CC26x2R1.
272268

273-
### 3.30.00.00
274-
Initial offering of select SimpleLink CC2640R2 SDK 3.30.00.20 examples.
269+
### 4.10.00.00
270+
Update of the examples to CC13x2 / CC26x2 SDK 4.10.00.00.
271+
First release of the examples for CC1352R1.
275272

276273
### 3.20.00.00
277-
Initial offering of SimpleLink CC13x2 / CC26x2 SDK 3.20.00.67 examples supporting
278-
the rev. E of the SimpleLinkCC26x2 and CC13x2 MCUs.
274+
Initial offering of SimpleLink CC13x2 / CC26x2 SDK 3.20.00.67 examples,
275+
supporting the rev. E of the SimpleLinkCC26x2 and CC13x2 MCUs.
279276

280277
### 2.40.00.00
281278
Initial offering of SimpleLink CC13x2 / CC26x2 SDK 2.40.00.81 examples.
282279

283-
### 2.20.00.00
284-
New examples added.
285-
* BLE-Stack: Simple Serial Socket Server/Client added
286-
287-
**SPP over BLE is now deprecated and replaced by Simple Serial Socket**
288-
289280
## Installation
290281

291282
This repository can be cloned and tracked using Git. For instructions on how to
292-
clone a repository from Github please refer to this guide:
293-
[Clone from Github](https://help.github.com/articles/cloning-a-repository/)
283+
clone a repository from GitHub please refer to this guide:
284+
[Clone from GitHub](https://help.github.com/articles/cloning-a-repository/)
294285

295286
For users who are unfamiliar with Git, there is the option of downloading the
296287
contents of the repository as a zip file. See instructions below.
@@ -300,23 +291,21 @@ contents of the repository as a zip file. See instructions below.
300291
1. Zip folder will appear in your Downloads folder
301292

302293
This repository can be cloned/download anywhere on your computer. There is a
303-
dependency between this repository and the SimpleLink CC2640R2 SDK install
294+
dependency between this repository and the SimpleLink CC26x2 SDK install
304295
location.
305296

306-
By default the SimpleLink CC2640R2 SDK will install to:
297+
By default, your chosen SDK will install to ``C:\ti\``
307298

308-
C:\ti\simplelink_cc2640r2_sdk_x_xx_xx_xx
309-
310-
If the SimpleLink CC2640R2 SDK must be installed to a different location, then
311-
see the [FAQ page](docs/faq.md) for IDE specific instructions for changing
299+
If the SimpleLink SDK must be installed to a different location,
300+
then see the [FAQ page](docs/faq.md) for IDE specific instructions for changing
312301
environment variables.
313302

314303
## Required Tools
315304

316-
Similar to the SimpleLink CC2640R2 SDK, the examples in this repository support
317-
the CCS and IAR toolchains. Please refer to the release notes for the supported
318-
versions of each toolcahin. Using a non supported version is
319-
untested and may result in unexpected behavior.
305+
Similar to the SimpleLink SDK, the examples in this repository
306+
support the CCS and IAR toolchains (not for all the examples).
307+
Please pay careful attention to versions of these tools, please refer to the
308+
release notes for supported versions.
320309

321310
For more information on toolchain setup, please refer to our
322311
[FAQ page](docs/faq.md).
@@ -328,65 +317,41 @@ related to the ble_examples repo.
328317

329318
## Examples / Demo List
330319

331-
### Glucose Sensor
332-
333-
This sample project implements the Glucose Sensor profiles in a Bluetooth low
334-
energy peripheral device to provide an example of a glucose level monitor
335-
using simulated measurement data. The application implements the Sensor role of
336-
the glucose sensor profile. The project is based on the adopted profile and
337-
service specifications for glucose sensor.
338-
* glucose\_sensor
339-
* BLE 4.2
340-
* [Documentation](examples/rtos/CC2640R2_LAUNCHXL/bleapps/glucose_sensor/README.html)
341-
* [CCS Project Files](examples/rtos/CC2640R2_LAUNCHXL/bleapps/glucose_sensor/tirtos/ccs)
342-
* [Source](examples/rtos/CC2640R2_LAUNCHXL/bleapps/glucose_sensor/src)
343-
* BLE 5.0
344-
* [Documentation](examples/rtos/CC2640R2_LAUNCHXL/ble5apps/glucose_sensor/README.html)
345-
* [CCS Project Files](examples/rtos/CC2640R2_LAUNCHXL/ble5apps/glucose_sensor/tirtos/ccs)
346-
* [Source](examples/rtos/CC2640R2_LAUNCHXL/ble5apps/glucose_sensor/src)
347-
348-
### Heart Rate Sensor
349-
350-
This sample project implements the Heart Rate profiles in a Bluetooth low
351-
energy peripheral device to provide an example of a heart rate monitor
352-
using simulated measurement data. The application implements the Sensor role of
353-
the heart rate profile. The project is based on the adopted profile and
354-
service specifications for heart rate sensor.
355-
* heart\_rate
356-
* BLE 4.2
357-
* [Documentation](examples/rtos/CC2640R2_LAUNCHXL/bleapps/heart_rate/README.html)
358-
* [CCS Project Files](examples/rtos/CC2640R2_LAUNCHXL/bleapps/heart_rate/tirtos/ccs)
359-
* [Source](examples/rtos/CC2640R2_LAUNCHXL/bleapps/heart_rate/src)
360-
* BLE 5.0
361-
* [Documentation](examples/rtos/CC2640R2_LAUNCHXL/ble5apps/heart_rate/README.html)
362-
* [CCS Project Files](examples/rtos/CC2640R2_LAUNCHXL/ble5apps/heart_rate/tirtos/ccs)
363-
* [Source](examples/rtos/CC2640R2_LAUNCHXL/ble5apps/heart_rate/src)
364-
365-
### Blood Pressure Monitor
366-
367-
This sample project implements the Blood Pressure profiles in a Bluetooth low
368-
energy peripheral device to provide an example blood pressure monitor (BPM)
369-
using simulated measurement data. The application implements the Sensor role of
370-
the blood pressure profile. The project is based on the adopted profile and
371-
service specifications for blood pressure.
372-
373-
* blood\_pressure
374-
* [Documentation](examples/rtos/CC2640R2_LAUNCHXL/bleapps/blood_pressure/readme.md)
375-
* [CCS Project Files](examples/rtos/CC2640R2_LAUNCHXL/bleapps/blood_pressure/tirtos/ccs)
376-
* [Source](examples/rtos/CC2640R2_LAUNCHXL/bleapps/blood_pressure/src)
320+
### Simple Serial Socket
321+
322+
This is a UART over BLE bridge example where a Simple Serial Socket Client
323+
(SSSC) and Simple Serial Socket Server (SSSS) connect with one another and
324+
exchange UART data over the air. An generic Simple Stream Service is used
325+
making it easy to exchange data sink and source to create a custom serial
326+
socket over BLE implementation.
327+
328+
329+
#### For CC2340R5
330+
331+
* Data Stream UART Over BLE
332+
* [Documentation](examples/rtos/LP_EM_CC2340R5/ble5stack/data_stream_UART_over_BLE/README.md)
333+
* [CCS Project Files](examples/rtos/LP_EM_CC2340R5/ble5stack/data_stream_UART_over_BLE/freertos/ticlang)
334+
* [Source](examples/rtos/LP_EM_CC2340R5/ble5stack/data_stream_UART_over_BLE)
335+
* Basic BLE GATT Client
336+
* [Documentation](examples/rtos/LP_EM_CC2340R5/ble5stack/basic_ble_GATT_client/README.md)
337+
* [CCS Project Files](examples/rtos/LP_EM_CC2340R5/ble5stack/basic_ble_GATT_client/freertos/ticlang)
338+
* [Source](examples/rtos/LP_EM_CC2340R5/ble5stack/basic_ble_GATT_client)
339+
* Serial Boot Loader Tool v1.0.0
340+
* [Documentation](tools/TI_CC2340_Linux_SBL/README.md)
341+
* [Source](tools/TI_CC2340_Linux_SBL/Source)
377342

378343

379344
## References
380345

381346
The following reference pages may be helpful during general Bluetooth Low
382-
Energy development.
383-
Users developing Bluetooth applications are encouraged to read the
384-
[BLE-Stack User's Guide](http://dev.ti.com/tirex/#/?link=Software%2FSimpleLink%20CC2640R2%20SDK%2FDocuments%2FBLE-Stack%2FBLE-Stack%20User's%20Guide).
347+
Energy development. New users of the SimpleLink Low Power F3 platform and Bluetooth
348+
5 development are encouraged to read the
349+
[BLE5-Stack User's Guide](https://dev.ti.com/tirex/content/simplelink_lowpower_f3_sdk_7_20_00_29/docs/ble5stack/ble_user_guide/html/ble-stack-5.x-guide/index-cc23xx.html).
385350

386351
As an additional resource, users are encouraged to complete the
387-
[SimpleLink Academy](http://dev.ti.com/tirex/#/?link=Software%2FSimpleLink%20CC2640R2%20SDK%2FSimpleLink%20Academy)
352+
[SimpleLink Academy](https://dev.ti.com/tirex/explore/node?node=A__AEaxXmSXZjp24G7-XUfwSQ__SIMPLELINK-ACADEMY-CC23XX__gsUPh5j__LATEST)
388353
training.
389354

390355
Other resources can be found below:
391356

392-
* [BLE E2E Page](www.ti.com/ble-forum)
357+
* [BLE E2E Page](www.ti.com/ble-forum)

0 commit comments

Comments
 (0)