mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-01-01 00:28:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

zephyr: update readme

Browse Source
This commit is contained in:
Matthias Ringwald 2023-06-20 14:45:53 +02:00
parent fba2f984f0
commit 87521db174
1 changed files with 41 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
port/zephyr/README.md
View File

@ -1,39 +1,66 @@
# Bluetooth: btstack
# BTstack Port for Zephyr RTOS
## Overview
This sample demonstrates Bluetooth functionality utilizing btstack.
This port targets any platform supported by Zephyr that either contains a built-in Bluetooth Controller
or is connected to an external Controller via one of the supported Zephyr HCI Transports drivers (see `zephyr/drivers/bluetooth/hci`)
## Requirements
## Status
Tested with nRF52 DK (PCA10040) and nRF52840 DK (PC10056) boards only. It uses the fixed static random BD ADDR stored in NRF_FICR, which will not compile on non nRF SoCs.
* A board with Bluetooth LE support
## Building and Running
first step needs only be done once.
Step two every time.
The first step needs to done once. Step two is needed every time to setup the environment.
### 1. Build Environment Preconditions
### 1. Build environment preconditions
Follow the getting started [guide](https://docs.zephyrproject.org/latest/develop/getting_started/index.html)
till you can build samples.
Then update 'env.sh' accordingly.
until you are able to build an example.
Then update the `ZEPHYR_ROOT` variable in `env.sh` to point to your `zephyrproject`. Defaults to `~/zephyrproject`
### 2. Prepare the build environmet
before beeing able to build this sample the environment needs to be prepared with:
To setup your environment to build a BTstack example, run the provided setup in `env.sh`.
```sh
source env.sh
```
### 3. Building samples
You can build using:
### 3. Build Example
You can build an example using:
```sh
west build -b nrf52840dk_nrf52840
```
to change zephyr platform settings use:
`nrf52840dk_nrf52840` selected the Nordic nRF52840 DK. For the older nRF52 DK with nRF52832, you can specify nrf52dk_nrf52832.
To get a list of all supported Zephyr targets, run `west boards`
To change zephyr platform settings use:
```sh
west build -b nrf52840dk_nrf52840 -t menuconfig
```
to build a different example:
To build a different example, e.g. the `gatt_streamer_server`, set the EXAMPLE environment variable:
```sh
EXAMPLE=gatt_streamer_server west build -b nrf52840dk_nrf52840
```
### 4. Flash Example
To flash a connected board:
```sh
west flash
```
## TODO
- Read NRF_FICR on Nordic SoCs
- Allow/document use of Zephyr HCI Drivers