improve README and added a LICENSE
parent
d99207d444
commit
f0c92c76da
|
@ -0,0 +1,21 @@
|
|||
MIT License
|
||||
|
||||
Copyright (c) 2022 Ken Barbour
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
34
README.md
34
README.md
|
@ -1,6 +1,36 @@
|
|||
# Weather Satellite Image Reception
|
||||
# WXRX - Automated Weather Satellite Image Reception
|
||||
|
||||
This should help automate capture of weather images from the NOAA satellites
|
||||
This is a collection of scripts for recording and decoding of NOAA Satellite images, and generating
|
||||
static web pages with the decoded image using any of the popular RTL2832U-based Software Defined Radios.
|
||||
|
||||
*Warning*: These scripts are still very much a work in progress and, in my opinion, are not ready for
|
||||
a major version number.
|
||||
|
||||
[See it in action](https://static.kenbarbour.com/wxrx/index.html)
|
||||
|
||||
## Dependencies
|
||||
* BASH
|
||||
* [wxtoimg](https://wxtoimgrestored.xyz) - *Note*: this may require `~/.wxtoimglic` and `~/.wxtoimgrc` to run properly
|
||||
* [predict](https://www.qsl.net/kd2bd/predict.html)
|
||||
* ImageMagick
|
||||
* [shunit2](https://github.com/kward/shunit2) (for development and testing)
|
||||
* rtl_fm
|
||||
* atd
|
||||
|
||||
## Usage
|
||||
Use `wxrx help` or `wxrx <command> help` for helptext for any of the scripts.
|
||||
|
||||
* `wxrx update` - Fetches telemetry data from Celestrak into the current directory. Needed for predictions
|
||||
* `wxrx predict` - Predicts satellite passes (default: passes rising above 45 degrees within the next 24 hours)
|
||||
* `wxrx record --duration {seconds} --noaa-{15|18|19} ` - Records a transmission from a satellite currently overhead to a wavfile
|
||||
* `wxrx decode [--timestamp <unix-timestamp>] [--satellite noaa-(15|18|19)] <wavfile>` - Create images for a recorded transmission using wxtoimg
|
||||
* `wxrx web` - Search directory tree within current directory and generates a website. Uses templates stored in `WXRX_WEB_TEMPLATES` (default: wxrx/web/templates; see lib/web-templates for examples), and places generated files in `WXRX_WEB_PUBDIR` (default wxrx/web/public)
|
||||
* `wxrx pass --noaa-{15|18|19} --duration {seconds}` - Handles the recording, decoding, and website generation of a single pass
|
||||
* `wxrx schedule` - Predicts future passes and uses `atd` to run `wxrx pass` to handle them
|
||||
|
||||
### Example usage
|
||||
* Set `wxrx/web/public` as a web server document root
|
||||
* Add `wxrx update && wxrx schedule` as a daily cronjoba
|
||||
|
||||
## Further reading
|
||||
[github.com/nootropicdesign/wx-ground-station](https://github.com/nootropicdesign/wx-ground-station)
|
||||
|
|
Loading…
Reference in New Issue