xref: /btstack/port/nrf5-cinnamon/README.md (revision 34fd36da1820bede7fdeb1f09f53c180688c8c25)
1*34fd36daSMatthias Ringwald# BTstack Port with Cinnamon for Nordic nRF5 Series
20138fcaeSMatthias Ringwald
30138fcaeSMatthias Ringwald*Cinnamon* is BlueKitchen's minimal, yet robust Controller/Link Layer implementation for use with BTstack.
40138fcaeSMatthias Ringwald
50138fcaeSMatthias RingwaldIn contrast to common Link Layer implementations, our focus is on a robust and compact implementation for production use,
60138fcaeSMatthias Ringwaldwhere code size matters (e.g. current code size about 8 kB).
70138fcaeSMatthias Ringwald
80138fcaeSMatthias Ringwald## Status
90138fcaeSMatthias RingwaldThe current implementation supports a single Peripheral role, or, passive scanning in Observer role. In the Peripheral role,
100138fcaeSMatthias Ringwaldchannel map updates, as well as connection param updates are supported.
110138fcaeSMatthias Ringwald
120138fcaeSMatthias RingwaldSupport for LE Central Role as well as Encryption is planned but not supported yet.
130138fcaeSMatthias Ringwald
140138fcaeSMatthias Ringwald## Requirements
150138fcaeSMatthias Ringwald- arm-none-eabi toolchain
160138fcaeSMatthias Ringwald- Nordic's nRF5-SDK
170138fcaeSMatthias Ringwald
180138fcaeSMatthias Ringwald## Supported Hardware
190138fcaeSMatthias RingwaldAll nNRF5x SOCs. Built files are provided for PCA10040 (52832 DK), but others can be supported with minimal changes.
200138fcaeSMatthias Ringwald
210138fcaeSMatthias Ringwald## Use
220138fcaeSMatthias Ringwald- Provide path to nRF5-SDK either in `NRF5_SDK_ROOT` environment variable or directly in `pca10040/armgcc/Makefile`.
230138fcaeSMatthias Ringwald- run make
240138fcaeSMatthias Ringwald- All supported examples are built in the `build` folder.
250138fcaeSMatthias Ringwald- You can use Segger's OZONE with the provided `EXAMPLE.jdebug` project file to flash and run the examples.
26