aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bfbfcd5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+raspi-rfm95-kiss
+================
+
+Use an RFM95 LoRa module connected to spidev0.0 as an AX.25 interface. The whole chain this code implements is:
+
+AX.25 kernel interface - KISS protocol over a PTY pair - KISS protocol implementation - RFM95 driver - SPI
+
+TODO
+====
+
+* [ ] KISS protocol implementation
+* [ ] RFM95 send
+* [ ] RFM95 recv in polling mode
+* [ ] RFM95 recv in GPIO interrupt mode
+
+
+License
+-------
+
+Parts of this code are taken from the ax25-tools, which are GPL-2.0. Other parts are MIT or Apache 2.0 licensed.
+
+New code is Copyright 2018 Matthias P. Braendli, GPL-2.0-only
+
+
+Misc remarks
+------------
+
+1. (Not needed) To build with wiringpi in dev mode: `cargo build --features wiringpi/development`