Skip to content

Commit 6dfa118

Browse files
committed
Describe the use of simulators
1 parent e5d8dc0 commit 6dfa118

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.developer

+26-2
Original file line numberDiff line numberDiff line change
@@ -686,8 +686,32 @@ Testing:
686686
touched the build system files or added a backend.
687687

688688
Simulators:
689-
* The simulators directory contains various programs that are built
690-
invoking "make -C simulators/ check" or "make check" from topdir.
689+
* The 'simulators' directory contains programs to simulate the protocol
690+
of many devices. They are built invoking "make -C simulators/ check"
691+
or "make check" from topdir. While simulators are made to test Hamlib
692+
with rigctl and rigctld, you should be able to guess the model number
693+
that corresponds to a given simulator and configure an application such
694+
as wsjtx to use that model and the port name printed by the simulator,
695+
as shown in the examples below.
696+
697+
To use a simulator on *nix-like systems, run its executable and take
698+
note of the port name:
699+
$ ./simulators/simft991
700+
name=/dev/pts/6
701+
then from another terminal run rigctl/rigctld using that port and a
702+
matching model number (see rigctl --list):
703+
$ ./tests/rigctl --model=1035 --rig-file=/dev/pts/6 \get_freq
704+
14074000
705+
706+
To use a simulator on Windows, first install a virtual COM port, then
707+
run the simulator passing the port name as first and only argument:
708+
> simulators\simft991 COM1234
709+
then from another command prompt run rigctl/rigctld or your
710+
application.
711+
712+
The COM port argument is currently ignored on *nix but it can be
713+
handled if there is a need to test a low level issue with RS-232
714+
and/or USB communication, if your machine has the needed hardware.
691715

692716

693717
8.2.1 Use of rig_debug() function

0 commit comments

Comments
 (0)