README.md

Warning: This code uses the 433,5 MHz as well as other potentially country-specific settings. Lookup if this is allowed in your country and change the details in src/PinedioLoraRadio.cpp!

This is a heavily modified fork from https://codeberg.org/JF002/pinedio-lora-driver .

# Board-Docs
[LoRa USB adapter](https://wiki.pine64.org/wiki/Pinedio#USB_adapter)
[Pinephone backplate](https://wiki.pine64.org/wiki/Pinedio#Pinephone_backplate).

# Build
```bash
git clone xxx
cd pinedio-lora-driver
git submodule update --init
```
In the SX-Library, the workaround-patch needs to be applied due to a not yet debugged bug in the kernel driver. Afterwards:
```bash
mkdir build && cd build
cmake ..
make -j
```

# Dependencies
You need to install and load [this driver](https://github.com/rogerjames99/spi-ch341-usb) to be able to use the USB adapter. This spi-ch341-usb is a driver that configures the CH341 chip (USB <-> serial converter) mounted on the USB adapter and exposes it as a `spidev` (userland SPI API) device.

# Current state of this project
This is only a PoC currently.

## TODO
 - [ ] Remove unnecessary `sleep()`
 - [ ] migrate to https://github.com/dimich-dmb/spi-ch341-usb and test if it works better (eg. without the patch).
 - [ ] Expose LoRa-Config to be able to fed into the library
 - [ ] replace some mutex-hacks with proper notify
 - [ ] Make a file that works on PineDio as well as the PinePhone LoRa-Backplate
 - [ ] ...

# License
This project is released under the terms of the **LGPLv3 license**.