This repository contains the ble5stack examples for TI devices supported by the SimpleLink Low Power F2 and F3 SDKs. To learn which devices are supported by each SDK, refer to the SDK Device Association section.
The examples/ directory contains the same ble5stack examples provided in those SDKs, in the same directory structure.
The SimpleLink Low Power F2 and F3 SDKs are provided as Git submodules in their respective subdirectories. If you're only interested in devices supported by the F3 SDK, you will only need to initialize and update the F3 SDK submodule.
As a quick reference, you can initialize and update a single Git submodule in one step like this:
# To initialize and update the F2 SDK
.../simplelink-ble5stack-examples$ git submodule update --init cc13xx_cc26xx_sdk
# To initialize and update the F3 SDK
.../simplelink-ble5stack-examples$ git submodule update --init simplelink-lowpower-f3-sdkAlternatively you can initialize/update all submodules when cloning a repo
with git clone --recurse-submodules {repo-ref}. See Git documentation for
details.
Once initialized and updated, you can refer to each SDK's README.md and Release Notes for details on how to download its dependencies, and build its libraries.
Note, the links above are to online copies of the latest SDK READMEs. They are useful for online readers, but be sure to consult the SDK submodule's actual README.md after cloning, checking out your branch/tag, and updating your submodule, as details may change from release to release.
Each time you update an SDK submodule, you will need to build its libraries.
This process can vary between the different SDKs, so refer to each SDK's
README.md for specifics, but generally you will need to edit the imports.mak
file at the top, then run make.
Note that sometimes the dependencies can vary from SDK to SDK. For example, if you've been using the F2 SDK and SysConfig version X, and want to start using the F3 SDK, it may require a newer SysConfig version. So, again, be sure to refer to each SDK's README.md and Release Notes.
Often newer versions of dependencies are compatible, so you can use newer-and-compatible versions than the SDK was validated against. But each SDK does have its own imports.mak so you can specify different dependency versions for each SDK if needed.
After building the SDK libraries, you can build the ble5stack examples. The examples support a few ways to build:
Remember, before building the examples, you must build the SDK libraries!
The examples also include TI Code Composer Studio (CCS) project support, enabling them to be imported into, and built by, CCS.
Before importing the example, the SDK(s) location must be registered with CCS:
- Preferences->Code Composer Studio->Products
- Select Add...
- Navigate to the SDK submodule location
- Select Open
Repeat for each SDK you will be using. This registers the SDK with CCS. Successful registration of an SDK will show it in the "Discovered Products" list:
If using FreeRTOS, its location must also be configured in CCS:
- Preferences->Code Composer Studio->Build->Environment
- Select Add...
- Add the variable name
FREERTOS_INSTALL_DIR - Assign it to the absolute path of your installation of FreeRTOS
Now you can import an example!
- Project->Import CCS Project...
- Select search-directory->Browse...
- Navigate to a directory within your clone of the example repo to search for examples and Select Folder
- Select the example(s) you wish to import and press Finish
Remember, before building the examples, you must build the SDK libraries!
Follow the instructions in your respective SDK's Quick Start Guide:
Click the links below to find the devices supported by each SDK.