Skip to content

Commit 9a08484

Browse files
authored
Merge pull request #2 from pr1001/patch-1
Improve README
2 parents 72bc864 + 00a5da5 commit 9a08484

File tree

1 file changed

+23
-28
lines changed

1 file changed

+23
-28
lines changed

README.md

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,46 @@
1-
# wsprdaemon (WD)
2-
A Debian/Raspberry Pi WSPR decoding and noise level graphing service
1+
# wsprdaemon (WD)
32

4-
This is a large bash script which utilizes kiwrecorder.py and other library and utility commands to record WSPR spots
5-
from one or more Kiwis, audio adapters and (for VHF/UHF) RTL-SDRs and *reliably* post them to wsprnet.org
3+
A Debian/Raspberry Pi [WSPR](https://en.wikipedia.org/wiki/WSPR_(amateur_radio_software)) decoding and noise level graphing service
64

7-
Schedules can be configured to switch between bands at different hours of the day, or at sunrise/sunset-relative times.
5+
This is a large bash script which utilizes [kiwirecorder.py](https://github.com/jks-prv/kiwiclient) and other library and utility commands to record WSPR spots from one or more [Kiwis](http://kiwisdr.com), audio adapters and (for VHF/UHF) [RTL-SDRs](https://www.rtl-sdr.com/about-rtl-sdr/) and *reliably* post them to [wsprnet.org](http://wsprnet.org).
86

9-
Signals obtained from multiple receievers on the same band ( e.g a 40M vertical and 500' Beverage ) can be merged together with only
10-
the best SNR posted to wsprnet.org
7+
Schedules can be configured to switch between bands at different hours of the day, or at sunrise/sunset-relative times.
118

12-
In addition WD can be configured to, at the same time, create graphs of the background noise level for display on the computer running WD
13-
and/or at http://graphs.wsprdaemon.org/
9+
Signals obtained from multiple receievers on the same band ( e.g a 40M vertical and 500' Beverage ) can be merged together with only the best SNR posted to [wsprnet.org](http://wsprnet.org).
1410

15-
WD can run on almost any Debian Linux system and is tested on Stretch and Buster for Raspberry Pi 3 and 4, and Ubuntu 18.04LTS on x86
16-
A Pi 3b can decode 14+ bands, but 14 bands of noise level graphing requires a Pi 4 or x86 server.
11+
In addition WD can be configured to, at the same time, create graphs of the background noise level for display on the computer running WD and/or at [graphs.wsprnet.org](http://graphs.wsprnet.org).
1712

13+
WD can run on almost any Debian Linux system and is tested on Stretch and Buster for Raspberry Pi 3 and 4, and Ubuntu 18.04LTS on x86. A Pi 3b can decode 14+ bands, but 14 bands of noise level graphing requires a Pi 4 or x86 server.
1814

19-
Installation
15+
## Installation
2016

21-
I recommend that you create a 'wsprdaemon' user to install and run WD on your system. That user will need sudo access for installation,
22-
and and auto sudo is needed if WDE is confiured to display graphic on the server's own web page.
17+
I recommend that you create a `wsprdaemon` user to install and run WD on your system. That user will need `sudo` access for installation, and and auto sudo is needed if WDE is configured to display graphics on the server's own web page.
2318

2419
Logged on as that user:
2520

26-
Dowload wsprdaemon.sh from this site
21+
Dowload `wsprdaemon.sh` from this site
2722

23+
```bash
2824
chmod +x wsprdaemon.sh
2925
mkdir ~/wsprdaemon
3026
mv wsprdaemon.sh ~/wsprdaemon/
3127
cd ~/wsprdaemon/
3228
./wsprdaemon.sh
29+
```
3330

34-
This first run of WD will install many, many utilities and libraries, and for some you will be prompted to agree to the insallation
35-
Some/all of them will requier sudo permission. I configure 'wsprdaemon' as a member of the 'sudoers' group and thus are never prompted
36-
for a password, but you experience may vary.
31+
This first run of WD will install many, many utilities and libraries, and for some you will be prompted to agree to the insallation. Some/all of them will require `sudo` permission. I configure `wsprdaemon` as a member of the `sudoers` group and thus are never prompted for a password, but you experience may vary.
3732

38-
At then end of a sucessful installation, WD creates a prototype configuration file '~/wsprdaemon/wsprdaemon.conf'. You will
39-
need to edit that file to reflect your desired configuration.
33+
At then end of a sucessful installation, WD creates a prototype configuration file at `~/wsprdaemon/wsprdaemon.conf`. You will need to edit that file to reflect your desired configuration.
4034

41-
After installtion and configuration is completed, run:
35+
## Usage
4236

43-
~/wsprdaemon/wsprdaemon.sh -a => Starts WD running as a background linux service which will
44-
automatically start after any reboot or power cycle of your server
45-
~/wsprdaemon/wsprdaemon.sh -z => Stop any running WD, but it will start again after a reboot/power cycle
46-
~/wsprdaemon/wsprdaemon.sh -s => Display the status of the WD service
37+
After installtion and configuration is completed, run:
4738

48-
~/wsprdaemon/wsprdaemon.sh -h => Help menu
39+
| Command | Description |
40+
| ------- | ----------- |
41+
| `~/wsprdaemon/wsprdaemon.sh -a` | Starts WD running as a background linux service which will automatically start after any reboot or power cycle of your server |
42+
| `~/wsprdaemon/wsprdaemon.sh -z` | Stop any running WD, but it will start again after a reboot/power cycle |
43+
| `~/wsprdaemon/wsprdaemon.sh -s` | Display the status of the WD service |
44+
| `~/wsprdaemon/wsprdaemon.sh -h` | Help menu |
4945

50-
Since I have no QA department, installations, especially on non-Pi systems, may encounter problems which I have not seen.
51-
However WD has been running for months at many top spotting sites and I hope you find it useful, not frustrating
46+
Since I have no QA department, installations, especially on non-Pi systems, may encounter problems which I have not seen. However WD has been running for months at many top spotting sites and I hope you find it useful, not frustrating.

0 commit comments

Comments
 (0)