README.md
1# BTstack Port with Cinnamon for Nordic nRF5 Series
2
3*Cinnamon* is BlueKitchen's minimal, yet robust Controller/Link Layer implementation for use with BTstack.
4
5In contrast to common Link Layer implementations, our focus is on a robust and compact implementation for production use,
6where code size matters (e.g. current code size about 8 kB).
7
8## Status
9The current implementation supports a single Peripheral role, or, passive scanning in Observer role. In the Peripheral role,
10channel map updates, as well as connection param updates are supported.
11
12Support for LE Central Role as well as Encryption is planned but not supported yet.
13
14## Requirements
15- arm-none-eabi toolchain
16- Nordic's nRF5-SDK
17
18## Supported Hardware
19All nNRF5x SOCs. Built files are provided for PCA10040 (52832 DK), but others can be supported with minimal changes.
20
21## Use
22- Provide path to nRF5-SDK either in `NRF5_SDK_ROOT` environment variable or directly in `pca10040/armgcc/Makefile`.
23- run make
24- All supported examples are built in the `build` folder.
25- You can use Segger's OZONE with the provided `EXAMPLE.jdebug` project file to flash and run the examples.
26