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