-
Notifications
You must be signed in to change notification settings - Fork 5
/
trx-control.7
112 lines (111 loc) · 2.87 KB
/
trx-control.7
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
.\" Copyright (c) 2023 - 2024 Marc Balmer HB9SSB
.\"
.\" 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.
.\"
.TH TRX-CONTROL 7 "16 June 2024" "trx-control"
.SH NAME
trx-control \- software to control amateur radio transceivers
.SH DESCRIPTION
.
Software to control amateur radio transceivers and related hardware like
relays, GPIO pins, rotators.
.
.PP
trx-control consists of
.IR trxd (8)
(a daemon to control the transceivers and other hardware) and
.IR trxctl (1)
a command line utility to access trxd.
.PP
Software that wants to make use of
.IR trxd (8)
should implement the protocol and talk to
.IR trxd (8)
directly over the network.
.
.
.PP
.IR trxd (8)
listens on port 14285 by default for incoming connections over
plain sockets and can optionally listen for WebSocket connections.
It supports both IPv4 and IPv6.
.
.PP
The effective transceiver control is done using Lua modules,
this way new transceivers can easily be supported by supplying
a corresponding Lua driver module for a specific transceiver model.
See https://lua.org and https://lua.msys.ch for more information on Lua.
.
.
.SH FILES
.
.TP
.I /usr/bin/trxctl
trx-control client.
.
.
.TP
.I /usr/sbin/trxd
trx-control daemon.
.
.
.TP
.I /usr/share/trxd/protocol
Lua scripts that implement common transceiver control protocols.
These can be used by the actual drivers.
.
.
.TP
.I /usr/share/trxd/trx
Lua scripts that control transceivers.
.
.
.TP
.I /usr/share/trxd/gpio
Lua scripts that control GPIO devices.
.
.
.TP
.I /usr/share/trxd/extension
Lua scripts that extend trx-control in a generic way.
.
.
.TP
.I /usr/share/trxd/lua
Lua modules for use by extensions.
.
.
.SH AUTHORS
.
The trx-control software was written by
.MT info\@hb9ssb.ch
Marc Balmer HB9SSB
.ME .
.
.
.SH "SEE ALSO"
.
.PP
.IR trxctl (1) ,
.IR trxd (8)
.PP
The client/server protocol is documented in the projects website at
https://trx-control.msys.ch.
.
.