File: README.md

package info (click to toggle)
golang-github-k0swe-wsjtx-go 4.0.1-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 192 kB
  • sloc: makefile: 15
file content (23 lines) | stat: -rw-r--r-- 1,076 bytes parent folder | download | duplicates (2) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
[![PkgGoDev](https://pkg.go.dev/badge/github.com/k0swe/wsjtx-go/v4)](https://pkg.go.dev/github.com/k0swe/wsjtx-go/v4)
[![Go Report Card](https://goreportcard.com/badge/github.com/k0swe/wsjtx-go/v4)](https://goreportcard.com/report/github.com/k0swe/wsjtx-go/v4)
[![Test](https://github.com/k0swe/wsjtx-go/workflows/Test/badge.svg?branch=v3)](https://github.com/k0swe/wsjtx-go/actions/workflows/test.yml?query=branch%3Av3)

# wsjtx-go

Golang binding for the WSJT-X amateur radio software's UDP communication interface. This library
supports receiving and sending all WSJT-X message types up through WSJT-X v2.5.2.

This is meant to be a fairly thin binding API, so familiarity with WSJT-X's
[`NetworkMessage.hpp`](https://sourceforge.net/p/wsjt/wsjtx/ci/wsjtx-2.5.2/tree/Network/NetworkMessage.hpp)
is recommended.

## Run

This repository is designed as a library but includes a simple driver program to document basic
integration. WSJT-X must be running and generating UDP packets for the driver to pick them up.

From this directory:

```shell script
go run cmd/main.go
```