Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/illdefined/cloudlog-adifwatch
Automatic upload of ADIF log to CloudLog
https://github.com/illdefined/cloudlog-adifwatch
adif amateur-radio
Last synced: about 2 months ago
JSON representation
Automatic upload of ADIF log to CloudLog
- Host: GitHub
- URL: https://github.com/illdefined/cloudlog-adifwatch
- Owner: illdefined
- License: other
- Created: 2021-02-13T23:18:30.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-08-28T15:02:08.000Z (over 1 year ago)
- Last Synced: 2024-10-07T08:39:33.678Z (3 months ago)
- Topics: adif, amateur-radio
- Language: Rust
- Homepage:
- Size: 102 KB
- Stars: 12
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Synopsis
This tool watches an [ADIF](https://adif.org/) log file for changes using the native filesystem
notification mechanism and uploads it to a [Cloudlog](https://www.magicbug.co.uk/cloudlog/)
instance through the [QSO API](https://github.com/magicbug/Cloudlog/wiki/API#apiqso).## Usage
On Linux systems the recommended way to use this tool is through the provided systemd unit. It
should be installed to `~/.config/systemd/user/`, the URL of the Cloudlog instance adjusted
appropriately and then started with `systemctl --user start cloudlog-adifwatch.service`. To start it
automatically when the user logs in, enable it with `systemctl --user enable
cloudlog-adifwatch.service`.By default the systemd unit expects the Cloudlog API key to be available in a file at
`~/.config/cloudlog-adifwatch/key.txt`, uses station profile ID 1 and watches the WSJT-X ADIF log
file at `~/.local/share/WSJT-X/wsjtx_log.adi`. These paths can be adjusted as needed in the unit
file.Alternatively, this tool can be started manually.
### Example
```
cloudlog-adifwatch https://fernschreibstelle.de ~/.config/cloudlog-adifwatch/key.txt 1 ~/.local/share/WSJT-X/wsjtx_log.adi
```## Implementation notes
The log is split into chunks of one ore more complete records which are then uploaded individually.
Partial writes to the log file are handled gracefully and only complete records are uploaded.The log file is kept open for reading and assumed to be appended to only. Truncation of the log file
or overwriting of data already written to the log file will likely result in undesired behaviour.