diff --git a/INSTALL.md b/INSTALL.md index 6f200ad..6725005 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,4 +1,4 @@ -# Installation and running the RPi-LoRa-Gateway +# Installation and running the RPi-LoRa-shield with APRX ## Install needed packages ` @@ -6,63 +6,12 @@ sudo apt install python3 python3-rpi.gpio python3-spidev aprx screen git python3 ` ## Checkout the code -Enter following commands:
-``` -cd -git clone https://github.com/tomelec/RPi-LoRa-KISS-TNC.git -cd RPi-LoRa-KISS-TNC -git clone https://github.com/mayeranalytics/pySX127x.git -``` -to change into homedirectory and then checkout the code and the LoRa Chip-Driver in the right directory. - -## Configuration -Afterwards configure as following: -### Edit aprx/aprx.conf.lora-aprs file -Type: -``` -cd -cd RPi-LoRa-KISS-TNC -sudo cp aprx/aprx.conf.lora-aprs /etc/aprx.conf -pico -w /etc/aprx.conf -``` -to copy and then open the config file. - -The most important settings are: -* **mycall**
-Your call with an apropriate SSID suffix
[Paper on SSID's from aprs.org](http://www.aprs.org/aprs11/SSIDs.txt) -* **myloc**
-NMEA lat/lon form: -``` -lat ddmm.mmN lon dddmm.mmE -``` -Example: -``` -lat 4812.52N lon 01622.39E -``` -(simplest way to find the right coordinats for this? Go to [aprs.fi](http://www.aprs.fi) on your location right-click and choose "Add marker" then click on the marker and you should see your coordinates in the NMEA style - enter this infos without any symbols into the config file as seen in the example above) - -* **passcode**
-see [see here to generate appropiate setting](https://apps.magicbug.co.uk/passcode/) -* **server**
-either leave the default server or if you're connected to Hamnet as well insert an APRSIS Server within the hamnet - a List of Aprs Hamnet servers can be found in the [OEVSV Wiki](http://wiki.oevsv.at/index.php/Anwendungen_am_HAMNET#APRS_Server)) +Clone this repository. +## Configuration -to save and close the file do: -`Strg + x` -> Y -> Enter - -### Edit driver config file -Type -``` -pico -w pySX127x/SX127x/board_config.py -``` -change in line 36 -from -``` -DIO0 = 22 # RaspPi GPIO 22 -DIO0 = 5 # RaspPi GPIO 5 -``` -to fix the SPI connection #todo how can we config this from outside? +Edit /etc/aprx.conf according to example in aprx/aprx.conf.lora-aprs ## Start the LoRa KISS TNC and aprx server instance ``` diff --git a/README.md b/README.md index f0691bc..938f9f9 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,14 @@ # Raspberry Pi LoRa KISS TNC -This project emulates a KISS TNC and controls a hardware LoRa transceiver -connected to the Raspberry´s SPI. That makes it possible to use existing -software, like digipeaters, with LoRa radio communication. The KISS TNC is -accessed via its TCP server. - -The current application is to run the KISS TNC together with the APRS digi [APRX](https://github.com/PhirePhly/aprx), which connects via TCP and provides -powerful APRS digipeating and I-gate functionality for LoRa-APRS. +This project was originally started by Tom Kottek (https://github.com/tomelec/RPi-LoRa-KISS-TNC). Because the program had some problems dealing with digipeated frames (it crashed when receiving a ssid with the 'has_been_digipeated' flag -*- set), I took on the task of fixing the code for my personal use. ## Hardware -The LoRa KISS TNC runs on Raspberry Pi 2 or newer together with the -*LoRa APRS Gateway Hat V2.0*. However, RFM98W oder RFM96W LoRa modules can -be wired up to the Raspberry Pi directly aswell. See the -[schematic](doc/LoRaAPRS-GW-RPI_V20_Schematic.pdf) for details. - -![Gateway on RPi](doc/images/LoRa-APRS_Gateway_V20.jpg) +I also designed my own (open source) hardware for it: a board holding a Raspberry Pi Zero 2 W, an SX1278 LoRa transceiver and a power supply with on/off button to safely switch on and off the system. The design files can be found on my website: [RPi LoRa_shield](https://meezenest.nl/mees/RPi_LoRa_shield.html) -## Development +## Software -This program and documentation is in a very early state and very experimental. -Only the LoRa radio modem of the gateway board is supported at the moment. -Display and buttons are not working. +The software controls the LoRa transceiver connected to the Raspberry´s SPI bus and emulates a KISS TNC over TCP. That makes it possible to use existing software like APRX. It is also possible to attach the KISS interface to the AX.25 stack via socat/kissattach. ### To Do -* Python 3 compatibility -* Get display and buttons working -* Noise floor telemetry -* Installation guide and documentation -* Proper configuration file -* ... +* A lot