github.com/la5nta/wl2k-go@v0.11.8/README.md (about)

     1  [![PkgGoDev](https://pkg.go.dev/badge/github.com/la5nta/wl2k-go)](https://pkg.go.dev/github.com/la5nta/wl2k-go)
     2  [![Build status](https://github.com/la5nta/wl2k-go/actions/workflows/go.yaml/badge.svg)](https://github.com/la5nta/wl2k-go/actions)
     3  [![Go Report Card](https://goreportcard.com/badge/github.com/la5nta/wl2k-go)](https://goreportcard.com/report/github.com/la5nta/wl2k-go)
     4  
     5  ### Looking for the cross platform winlink client? Visit [http://getpat.io](http://getpat.io).
     6  
     7  ## Overview
     8  
     9  wl2k-go is a collection of Go packages implementing various parts needed to build a Winlink client.
    10  
    11  The project's goal is to encourage and facilitate development of cross-platform Winlink clients.
    12  
    13  _This project is under heavy development and breaking API changes are to be expected._
    14  
    15  ## Pat: The client application
    16  
    17  On 6 March 2016 the cmd/wl2k application **moved** to it's own [repository](https://github.com/la5nta/pat).
    18  
    19  Check out [getpat.io](http://getpat.io) for the latest version of the cross platform Winlink client, Pat.
    20  
    21  ## fbb: The FBB (Winlink 2000 - B2F) protocol implementation
    22  
    23  An implementation of the B2 Forwarding Protocol and Winlink 2000 Message Structure (the WL2K-protocol).
    24  
    25  ```go
    26  mycall := "LA5NTA"
    27  mbox := mailbox.NewDirHandler("/tmp/mailbox", false)
    28  session := fbb.NewSession(
    29  	mycall,
    30  	telnet.TargetCall,
    31  	"JP20qh",
    32  	mbox, // Use /tmp/mailbox as the mailbox for this session
    33  )
    34  
    35  // Exchange messages over any connection implementing the net.Conn interface
    36  conn, _ := telnet.Dial(mycall)
    37  session.Exchange(conn)
    38  
    39  // Print subjects of messages in the inbox
    40  msgs, _ := mbox.Inbox()
    41  for _, msg := range msgs {
    42  	fmt.Printf("Have message: %s\n", msg.Subject())
    43  }
    44  ```
    45  
    46  For detailed package documentation, see <http://godoc.org/github.com/la5nta/wl2k-go>.
    47  
    48  A big thanks to paclink-unix by Nicholas S. Castellano N2QZ (and others). Without their effort and choice to share their knowledge through open source code, this implementation would probably never exist.
    49  
    50  Paclink-unix was used as reference implementation for the B2F protocol since the start of this project.
    51  
    52  ### Gzip experiment
    53  
    54  Gzip message compression has been added as an experimental B2F extension, as an alternative to LZHUF. The feature can be enabled by setting the environment variable `GZIP_EXPERIMENT=1` at runtime.
    55  
    56  The protocol extension is negotiated by an additional character (G) in the handshake SID as well as a new proposal code (D), thus making it backwards compatible with software not supporting gzip compression.
    57  
    58  The G sid flag tells the other party that gzip is supported through a D-proposal. The D-proposal has the same format as C-proposals, but is used to flag the data as gzip compressed.
    59  
    60  The gzip feature works transparently, which means that it will not break protocol if it's unsupported by the other winlink node.
    61  
    62  ## lzhuf: The compression
    63  
    64  Package lzhuf implements the lzhuf compression used by the binary FBB protocols B, B1 and B2.
    65  
    66  For detailed package documentation, see <http://godoc.org/github.com/la5nta/wl2k-go/lzhuf>.
    67  
    68  ## transport
    69  
    70  Package transport provides access to various connected modes commonly used for winlink.
    71  
    72  The modes is made available through common interfaces and idioms from the net package, mainly net.Conn and net.Listener.
    73  
    74  For detailed package documentation, see <http://godoc.org/github.com/la5nta/wl2k-go/transport>.
    75  
    76  #### telnet
    77  * A simple TCP dialer/listener for the "telnet"-method.
    78  * Supports both P2P and CMS dialing.
    79  
    80  #### ax25
    81  * Wrapper for the Linux AX.25 library (build with tag "libax25").
    82  * Kenwood TH-D7x/TM-D7x0 (or similar) TNCs over serial.
    83  
    84  #### ardop
    85  A driver for the ARDOP_WIN and ARDOPc TNCs. Provides dialing and listen capabilities over ARDOP (Amateur Radio Digital Open Protocol).
    86  
    87  ## mailbox: Directory based MBoxHandler implementation
    88  
    89  For detailed package documentation, see <http://godoc.org/github.com/la5nta/wl2k-go/mailbox>.
    90  
    91  ```go
    92  mbox := mailbox.NewDirHandler("/tmp/mailbox", false)
    93  
    94  session := fbb.NewSession(
    95      "N0CALL",
    96      telnet.TargetCall,
    97      "JP20qh",
    98      mbox,
    99  )
   100  ```
   101  
   102  ## rigcontrol/hamlib
   103  
   104  Go bindings for a _subset_ of hamlib. It provides both native cgo bindings and a rigctld client.
   105  
   106  Build with `-tags libhamlib` to link against libhamlib (the native library).
   107  
   108  See <http://godoc.org/github.com/la5nta/wl2k-go/rigcontrol/hamlib> for more details.
   109  
   110  ## Copyright/License
   111  
   112  Copyright (c) 2014-2015 Martin Hebnes Pedersen LA5NTA
   113  
   114  (See LICENSE)
   115  
   116  ## Thanks to
   117  
   118  The JNOS developers for the lzhuf implementation which got ported to Go.
   119  
   120  The paclink-unix team (Nicholas S. Castellano N2QZ and others) - reference implementation
   121  
   122  Amateur Radio Safety Foundation, Inc. - The Winlink 2000 project
   123  
   124  F6FBB Jean-Paul ROUBELAT - the FBB forwarding protocol
   125  
   126  ### Contributors (alphabetical)
   127  
   128  * LA3QMA - Kai Günter Brandt
   129  * LA5NTA - Martin Hebnes Pedersen
   130  * Colin Stagner
   131  
   132  _wl2k-go is not affiliated with The Winlink Development Team nor the Winlink 2000 project [http://winlink.org]._