From 8a71985d120e79ceb54a41cd5f487d61f12ffc38 Mon Sep 17 00:00:00 2001 From: marcel Date: Fri, 29 Apr 2022 17:50:21 +0200 Subject: [PATCH] README.md editted --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a3cde5c..77d60a8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # lora_aprs_node_pico -LoRa communication for Raspberry Pi RP2040 Microcontroller. +A simple LoRa APRS module which can be used as a remote data logger and/or remote I/O controller. It is an evolution of another project of mine: [https://www.meezenest.nl/mees-elektronica/aprs_telemetry.html](https://www.meezenest.nl/mees-elektronica/aprs_telemetry.html) -This program is written for RP2040 C++ SDK. +This program is written for the RP2040 C++ SDK. ## Supported Hardware * RP2040 boards @@ -22,17 +22,16 @@ This program is written for RP2040 C++ SDK. | GPIO 9 | RESET | | GPIO 10 | DIO1 / G1 | -Default Pinout can be overrided with setPins() function +Default pinout can be overrided with the setPins() function ## Installation -1. [Set up the Pico C/C++ SDK](https://github.com/raspberrypi/pico-sdk) -2. Download this repo -3. Set `PICO_SDK_PATH` +1. Download this repo +2. Set `PICO_SDK_PATH` to included pico-sdk ```sh export PICO_SDK_PATH="path to pico-sdk" ``` -4. Create `build` directory then run `cmake` and `make`: +3. Create `build` directory then run `cmake` and `make`: ```sh mkdir build cd build @@ -40,7 +39,7 @@ cmake .. make ``` ## Notes -Currently this is only tested on Raspberry Pi Pico and Semtech1278 board. Feel free to reach out for any bugs or support. +I added the pico-sdk to prevent compatibility issues. Probably not a recommended practice, but there you go! ## References -This [project](https://github.com/akshayabali/LoRa-RP2040) is based on LoRa Library for Arduino:[sandeepmistry/arduino-LoRa](https://github.com/sandeepmistry/arduino-LoRa) +This project is based on the works of [akshayabali](https://github.com/akshayabali/LoRa-RP2040) which is based on the LoRa Library for Arduino:[sandeepmistry/arduino-LoRa](https://github.com/sandeepmistry/arduino-LoRa)