license: update source file and licensing files
[libsi24] / README.md
1 # Library for SI24R1
2 SI24R1 is a very low power wireless chip in the 2.4 GHz ISM radio band.
3 This is a clone of the original NRF24l01 chip. I do not have the
4 original chip, but as far as I can tell this are pin and silicon compatible.
5
6 ## How to use
7 You will probably need to include the header and source file to your
8 project and glue ``int (*write_and_read)(unsigned char *data, size_t sz)``
9 and ``void (*chip_enable)(unsigned val)`` functions to your specific SPI 
10 HAL vendor calls. 
11
12 ## Example projects
13 Here is a list of example projects that include this library:
14
15 - ESP32: https://github.com/robinkrens/esp32-si24r1-example
16
17 ## Pinout picture
18 My chip does not have a silk screen. Luckily it is compatible with 
19 the nrf24l01. Here is a picture for reference:
20
21 ![pinout](https://github.com/robinkrens/libsi24/raw/master/doc/si24r1-pinout.jpg)
22
23 ## Currently supported functionality
24 - [X] Receiver mode 
25 - [X] Transfer mode
26 - [X] Dynamic payloads
27
28 ## Not supported yet 
29 - [ ] Multiple channels
30
31 ## References
32 - https://datasheet.lcsc.com/szlcsc/1811142211_Nanjing-Zhongke-Microelectronics-Si24R1_C14436.pdf