Update README.md and Dockerfile

pull/61/head
Pieter Robyns 2017-09-20 12:21:03 +02:00
rodzic 040be7eb48
commit 994f80ce53
2 zmienionych plików z 22 dodań i 14 usunięć

Wyświetl plik

@ -65,23 +65,30 @@ make && sudo make install
## Testing and usage ## Testing and usage
To test your installation, you can download one of the example LoRa signals at [rpp0/gr-lora-samples](https://github.com/rpp0/gr-lora-samples). Configure ```apps/lora_receive_file.py``` to use the sample and run the script. You should see the decoded sample data: To test your installation, you can simply run the example app ```apps/lora_receive_file_nogui.py```. The script will download an example trace, and attempt to decode it using gr-lora. You should see the following output:
``` ```
$ ./lora_receive_file.py $ ./lora_receive_file_nogui.py
[?] Download test LoRa signal to decode? [y/N] y
Bits (nominal) per symbol: 7 [+] Downloading https://research.edm.uhasselt.be/probyns/lora/usrp-868.1-sf7-cr4-bw125-crc-0.sigmf-data -> ./example-trace.sigmf-data . . . . . . . . . . . . . . . . . .
Bins per symbol: 128 [+] Downloading https://research.edm.uhasselt.be/probyns/lora/usrp-868.1-sf7-cr4-bw125-crc-0.sigmf-meta -> ./example-trace.sigmf-meta . .
Header bins per symbol: 32 [+] Configuration: 868.1 MHz, SF 7, CR 4/8, BW 125 kHz, prlen 8, crc on, implicit off
Samples per symbol: 1024 [+] Decoding. You should see a header, followed by 'deadbeef' and a CRC 5 times.
Using Volk machine: avx2_64_mmx_orc Bits (nominal) per symbol: 3.5
00 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 Bins per symbol: 128
88 88 88 88 88 88 88 88 88 88 88 88 88 88 88 88 88 88 88 88 88 88 88 Samples per symbol: 1024
12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 12 Decimation: 8
... 04 90 40 de ad be ef 70 0d
04 90 40 de ad be ef 70 0d
04 90 40 de ad be ef 70 0d
04 90 40 de ad be ef 70 0d
04 90 40 de ad be ef 70 0d
[+] Done
``` ```
Alternatively, if you have a hardware LoRa transmitter, you use ```apps/lora_receive_realtime.py``` to decode signals in real time. If you have a Microchip RN2483, you can use [python-loranode](https://github.com/rpp0/python-loranode) to easily send messages via Python. Other example traces can be found [in the gr-lora-samples repository](https://github.com/rpp0/gr-lora-samples).
If you have a hardware LoRa transmitter, you use ```apps/lora_receive_realtime.py``` to decode signals in real time. With a Microchip RN2483, you can use [python-loranode](https://github.com/rpp0/python-loranode) to easily send messages via Python.
By default, decoded messages will be printed to the console output. However, you can use a `message_socket_sink` to forward messages to port 40868 over UDP. See the [tutorial](https://github.com/rpp0/gr-lora/wiki/Capturing-LoRa-signals-using-an-RTL-SDR-device) for more information. By default, decoded messages will be printed to the console output. However, you can use a `message_socket_sink` to forward messages to port 40868 over UDP. See the [tutorial](https://github.com/rpp0/gr-lora/wiki/Capturing-LoRa-signals-using-an-RTL-SDR-device) for more information.
@ -101,6 +108,7 @@ Receivers: HackRF One, USRP B201, RTL-SDR
## Changelog ## Changelog
- Version 0.6.2: Improved Message Socket Sink and higher sensitivity to low-power signals.
- Version 0.6.1: Minor bug fixes and improvements. - Version 0.6.1: Minor bug fixes and improvements.
- Version 0.6 : Significantly increased decoding accuracy and clock drift correction. - Version 0.6 : Significantly increased decoding accuracy and clock drift correction.
- Version 0.5 : Major overhaul of preamble detection and upchirp syncing - Version 0.5 : Major overhaul of preamble detection and upchirp syncing

Wyświetl plik

@ -6,7 +6,7 @@ workdir /lib
run pacman -Syu --noconfirm run pacman -Syu --noconfirm
# Install required dependencies # Install required dependencies
run pacman -S git python2-scipy swig cppunit fftw boost boost-libs gnuradio gnuradio-osmosdr libvolk log4cpp base-devel cmake wxgtk-common wxgtk2 wxgtk3 wxpython libuhd-firmware gnuradio-companion --noconfirm run pacman -S git python2-scipy swig cppunit fftw boost boost-libs gnuradio gnuradio-osmosdr libvolk log4cpp base-devel cmake wxgtk-common wxgtk2 wxgtk3 wxpython libuhd-firmware gnuradio-companion python2-requests --noconfirm
workdir /liquid workdir /liquid