|
| 1 | + |
| 2 | +# Silicon Labs Bluetooth Applications # |
| 3 | + |
| 4 | +The Silicon Labs Bluetooth stack allows for a wide variety applications to be built on its foundation. This repo showcases some example applications using the Silicon Labs Bluetooth stack. |
| 5 | + |
| 6 | +## Project Format Example ## |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | +## Requirements ## |
| 11 | + |
| 12 | +1. Silicon Labs EFR32 Development Kit |
| 13 | +2. Simplicity Studio 5 |
| 14 | +3. Compatible SDK version that specified in each project's readme file. You can install it via Simplicity Studio or download it from our GitHub [gecko_sdk](https://github.com/SiliconLabs/gecko_sdk) or [simplicity_sdk](https://github.com/SiliconLabs/simplicity_sdk) |
| 15 | +4. Compatible Third-Party Hardware Drivers extension that also specified in each project's readme file, available [here](https://github.com/SiliconLabs/third_party_hw_drivers_extension) |
| 16 | + |
| 17 | + |
| 18 | +## Bootloader ## |
| 19 | + |
| 20 | +Note that example projects do not include bootloaders regardless of Bluetooth-based example projects requiring a bootloader on the device to support device firmware upgrade (DFU). To have a running application, you should either |
| 21 | + |
| 22 | +- flash the proper bootloader or |
| 23 | +- remove the DFU functionality from the project. |
| 24 | + |
| 25 | +If your application does not require adding a bootloader, remove the DFU functionality by uninstalling the Bootloader Application Interface software component including all of its dependents. This automatically puts your application code to the start address of the flash, which means that a bootloader is no longer needed. Note that you are not able to upgrade your firmware after the removal of the DFU functionality. |
| 26 | + |
| 27 | +If you want to add a bootloader, you can either |
| 28 | + |
| 29 | +- Create a bootloader project, build it and flash it to your device. Note that different projects expect different bootloaders: |
| 30 | + |
| 31 | + - for NCP and RCP projects create a BGAPI UART DFU type bootloader |
| 32 | + - for SoC projects on Series 1 devices create a Bluetooth in-place OTA DFU type bootloader - or any Internal Storage type bootloader |
| 33 | + - for SoC projects on Series 2 devices create a Bluetooth Apploader OTA DFU type bootloader |
| 34 | + |
| 35 | +- or run a pre-compiled demo on your device from the Launcher view before flashing your application. Pre-compiled demos flash both bootloader and application images to the device. Flashing your own application image after the demo overwrites the demo application, but leave the bootloader in place. |
| 36 | + |
| 37 | + - For NCP and RCP projects, flash the Bluetooth - NCP demo. |
| 38 | + - For SoC projects, flash the Bluetooth - SoC Thermometer demo. |
| 39 | + |
| 40 | +Important Notes: |
| 41 | + |
| 42 | +- when you flash your application image to the device, use the .hex or .s37 output file. Flashing .bin files may overwrite (erase) the bootloader. |
| 43 | + |
| 44 | +- On Series 1 devices (EFR32xG1x), both first stage and second stage bootloaders have to be flashed. This can be done at once by flashing the -combined.s37 file found in the bootloader project after building the project. |
| 45 | + |
| 46 | +- On Series 2 devices SoC example projects require a Bluetooth Apploader OTA DFU type bootloader by default. This bootloader needs a lot of flash space and does not fit into the regular bootloader area, hence the application start address must be shifted. This shift is automatically done by the Apploader Support for Applications software component, which is installed by default. If you want to use any other bootloader type, you should remove this software component in order to shift the application start address back to the end of the regular bootloader area. Note, that in this case you cannot do OTA DFU with Apploader, but you can still implement application-level OTA DFU by installing the Application OTA DFU software component instead of In-place OTA DFU. |
| 47 | + |
| 48 | +For more information on bootloaders, see [UG103.6: Bootloader Fundamentals](https://www.silabs.com/documents/public/user-guides/ug103-06-fundamentals-bootloading.pdf) and [UG489: Silicon Labs Gecko Bootloader User's Guide for GSDK 4.0 and Higher](https://www.silabs.com/documents/public/user-guides/ug489-gecko-bootloader-user-guide-gsdk-4.pdf). |
| 49 | + |
| 50 | +## Documentation ## |
| 51 | + |
| 52 | +The official Bluetooth documentation is available on the [Developer Documentation](https://docs.silabs.com/bluetooth/latest/) page. |
| 53 | + |
| 54 | +## Reporting Bugs/Issues and Posting Questions and Comments ## |
| 55 | + |
| 56 | +To report bugs in the Application Examples projects, please create a new "Issue" in the "Issues" section of this repo. Please reference the board, project, and source files associated with the bug, and reference line numbers. If you are proposing a fix, also include information on the proposed fix. Since these examples are provided as-is, there is no guarantee that these examples will be updated to fix these issues. |
| 57 | + |
| 58 | +Questions and comments related to these examples should be made by creating a new "Issue" in the "Issues" section of this repo. |
| 59 | + |
| 60 | +## Disclaimer |
| 61 | + |
| 62 | +The Gecko SDK suite supports development with Silicon Labs IoT SoC and module devices. Unless otherwise specified in the specific directory, all examples are considered to be EXPERIMENTAL QUALITY which implies that the code provided in the repos has not been formally tested and is provided as-is. It is not suitable for production environments. In addition, this code will not be maintained and there may be no bug maintenance planned for these resources. Silicon Labs may update projects from time to time. |
0 commit comments