Documentation
¶
Index ¶
Constants ¶
View Source
const (
PlaceholderMycall = "{mycall}"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AX25Config ¶
type AX25Config struct {
// axport to use (as defined in /etc/ax25/axports).
Port string `json:"port"`
// Optional beacon when listening for incoming packet-p2p connections.
Beacon BeaconConfig `json:"beacon"`
// (optional) Reference name to the Hamlib rig for frequency control.
Rig string `json:"rig"`
}
type ArdopConfig ¶
type ArdopConfig struct {
// Network address of the Ardop TNC (e.g. localhost:8515).
Addr string `json:"addr"`
// ARQ bandwidth (200/500/1000/2000 MAX/FORCED).
ARQBandwidth ardop.Bandwidth `json:"arq_bandwidth"`
// (optional) Reference name to the Hamlib rig to control frequency and ptt.
Rig string `json:"rig"`
// Set to true if hamlib should control PTT (SignaLink=false, most rigexpert=true).
PTTControl bool `json:"ptt_ctrl"`
// (optional) Send ID frame at a regular interval when the listener is active (unit is seconds)
BeaconInterval int `json:"beacon_interval"`
// Send FSK CW ID after an ID frame.
CWID bool `json:"cwid_enabled"`
}
type BeaconConfig ¶
type Config ¶
type Config struct {
// This station's callsign.
MyCall string `json:"mycall"`
// Secure login password used when a secure login challenge is received.
//
// The user is prompted if this is undefined.
SecureLoginPassword string `json:"secure_login_password"`
// Auxiliary callsigns to fetch email on behalf of.
AuxAddrs []string `json:"auxiliary_addresses"`
// Maidenhead grid square (e.g. JP20qe).
Locator string `json:"locator"`
// List of service codes for rmslist (defaults to PUBLIC)
ServiceCodes []string `json:"service_codes"`
// Default HTTP listen address (for web UI).
//
// Use ":8080" to listen on any device, port 8080.
HTTPAddr string `json:"http_addr"`
// Handshake comment lines sent to remote node on incoming connections.
//
// Example: ["QTH: Hagavik, Norway. Operator: Martin", "Rig: FT-897 with Signalink USB"]
MOTD []string `json:"motd"`
// Connect aliases
//
// Example: {"LA1B-10": "ax25:///LD5GU/LA1B-10", "LA1B": "winmor://LA3F?freq=5350"}
// Any occurrence of the substring "{mycall}" will be replaced with user's callsign.
ConnectAliases map[string]string `json:"connect_aliases"`
// Methods to listen for incoming P2P connections by default.
//
// Example: ["ax25", "winmor", "telnet", "ardop"]
Listen []string `json:"listen"`
// Hamlib rigs available (with reference name) for ptt and frequency control.
HamlibRigs map[string]HamlibConfig `json:"hamlib_rigs"`
AX25 AX25Config `json:"ax25"` // See AX25Config.
SerialTNC SerialTNCConfig `json:"serial-tnc"` // See SerialTNCConfig.
Winmor WinmorConfig `json:"winmor"` // See WinmorConfig.
Ardop ArdopConfig `json:"ardop"` // See ArdopConfig.
Pactor PactorConfig `json:"pactor"` // See PactorConfig.
Telnet TelnetConfig `json:"telnet"` // See TelnetConfig.
// See GPSdConfig.
GPSd GPSdConfig `json:"gpsd"`
// Legacy support for old config files only. This field is deprecated!
// Please use "Addr" field in GPSd config struct (GPSd.Addr)
GPSdAddrLegacy string `json:"gpsd_addr,omitempty"`
// Command schedule (cron-like syntax).
//
// Examples:
// # Connect to telnet once every hour
// "@hourly": "connect telnet"
//
// # Change winmor listen frequency based on hour of day
// "00 10 * * *": "freq winmor:7350.000", # 40m from 10:00
// "00 18 * * *": "freq winmor:5347.000", # 60m from 18:00
// "00 22 * * *": "freq winmor:3602.000" # 80m from 22:00
Schedule map[string]string `json:"schedule"`
// By default, Pat posts your callsign and running version to the Winlink CMS Web Services
//
// Set to true if you don't want your information sent.
VersionReportingDisabled bool `json:"version_reporting_disabled"`
}
var DefaultConfig Config = Config{ MOTD: []string{"Open source Winlink client - getpat.io"}, AuxAddrs: []string{}, ServiceCodes: []string{"PUBLIC"}, ConnectAliases: map[string]string{ "telnet": "telnet://{mycall}:CMSTelnet@cms.winlink.org:8772/wl2k", }, Listen: []string{}, HTTPAddr: "localhost:8080", AX25: AX25Config{ Port: "wl2k", Beacon: BeaconConfig{ Every: 3600, Message: "Winlink P2P", Destination: "IDENT", }, }, SerialTNC: SerialTNCConfig{ Path: "/dev/ttyUSB0", Baudrate: 9600, Type: "Kenwood", }, Winmor: WinmorConfig{ Addr: "localhost:8500", InboundBandwidth: 1600, }, Ardop: ArdopConfig{ Addr: "localhost:8515", ARQBandwidth: ardop.Bandwidth500Max, CWID: true, }, Pactor: PactorConfig{ Path: "/dev/ttyUSB0", Baudrate: 57600, }, Telnet: TelnetConfig{ ListenAddr: ":8774", Password: "", }, GPSd: GPSdConfig{ EnableHTTP: false, UseServerTime: false, Addr: "localhost:2947", }, GPSdAddrLegacy: "", Schedule: map[string]string{}, HamlibRigs: map[string]HamlibConfig{}, }
type GPSdConfig ¶ added in v0.8.0
type GPSdConfig struct {
// enable GPSd support in web interface
// WARNING: If you enable GPSd http endpoint (enable_http) you might
// expose your current position to anyone who has access to Pat!!!
EnableHTTP bool `json:"enable_http"`
// Use server time instead of timestamp provided by GPSd (e.g for older GPS
// device with week roll-over issue)
UseServerTime bool `json:"use_server_time"`
// Address and port of GPSd server (e.g. localhost:2947)
Addr string `json:"addr"`
}
type HamlibConfig ¶
type HamlibConfig struct {
// The network type ("serial" or "tcp"). Use 'tcp' for rigctld.
//
// (For serial support: build with "-tags libhamlib".)
Network string `json:"network,omitempty"`
// The rig address.
//
// For tcp (rigctld): "address:port" (e.g. localhost:4532).
// For serial: "/path/to/tty?model=&baudrate=" (e.g. /dev/ttyS0?model=123&baudrate=4800).
Address string `json:"address,omitempty"`
// The rig's VFO to control ("A" or "B"). If empty, the current active VFO is used.
VFO string `json:"VFO"`
}
type PactorConfig ¶ added in v0.7.0
type PactorConfig struct {
// Path/port to TNC device (e.g. /dev/ttyUSB0 or COM1).
Path string `json:"path"`
// Baudrate for the serial port (e.g. 57600).
Baudrate int `json:"baudrate"`
// (optional) Reference name to the Hamlib rig for frequency control.
Rig string `json:"rig"`
// (optional) Path to custom TNC initialization script.
InitScript string `json:"custom_init_script"`
}
type SerialTNCConfig ¶
type TelnetConfig ¶
type WinmorConfig ¶
type WinmorConfig struct {
// Network address of the Winmor TNC (e.g. localhost:8500).
Addr string `json:"addr"`
// Bandwidth to use when getting an inbound connection (500/1600).
InboundBandwidth int `json:"inbound_bandwidth"`
// TX audio drive level
//
// Set to 0 to use WINMOR defaults
DriveLevel int `json:"drive_level"`
// (optional) Reference name to the Hamlib rig to control frequency and ptt.
Rig string `json:"rig"`
// Set to true if hamlib should control PTT (SignaLink=false, most rigexpert=true).
PTTControl bool `json:"ptt_ctrl"`
}
Click to show internal directories.
Click to hide internal directories.