Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
RIGCTLSYNC(1)		       Hamlib Utilities			 RIGCTLSYNC(1)

NAME
       rigctlsync - synchronize	a rig to SDR# (or other	rig)

SYNOPSIS
       rigctlsync [-hlLuV] [-m id] [-r device] [-R device] [-s baud] [-S baud]
		  [-c id] [-C parm=val]	[-B] [-v[-Z]]

DESCRIPTION
       Allows you to synchronize frequency from	a rig to SDR#.	Best when used
       with rigctld, FlRig, or a multiport radio.

       Please  report bugs and provide feedback	at the e-mail address given in
       the BUGS	section	below.	Patches	and code enhancements sent to the same
       address are welcome.

OPTIONS
       This program follows the	usual GNU command line syntax.	Short  options
       that take an argument may have the value	follow immediately or be sepa-
       rated  by a space.  Long	options	starting with two dashes (`-') require
       an `=' between the option and any argument.

       Here is a summary of the	supported options:

       -m, --model=id
	      Select radio model number.

	      See model	list (use "rigctlsync -l").

	      Note: rigctlsync (or third party software	using the C API)  will
	      use radio	model 2	for NET	rigctl (communicating with rigctld).

       -r, --rig-file=device
	      Use device as the	file name of the port connected	to the radio.

	      Often a serial port, but could be	a USB to serial	adapter.  Typ-
	      ically  /dev/ttyS0,  /dev/ttyS1,	/dev/ttyUSB0,  etc.  on	Linux,
	      COM1, COM2, etc. on MS Windows.  The BSD flavors	and  Mac  OS/X
	      have their own designations.  See	your system's documentation.

	      The special string "uh-rig" may be given to enable micro-ham de-
	      vice support.

       -R, --rig-file2=device
	      Use  device  as the file name of one of the virtual com ports --
	      your program will	connect	to the other com port of  the  virtual
	      pair.

       -s, --serial-speed=baud
	      Set serial speed to baud rate.

	      Uses  maximum  serial speed from radio backend capabilities (set
	      by -m above) as the default.

       -S, --serial-speed2=baud
	      Set serial speed to baud rate for	virtual	com port (see -R).

	      Uses maximum serial speed	from radio backend  capabilities  (set
	      by -m above) as the default.

       -c, --civaddr=id
	      Use id as	the CI-V address to communicate	with the rig.

	      Only useful for Icom and some Ten-Tec rigs.

	      Note:  The  id is	in decimal notation, unless prefixed by	0x, in
	      which case it is hexadecimal.

       -L, --show-conf
	      List all config parameters for the radio defined with -m above.

       -C, --set-conf=parm=val[,parm=val]
	      Set radio	configuration parameter(s), e.g.  stop_bits=2.

	      Use the -L option	above for a list of  configuration  parameters
	      for a given model	number.

       -u, --dump-caps
	      Dump capabilities	for the	radio defined with -m above and	exit.

       -l, --list
	      List all model numbers defined in	Hamlib and exit.

	      The list is sorted by model number.

	      Note:  In	 Linux	the  list  can	be  scrolled back using	Shift-
	      PageUp/Shift-PageDown, or	using the scrollbars of	a virtual ter-
	      minal in X or the	cmd window in  Windows.	  The  output  can  be
	      piped to more(1) or less(1), e.g.	"rigctl	-l | more".

       -n, --no-restore-ai
	      rigctl  restores	the state of auto information (AI) on the con-
	      trolled rig.

	      If this is not desired, for example if you are using  rigctl  to
	      turn AI mode on or off, pass this	option.

       -B, --mapa2b
	      Maps  set_freq  on  VFOA	to VFOB	instead.  This allows using CW
	      skimmer with the rig in split mode and clicking on  a  frequency
	      in CW skimmer will set VFOB to the transmit frequency.

       -v, --verbose
	      Set verbose mode,	cumulative (see	DIAGNOSTICS below).

       -Z, --debug-time-stamps
	      Enable time stamps for the debug messages.

	      Use  only	 in  combination with the -v option as it generates no
	      output on	its own.

       -h, --help
	      Show a summary of	these options and exit.

       -V, --version
	      Show version of rigctl and exit.

       Note: Some options may not be implemented by a given backend  and  will
       return  an error.  This is most likely to occur with the	--set-conf and
       --show-conf options.

DIAGNOSTICS
       The -v, --verbose option	allows different levels	of diagnostics	to  be
       output  to  stderr  and correspond to -v	for BUG, -vv for ERR, -vvv for
       WARN, -vvvv for VERBOSE,	or -vvvvv for TRACE.

       A given verbose level is	useful for providing needed debugging informa-
       tion to the email address below.	 For example, TRACE output  shows  all
       of  the values sent to and received from	the radio which	is very	useful
       for radio backend library development and may be	requested by  the  de-
       velopers.

EXIT STATUS
       rigctlsync exits	with:

       0      if all operations	completed normally;

       1      if there was an invalid command line option or argument;

       2      if an error was returned by Hamlib.

EXAMPLE
       Start rigctlsync	with FLRig as the Hamlib model <>.

	   $ rigctlsync	-m 4 -M	9 -R 192.168.1.1:4532

       The  following  diagram	shows the communications flow that allows N1MM
       Logger+ to communicate with a radio connected to	Flrig:

BUGS
       Report bugs to:

	      Hamlib Developer mailing list
	      <hamlib-developer@lists.sourceforge.net>

COPYING
       This file is part of Hamlib, a project to develop a library  that  sim-
       plifies	radio, rotator,	and amplifier control functions	for developers
       of software primarily of	interest to radio amateurs  and	 those	inter-
       ested in	radio communications.

       Copyright (C) 2000-2011 Stephane	Fillod
       Copyright (C) 2000-2018 the Hamlib Group	(various contributors)
       Copyright (C) 2010-2020 Nate Bargmann
       Copyright (C) 2019 Michael Black	W9MDB

       This  is	 free  software;  see the file COPYING for copying conditions.
       There is	NO warranty; not even for MERCHANTABILITY  or  FITNESS	FOR  A
       PARTICULAR PURPOSE.

SEE ALSO
       rigctld(1), rigctl(1), socat(1),	hamlib(7)

COLOPHON
       Links  to  the Hamlib Wiki, Git repository, release archives, and daily
       snapshot	archives are available via hamlib.org <http://www.hamlib.org>.

Hamlib				  2023-01-27			 RIGCTLSYNC(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=rigctlsync&sektion=1&manpath=FreeBSD+Ports+14.3.quarterly>

home | help