Skip to content

Commit 6b88370

Browse files
jan-TIjan-TI
committed
Updated top-level docs
1 parent c16914d commit 6b88370

File tree

2 files changed

+28
-111
lines changed

2 files changed

+28
-111
lines changed

‎README.md‎

Lines changed: 24 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -12,32 +12,42 @@
1212

1313
# Introduction
1414

15-
These examples and demos are for **TI SimpleLink Low Power F3 SDK 7.20.xx.xx**
16-
17-
This repository contains *Bluetooth® Low Energy* sample applications for
15+
This repository contains *Bluetooth® Low Energy* & *Proprietary RF* sample applications for
1816
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.
17+
18+
These examples are each hosted on different branches of this repo. Please reference the table below to find examples for each of these SDKs.
2019

2120
These examples have not been validated as production-ready.
2221

2322
**Do not** use GitHub's bug tracking feature for support. For inquiries, see the
24-
[Bluetooth® low energy Forum](https://e2e.ti.com/support/wireless_connectivity/bluetooth_low_energy/f/538).
23+
[Bluetooth® low energy Forum](https://e2e.ti.com/support/wireless_connectivity/bluetooth_low_energy/f/538)
24+
and the [Other Wireless Technologies Forum](https://e2e.ti.com/support/wireless-connectivity/other-wireless-group/other-wireless/f/other-wireless-technologies-forum).
2525

2626
To use the examples and tools in this repository, please download and install
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:
29-
30-
* [LP-EM-CC2340R5](https://www.ti.com/tool/LP-EM-CC2340R5)
27+
the relevant SDK listed in a given branch **first**, and if necessary obtain the required evaluation kit:
3128

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

3532
<table>
3633
<tbody>
3734
<tr>
3835
<th width = 50%>SDK</th>
3936
<th>Examples</th>
4037
</tr>
38+
<tr>
39+
<td>
40+
<a href = "https://github.com/TexasInstruments/ble_examples/tree/simplelink_low_power_f3_sdk-7.40">TI SimpleLink Low Power F3 SDK 7.40.00.00</a>
41+
</td>
42+
<td>
43+
<ul>
44+
<li>Data Stream UART over BLE example</li>
45+
<li>Basic BLE GATT Client example</li>
46+
<li>UART RF Carrier Wave</li>
47+
<li>Serial Boot Loader Tool v1.0.0 (SDK version independent)</li>
48+
</ul>
49+
</td>
50+
</tr>
4151
<tr>
4252
<td>
4353
<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>
@@ -256,6 +266,10 @@ The numbering scheme is in the form of M.mm.pp.bb. The fields pp.bb are incremen
256266
as GitHub examples are released, M.mm will map a GitHub release to a SimpleLink
257267
SDK release.
258268

269+
### SimpleLink Low Power F3 SDK Examples 7.40.00.00
270+
Update of the examples for SimpleLinK Low Power F3 SDK (CC23XX) & Serial Boot Loader tool.
271+
Addition of UART
272+
259273
### 7.20.00.00
260274
First release of the examples for SimpleLinK Low Power F3 SDK (CC23XX) & Serial Boot Loader tool.
261275

@@ -315,31 +329,6 @@ For more information on toolchain setup, please refer to our
315329
The [FAQ page](docs/faq.md) will try to address some of the common questions
316330
related to the ble_examples repo.
317331

318-
## Examples / Demo List
319-
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)
342-
343332

344333
## References
345334

‎docs/faq.md‎

Lines changed: 4 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,13 @@
11
## Frequently Asked Questions
22

3-
* [What if I installed the SimpleLink CC2640R2 SDK at a non default location (i.e. not at ``C:\ti\simplelink_cc2640r2_sdk_x_xx_xx_xx``)?](#default)
4-
* [Why am I getting an error when I am trying to run a Python script from the /tools folder?](#python)
5-
* [How can I setup my toolchain for use with the ble\_examples repo?](#toolchain)
63
* [I am using a LaunchPad device, how can I view display data?](#display)
74
---
85

9-
### <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_x_xx_xx_xx``)?
10-
11-
All projects reference files from the BLE stack using environment variables, you
12-
can change this in your IDE's project files.
13-
14-
**CCS**
15-
16-
No changes to the project is necessary. You just need to ensure that Code
17-
Composer Studio was able to discover the SimpleLink CC2640R2 SDK in the
18-
available *RTSC Products* tab. See the
19-
[BLE-Stack User's Guide](http://dev.ti.com/tirex/#/?link=Software%2FSimpleLink%20CC2640R2%20SDK%2FDocuments%2FBLE-Stack%2FBLE-Stack%20User's%20Guide)
20-
for more details.
21-
22-
23-
**IAR**
24-
25-
1. Navigate to the sample project directory within the repo and open the
26-
`.custom_argvars` file.
27-
1. Update the value of ``SIMPLELINK_CORE_SDK_INSTALL_DIR`` to point to your
28-
custom installation directory where you installed the SimpleLink CC2640R2 SDK.
29-
30-
---
31-
### <a name="versioning"></a>How should I keep my application based on a TI BLE-Stack SDK under version control?
32-
33-
There are many ways to solve and address this issue. We are merely presenting
34-
one suggested workflow out of the many combinations that exist.
35-
36-
Since this is an advanced topic, it has its own page dedicated to it.
37-
You can read more here: [Version Control](suggested_workflow.md)
38-
39-
---
40-
41-
### <a name="python"></a>Why am I getting an error when I am trying to run a Python script from the /tools folder?
42-
43-
Likely your Python environment is not installed correctly. Please check the
44-
following debug steps:
45-
46-
1. All scripts in the tools folder use Python 2.7, ensure that you have this
47-
version installed to `C:\Python27`
48-
1. Python scripts can be invoked using `python <script_name>.py` this requires
49-
adding Python to your environment variables.
50-
* Add ``C:\Python27`` to the `PATH` variable within your Windows environment
51-
variables, see
52-
[windows env vars](https://www.java.com/en/download/help/path.xml) for more
53-
info.
54-
1. If you can run the script successfully but get a runtime error, you likely
55-
don't have the necessary python modules installed.
56-
* Python modules can be found by looking at the `import` statements at the top
57-
of the `.py` file. You can install Python modules using the Python package
58-
manager, pip.
59-
- Install Pip by following
60-
[these steps](http://stackoverflow.com/questions/4750806/how-do-i-install-pip-on-windows).
61-
The section "Python 2 ≤ 2.7.8 and Python 3 ≤ 3.3" will be most helpful.
62-
63-
---
64-
65-
### <a name="toolchain"></a>How can I setup my toolchain for use with the ble\_examples repo?
66-
67-
**CCS**
68-
69-
For BLE-Stack examples, see the *Developing with CCS* section of the
70-
[BLE-Stack User's Guide](http://dev.ti.com/tirex/#/?link=Software%2FSimpleLink%20CC2640R2%20SDK%2FDocuments%2FBLE-Stack%2FBLE-Stack%20User's%20Guide).
71-
**IAR**
72-
73-
For BLE-Stack examples, see the *Developing with IAR* section of the
74-
[BLE-Stack User's Guide](http://dev.ti.com/tirex/#/?link=Software%2FSimpleLink%20CC2640R2%20SDK%2FDocuments%2FBLE-Stack%2FBLE-Stack%20User's%20Guide).
75-
76-
---
77-
786
### <a name="display"></a>I am using a LaunchPad device, how can I view display data?
797

80-
LaunchPad projects are already set up to use the tidriver Display. For more
81-
information about the Display driver please see the Display.h driver
82-
documentation in the SimpleLink CC2640R2 SDK (`docs/tidrivers/tidriversAPI.html`)
8+
LaunchPad projects general display output data through the use of a Display driver. For more
9+
information the specific driver used depends on the SDK and the example, but all of these
10+
drivers are thoroughly documented and may be modified to suit the project's needs.
8311

8412
To setup your PC to receive this data please follow the steps below:
8513

@@ -98,4 +26,4 @@ To setup your PC to receive this data please follow the steps below:
9826
|:---------------------------------------------:|:-------------------------------------:|
9927
| ![Putty Main](resources/putty_main_scrn.png) | ![Putty serial](resources/putty_serial_scrn.png) |
10028

101-
**You may need to unplug/replug your LaunchPad and restart PuTTY if you do not see any output.**
29+
**You may need to unplug/replug your LaunchPad and restart PuTTY if you do not see any output.**

0 commit comments

Comments
 (0)