hamradio/Hamlib
1
0
Fork 0
mirror of https://github.com/Hamlib/Hamlib.git synced 2024-09-23 03:17:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'upstream/master'

Browse Source
This commit is contained in:
Sebastian Denz 2018-11-18 21:21:44 +01:00
commit 13959669ce
75 changed files with 8311 additions and 3616 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -33,6 +33,7 @@ build-aux/
doc/hamlib.cfg
doc/hamlib.info
doc/stamp-vti
doc/hamlib.html
doc/version.texi
hamlib-*.tar.gz
include/config.h

1
Android.mk
View File

@ -23,6 +23,7 @@ include $(TOP_PATH)/kenwood/Android.mk
include $(TOP_PATH)/kit/Android.mk
include $(TOP_PATH)/lowe/Android.mk
include $(TOP_PATH)/m2/Android.mk
include $(TOP_PATH)/meade/Android.mk
include $(TOP_PATH)/pcr/Android.mk
include $(TOP_PATH)/prm80/Android.mk
include $(TOP_PATH)/racal/Android.mk

2
Makefile.am
View File

@ -22,7 +22,7 @@ SUBDIRS = macros include lib \
## Static list of distributed directories. $(BACKEND_LIST) is dynamically
## assigned by 'configure' so list rig backends statically.
DIST_SUBDIRS = macros include lib src c++ bindings tests doc android scripts\
adat alinco aor barrett drake dorji dummy flexradio icom icmarine jrc\
adat alinco aor barrett drake dorji dummy elad flexradio icom icmarine jrc\
kachina kenwood kit lowe pcr prm80 racal rft rs skanti tapr tentec\
tuner uniden wj yaesu winradio\
$(ROT_BACKEND_LIST)

29
NEWS
View File

@ -5,8 +5,35 @@ Copyright (C) 2000-2018 Stephane Fillod, and others
Please send Hamlib bug reports to hamlib-developer@lists.sourceforge.net
Version 4.0
2019-??-??
* API/ABI changes, advance ABI to 4 0 0.
* Add GPIO and GPION options for DCD. Jeroen Vreeken
* New backend: ELAD FDM DUO. Giovanni, HB9EIK.
Version 3.3
2018-??-??
2018-08-12
* New models, R&S xk2100, TRXMAnager, Meade LX200
* HTML manual is now generated at 'make dist' so users don't
need GNU Info tools installed. TNX Greg, N1DAM for the suggestion.
* Handle longer udev generated file names up to 512 characters
* Add debug time stamps with new '-Z' option and '--debug-time-stamps'
options to rigctl, rotctl, rigctld, and rotctld utilities.
* rigctld/rotctld continue working after serial or TCP device
disappears.
* Updates and fixes to FT-817, K3, IC-7300, AOR 3030, TM-D710,
OMNI VII, TH-D72, Flrig, TS-590, piHPSDR, TS-2000, and netrigctl.
* Update utility manual pages (section 1) and remove their reference
material from the Info manual so it only needs to be update in one
file.
* Add new general project manual pages (section 7) and edit the Info
manual to match. These should not change much so keeping them in
sync should not be too much of a burden. The Info manual may be
removed at some point in the future.
* Last planned release of the present API/ABI. Future releases will
require recompilation and relinking by client programs using the C
library interface (programs that only use the network daemons should
be unaffected).
Version 3.2
2018-03-15

16
configure.ac
View File

@ -15,7 +15,7 @@ dnl however, the use of '~' should be fine as apt (others?) will treat
dnl it as an earlier version than the actual release. TNX KA6MAL
dnl PACKAGE_NAME + " " + PACKAGE_VERSION must not exceed 20 chars!
AC_INIT([Hamlib],
[3.3~git],
[4.0~git],
[hamlib-developer@lists.sourceforge.net],
[hamlib],
[http://www.hamlib.org])
@ -49,15 +49,15 @@ dnl added to AC_CONFIG_FILES near the end of this file. See README.developer
dnl Beware of duplication should a backend directory include both rig and
dnl rotor definitions, e.g. "dummy". Optional backends will not be listed
dnl here but will be added later, e.g. "winradio".
BACKEND_LIST="adat alinco aor barrett dorji drake dummy flexradio icom icmarine jrc kachina kenwood kit lowe pcr prm80 racal rft rs skanti tapr tentec tuner uniden wj yaesu"
ROT_BACKEND_LIST="amsat ars celestron cnctrk easycomm ether6 fodtrack gs232a heathkit m2 rotorez sartek spid ts7400 prosistel"
BACKEND_LIST="adat alinco aor barrett dorji drake dummy elad flexradio icom icmarine jrc kachina kenwood kit lowe pcr prm80 racal rft rs skanti tapr tentec tuner uniden wj yaesu"
ROT_BACKEND_LIST="amsat ars celestron cnctrk easycomm ether6 fodtrack gs232a heathkit m2 meade rotorez sartek spid ts7400 prosistel"
dnl See README.release on setting these values
# Values given to -version-info when linking. See libtool documentation.
# Set them here to keep c++/Makefile and src/Makefile in sync.
ABI_VERSION=3
ABI_REVISION=3
ABI_AGE=1
ABI_VERSION=4
ABI_REVISION=0
ABI_AGE=0
AC_DEFINE_UNQUOTED([ABI_VERSION], [$ABI_VERSION], [Frontend ABI version])
AC_DEFINE_UNQUOTED([ABI_REVISION], [$ABI_REVISION], [Frontend ABI revision])
@ -787,7 +787,9 @@ android/Makefile
prosistel/Makefile
dorji/Makefile
barrett/Makefile
hamlib.pc])
meade/Makefile
hamlib.pc
elad/Makefile])
AC_OUTPUT

5
doc/Makefile.am
View File

@ -2,13 +2,14 @@ EXTRA_DIST = hamlib.cfg index.doxygen hamlib.css footer.html \
Hamlib_design.eps Hamlib_design.png
dist_man_MANS = man1/rigctl.1 man1/rigctld.1 man1/rigmem.1 man1/rigsmtr.1 \
man1/rigswr.1 man1/rotctl.1 man1/rotctld.1
man1/rigswr.1 man1/rotctl.1 man1/rotctld.1 man7/hamlib.7 \
man7/hamlib-primer.7 man7/hamlib-utilities.7
htmldir = $(docdir)/html
dist_html_DATA = Hamlib_design.png hamlib.html
SRCDOCLST = ../src/rig.c ../src/rotator.c ../src/tones.c ../src/locator.c \
../src/event.c ../src/conf.c ../src/mem.c ../src/settings.c
../src/event.c ../src/conf.c ../src/mem.c ../src/settings.c
info_TEXINFOS = hamlib.texi
hamlib_TEXINFOS = nutshell.texi getting_started.texi utility_programs.texi \

155
doc/README.man-pages Normal file
View File

@ -0,0 +1,155 @@
Guidelines for updating and authoring new man pages.
Overview
========
The man pages are written in the roff formatting language. See roff(7) ("man
roff") for an overview. roff is implemented on modern Unix like systems by
groff (GNU roff) which is a suite of programs and macro definition files that
make up the roff system.
Documentation written in roff can be transformed into a number of formats for
final publication. For the Hamlib project, the output formats are the classic
man(1) format to a terminal screen, HTML, and PDF. While groff includes a
number of macro pacakges suitable for a variety of document styles, Hamlib
source files are written using the man(7) macro package. The layout of Hamlib
man pages generally follow the format specified in man-pages(7). The macros
used in the man pages format is specified in groff_man(7).
The use of mdoc from the BSD projects has been considered and may be used in
the future if the need arises. Conversely, the classic man macros are
reasonably well understood, fairly simple, easy to use, can be processed by a
wide range of tools, and fits the Hamlib philosophy of being as approachable
as possible. To be fair, mdoc is very comprehensive and would allow many more
formatting choices to be available for the various output formats. At some
point mdoc may well be the better choice.
The latest versions of the manual pages referenced above may be found at:
http://man7.org/linux/man-pages/dir_section_7.html
For information on mdoc, see:
http://mandoc.bsd.lv/
Recommended Practices
=====================
Sections
--------
The man pages are sorted into various sections depending on the part of the
system they document. For Hamlib, the man pages fall into one of three
categories. The placement is as follows:
Section Hamlib subject domain
1 Executables, rigctl, rotctl, etc.
3 Hamlib library constants and functions.
7 General Hamlib information.
Macros and escapes
------------------
The use of man macros to mark up the roff source files is strongly encouraged.
In some cases, the use of lower level troff font escapes, such as "\fBxxx\fP",
is required, but should be used sparingly. Such escapes are hard to read and
not all editors can highlight the escape correctly.
The default font for HTML and PDF is Roman (often Times Roman on the local
system) and rarely needs to be specified directly with the ".R" macro. Text
may be bolded using the ".B" macro or italicized using the ".I" macro. A set
of combination macros exist that combine alternating sequences of styled text
such as ".BR" for alternating Bold and Roman text.
In the OPTIONS and COMMANDS sections of the utility pages there are complex
constructs of the form of:
.BR M ", " set_mode " \(aq" \fIMode\fP "\(aq \(aq" \fIPassband\fP \(aq
The result is that the command strings will be in Bold, the punctuation will
be in Roman, and the names of the variables will be in Italics using the low
level troff font escapes. Quoted strings are required to ensure spacing
between items as the ".BR" macro uses (and other combination macros) spaces to
separate its arguments. As you can see, the font escapes are hard to read as
they must be run up tight against the text.
Special symbols such as copyright or trademark glyphs and styled quotation
marks do require roff escapes inlined with the text. Several such escapes
can be found in the Hamlib roff source files:
Escape Description
\(aq ASCII single quote
\(oq Styled opening single quote
\(cq Styled closing single quote
\(lq Styled opening double quote
\(rq Styled closing double quote
\(co Copyright symbol
Besides the macros documented in man(7), the following troff macros are used
in the Hamlib man pages:
Macro Description
.br Line break (analogous to '\n' in C)
.sp Line break plus an additional blank line
.nf Do not justify following text (encloses the .MT block)
.fi Resume justification
Structure
---------
In addition to the standard man page sections of NAME, SYNPOPSIS, etc., the
Hamlib utility (section 1) man pages add the sections COMMANDS, READLINE,
PROTOCOL, DIAGNOSTICS, COPYRIGHT, and COLOPHON depending on the individual
utility.
Layout Tips
===========
Keep in mind that roff documents are most often processed in a single pass,
i.e. the document processor reads the file from top to bottom and formats the
text per the macros and escapes found along the way. Anything that is not a
macro or an escape gets rendered into the output file and that includes blank
lines. As a result, best practice is to not include blank lines in the
running text. Instead use the ".PP" or ".IP" macros to indicate a paragraph
or an indented paragraph break. To provide vertical spac between elements of
the source document, a single '.' on a line will be discarded by the document
processor. This provides a way to visually separate paragraphs and headings.
Note: While the man macro package recognizes ".LP" and ".P" as synonyms for
".PP", some tools may only recognize ".PP". One such tool is the older
'man2html' converter.
Blank lines may be included as part of an example block placed between the
".EX" and ".EE" macros. Lines between these macros are rendered in HTML and
PDF as blocks of constant width text and should be verbatim input or output
from the shell, programs, or blocks of source code.
Examples should be indented from the blocks of text. The ".RS 0.5i" macro is
used for indentation of normal text blocks while ".RS 1.0i" is used for
indented text blocks, such as a block indented using the ".TP" macro. For
each case the indented block must be followed by the ".RE" macro to return the
next block of text to the normal indentation level.
Normal section headings use the ".SH" macro which provides for vertical space
between the previous text and the heading and also begins the next block of
running text. All text blocks must follow a heading. Headings are normally
composed of one word in all capital letters.
Sub-headings use the ".SS" macro which provides vertical space above the
previous block of text and indents the sub-heading to about half the distance
from the left margin and the block of text that follows. Only one level of
sub-headings is provided.
Getting Help
============
If something is unclear on how to format a new or updated man page, simply
post your question to the mailing list:
hamlib-developer@lists.sourceforge.net
73!

192
doc/getting_started.texi
View File

@ -1,13 +1,13 @@
There are several ways to obtain a working installation of Hamlib. In
the following sections discuss installing from a package manager,
building from source, and installing Hamlib project supplied binaries on
Microsoft Windows@registeredsymbol{}.
There are several ways to obtain a working installation of Hamlib.
The following sections discuss installing from a package manager,
building from source, and installing Hamlib project supplied binaries
on Microsoft Windows@registeredsymbol{}.
@menu
* Unix binary packages::
* Source options::
* Building from source::
* MS Windows 32 binaries::
* Microsft Windows binaries::
@end menu
@node Unix binary packages
@ -31,17 +31,17 @@ the documentation for your chosen distribution be your guide.
Distribution packages are most often official Hamlib releases and in
some cases could be quite old and lacking support for newer radios or
rotors. In some cases support is improved in existing radio or rotor
back ends and bugs are fixed in newer releases. Often times to get
the improved support/bug fixes, building from source will be required.
Relax, it's not hard. :-)
rotators. In some cases support is improved in existing radio or
rotator back ends and bugs are fixed in newer releases. Often times
to get the improved support/bug fixes, building from source will be
required. Relax, it's not hard. :-)
Source code is available as official releases, testing snapshots,
daily development snapshots, and the bleeding edge of development
directly from the @url{http://git-scm.com/, Git} repository. As a
rule, even the bleeding edge tarballs should configure and compile
without error even though certain implementation work may be in
progress and may be incomplete or have errors.
directly from the @url{https://github.com/Hamlib/Hamlib, Git
repository}. As a rule, even the bleeding edge tarballs should
configure and compile without error even though certain implementation
work may be in progress and may be incomplete or have errors.
@menu
* Source releases::
@ -56,9 +56,12 @@ progress and may be incomplete or have errors.
@cindex Source, obtaining releases
Official Hamlib source releases, commonly called @dfn{tarballs} can be
found on the @url{http://sourceforge.net/projects/hamlib/files/hamlib/,
SourceForge.net Hamlib files} Web page. The most recent release is
listed first.
found on the
@url{http://sourceforge.net/projects/hamlib/files/hamlib/,
SourceForge.net Hamlib files} Web page. As a convenience, release
archives are also mirrored at the
@url{https://github.com/Hamlib/Hamlib/releases, GitHub Hamlib
releases} page. The most recent release is listed first.
@node Source snapshots
@subsection Getting source snapshots
@ -66,20 +69,25 @@ listed first.
@cindex Source, getting snapshots
@cindex Source, obtaining snapshots
@cindex Source, daily snapshots
@cindex Source, release candidates
@cindex Source, RC
Testing release candidates and daily snapshots of the development
repository are available via the World Wide Web from
@url{http://n0nb.users.sourceforge.net/, Hamlib Git daily snapshots}.
These are not official releases but are provided for testing new
features and bug fixes.
Testing release candidates (RCs) are posted during the period (often a
few weeks) before a planned release. Beginning with the 3.2 release,
RCs are hosted by the @url{https://github.com/Hamlib/Hamlib/releases,
GitHub release archive}. RCs are identifed by having a @i{~rc}
suffix.
Testing release snapshots are only posted for a few weeks before a
planned release. The daily development snapshot is made and posted
each day by around 1030 UTC. Daily snapshots @i{should} compile but
sometimes a bug creeps in that prevents compilation. If that should
happen, please report it to the
@email{hamlib-developer@@lists.sourceforge.net, hamlib-developer
mailing list}.
Daily snapshots of the development repository are available via the
World Wide Web from @url{http://n0nb.users.sourceforge.net/, Hamlib
Git daily snapshots}. These are not official releases but are
provided for testing new features and bug fixes.
The daily development snapshot is made and posted each day by around
1030 UTC. Daily snapshots @i{should} compile but sometimes a bug
creeps in that prevents compilation. If that should happen, please
report it to the @email{hamlib-developer@@lists.sourceforge.net,
hamlib-developer mailing list}.
@node Git clone
@subsection Git repository
@ -102,6 +110,12 @@ To clone the repository use the following command:
git clone git://git.code.sf.net/p/hamlib/code hamlib
@end example
or:
@example
git clone https://github.com/Hamlib/Hamlib.git
@end example
Odds are that you will want to run the above command in a sub
directory of your home directory. The @file{hamlib} directory will be
created by Git and the @dfn{master} branch will be checked out for you
@ -120,13 +134,13 @@ repository.
@cindex Source, building from
Building from source will be required for various reasons. Perhaps
only an older release is provided by your distribution, or you'd like
to test recent changes to Hamlib---either a specific back end or API
changes---and offer a report to the developers, or you'd like to take
part in development and offer your contribution to the project, or
you'd just like to learn how to build a relatively comprehensive
only an older release is provided by your distribution, or you would
like to test recent changes to Hamlib---either a specific back end or
API changes---and offer a report to the developers, or you'd like to
take part in development and offer your contribution to the project,
or you'd just like to learn how to build a relatively comprehensive
package from source. Any is a good reason to build from the source
code.
code archive.
Before going further, this manual assumes familiarity with working
from the command prompt in a Linux/BSD/Unix like system's @dfn{shell}
@ -150,7 +164,7 @@ Let's get started.
* Other make targets::
* Parallel build trees::
* Adding debugging symbols::
* Compiling MS Windows 32::
* Compiling Microsoft Windows::
@end menu
@node Compiling source tarballs
@ -161,16 +175,16 @@ Let's get started.
Before proceeding, it is essential to read the information in the
files, @file{README}, @file{INSTALL}, and @file{README.betatester}
supplied in the Hamlib @dfn{top-level} directory which will be named
something like @file{hamlib-3.0~git} where the latter part is
the release version. In this case the @samp{3.0~git} indicates this is
a development snapshot of the Git master branch. These files
provide detailed information for compiling Hamlib and will vary some
from release to release.
something like @file{hamlib-3.3~git} where the latter part is the
release version. In this case the @samp{3.3~git} indicates this is a
development snapshot of the Git master branch. These files provide
detailed information for compiling Hamlib and will vary some from
release to release.
Compiling from a source tarball whether it is an official release or
a testing or daily development snapshot follows the same set of commands,
known as the @dfn{three step} which are each run from the top-level
directory:
Compiling from a source tarball whether it is an official release or a
testing or daily development snapshot follows the same set of
commands, known as the @dfn{three step} which are each run from the
top-level directory:
@example
./configure
@ -192,7 +206,7 @@ sudo make install
The @command{./configure} command examines your system and checks it
for any packages that are required or good to have options for
compiling Hamlib. The leading @file{./} tells the shell to only run
the @command{configure} command found in the current directory. It's
the @command{configure} command found in the current directory. It is
always possible that a @command{configure} command could be lurking
elsewhere and we don't want to run that!
@ -216,9 +230,9 @@ LinuxCommand.org reference above.
@end quotation
Of course, things are usually complicated a bit by options and Hamlib
is no exception. The good news is that the defaults, i.e. no options,
work well in most situations. Options are needed to enable the
compilation of certain portions of Hamlib such as the language
is no exception. The good news is that the defaults, i.e., no
options, work well in most situations. Options are needed to enable
the compilation of certain portions of Hamlib such as the language
bindings. Optional features usually require that more development
tools are installed. The @file{INSTALL}, and @file{README.betatester}
files in the Hamlib top-level directory will have details on the
@ -249,16 +263,20 @@ exist during installation as will several other directories in it.
Installing in your home directory means that @dfn{root}, or superuser
(administrator) privileges are not required when running @command{make
install}. On the other hand, some extra work will need to be done so
other programs can use the library. (TODO: describe this in an
appendix).
other programs can use the library.
@ignore
(TODO: describe library hackery in an appendix).
@end ignore
Another useful option is @samp{--help} which will give a few screens
full of options for @command{configure}. If in a desktop environment
the scroll bar can be used to scroll back up through the output. In
either a terminal or a virtual console Linux supports the
@key{Shift-PageUp} key combination to scroll back up. As luck would
have it, @key{Shift-PageDown} can be used to scroll down toward the
end of the output and the shell prompt.
@key{Shift-PageUp} key combination to scroll back up. Converesely
@key{Shift-PageDown} can be used to scroll down toward the end of the
output and the shell prompt (Shift-UpArrow/Shift-DownArrow may also
work to scroll one line at a time).
After a fair amount of time, depending on your computer, and a lot of
screen output, @command{configure} will finish its job. So long as
@ -349,19 +367,9 @@ as root from any directory.
@quotation Note
Subsequent installations of Hamlib will not need to have
@command{ldconfig} run after each installation so long as no new
backend libraries nor a newer major version of Hamlib were installed.
A developer adding a new backend (see @file{README.developer}) will
need to run @command{ldconfig} for the new back end library to be
found by the library loader (this refers a new back end, i.e. a
sibling to the existing Icom, Kenwood, Yaesu, etc.@: back ends, not a
new model in an existing back end).
Likewise, any time a new back end appears in a source tarball,
@command{ldconfig} will need to be run for the library loader to find
it. There is no harm running @command{ldconfig} after each run of
@command{make install}.
@command{ldconfig} run after each installation if a newer major
version of Hamlib was not installed, i.e. when recompiling the same
version during development.
@end quotation
On some distributions a bit of configuration will be needed before
@ -425,7 +433,10 @@ To remove even the generated @file{Makefile}s, run @command{make
distclean} from the top-level directory. After this target is run,
@command{configure} will need to be run again to regenerate the
@file{Makefile}s. This command may not be as useful as the
@file{Makefile}s do not take up much space.
@file{Makefile}s do not take up much space, however it can be useful
for rebuilding the @file{Makefile}s when modifying a
@file{Makefile.am} or @file{confgure.ac} during build system
development.
@node Parallel build trees
@subsection Parallel build trees
@ -458,16 +469,14 @@ Run:
@command{../hamlib/configure CFLAGS="-ggdb3 -O0" CXXFLAGS="-ggdb3 -O0"}
@end example
from a build directory intended for a debugging build.
from a sibling build directory intended for a debugging build.
The @samp{-ggdb3} option tells the C compiler, this case the GNU C
Compiler, @command{gcc}, to add special symbols useful for
@command{gdb}. The @samp{-O0} option tells @command{gcc} to turn off
Compiler, @command{gcc}, to add special symbols useful for GDB, the
GNU debugger. The @samp{-O0} option tells @command{gcc} to turn off
all optimizations which will make it easier to follow some variables
that might otherwise be optimized away. @samp{CFLAGS} and
@samp{CXXFLAGS} may be set independently for each compiler (sadly, a
bug in the build system source file in Hamlib 1.2.15.3 and earlier did
not preserve @samp{CXXFLAGS}).
@samp{CXXFLAGS} may be set independently for each compiler.
@quotation Note
There are a number compiler options available for controlling debugging
@ -475,13 +484,13 @@ symbols and setting optimization levels. Please consult the compiler's
manual for all the details.
@end quotation
@node Compiling MS Windows 32
@subsection Compiling for MS Windows 32 bit architectures
@cindex Compiling for MS Windows 32
@cindex MS Windows 32, compiling
@node Compiling Microsoft Windows
@subsection Compiling for Microsoft Windows
@cindex Compiling for Microsoft Windows
@cindex Microsoft Windows, compiling
Currently compiling is done on a Debian 8 (Jessie) virtual machine
using @url{http://www.mingw.org/, MinGW32}. @file{README.build-win32}
using @url{http://www.mingw.org/, MinGW}. @file{README.build-win32}
in the @file{scripts} directory has details on how this is
accomplished.
@ -489,23 +498,28 @@ Work is ongoing to correct build issues in the
@url{http://www.cygwin.com/, Cygwin} environment running on MS
Windows.
@node MS Windows 32 binaries
@section Pre-compiled binaries for MS Windows 32 bit architectures
@cindex Pre-compiled binaries for MS Windows 32
@cindex MS Windows 32, compiled binaries
@cindex MS Windows 32, pre-compiled binaries
@node Microsft Windows binaries
@section Pre-compiled binaries for Microsoft Windows
@cindex Pre-compiled binaries for Microsoft Windows
@cindex Microsoft Windows, compiled binaries
@cindex Microsoft Windows, pre-compiled binaries
Pre-compiled binaries for MS Windows 32 bit architectures (Windows NT
and newer) are available for both official releases and daily
development snapshots. Official releases are available through the
Pre-compiled binaries for Microsoft Windows 32 and 64 bit
architectures (Windows NT and newer) are available for both official
releases and daily development snapshots. Official releases are
available through the
@url{http://sourceforge.net/projects/hamlib/files/hamlib/,
SourceForge.net file download service}. Daily development snapshots
are available from @url{http://n0nb.users.sourceforge.net/}.
SourceForge.net file download service}. As an alternative, official
releases are also available though the
@url{https://github.com/Hamlib/Hamlib/releases, Hamlib archive at
GitHub}. Daily development snapshots are available from
@url{http://n0nb.users.sourceforge.net/}.
Beginning with the Hamlib 1.2.15.3 release a self-extracting installer
is available. Among its features are selecting which portions of
Hamlib are installed. The @env{PATH} environment variable will need
to be set manually per the included @file{README.win32-bin} file.
to be set manually per the included @file{README.w32-bin} or
@file{README.w64-bin} file.
Daily development snapshots feature both a .ZIP archive and the self
extracting installer.

2
doc/hamlib.texi
View File

@ -12,7 +12,7 @@ updated @value{UPDATED}), which is a development effort to provide a
consistent programming interface for programmers wanting to incorporate
radio and rotor control into their programs.
Copyright @copyright{} 2013 Nate Bargmann
Copyright @copyright{} 2013,2018 Nate Bargmann
@quotation
Permission is granted to copy, distribute and/or modify this document under

10
doc/man1/rigmem.1
View File

@ -39,7 +39,7 @@ from the command line only.
.
.PP
Keep in mind that Hamlib is BETA level software. While a lot of backend
libraries lack complete rig support, the basic functions are usually well
libraries lack complete radio support, the basic functions are usually well
supported.
.
.PP
@ -84,15 +84,15 @@ Set radio serial speed to
.I baud
rate.
.IP
Uses maximum serial speed from rig backend capabilities as the default.
Uses maximum serial speed from radio backend capabilities as the default.
.
.TP
.BR \-c ", " \-\-civaddr = \fIid\fP
Use
.I id
as the CI-V address to communicate with the rig.
as the CI-V address to communicate with the radio.
.IP
Only useful for Icom and some Ten-Tec rigs.
Only useful for Icom and some Ten-Tec radios.
.IP
.BR Note :
The
@ -243,7 +243,7 @@ if an error was returned by
.B 3
the
.B Hamlib
backend has no memory support implemented and/or the rig has no memory access
backend has no memory support implemented and/or the radio has no memory access
available.
.
.

17
doc/man1/rigsmtr.1
View File

@ -35,7 +35,7 @@ rigsmtr \- measure S-Meter vs azimuth using Hamlib
.B rigsmtr
uses
.B Hamlib
to control a rig to measure S-Meter value versus antenna azimuth.
to control a radio to measure S-Meter value versus antenna azimuth.
.
.PP
It rotates the antenna from minimum azimuth to maximum azimuth.
@ -46,12 +46,13 @@ and the corresponding S-Meter level in dB relative to S9 are then printed on
.BR stdout .
.
.PP
To work correctly, rigsmtr needs a rig that could measure S-Meter and a Hamlib
backend that is able to retrieve it, connected to a Hamlib supported rotator.
To work correctly, rigsmtr needs a radio that could measure S-Meter and a
Hamlib backend that is able to retrieve it, connected to a Hamlib supported
rotator.
.
.PP
Keep in mind that Hamlib is BETA level software. While a lot of backend
libraries lack complete rig support, the basic functions are usually well
libraries lack complete radio support, the basic functions are usually well
supported.
.
.PP
@ -96,15 +97,15 @@ Set radio serial speed to
.I baud
rate.
.IP
Uses maximum serial speed from rig backend capabilities as the default.
Uses maximum serial speed from radio backend capabilities as the default.
.
.TP
.BR \-c ", " \-\-civaddr = \fIid\fP
Use
.I id
as the CI-V address to communicate with the rig.
as the CI-V address to communicate with the radio.
.IP
Only useful for Icom and some Ten-Tec rigs.
Only useful for Icom and some Ten-Tec radios.
.IP
.BR Note :
The
@ -231,7 +232,7 @@ if an error was returned by
.
.TP
.B 3
if the rig doesn't have the required capabilities.
if the radio doesn't have the required capabilities.
.
.
.SH EXAMPLE

8
doc/man1/rigswr.1
View File

@ -75,7 +75,7 @@ needs a radio that can measure VSWR and a
backend that supports reading VSWR from the radio.
.PP
Keep in mind that Hamlib is BETA level software. While a lot of backend
libraries lack complete rig support, the basic functions are usually well
libraries lack complete radio support, the basic functions are usually well
supported.
.
.PP
@ -120,14 +120,14 @@ Set radio serial speed to
.I baud
rate.
.IP
Uses maximum serial speed from rig backend capabilities as the default.
Uses maximum serial speed from radio backend capabilities as the default.
.TP
.BR \-c ", " \-\-civaddr = \fIid\fP
Use
.I id
as the CI-V address to communicate with the rig.
as the CI-V address to communicate with the radio.
.IP
Only useful for Icom and some Ten-Tec rigs.
Only useful for Icom and some Ten-Tec radios.
.IP
.BR Note :
The

838
doc/man7/hamlib-primer.7 Normal file
View File

@ -0,0 +1,838 @@
.\" Hey, EMACS: -*- nroff -*-
.\"
.\" For layout and available macros, see man(7), man-pages(7), groff_man(7)
.\" Please adjust the date whenever revising the manpage.
.\"
.\" Please keep this file in sync with doc/getting_started.texi
.\"
.TH HAMLIB-PRIMER "7" "2018-05-27" "Hamlib" "Hamlib Information Manual"
.
.
.SH NAME
.
hamlib-primer \- compiling and using the radio and rotator control library
.
.
.SH DESCRIPTION
.
There are several ways to obtain a working installation of Hamlib.
.
The following sections discuss installing from a package manager, building
from source, and installing Hamlib project supplied binaries on Microsoft
Windows\*R.
.
.
.SS Installing binary packages on Linux and BSD
.
The easiest way to install a released version of Hamlib on a Linux based
distribution or a BSD variant is through the provided
.IR "package manager" .
.
While package managers vary according to the distribution (it's easy to lump
BSD variants in this group too) their end goal is to provide ready to use
software packages.
.
Since such a wide variety of package managers exist, it is best to recommend
that the documentation for your chosen distribution be your guide.
.
.
.SS A variety of Hamlib sources
.
Distribution packages are most often official Hamlib releases and in some
cases could be quite old and lacking support for newer radios or rotators.
.
In some cases support is improved in existing radio or rotator back ends and
bugs are fixed in newer releases.
.
Often times to get the improved support/bug fixes, building from source will
be required.
.
Relax, it's not hard. :-)
.
.PP
Source code is available as official releases, testing snapshots, daily
development snapshots, and the bleeding edge of development directly from the
.UR https://github.com/Hamlib/Hamlib
Git repository
.UE .
.
As a rule, even the bleeding edge tarballs should configure and compile
without error even though certain implementation work may be in progress and
may be incomplete or have errors.
.
.
.SS Getting released source
.
.
Official Hamlib source releases, commonly called
.I tarballs
can be
found on the
.UR http://sourceforge.net/projects/hamlib/files/hamlib/
SourceForge.net Hamlib files
.UE
Web page.
.
As a convenience, release archives are also mirrored at the
.UR https://github.com/Hamlib/Hamlib/releases
GitHub Hamlib releases
.UE
page.
.
The most recent release is listed first.
.
.
.SS Getting source snapshots
.
Testing release candidates (RCs) are posted during the period (often a few
weeks) before a planned release.
.
Beginning with the 3.2 release, RCs are hosted by the
.UR https://github.com/Hamlib/Hamlib/releases
GitHub release archive
.UE .
.
RCs are identifed by having a
.I ~rc
suffix.
.
.PP
Daily snapshots of the development repository are available via the World Wide
Web from
.UR http://n0nb.users.sourceforge.net/
Hamlib Git daily snapshots
.UE .
.
These are not official releases but are provided for testing new features and
bug fixes.
.
.PP
The daily development snapshot is made and posted each day by around 1030 UTC.
.
Daily snapshots
.I should
compile but sometimes a bug creeps in that prevents compilation.
.
If that should happen, please report it to the
.MT hamlib-developer@@lists.sourceforge.net
hamlib-developer mailing list
.ME .
.
.
.SS Git repository
.
The source repository can be
.I cloned
which copies the repository to your computer including its entire history,
branches, and release tag information.
.
In other words, once the
.BR git "(1) " clone
command is finished a complete copy of the Hamlib development will be on your
computer.
.
You can do quite a lot with this as nothing is hidden from view since the
entire history of Hamlib is right there all the way from the very first commit
to the present.
.
None of the meta-data is hidden away on some central server.
.
.PP
To clone the repository use the following command:
.
.sp
.RS 0.5i
.EX
git clone https://git.code.sf.net/p/hamlib/code hamlib
.EE
.RE
.
.PP
or:
.sp
.RS 0.5i
.EX
git clone https://github.com/Hamlib/Hamlib.git
.EE
.RE
.
.PP
.
Odds are that you will want to run the above command in a sub directory of
your home directory.
.
The
.I hamlib
directory will be created by Git and the
.I master
branch will be checked out for you as the
.IR "working copy" .
.
The master branch is one of several branches used in Hamlib development.
.
It is the main branch of new features and bug fixes.
.
The working copy will be the latest revision of every file at the time of the
clone.
.
Later updates from the developers will require using another Git command to
update your local repository.
.
.
.SS Building from source
.
Building from source will be required for various reasons.
.
Perhaps only an older release is provided by your distribution, or you would like
to test recent changes to Hamlib\(emeither a specific back end or API
changes\(emand offer a report to the developers, or you would like to take part in
development and offer your contribution to the project, or you would just like to
learn how to build a relatively comprehensive package from source.
.
Any is a good reason to build from the source code archive.
.
.PP
Before going further, this manual assumes familiarity with working from the
command prompt in a Linux/BSD/Unix like system's
.I shell
environment, either in a
.I virtual console
(a text only screen with no graphics) or in a
.I terminal
in a desktop environment
.RB ( xterm ,
.BR rxvt ,
.BR konsole ,
.BR gnome\-terminal ,
.BR xfce4\-terminal ,
.BR terminal ,
etc.).
.
If this is new to you, take some time and read up on using the shell.
.
A good tutorial can be found at
.UR http://linuxcommand.org/
LinuxCommand.org
.UE
which also offers an in-depth book that can be purchased or downloaded for no
cost (the Hamlib project is not associated with nor has any interest in the
sale of this book, it just looks like a very good effort on the part of its
author).
.
.PP
Let's get started.
.
.
.SS Compiling source tarballs
.
Before proceeding, it is essential to read the information in the files,
.IR README ,
.IR INSTALL ,
and
.I README.betatester
supplied in the Hamlib
.I top-level
directory which will be named
something like
.I hamlib-3.3~git
where the latter part is the release version.
.
In this case the
.I 3.3~git
indicates this is a development snapshot of the Git master branch.
.
These files provide detailed information for compiling Hamlib and will vary
some from release to release.
.
.PP
Compiling from a source tarball whether it is an official release or a testing
or daily development snapshot follows the same set of commands, known as the
.I three step
which are each run from the top-level directory:
.
.sp
.RS 0.5i
.EX
\&./configure
make
sudo make install
.EE
.RE
.
.SS configure
.
The
.IB ./ configure
command examines your system and checks it for any packages that are required
or good to have options for compiling Hamlib.
.
The leading
.I ./
tells the shell to only run the
.B configure
command found in the current directory.
.
It is always possible that a
.B configure
command could be lurking elsewhere and we don't want to run that!
.
.PP
Run:
.
.sp
.RS 0.5i
.EX
\&./configure
.EE
.RE
.
.PP
from the top-level directory.
.
.IP
.BR Note :
Some distributions are configured so commands can only be run from directories
listed in the
.B PATH
environment variable.
.
The
.I ./
is necessary or the
.B configure
command will not be run as the
.I current directory
(defined as
.IR . )
is not in the
.BR PATH .
.
This is considered a default security feature so that only programs provided
by the distribution are run.
.
.B PATH
can be modified for your own session, but that is a topic for the
LinuxCommand.org reference above.
.
.PP
Of course, things are usually complicated a bit by options and Hamlib is no
exception.
.
The good news is that the defaults, i.e., no options, work well in most
situations.
.
Options are needed to enable the compilation of certain portions of Hamlib
such as the language bindings.
.
Optional features usually require that more development tools are installed.
.
The
.I INSTALL
and
.I README.betatester
files in the Hamlib top-level directory will have details on the options
available for that release.
.
.PP
A useful option is
.B \-\-prefix
which tells
.B configure
where in the file system hierarchy Hamlib should be installed.
.
If it is not given, Hamlib will be installed in the
.I /usr/local
file system hierarchy.
.
Perhaps you want to install to your home directory instead:
.
.sp
.RS 0.5i
.EX
\&./configure \-\-prefix=$HOME/local
.EE
.RE
.
.IP
.BR Note :
For practice you may wish to start out using the
.BR \-\-prefix = \fI$HOME/local\fP
option to install the Hamlib files into your home directory and avoid
overwriting any version of Hamlib installed into the system directories.
.
The code examples in the remainder of this manual will assume Hamlib has been
installed to
.IR $HOME/local .
.
.PP
All of the files will be installed in the
.I local
directory of your home directory.
.
.I local
will be created if it does not exist during installation as will several other
directories in it.
.
Installing in your home directory means that
.IR root ,
or superuser (administrator) privileges are not required when running
.BR "make install" .
.
On the other hand, some extra work will need to be done so other programs can
use the library.
.
.\" (TODO: describe library hackery in an appendix).
.
.PP
Another useful option is
.B \-\-help
which will give a few screens full of options for
.BR configure .
.
If in a desktop environment the scroll bar can be used to scroll back up
through the output.
.
In either a terminal or a virtual console Linux supports the Shift\-PageUp key
combination to scroll back up.
.
Conversely, Shift\-PageDown can be used to scroll down toward the end of the
output and the shell prompt (Shift\-UpArrow/Shift\-DownArrow may also work to
scroll one line at a time).
.
.PP
After a fair amount of time, depending on your computer, and a lot of screen
output,
.B configure
will finish its job.
.
So long as the few lines previous to the shell prompt don't say \(lqerror\(rq
or some such failure message Hamlib is ready to be compiled.
.
If there is an error and all of the required packages listed in
.I README.betatester
have been installed, please ask for help on the
.MT hamlib\-developer@@lists.sourceforge.net
hamlib-developer mailing list
.ME .
.
.
.SS make
.
The
.BR make (1)
command is responsible for running the
.I compiler
which reads the source files and from the instructions it finds in them writes
.I object
files which are the binary instructions the CPU of a computer can execute.
.
.B make
then calls the
.I linker
which puts the object files together in the correct order to create the Hamlib
library files and its executable programs.
.
.PP
Run:
.
.sp
.RS 0.5i
.EX
make
.EE
.RE
.
.PP
from the top-level directory.
.
.PP
Any error that causes
.B make
to stop early is cause for a question to the
.MT hamlib\-developer@@lists.sourceforge.net
hamlib-developer mailing list
.ME .
.
.PP
In general
.B make
will take longer than
.B configure
to complete its run.
.
As it is a system command, and therefore found in the
.BR PATH ,
prefixing
.B make
with
.I ./
will cause a \(lqcommand not found\(rq error from the shell.
.
.
.SS make install
.
Assuming that you have not set the installation prefix to your home directory,
root (administrator) privileges will be required to install Hamlib to the
system directories.
.
Two popular methods exist for gaining root privileges,
.BR su (1)
and
.BR sudo (8).
.
.B sudo
is probably the most popular these days, particularly when using the
.UR http://www.ubuntu.com
Ubuntu
.UE
family of distributions.
.
.PP
Run:
.
.sp
.RS 0.5i
.EX
sudo make install
.EE
.RE
.
.PP
as root from the top-level directory.
.
.PP
Running
.B make install
will call the installer to put all of the newly compiled files and other files
(such as this document) in predetermined places set by the
.B \-\-prefix
option to
.B configure
in the directory hierarchy (yes, this is by design and
.B make
is not just flinging files any old place!).
.
.PP
A lot of screen output will be generated.
.
Any errors will probably be rather early in the process and will likely be
related to your
.I username
not having write permissions in the system directory structure.
.
.
.SS ldconfig
.
Once the installation is complete one more step is required if Hamlib has
never been installed from a local build before.
.
The
.B ldconfig
command tells the system library loader where to find the newly installed
Hamlib libraries.
.
It too will need to be run with root privileges:
.
.PP
Run:
.
.sp
.RS 0.5i
.EX
sudo ldconfig
.EE
.RE
.
.PP
as root from any directory.
.
.PP
.BR Note :
Subsequent installations of Hamlib will not need to have
.B ldconfig
run after each installation if a newer version of Hamlib was not installed,
i.e. when recompiling the same version during development.
.
.PP
On some distributions a bit of configuration will be needed before
.B ldconfig
will add locally compiled software to its database.
.
Please consult your distribution's documentation.
.
.
.SS Bootstrapping from a \(aqgit clone\(aq
.
Choosing to build from from a
.B git clone
requires a few more development tools (notice a theme here?) as detailed in
.IR README.developer .
.
The most critical will be the GNU Autotools
.RB ( autoconf ,
.BR automake ,
.BR libtool ,
and more) from which the build system consisting of
.BR configure ,
the various
.IR Makefile.in s
throughout the directory structure, and the final
.IR Makefile s
are generated.
.
.PP
In the top-level directory is the
.B bootstrap
script from which the build system is
.IR bootsrapped\(emthe
process of generating the Hamlib build system from
.I configure.ac
and the various
.IR Makefile.am s.
.
At its completion the
.B configure
script will be present to configure the build system.
.
.PP
Next
.B configure
is run with any needed build options
.RB ( "configure \-\-help"
is useful) to enable certain features or provide paths for locating needed
build dependencies, etc.
.
Environment variables intended for the preprocessor and/or compiler may also
be set on the
.B configure
command line.
.
.PP
After the configuration is complete, the build may proceed with the
.B make
step as for the source tarballs above.
.
Or
.B configure \-\-help
may be run, and
.B configure
run again with specific options in which case the
.IR Makefile s
will be regenerated and the build can proceed with the new configuration.
.
.
.SS Other make targets
.
Besides
.BR "make install" ,
other
.I targets
exist when running
.BR make .
.
Running
.B make clean
from the top-level directory removes all of the generated object and
executable files generated by running
.B make
freeing up considerable disk space.
.
.PP
.BR Note :
During development of individual source files, it is not necessary to
run
.B make clean
each time before
.BR make .
.
Simply run
.B make
and only the modified file(s) and any objects that depend on them will be
recompiled.
.
This speeds up development time considerably.
.
.PP
To remove even the generated
.IR Makefile s,
run
.B make distclean
from the top-level directory.
.
After this target is run,
.B configure
will need to be run again to regenerate the
.IR Makefile s.
.
This command may not be as useful as the
.IR Makefile s
do not take up much space, however it can be useful for rebuilding the
.IR Makefile s
when modifying a
.I Makefile.am
or
.I confgure.ac
during build system development.
.
.
.SS Parallel build trees
.
One feature of the GNU build system used by Hamlib is that the object files
can be kept in a directory structure separate from the source files.
.
While this has no effect on the
.B make
targets described above, it does help the developer find files in the source
tree!
.
One such way of using parallel builds is described in
.IR README.developer .
.
.PP
Parallel builds can be very useful as one build directory can be configured
for a release and another build directory can be configured for debugging with
different options passed to
.B configure
from each directory.
.
The generated
.IR Makefile s
are unique to each build directory and will not interfere with each other.
.
.
.SS Adding debugging symbols
.
When additional debugging symbols are needed with, for example, the GNU
Debugger,
.BR gdb ,
the needed compiler and linker options are passed as environment variables.
.
.PP
Run:
.sp
.RS 0.5i
.EX
\&../hamlib/configure CFLAGS="-ggdb3 -O0" CXXFLAGS="-ggdb3 -O0"
.EE
.RE
.
.PP
from a sibling build directory intended for a debugging build.
.
.PP
The
.B \-ggdb3
option tells the C compiler, in this case the GNU C Compiler,
.BR gcc ,
to add special symbols useful for GDB, the GNU debugger.
.
The
.B -O0
option tells
.B gcc
to turn off all optimizations which will make it easier to follow some
variables that might otherwise be optimized away.
.
.B CFLAGS
and
.B CXXFLAGS
may be set independently for each compiler.
.
.PP
.BR Note :
There are a number compiler options available for controlling debugging
symbols and setting optimization levels.
.
Please consult the compiler's manual for all the details.
.
.
.SS Compiling for Microsoft Windows
.
Currently compiling is done on a Debian 8 (Jessie) virtual machine using
.UR http://www.mingw.org
MinGW
.UE .
.I README.build-win32
in the
.I scripts
directory has details on how this is accomplished.
.
.
.SS Pre-compiled binaries for Microsoft Windows
.
Pre-compiled binaries for Microsoft Windows 32 and 64 bit architectures
(Windows NT and newer) are available for both official releases and daily
development snapshots.
.
Official releases are available through the
.UR http://sourceforge.net/projects/hamlib/files/hamlib/
SourceForge.net file download service
.UE .
.
As an alternative, official releases are also available though the
.UR https://github.com/Hamlib/Hamlib/releases
Hamlib archive at GitHub
.UE .
.
Daily development snapshots are available from the
.UR http://n0nb.users.sourceforge.net/
daily snapshots page
.UE .
.
.PP
Beginning with the Hamlib 1.2.15.3 release a self-extracting installer is
available.
.
Among its features are selecting which portions of Hamlib are installed.
.
The
.B PATH
environment variable will need to be set manually per the included
.I README.w32-bin
or
.I README.w64-bin
file.
.
.PP
Daily development snapshots feature both a .ZIP archive and the self
extracting installer.
.
.PP
Bug reports and questions about these archives should be sent to the
.MT hamlib-developer@@lists.sourceforge.net
hamlib-developer mailing list
.ME .
.
.
.SH COPYING
.
This file is part of Hamlib, a project to develop a library that simplifies
radio and rotator control functions for developers of software primarily of
interest to radio amateurs and those interested in radio communications.
.
.PP
Copyright \(co 2001-2018 Hamlib Group (various contributors)
.
.PP
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.
.
.
.SH SEE ALSO
.
.BR git (1),
.BR hamlib (7),
.BR ldconfig (8),
.BR make (1),
.BR su (1),
.BR sudo (8)
.
.
.SH COLOPHON
.
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives:
.IP
.UR http://www.hamlib.org
hamlib.org
.UE .

835
doc/man7/hamlib-utilities.7 Normal file
View File

@ -0,0 +1,835 @@
.\" Hey, EMACS: -*- nroff -*-
.\"
.\" For layout and available macros, see man(7), man-pages(7), groff_man(7)
.\" Please adjust the date whenever revising the manpage.
.\"
.\" Please keep this file in sync with doc/utility-programs.texi
.\"
.TH HAMLIB-UTILITIES "7" "2018-05-27" "Hamlib" "Hamlib Information Manual"
.
.
.SH NAME
.
hamlib-utilties \- radio and rotator control utilities of Hamlib
.
.
.SH DESCRIPTION
.
Included with the Hamlib distribution are several utility programs.
.
Besides providing a way for developers to test new code and bug fixes, the
programs also offer a reference implementation for interfacing to the Hamlib
library functions both through the
.B C
.SM API
(Application Programming Interface) and offering a network accessible
.SM API.
.
.PP
This page summarizes the two test programs,
.BR rigctl (1)
for testing radio back ends and
.BR rotctl (1)
for testing rotator back ends and the two network daemons,
.BR rigctld (1)
and
.BR rotcltd (1)
for radio and rotator access via network sockets.
.
Also included are three demonstation utilities,
.BR rigmem (1),
.BR rigsmtr (1),
and
.BR rigswr (1)
which provide functional examples of how Hamlib may be used to accomplish
various tasks.
.
.
.SH rigctl
.
.BR rigctl (1)
is the most frequently used Hamlib utility.
.
As the other
.I ctl
utilities share many of the same characteristics, much of the introductory
information presented in this section is applicable to the other utility
programs.
.
.
.SS Introduction to rigctl
.
Most likely the first of the Hamlib utility programs that is used is
.BR rigctl (1).
.
rigctl is a character based interactive program and a command line program
able to set or query a radio's value with a single command.
.
rigctl is invoked from a shell command prompt with various options and
additional commands.
.
.PP
In its most simple use as a
.I "command line"
program, rigctl is used to set frequency and mode by typing commands after any
rigctl options:
.
.sp
.RS 0.5i
.EX
rigctl F 14205000
.br
rigctl M USB 2400
.EE
.RE
.
.PP
and then query those values:
.
.sp
.RS 0.5i
.EX
rigctl f
.br
rigctl m
.EE
.RE
.
.PP
Entering
.I "interactive mode"
is a simple matter of not placing any commands after any rigctl options:
.
.sp
.RS 0.5i
.EX
rigctl
.EE
.RE
.
.PP
Entering interactive mode allows successive commands to be entered without
exiting rigctl.
.
Recent additions to rigctl allow command editing and history recall through
use of the
.UR https://tiswww.case.edu/php/chet/readline/rltop.html
Readline
.UE
library.
.
.PP
Interactive mode is indicated by the spartan prompt:
.
.sp
.RS 0.5i
.EX
Rig command:
.EE
.RE
.
.PP
Commands are given at the prompt and follow the general rule that upper case
letters set a value and lower case letters query a value:
.
.sp
.RS 0.5i
.EX
Rig command: M
.br
Mode: USB
.br
Passband: 2500
.sp
Rig command: m
.br
Mode: USB
.br
Passband: 2500
.sp
Rig command:
.EE
.RE
.
.PP
An additional prompt is printed when more information is required by the
command.
.
For \f(CWM\fP above, rigctl prompted for the \f(CWMode\fP and \f(CWPassband\fP
values.
.
For \f(CWm\fP above, rigctl returned the \f(CWMode\fP and \f(CWPassband\fP
values without further prompts.
.
The command prompt is returned after each command invocation.
.
.PP
The above examples invoked rigctl without specifying a radio model.
.
This is a feature where the Hamlib internal radio model 1
.I dummy
is used instead.
.
The dummy radio provides a way to test Hamlib functions without the need for
actual radio hardware.
.
However, to develop the Hamlib backend capability for a given radio, having
the actual radio connected to the computer is necessary for debugging.
.
.PP
For example, to quickly set frequency on an Elecraft K3:
.
.sp
.RS 0.5i
.EX
rigctl -m 229 -r /dev/rig F 3900000
.EE
.RE
.
.PP
and to query the frequency and then mode:
.
.sp
.RS 0.5i
.EX
rigctl -m 229 -r /dev/rig f
.br
3900000
.sp
rigctl -m 229 -r /dev/rig m
.br
LSB
.br
2000
.EE
.RE
.
.PP
.BR Note :
the returned values do not have the prompt strings associated with interactive
mode as shown above.
.
.PP
The
.B \-m
option takes a numeric value that corresponds to a given radio back end model.
.
The
.B \-r
option takes the path to the port device on
.SM POSIX
and the device name on Microsoft Windows.
.
.PP
.BR Note :
A complete list of supported radio models may be seen by use of the
.B -l
option:
.
.sp
.RS 0.5i
.EX
rigctl -l
.br
Rig # Mfg Model Version Status
.br
1 Hamlib Dummy 0.5 Beta
.br
2 Hamlib NET rigctl 0.3 Beta
.br
101 Yaesu FT-847 0.5 Beta
.br
103 Yaesu FT-1000D 0.0.6 Alpha
.br
\&.
.br
\&.
.br
\&.
.br
2702 Rohde&Schwarz EB200 0.1 Untested
.br
2801 Philips/Simoco PRM8060 0.1 Alpha
.br
2901 ADAT www.adat.ch ADT-200A 1.36 Beta
.EE
.RE
.
.PP
The list is long so use \f(CWShift\-PageUp\fP/\f(CWShift\-PageDown\fP on
Linux, \f(CWScrollLock\fP then \f(CWPageUp\fP/\f(CWPageDown\fP on Free BSD, or
use the scrollbar to the virtual terminal window
.RB ( cmd
window on Microsoft Windows) or the output can be piped to
.BR more (1)
or
.BR less (1),
e.g. \(lq\f(CWrigctl -l | more\fP\(rq to scroll back up the list.
.
The list is sorted numerically by model number since Hamlib 1.2.15.1.
.
Model numbers of a manufacturer/protocol family are grouped together.
.
.
.SS rigctl reference
.
The complete reference for rigctl can be found in the
.BR rigctl (1)
manual page.
.
.
.SH rotctl
.
Identical in function to
.BR rigctl (1),
.BR rotctl (1)
provides a means for testing Hamlib functions useful for rotator control and
QTH (Maidenhead gridsquare system, see
.UR https://en.wikipedia.org/wiki/Maidenhead_Locator_System
Maidenhead Locator System
.UE )
locator computations.
.
As rotators have a much narrower scope than radios, there are fewer command
line options and commands for rotctl.
.
.
.SS Introduction to rotctl
.
.BR rotctl (1)
is a character based interactive program and a command line program able to
set or query a rotator's value with a single command.
.
rotctl is invoked from a shell command prompt with various options and
additional commands.
.
.PP
In its most simple use as a
.I "command line"
program, rotctl is used to set azimuth position and (optionally) elevation by
typing commands after any rotctl options:
.
.sp
.RS 0.5i
.EX
rotctl P 145.0 23.0
.br
rotctl M 8 25
.EE
.RE
.
.PP
and then query those values:
.
.sp
.RS 0.5i
.EX
rotctl p
.EE
.RE
.
.PP
Entering
.I "interactive mode"
is a simple matter of not placing any commands after any rotctl options:
.
.sp
.RS 0.5i
.EX
rotctl
.EE
.RE
.
.PP
Entering interactive mode allows successive commands to be entered without
exiting rotctl.
.
Interactive mode allows for command editing and history recall through the use
of the
.UR https://tiswww.case.edu/php/chet/readline/rltop.html
Readline
.UE
library.
.
.PP
Interactive mode is indicated by the spartan prompt:
.
.sp
.RS 0.5i
.EX
Rotator command:
.EE
.RE
.
.PP
Commands are given at the prompt:
.
.sp
.RS 0.5i
.EX
Rotator command: M
.br
Direction: 16
.br
Speed: 60
.sp
Rotator command: p
.br
Azimuth: 11.352000
.br
Elevation: 0.000000
.sp
Rotator command: p
.br
Azimuth: 27.594000
.br
Elevation: 0.000000
.sp
Rotator command:
.EE
.RE
.
.PP
An additional prompt is printed when more information is required by the
command.
.
For \f(CWM\fP above, rotctl prompted for the \f(CWDirection\fP and
\f(CWSpeed\fP values.
.
For \f(CWp\fP above, rotctl returned the \f(CWAzimuth\fP and \f(CWElevation\fP
values without further prompts.
.
The command prompt is returned after each command invocation.
.
.PP
The above examples invoked rotctl without specifying a rotator model.
.
This is a feature where the Hamlib internal rotator model 1
.I dummy
is used instead.
.
The dummy rotator provides a way to test Hamlib functions without the need for
actual rotator hardware.
.
However, to develop back end capability for a given rotator, having the actual
controller connected to the computer is necessary for debugging.
.
.PP
For example, to quickly set position for RotorEZ:
.
.sp
.RS 0.5i
.EX
rotctl -m 401 -r /dev/rotor P 100.0 0.0
.EE
.RE
.
.PP
and to query the position:
.
.sp
.RS 0.5i
.EX
rotctl -m 401 -r /dev/rotor p
.br
100.000000
.br
0.000000
.EE
.RE
.
.PP
The returned values do not have the prompt strings associated with interactive
mode as shown above.
.
.PP
The
.B -m
option takes a numeric value that corresponds to a given rotator back end model.
.
The
.B -r
option takes the path to the port device on
.SM POSIX
or the device name on Microsoft Windows.
.
.PP
.BR Note :
A complete list of supported rotator models may be seen by use of the
.B -l
option:
.
.sp
.RS 0.5i
.EX
rotctl -l
.br
Rot # Mfg Model Version Status
.br
1 Hamlib Dummy 0.5 Beta
.br
2 Hamlib NET rotctl 0.3 Beta
.br
201 Hamlib EasycommI 0.3 Beta
.br
202 Hamlib EasycommII 0.3 Beta
.br
\&.
.br
\&.
.br
\&.
.br
1201 AMSAT IF-100 0.1 Untested
.br
1301 LA7LKA ts7400 0.1 Beta
.br
1401 Celestron NexStar 0.1 Untested
.EE
.RE
.
.PP
The list is long so use \f(CWShift\-PageUp\fP/\f(CWShift\-PageDown\fP on
Linux, \f(CWScrollLock\fP then \f(CWPageUp\fP/\f(CWPageDown\fP on Free BSD, or
use the scrollbar to the virtual terminal window
.RB ( cmd
window on Microsoft Windows) or the output can be piped to
.BR more (1)
or
.BR less (1),
e.g. \(lq\f(CWrotctl -l | more\fP\(rq to scroll back up the list.
.
The list is sorted numerically by model number since Hamlib 1.2.15.1.
.
Model numbers of a manufacturer/protocol family are grouped together.
.
.
.SS rotctl reference
.
The complete reference for rotctl can be found in the
.BR rotctl (1)
manual page.
.
.
.SH rigctld
.
The
.BR rigctld (1)
program is a network server that accepts the familiar commands of
.BR rigctl (1)
and provides the response data over a
.SM TCP/IP
network socket to an application.
.
In this manner an application can access a rigctld instance from nearly
anywhere (caveat, no security is currently provided by rigctld).
.
Applications using rigctld do not link directly to Hamlib nor use its C API.
.
.
.SS Introduction to rigctld
.
.BR rigctld (1)
communicates to a client through a
.SM TCP
network socket using text commands shared with
.BR rigctl (1).
.
The protocol is simple; commands are sent to rigctld on one line and rigctld
responds to
.B get
commands with the requested values, one per line, when successful, otherwise,
it responds with one line
.B RPRT
.IR x ,
where
.I x
is a negative number indicating the Hamlib error code.
.
Commands that do not return values respond with the line
.B RPRT
.IR x ,
where
.I x
is zero when successful, otherwise a negative number indicating the Hamlib
error code.
.
Each line is terminated with a newline,
.IR \en ,
character.
.
This protocol is primarily for use by the
.B NET rigctl
(radio model 2) backend.
.
.PP
A separate Extended Response protocol extends the above behavior by echoing
the received command string as a header, any returned values as a key: value
pair, and the
.B RPRT
.I x
string as the end of response marker which includes the Hamlib success or
failure value.
.
Consider using this protocol for clients that will interact with
rigctld directly through a TCP network socket.
.
.PP
Multiple radios can be controlled on different TCP ports by use of multiple
rigctld processes each listening on a unique TCP port.
.
It is hoped that rigctld will be especially useful for client authors using
languages such as
.UR http://www.perl.org/
Perl
.UE ,
.UR http://www.python.org/
Python
.UE ,
.UR http://php.net/
PHP
.UE ,
.UR http://www.ruby-lang.org/en/
Ruby
.UE ,
.UR http://www.tcl.tk/
TCL
.UE ,
and others.
.
.
.SS rigctld reference
.
The complete reference for rigctld can be found in the
.BR rigctld (1)
manual page.
.
.
.SH rotctld
.
The
.BR rotctld (1)
program is a network server that accepts the familiar commands of
.BR rotctl (1)
and provides the response data over a \f(CWTCP/IP\fP network socket to an
application.
.
In this manner an application can access a rotctld instance from nearly
anywhere (caveat, no security is currently provided by rotctld).
.
Applications using rotctld do not link directly to Hamlib nor use its C API.
.
.
.SS Introduction to rotctld
.
.BR rotctld (1)
communicates to a client through a
.SM TCP
network socket using text commands shared with
.BR rotctl (1).
.
The protocol is simple, commands are sent to rotctld on one line and
rotctld responds to
.B get
commands with the requested values, one per line, when successful, otherwise,
it responds with one line
.B RPRT
.IR x ,
where
.I x
is a negative number indicating the Hamlib error code.
.
Commands that do not return values respond with the line
.B RPRT
.IR x ,
where
.I x
is zero when successful, otherwise a negative number indicating
the Hamlib error code.
.
Each line is terminated with a newline,
.I \en
character.
.
This protocol is primarily for use by the
.B NET rotctl
(rotator model 2) backend.
.
.PP
A separate Extended Response protocol extends the above behavior by echoing
the received command string as a header, any returned values as a key: value
pair, and the
.B RPRT
.I x
string as the end of response marker which includes the Hamlib success or
failure value.
.
Consider using this protocol for clients that will interact with
rotctld directly through a TCP network socket.
.
.PP
Multiple rotators can be controlled on different TCP ports by use of multiple
rotctld processes each listening on a unique TCP port.
.
It is hoped that rotctld will be especially useful for client authors using
languages such as
.UR http://www.perl.org/
Perl
.UE ,
.UR http://www.python.org/
Python
.UE ,
.UR http://php.net/
PHP
.UE ,
.UR http://www.ruby-lang.org/en/
Ruby
.UE ,
.UR http://www.tcl.tk/
TCL
.UE ,
and others.
.
.
.SS rotctld reference
.
The complete reference for rotctld can be found in the
.BR rotctld (1)
manual page.
.
.
.SH rigmem
.
.B rigmem
may be used to backup and restore memory of radio transceivers and receivers.
.
.
.SS Introduction to rigmem
.
Backup and restore memory of radio transceivers and receivers.
.B rigmem
accepts
.IR command s
from the command line only.
.
.
.SS rigmem reference
.
The complete reference for rigmem can be found in the
.BR rigmem (1)
manual page.
.
.
.SH rigsmtr
.
.B rigsmtr
uses
.B Hamlib
to control a radio to measure S-Meter value versus antenna azimuth.
.
.
.SS Introduction to rigsmtr
.
rigsmtr rotates the antenna from minimum azimuth to maximum azimuth.
Every second, or
.I time_step
if specified in seconds, it retrieves the signal strength. Azimuth in degrees
and the corresponding S-Meter level in dB relative to S9 are then printed on
.BR stdout .
.
.PP
To work correctly, rigsmtr needs a radio that could measure S-Meter and a Hamlib
backend that is able to retrieve it, connected to a Hamlib supported rotator.
.
.
.SS rigsmtr reference
.
The complete reference for rigsmtr can be found in the
.BR rigsmtr (1)
manual page.
.
.
.SH rigswr
.
.B rigswr
may be used to measure VSWR vs frequency.
.
.
.SS Introduction to rigswr
.
rigswr uses Hamlib to control a radio to measure VSWR (Voltage Standing
Wave Ratio) over a frequency range.
It scans frequencies from
.I start_freq
to
.I stop_freq
with an optional increment of
.I freq_step
(default step is 100 kHz).
.
All values must be entered as an integer in Hertz (cycles per second).
.BR Note :
rigswr assumes that
.I start_freq is less than or equal to
.IR stop_freq .
.
If it is greater, rigswr will exit without doing anything.
.
.PP
For each frequency, rigswr transmits at 25% of total POWER during 0.5 second
in CW mode and reads VSWR.
.
.PP
Frequency and the corresponding VSWR are then printed on stdout.
.
.PP
To work correctly, rigswr needs a radio that can measure VSWR and a
Hamlib backend that supports reading VSWR from the radio.
.
.
.SS rigswr reference
.
The complete reference for rigswr can be found in the
.BR rigswr (1)
manual page.
.
.
.SH COPYING
.
This file is part of Hamlib, a project to develop a library that simplifies
radio and rotator control functions for developers of software primarily of
interest to radio amateurs and those interested in radio communications.
.
.PP
Copyright \(co 2001-2018 Hamlib Group (various contributors)
.
.PP
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.
.
.
.SH SEE ALSO
.
.BR less (1),
.BR more (1),
.BR rigctl (1),
.BR rigctld (1),
.BR rotctl (1),
.BR rotctld (1),
.BR rigmem (1),
.BR rigsmtr (1),
.BR rigswr (1),
.BR hamlib (7),
.BR hamlib-primer (7)
.
.
.SH COLOPHON
.
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives:
.IP
.UR http://www.hamlib.org
hamlib.org
.UE .

345
doc/man7/hamlib.7 Normal file
View File

@ -0,0 +1,345 @@
.\" Hey, EMACS: -*- nroff -*-
.\"
.\" For layout and available macros, see man(7), man-pages(7), groff_man(7)
.\" Please adjust the date whenever revising the manpage.
.\"
.\" Please keep this file in sync with doc/nutshell.texi
.\"
.TH HAMLIB "7" "2018-05-21" "Hamlib" "Hamlib Information Manual"
.
.
.SH NAME
.
hamlib \- radio and rotator control library
.
.
.SH DESCRIPTION
.
The
.BR "Ham Radio Control Libraries" ,
.B Hamlib
for short, is a development effort to provide a consistent interface for
programmers wanting to incorporate radio and rotator control in their
programs.
.
.PP
Hamlib is not a complete user application, rather, it is a software layer
intended to make controlling various radios and other amateur radio station
(shack) hardware much easier.
.
Hamlib will allow authors of software such as logging programs, digital
communications programs, or those wanting to develop the ultimate radio
control software to concentrate on the user interface and the basic function
of the program rather than radio control.
.
Hamlib consists of several parts, the programming library, utility programs,
and library interfaces to other programming languages.
.
.PP
Most recent amateur radio transceivers allow external control of their
functions through a serial interface.
.
Unfortunately, control commands are not always consistent across a
manufacturer's product line and each manufacturer's product line differs
greatly from its competitors.
.
.PP
Hamlib attempts to solve this problem by presenting a
.I virtual radio
to the programmer by providing an interface to actions such as setting a given
Variable Frequency Oscillator's (VFO) frequency, setting the operating mode,
querying the radio of its current status and settings, and giving the
application a list of a given radio's capabilities.
.
Unfortunately, what can be accomplished by Hamlib is limited by the radios
themselves and some offer very limited capability.
.
.PP
Other devices, such as antenna rotators, can be placed into the Hamlib control
scheme.
.
Other recent developments include network interface servers and a USB
interface capability.
.
Language bindings are provided for
.BR C ", " C++ ", " Perl ", " Python ", " Lua " and " TCL
(more to come).
.
.
.SS Overview
.
Hamlib is a
.I front end
library providing a
.B C
language Application Programming Interface (API) to programmers wishing to
integrate radio or rotator control in their applications.
.
Hamlib presents a
.I virtual radio
or
.I virtual rotator
that is a consistent interface to an application despite wide differences in
radio and rotator interfaces and capabilities.
.
.PP
The front end library uses a number of
.I back end
libraries to translate from the front end to the various individual radio and
rotator models.
.
A back end library handles conversion of the front end variables to the format
needed by the radio or rotator device it controls.
.
The back end libraries are generally grouped by manufacturer and in some cases
by a common control protocol.
.
.PP
Hamlib also provides an interface library for each of several common
.I scripting
languages such as
.UR http://www.perl.org
.B Perl
.UE ,
.UR http://www.python.org
.B Python
.UE ,
.UR https://www.lua.org
.B Lua
.UE ,
and
.UR http://www.tcl.tk
.B TCL
.UE .
.
These language
.I bindings
are
generated through the use of
.UR http://www.swig.org
.B SWIG
.UE ,
a parser/generator for multiple language interfaces to a
.B C
library.
.
A natively generated
.B C++
language interface is also provided.
.
.PP
Besides the C and supplemental APIs, Hamlib also provides a pair of network
daemons that provide a text command based API for controlling an attached
radio or rotator through a
.BR TCP / IP
network connection.
.
The daemons then handle the interface to the Hamlib C API.
.
.PP
More than one type of device, radio or rotator, may be controlled at a
time, however, there is generally a limit of one device per serial port
or other port.
.
.
.SS Hamlib project information
.
The Hamlib Project was founded by Frank Singleton, VK3FCS/KM5WS in July 2000.
.
Shortly after Stephane Fillod, F8CFE, joined Frank on the Hamlib project and
the API and implementation development led to a reasonable level of maturity
in a few years.
.
A major milestone was reached when Hamlib 1.2.0 was released in March 2004.
.
The API and Application Binary Interface (ABI) interfaces have remained stable
since that time up to the latest release of 3.2 in early 2018.
.
.PP
Development continues through the major version number
.RI 3. x
series and beyond.
.
While some API tweaks are planned, ABI compatibility with the prior
.RI 1.2. x
releases remains a priority.
.
Other goals include streamlining the build system (done), improving the SWIG
generated language bindings (done), improving the overall documentation (this
man page with more in progress), and other updates as warranted.
.
.PP
The Project is hosted by
.UR https://sourceforge.net
SourceForge.net
.UE
at the
.UR https://sourceforge.net/projects/hamlib/
Hamlib project page
.UE .
.
As
.UR https://github.com
GitHub
.UE
has become a very popular project hosting site, Hamlib also has a dedicated
.UR https://github.com/Hamlib/Hamlib
GitHub project page
.UE .
.
GitHub also hosts the
.UR http://www.hamlib.org
hamlib.org
.UE
Web site and the
.UR https://github.com/Hamlib/Hamlib/wiki
Hamlib Wiki
.UE .
.
.PP
Development discussion and most user support take place on the
.UR https://sourceforge.net/p/hamlib/mailman/
hamlib-developer mailing list
.UE .
While there are
.UR https://sourceforge.net/p/hamlib/discussion/
SourceForge.net discussion forums
.UE ,
they are rarely used and not as closely read by the developers as the mailing
list.
.
.PP
For
.IR "source code management" ,
the project uses
.UR http://git-scm.com/
.B Git
.UE ,
a fast, distributed content tracker.
.
Among its features is that every developer has the complete Hamlib
development history available locally.
.
For more information on using Git, see
.BR hamlib\-git (7).
.
.IP
.BR Note :
while a canonical Git repository is hosted at SourceForge, its availability is
not essential to continued development although development work flows would
change temporarily.
.
Several developers find the GitHub Web interface easier to use and lately
development has centered around GitHub rather than SourceForge.
.
.
.SS Applications using Hamlib
.
A number of application developers have taken advantage of Hamlib's
capabilities to implement radio and/or rotator control.
.
While not exhaustive, a list is maintained at the Hamlib Wiki,
.UR https://github.com/Hamlib/Hamlib/wiki/Applications-and-Screen-Shots
Applications/Screenshots
.UE .
Developers are encouraged to request their applications be added to the
gallery by way of the hamlib-developer mailing list.
.
.
.SS Using Hamlib with your program
.
As with other Free Software projects, Hamlib relies heavily on copyleft
licensing to encourage development contributions and provide an open
atmosphere for development.
.
Hamlib's source code is released under two
licenses, the
.B Lesser General Public License
(LGPL) for the library portion, and the
.B General Public License
(GPL) for the utility programs.
.
.PP
The LGPL allows the library to be used (linked) by programs regardless of
their individual license.
.
However, any contributions to the library source remain under copyleft which
means that the library source code may not be used in violation of the terms
of the LGPL.
.
.PP
The utility program source files are released under the GPL.
.
Any direct use of these sources must be in a form that complies with the terms
of the GPL.
.
Concepts learned by studying these sources for the purpose of understanding
the Hamlib API is not covered nor prohibited by the GPL, however, directly
copying GPL sources into any work that is incompatible with the terms of the
GPL is prohibited.
.
.
.SS Radios with a clone capability
.
Hamlib's focus is on controlling radios that employ a port and command
protocol for setting frequency, mode, VFO, PTT, etc.
.
Most VHF/UHF transceivers do not employ such control capability but do provide
for cloning the memory contents from radio to another of the same model.
.
A related project,
.UR http://chirp.danplanet.com
CHIRP
.UE ,
aims to support radios with such a clone capability.
.
Please contact the CHIRP project for support of such radios.
.
.
.SS Pronouncing Hamlib
.
English speakers seem to have two alternate pronunciations for our project:
.
.nf
.IP \(bu 4
Hamlib (Ham \- lib, long \(oqi\(cq, as in library.) IPA style: /\(aqham læb/
.
.IP \(bu 4
Hamlib (Ham \- lib, short \(oqi\(cq, as in liberty.) IPA style: /\(aqham lɪb/
.fi
.
.PP
Then again, we have people who say Linux \(lqL-eye-nux\(rq and those who say
\(lqL-in-nux\(rq...
.
.PP
If you're French, the above does not apply! :-)
.
.
.SH COPYING
.
This file is part of Hamlib, a project to develop a library that simplifies
radio and rotator control functions for developers of software primarily of
interest to radio amateurs and those interested in radio communications.
.
.PP
Copyright \(co 2001-2018 Hamlib Group (various contributors)
.
.PP
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.
.
.
.SH SEE ALSO
.
.BR hamlib-primer (7)
.
.
.SH COLOPHON
.
Links to the Hamlib Wiki, Git repository, release archives, and daily snapshot
archives:
.IP
.UR http://www.hamlib.org
hamlib.org
.UE .

173
doc/nutshell.texi
View File

@ -1,33 +1,34 @@
The @dfn{Ham Radio Control Libraries}, @dfn{Hamlib} for short, is a
development effort to provide a consistent interface for programmers
wanting to incorporate radio control in their programs.
wanting to incorporate radio and rotator control in their programs.
Hamlib is not a complete user application, rather, it is a software
layer intended to make controlling various radios and other shack
hardware much easier. Hamlib will allow authors of such software as
logging programs, digital communications programs, or those wanting to
develop the ultimate radio control software to concentrate on the user
interface and the basic function of the program rather than radio
control. Hamlib consists of several parts, the programming library,
utility programs, and library interfaces to other programming languages.
layer intended to make controlling various radios and other amateur
radio station (shack) hardware much easier. Hamlib will allow authors
of software such as logging programs, digital communications programs,
or those wanting to develop the ultimate radio control software to
concentrate on the user interface and the basic function of the
program rather than radio control. Hamlib consists of several parts,
the programming library, utility programs, and library interfaces to
other programming languages.
Most recent amateur radio transceivers allow external control of their
functions through a serial interface. Unfortunately, control commands
are not always consistent across a manufacturer's product line and each
manufacturer's product line differs greatly from its competitors.
functions through a serial interface. Unfortunately, control commands
are not always consistent across a manufacturer's product line and
each manufacturer's product line differs greatly from its competitors.
Hamlib attempts to solve this problem by presenting a "virtual radio" to
the programmer by providing an interface to actions such as setting a
given VFO's frequency, setting the operating mode, querying the radio of
its current status and settings, and giving the application a list of a
given radio's capabilities. Unfortunately, what can be accomplished by
Hamlib is limited by the radios themselves and some offer very limited
capability.
Hamlib attempts to solve this problem by presenting a "virtual radio"
to the programmer by providing an interface to actions such as setting
a given Variable Frequency Oscillator's (VFO) frequency, setting the
operating mode, querying the radio of its current status and settings,
and giving the application a list of a given radio's capabilities.
Unfortunately, what can be accomplished by Hamlib is limited by the
radios themselves and some offer very limited capability.
Other devices, such as antenna rotors, can be placed into the Hamlib
control scheme. Other recent developments include network interface
servers and a USB interface capability. Language bindings are provided
for C, C++, Perl, Python, Lua and TCL (more to come).
Other devices, such as antenna rotators, can be placed into the Hamlib
control scheme. Other recent developments include network interface
servers and a USB interface capability. Language bindings are
provided for C, C++, Perl, Python, Lua and TCL (more to come).
@menu
* Overview::
@ -44,20 +45,20 @@ for C, C++, Perl, Python, Lua and TCL (more to come).
@cindex Front end library
@cindex Virtual radio
@cindex Virtual rotor
@cindex Virtual rotator
Hamlib is a @dfn{front end} library providing a @emph{C} language
Application Programming Interface @acronym{API} to programmers wishing
to integrate radio or rotor control in their applications. Hamlib
presents a @dfn{virtual radio} or @dfn{virtual rotor} that is a
consistent interface to an application despite wide differences in radio
and rotor interfaces and capabilities.
to integrate radio or rotator control in their applications. Hamlib
presents a @dfn{virtual radio} or @dfn{virtual rotator} that is a
consistent interface to an application despite wide differences in
radio and rotator interfaces and capabilities.
@cindex Back end library
The front end library uses a number of @dfn{back end} libraries to
translate from the front end to the various individual radio and
rotor models. A back end library handles conversion of the
front end variables to the format needed by the radio or rotor
device it controls. The back end libraries are generally grouped by
rotator models. A back end library handles conversion of the front
end variables to the format needed by the radio or rotator device it
controls. The back end libraries are generally grouped by
manufacturer and in some cases by a common control protocol.
@quotation
@ -78,23 +79,25 @@ of Hamlib's design.
@cindex Languages, scripting
@cindex Interface, languages
Hamlib also provides an interface library for each of several common
@dfn{scripting} languages such as @url{http://www.perl.org, Perl, Perl},
@url{http://www.python.org, Python, Python}, @url{https://www.lua.org, Lua, Lua}
and @url{http://www.tcl.tk, TCL, TCL}. These language @dfn{bindings} are
generated through the use of @url{http://www.swig.org, SWIG, SWIG} a parser/generator
for multiple language interfaces to a C library. A native generated @emph{C++}
@dfn{scripting} languages such as @url{http://www.perl.org, Perl,
Perl}, @url{http://www.python.org, Python, Python},
@url{https://www.lua.org, Lua, Lua} and @url{http://www.tcl.tk, TCL,
TCL}. These language @dfn{bindings} are generated through the use of
@url{http://www.swig.org, SWIG, SWIG} a parser/generator for multiple
language interfaces to a C library. A native generated @emph{C++}
language interface is also provided.
@cindex Daemon, network
@cindex Network, daemon
Besides the C and supplemental APIs, Hamlib also provides a pair of
network daemons that provide a text command based API for controlling
an attached radio or rotor through a @emph{TCP/IP} network connection.
The daemons then handle the interface to the Hamlib C API.
an attached radio or rotator through a @emph{TCP/IP} network
connection. The daemons then handle the interface to the Hamlib C
API.
More than one type of device, radio or rotor, may be controlled at a
time, however, there is generally a limit of one device per serial port
or other port.
More than one type of device, radio or rotator, may be controlled at a
time, however, there is generally a limit of one device per serial
port or other port.
@node The Hamlib project
@section Hamlib project information
@ -102,50 +105,47 @@ or other port.
@cindex Project, Hamlib
The Hamlib Project was founded by Frank Singleton,VK3FCS/KM5WS in July
2000. Shortly after Stephane Fillod, F8CFE, joined Frank on the Hamlib
project and the API and implementation development led to a reasonable
level of maturity in a few years. A major milestone was reached when
Hamlib 1.2.0 was released in March 2004. The API and Application
Binary Interface (@acronym{ABI}) interfaces have remained stable since
that time up to the latest release of 1.2.15.3 in late 2012.
2000. Shortly after Stephane Fillod, F8CFE, joined Frank on the
Hamlib project and the API and implementation development led to a
reasonable level of maturity in a few years. A major milestone was
reached when Hamlib 1.2.0 was released in March 2004. The API and
Application Binary Interface (@acronym{ABI}) interfaces have remained
stable since that time up to the latest release of 3.2 in early 2018.
Development continues with a bump of the public version number to 3.0
(essentially simply dropping the ``1.'' of previous releases). While some
API tweaks are planned, ABI compatibility with the prior 1.2.@i{x}
releases remains a priority. Other goals include streamlining the
build system (done), improving the SWIG generated language bindings
(in progress), improving the overall documentation (this manual, in
progress), and other updates as warranted.
Development continues through the major version number 3.x and beyond.
While some API tweaks are planned, ABI compatibility with the prior
1.2.@i{x} releases remains a priority. Other goals include
streamlining the build system (done), improving the SWIG generated
language bindings (done), improving the overall documentation (this
manual, in progress), and other updates as warranted.
The Project is hosted by @url{https://sourceforge.net/,
SourceForge.net} at the @url{https://sourceforge.net/projects/hamlib/,
Hamlib project page} and the
@url{http://sourceforge.net/apps/mediawiki/hamlib/index.php, Hamlib
Wiki}.
Hamlib project page}. As @url{https://github.com/, GitHub} has become
a very popular project hosting site, Hamlib also has a dedicated
@url{https://github.com/Hamlib/Hamlib, GitHub project page}. GitHub
also hosts the @url{http://www.hamlib.org, hamlib.org} Web site and
the @url{https://github.com/Hamlib/Hamlib/wiki, Hamlib Wiki}.
Development discussion and most user support take place on the
@url{https://sourceforge.net/p/hamlib/mailman/, hamlib-developer mailing
list}. While there are
@url{https://sourceforge.net/p/hamlib/mailman/, hamlib-developer
mailing list}. While there are
@url{https://sourceforge.net/p/hamlib/discussion/, SourceForge.net
discussion forums}, they are rarely used and not as closely read by the
developers as the mailing list.
discussion forums}, they are rarely used and not as closely read by
the developers as the mailing list.
For @dfn{source code management}, the project uses
@url{http://git-scm.com/, Git}, a fast, distributed content tracker.
Among its features is that every developer has the complete Hamlib
development history available locally. While a canonical Git
repository is hosted as SourceForge, its availability is not essential to
continued development, although development work flows would change
temporarily. For more information on using Git, @pxref{Working with
Git}.
development history available locally. For more information on using
Git, @pxref{Working with Git}.
@quotation Note
The SourceForge.net Web interface to the Hamlib Git repository is
currently broken (a ticket is pending) as of late February, 2013. A
mirror exists at @url{https://github.com/N0NB/hamlib, GitHub} which
supports browsing via the Web and other Git commands. Access of the
SF.net repository by other means (SSH or Git protocols) is unaffected
by this issue.
While a canonical Git repository is hosted as SourceForge, its
availability is not essential to continued development, although
development work flows would change temporarily. Several developers
find the GitHub Web interface easier to use and lately development has
centered around GitHub rather than SourceForge.
@end quotation
@node Applications using Hamlib
@ -154,9 +154,9 @@ by this issue.
@cindex Applications, using Hamlib
A number of application developers have taken advantage of Hamlib's
capabilities to implement radio and/or rotor control. While not
capabilities to implement radio and/or rotator control. While not
exhaustive, a list is maintained at the Hamlib Wiki,
@url{https://sourceforge.net/apps/mediawiki/hamlib/,
@url{https://github.com/Hamlib/Hamlib/wiki/Applications-and-Screen-Shots,
Applications/Screenshots}. Developers are encouraged to request their
applications be added to the gallery by way of the hamlib-developer
mailing list.
@ -166,16 +166,17 @@ mailing list.
@cindex Hamlib licensing
@cindex Licensing, Hamlib
As with other Free Software projects, Hamlib relies heavily on copyleft
licensing to encourage development contributions and provide an open
atmosphere for development. Hamlib's source code is released under two
licenses, the @acronym{LGPL} for the library portion, and the
@acronym{GPL} for the utility programs.
As with other Free Software projects, Hamlib relies heavily on
copyleft licensing to encourage development contributions and provide
an open atmosphere for development. Hamlib's source code is released
under two licenses, the Lesser General Public License (@acronym{LGPL})
for the library portion, and the General Public License
(@acronym{GPL}) for the utility programs.
The LGPL allows the library to be used (linked) by programs regardless
of their individual license. However, any contributions to the library
source remain under copyleft which means that the library source code
may not be used in violation of the terms of the LGPL.
of their individual license. However, any contributions to the
library source remain under copyleft which means that the library
source code may not be used in violation of the terms of the LGPL.
The utility program source files are released under the GPL. Any direct
use of these sources must be in a form that complies with the terms of
@ -192,12 +193,12 @@ with the terms of the GPL is prohibited.
@cindex Cloning, radio
Hamlib's focus is on controlling rigs that employ a port and command
protocol for setting frequency, mode, VFO, PTT, etc. Most VHF/UHF
protocol for setting frequency, mode, VFO, PTT, etc. Most VHF/UHF
transceivers do not employ such control capability but do provide for
cloning the memory contents from radio to another of the same model. A
related project, @url{http://chirp.danplanet.com/, CHIRP}, aims to
support rigs with such a clone capability. Please contact the CHIRP
project for support of such rigs.
cloning the memory contents from radio to another of the same model.
A related project, @url{http://chirp.danplanet.com/, CHIRP}, aims to
support radios with such a clone capability. Please contact the CHIRP
project for support of such radios.
@node Pronunciation
@section Pronouncing Hamlib

3195
doc/utility_programs.texi
View File

File diff suppressed because it is too large Load Diff

291
dummy/flrig.c
View File

@ -96,6 +96,8 @@ struct flrig_priv_data {
freq_t curr_freqB;
pbwidth_t curr_widthA;
pbwidth_t curr_widthB;
int has_get_modeA; /* True if this function is available */
int has_get_bwA; /* True if this function is available */
};
const struct rig_caps flrig_caps = {
@ -104,9 +106,9 @@ const struct rig_caps flrig_caps = {
.mfg_name = "FLRig",
.version = BACKEND_VER,
.copyright = "LGPL",
.status = RIG_STATUS_BETA,
.status = RIG_STATUS_STABLE,
.rig_type = RIG_TYPE_TRANSCEIVER,
.targetable_vfo = RIG_TARGETABLE_FREQ,
.targetable_vfo = RIG_TARGETABLE_FREQ|RIG_TARGETABLE_MODE,
.ptt_type = RIG_PTT_RIG,
.port_type = RIG_PORT_NETWORK,
.write_delay = 0,
@ -166,33 +168,31 @@ const struct rig_caps flrig_caps = {
// Structure for mapping flrig dynmamic modes to hamlib modes
// flrig displays modes as the rig displays them
// hamlib displays modes in generic form
#define MAXMODELEN 8
struct s_modeMap {
int mode_hamlib;
char mode_flrig[MAXMODELEN];
char *mode_flrig;
};
// FLRig will provide us the modes for the selected rig
// We will then put them in this struct
static struct s_modeMap modeMap[]= {
{RIG_MODE_USB,""},
{RIG_MODE_LSB,""},
{RIG_MODE_PKTUSB,""},
{RIG_MODE_PKTLSB,""},
{RIG_MODE_PKTUSB,""},
{RIG_MODE_PKTLSB,""},
{RIG_MODE_AM,""},
{RIG_MODE_FM,""},
{RIG_MODE_FMN,""},
{RIG_MODE_WFM,""},
{RIG_MODE_CW,""},
{RIG_MODE_CW,""},
{RIG_MODE_CWR,""},
{RIG_MODE_CWR,""},
{RIG_MODE_RTTY,""},
{RIG_MODE_RTTYR,""},
{0,""}
{RIG_MODE_USB,NULL},
{RIG_MODE_LSB,NULL},
{RIG_MODE_PKTUSB,NULL},
{RIG_MODE_PKTLSB,NULL},
{RIG_MODE_PKTUSB,NULL},
{RIG_MODE_PKTLSB,NULL},
{RIG_MODE_AM,NULL},
{RIG_MODE_FM,NULL},
{RIG_MODE_FMN,NULL},
{RIG_MODE_WFM,NULL},
{RIG_MODE_CW,NULL},
{RIG_MODE_CW,NULL},
{RIG_MODE_CWR,NULL},
{RIG_MODE_CWR,NULL},
{RIG_MODE_RTTY,NULL},
{RIG_MODE_RTTYR,NULL},
{0,NULL}
};
/*
@ -219,25 +219,6 @@ static int check_vfo(vfo_t vfo)
return TRUE;
}
/*
* vfo_curr
* Assumes rig!=NULL
*/
static int vfo_curr(RIG *rig, vfo_t vfo)
{
int retval = 0;
vfo_t vfocurr;
struct flrig_priv_data *priv = (struct flrig_priv_data *) rig->state.priv;
// get the current VFO from flrig in case user changed it
if ((retval = flrig_get_vfo(rig, &vfocurr)) != RIG_OK) {
return retval;
}
priv->curr_vfo = vfocurr;
retval = (vfo == vfocurr);
return retval;
}
/* Rather than use some huge XML library we only need a few things
* So we'll hand craft them
* xml_build takes a value and return an xml string for FLRig
@ -337,6 +318,10 @@ static char *xml_parse(char *xml, char *value, int value_len)
if (value != NULL) {
xml_parse2(next, value, value_len);
}
if (strstr(value,"faultString")) {
rig_debug(RIG_DEBUG_ERR, "%s error:\n%s\n", __FUNCTION__, value);
value[0]=0; /* truncate to give empty response */
}
return value;
}
@ -352,7 +337,7 @@ static int read_transaction(RIG *rig, char *xml, int xml_len)
rig_debug(RIG_DEBUG_TRACE, "%s\n", __FUNCTION__);
struct rig_state *rs = &rig->state;
rs->rigport.timeout = 4000; // 3 second read string timeout
rs->rigport.timeout = 1000; // 2 second read string timeout
int retry=5;
char *delims="\n";
@ -360,7 +345,7 @@ static int read_transaction(RIG *rig, char *xml, int xml_len)
do {
char tmp_buf[MAXXMLLEN]; // plenty big for expected flrig responses
int len = read_string(&rs->rigport, tmp_buf, sizeof(tmp_buf), delims, strlen(delims));
rig_debug(RIG_DEBUG_WARN,"%s: string='%s'",__FUNCTION__,tmp_buf);
rig_debug(RIG_DEBUG_WARN,"%s: string='%s'",__FUNCTION__,tmp_buf);
if (len > 0) retry = 3;
if (len <= 0) {
rig_debug(RIG_DEBUG_ERR,"%s: read_string error=%d\n",__FUNCTION__,len);
@ -373,8 +358,8 @@ static int read_transaction(RIG *rig, char *xml, int xml_len)
}
if (strstr(xml,terminator)) {
rig_debug(RIG_DEBUG_VERBOSE,"%s: got %s\n",__FUNCTION__,terminator);
// Testing slowing down 3 of commands per second
usleep(2*1000);
// Slow down just a bit -- not sure this is needed anymore but not a big deal here
usleep(2*1000);
retval = RIG_OK;
}
else {
@ -395,11 +380,11 @@ static int write_transaction(RIG *rig, char *xml, int xml_len)
char xmltmp[MAXXMLLEN];
struct rig_state *rs = &rig->state;
// This shouldn't ever happen...but just in case
// We need to avoid and empty write as rigctld replies with blank line
if (xml_len == 0) {
rig_debug(RIG_DEBUG_ERR,"%s: len==0??\n",__FUNCTION__);
rig_debug(RIG_DEBUG_ERR,"%s: len==0??\n",__FUNCTION__);
}
while(try-- >= 0 && retval != RIG_OK) {
@ -476,9 +461,11 @@ static char * modeMapGetFLRig(unsigned int modeHamlib)
static unsigned int modeMapGetHamlib(const char *modeFLRig)
{
int i;
char modeFLRigCheck[64];
snprintf(modeFLRigCheck,sizeof(modeFLRigCheck),"|%.32s|",modeFLRig);
rig_debug(RIG_DEBUG_VERBOSE,"%s: get hamlib mode from %s\n",__FUNCTION__,modeFLRig);
for(i=0; modeMap[i].mode_hamlib!=0; ++i) {
if (streq(modeMap[i].mode_flrig,modeFLRig)) {
if (strstr(modeMap[i].mode_flrig,modeFLRigCheck)) {
rig_debug(RIG_DEBUG_VERBOSE,"%s: got hamlib mode %s\n",__FUNCTION__,rig_strrmode(modeMap[i].mode_hamlib));
return modeMap[i].mode_hamlib;
}
@ -495,10 +482,26 @@ static unsigned int modeMapGetHamlib(const char *modeFLRig)
static void modeMapAdd(unsigned int *modes,int mode_hamlib,char *mode_flrig)
{
int i;
rig_debug(RIG_DEBUG_VERBOSE,"%s:mode_flrig=%s\n",__FUNCTION__,mode_flrig);
int len1 = strlen(mode_flrig)+3; /* bytes needed for allocating */
for(i=0; modeMap[i].mode_hamlib!=0; ++i) {
if (modeMap[i].mode_hamlib==mode_hamlib) {
*modes |= modeMap[i].mode_hamlib;
strncpy(modeMap[i].mode_flrig,mode_flrig,sizeof(modeMap[i].mode_flrig));
/* we will pipe delimit all the entries for easier matching */
/* all entries will have pipe symbol on both sides */
if (modeMap[i].mode_flrig == NULL) {
modeMap[i].mode_flrig = calloc(1,len1);
if (modeMap[i].mode_flrig == NULL) {
rig_debug(RIG_DEBUG_ERR,"%s: error allocating memory for modeMap\n",__FUNCTION__);
return;
}
}
int len2 = strlen(modeMap[i].mode_flrig); /* current len w/o null */
modeMap[i].mode_flrig = realloc(modeMap[i].mode_flrig,strlen(modeMap[i].mode_flrig)+len1);
if (strlen(modeMap[i].mode_flrig)==0) modeMap[i].mode_flrig[0]='|';
strncat(modeMap[i].mode_flrig,mode_flrig,len1+len2);
strncat(modeMap[i].mode_flrig,"|",len1+len2);
rig_debug(RIG_DEBUG_VERBOSE,"%s: Adding mode=%s at %d, index=%d, result=%s\n",__FUNCTION__,mode_flrig, mode_hamlib, i, modeMap[i].mode_flrig);
return;
}
}
@ -527,6 +530,31 @@ static int flrig_open(RIG *rig) {
strncpy(priv->info,value,sizeof(priv->info));
rig_debug(RIG_DEBUG_VERBOSE,"Transceiver=%s\n", value);
/* see if get_modeA is available */
pxml = xml_build("rig.get_modeA", NULL, xml, sizeof(xml));
retval = write_transaction(rig, pxml, strlen(pxml));
read_transaction(rig, xml, sizeof(xml));
xml_parse(xml, value, sizeof(value));
if (strlen(value)>0) { /* must have it since we got an answer */
priv->has_get_modeA = 1;
rig_debug(RIG_DEBUG_VERBOSE,"%s: getmodeA is available=%s\n", __FUNCTION__, value);
}
else {
rig_debug(RIG_DEBUG_VERBOSE,"%s: getmodeA is not available\n",__FUNCTION__);
}
/* see if get_bwA is available */
pxml = xml_build("rig.get_bwA", NULL, xml, sizeof(xml));
retval = write_transaction(rig, pxml, strlen(pxml));
read_transaction(rig, xml, sizeof(xml));
xml_parse(xml, value, sizeof(value));
if (strlen(value)>0) { /* must have it since we got an answer */
priv->has_get_bwA = 1;
rig_debug(RIG_DEBUG_VERBOSE,"%s: get_bwA is available=%s\n", __FUNCTION__, value);
}
else {
rig_debug(RIG_DEBUG_VERBOSE,"%s: get_bwA is not available\n",__FUNCTION__);
}
pxml = xml_build("rig.get_AB", value, xml, sizeof(xml));
retval = write_transaction(rig, pxml, strlen(pxml));
read_transaction(rig, xml, sizeof(xml));
@ -605,6 +633,7 @@ static int flrig_open(RIG *rig) {
else if (streq(p,"RTTY-L")) modeMapAdd(&modes,RIG_MODE_RTTYR,p);
else if (streq(p,"RTTY(U)")) modeMapAdd(&modes,RIG_MODE_RTTY,p);
else if (streq(p,"RTTY(R")) modeMapAdd(&modes,RIG_MODE_RTTYR,p);
else if (streq(p,"DIG")) modeMapAdd(&modes,RIG_MODE_PKTUSB,p);
else rig_debug(RIG_DEBUG_ERR,"%s: Unknown mode for this rig='%s'\n",__FUNCTION__,p);
}
rig->state.mode_list = modes;
@ -657,7 +686,7 @@ static int flrig_get_freq(RIG *rig, vfo_t vfo, freq_t *freq)
}
if (vfo == RIG_VFO_CURR) {
vfo = priv->curr_vfo;
vfo = priv->curr_vfo;
rig_debug(RIG_DEBUG_VERBOSE, "%s: get_freq2 vfo=%s\n",
__FUNCTION__, rig_strvfo(vfo));
}
@ -723,7 +752,7 @@ static int flrig_set_freq(RIG *rig, vfo_t vfo, freq_t freq)
}
if (vfo == RIG_VFO_CURR) {
vfo = priv->curr_vfo;
vfo = priv->curr_vfo;
}
else if (vfo == RIG_VFO_TX && priv->split) {
vfo = RIG_VFO_B; // if split always TX on VFOB
@ -856,7 +885,7 @@ static int flrig_set_split_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t wid
// save some VFO swapping .. may replace with VFO specific calls that won't cause VFO change
if (vfo==RIG_VFO_A && mode==priv->curr_modeA) return RIG_OK;
if (vfo==RIG_VFO_B && mode==priv->curr_modeB) return RIG_OK;
retval = flrig_set_mode(rig,RIG_VFO_B,mode,width);
retval = flrig_set_mode(rig,vfo,mode,width);
rig_debug(RIG_DEBUG_TRACE, "%s: set mode=%s\n",__FUNCTION__,rig_strrmode(mode));
return retval;
}
@ -878,7 +907,7 @@ static int flrig_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)
if (priv->ptt) return RIG_OK;
if (vfo == RIG_VFO_CURR) {
vfo = priv->curr_vfo;
vfo = priv->curr_vfo;
}
if (check_vfo(vfo) == FALSE) {
@ -886,21 +915,16 @@ static int flrig_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)
__FUNCTION__, rig_strvfo(vfo));
return -RIG_EINVAL;
}
//
// Don't touch mode or width if PTT=true
ptt_t ptt;
retval = flrig_get_ptt(rig,RIG_VFO_A,&ptt);
if (ptt) {
priv->ptt = 1;
rig_debug(RIG_DEBUG_ERR,"%s call not made as PTT=1\n",__FUNCTION__);
return RIG_OK; // just return OK and ignore this
if (priv->ptt) {
rig_debug(RIG_DEBUG_ERR,"%s call not made as PTT=1\n",__FUNCTION__);
return RIG_OK; // just return OK and ignore this
}
// Switch to VFOB if appropriate since we can't set mode directly
// MDB
int vfoSwitched = 0;
rig_debug(RIG_DEBUG_WARN,"%s: curr_vfo = %s\n",__FUNCTION__,rig_strvfo(priv->curr_vfo));
if (vfo == RIG_VFO_B && priv->curr_vfo != RIG_VFO_B) {
if (!priv->has_get_bwA && vfo == RIG_VFO_B && priv->curr_vfo != RIG_VFO_B) {
vfoSwitched = 1;
rig_debug(RIG_DEBUG_WARN,"%s: switch to VFOB = %d\n",__FUNCTION__,vfoSwitched);
}
@ -919,7 +943,17 @@ static int flrig_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)
char cmd_buf[MAXCMDLEN];
sprintf(cmd_buf, "<params><param><value>%s</value></param></params>", ttmode);
char xml[MAXXMLLEN];
char *pxml = xml_build("rig.set_mode", cmd_buf, xml, sizeof(xml));
char *pxml=NULL;
if (!priv->has_get_modeA) {
pxml = xml_build("rig.set_mode", cmd_buf, xml, sizeof(xml));
}
else {
char *cmd="rig.set_modeA";
if (vfo==RIG_VFO_B) {
cmd="rig.set_modeB";
}
pxml = xml_build(cmd, cmd_buf, xml, sizeof(xml));
}
retval = write_transaction(rig, pxml, strlen(pxml));
if (retval < 0) {
@ -930,15 +964,25 @@ static int flrig_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)
read_transaction(rig, xml, sizeof(xml));
rig_debug(RIG_DEBUG_VERBOSE, "%s: response=%s\n", __FUNCTION__,xml);
// Need to update the available bandwidths for this mode
if (width > 0) {
// Determine if we need to update the bandwidth
int needBW=0;
if (vfo == RIG_VFO_A) needBW = priv->curr_widthA != width;
else if (vfo == RIG_VFO_B) needBW = priv->curr_widthB != width;
else rig_debug(RIG_DEBUG_ERR,"%s: needBW unknown vfo=%s\n",__FUNCTION__,rig_strvfo(vfo));
// Need to update the bandwidth
if (width > 0 && needBW) {
sprintf(cmd_buf, "<params><param><value><i4>%ld</i4></value></param></params>", width);
// if we're not on VFOB but asking for VFOB still have to switch VFOS
if (!vfoSwitched && vfo==RIG_VFO_B) flrig_set_vfo(rig,RIG_VFO_B);
if (!vfoSwitched && vfo==RIG_VFO_A) flrig_set_vfo(rig,RIG_VFO_A);
pxml = xml_build("rig.set_bandwidth", cmd_buf, xml, sizeof(xml));
retval = write_transaction(rig, pxml, strlen(pxml));
if (retval < 0) {
return retval;
}
read_transaction(rig, xml, sizeof(xml));
if (!vfoSwitched && vfo==RIG_VFO_B) flrig_set_vfo(rig,RIG_VFO_A);
if (!vfoSwitched && vfo==RIG_VFO_A) flrig_set_vfo(rig,RIG_VFO_B);
}
// Return to VFOA if needed
@ -984,29 +1028,26 @@ static int flrig_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width)
vfo_t curr_vfo = priv->curr_vfo;
if (vfo == RIG_VFO_CURR) {
vfo = priv->curr_vfo;
vfo = priv->curr_vfo;
}
rig_debug(RIG_DEBUG_TRACE, "%s: using vfo=%s\n", __FUNCTION__,
rig_strvfo(vfo));
//
// Don't touch mode or width if PTT=true
ptt_t ptt;
retval = flrig_get_ptt(rig,RIG_VFO_A,&ptt);
if (ptt) {
priv->ptt = 1;
if (vfo == RIG_VFO_A) *mode = priv->curr_modeA;
else *mode = priv->curr_modeB;
rig_debug(RIG_DEBUG_ERR,"%s call not made as PTT=1\n",__FUNCTION__);
return RIG_OK; // just return OK and ignore this
if (priv->ptt) {
if (vfo == RIG_VFO_A) *mode = priv->curr_modeA;
else *mode = priv->curr_modeB;
rig_debug(RIG_DEBUG_ERR,"%s call not made as PTT=1\n",__FUNCTION__);
return RIG_OK; // just return OK and ignore this
}
// Switch to VFOB if appropriate
int vfoSwitched=0;
if (vfo == RIG_VFO_B && curr_vfo != RIG_VFO_B) {
rig_debug(RIG_DEBUG_ERR,"%s has_get_modeA=%d\n",__FUNCTION__,priv->has_get_modeA);
if (priv->has_get_modeA == 0 && vfo == RIG_VFO_B && curr_vfo != RIG_VFO_B) {
vfoSwitched = 1;
}
if (vfoSwitched) {
rig_debug(RIG_DEBUG_VERBOSE,"%s switch to VFOB=%d\n",__FUNCTION__,priv->has_get_modeA);
retval = flrig_set_vfo(rig, RIG_VFO_B);
if (retval < 0) {
return retval;
@ -1014,7 +1055,16 @@ static int flrig_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width)
}
char xml[MAXXMLLEN];
char *pxml = xml_build("rig.get_mode", NULL, xml, sizeof(xml));
char *cmdp="rig.get_mode"; /* default to old way */
if (priv->has_get_modeA) { /* change to new way if we can */
/* calling this way reduces VFO swapping */
/* we get the cached value in flrig */
/* vfo B may not be getting polled though in FLRig */
/* so we may not be 100% accurate if op is twiddling knobs */
cmdp = "rig.get_modeA";
if (vfo==RIG_VFO_B) cmdp = "rig.get_modeB";
}
char *pxml = xml_build(cmdp, NULL, xml, sizeof(xml));
retval = write_transaction(rig, pxml, strlen(pxml));
if (retval < 0) {
return retval;
@ -1037,8 +1087,17 @@ static int flrig_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width)
}
// Get the bandwidth
pxml = xml_build("rig.get_bw", NULL, xml, sizeof(xml));
/* Get the bandwidth */
cmdp="rig.get_bw"; /* default to old way */
if (priv->has_get_bwA) { /* change to new way if we can */
/* calling this way reduces VFO swapping */
/* we get the cached value in flrig */
/* vfo B may not be getting polled though in FLRig */
/* so we may not be 100% accurate if op is twiddling knobs */
cmdp = "rig.get_bwA";
if (vfo==RIG_VFO_B) cmdp = "rig.get_bwB";
}
pxml = xml_build(cmdp, NULL, xml, sizeof(xml));
retval = write_transaction(rig, pxml, strlen(pxml));
if (retval < 0) {
return retval;
@ -1100,10 +1159,6 @@ static int flrig_set_vfo(RIG *rig, vfo_t vfo)
vfo = priv->curr_vfo;
}
// Force PTT off
// Why were we turning off PTT here?
// flrig_set_ptt(rig,RIG_VFO_A,0);
char value[MAXCMDLEN];
char xml[MAXXMLLEN];
sprintf(value, "<params><param><value>%s</value></param></params>",
@ -1114,11 +1169,23 @@ static int flrig_set_vfo(RIG *rig, vfo_t vfo)
if (retval < 0) {
return retval;
}
//usleep(50*1000); // temporary sleep until flrig is fixed
priv->curr_vfo = vfo;
rs->tx_vfo = RIG_VFO_B; // always VFOB
read_transaction(rig, xml, sizeof(xml));
/* for some rigs FLRig turns off split when VFOA is selected */
/* so if we are in split and asked for A we have to turn split back on */
if (priv->split && vfo==RIG_VFO_A) {
char xml[MAXXMLLEN];
char value[MAXCMDLEN];
sprintf(value, "<params><param><value><i4>%d</i4></value></param></params>", priv->split);
char *pxml = xml_build("rig.set_split", value, xml, sizeof(xml));
retval = write_transaction(rig, pxml, strlen(pxml));
if (retval < 0) {
return retval;
}
read_transaction(rig, xml, sizeof(xml)); // get response but don't care
}
return RIG_OK;
}
@ -1193,6 +1260,11 @@ static int flrig_set_split_freq(RIG *rig, vfo_t vfo, freq_t tx_freq)
__FUNCTION__, rig_strvfo(vfo));
return -RIG_EINVAL;
}
// we always split on VFOB so if no change just return
freq_t qtx_freq;
retval = flrig_get_freq(rig, RIG_VFO_B, &qtx_freq);
if (retval != RIG_OK) return retval;
if (tx_freq == qtx_freq) return RIG_OK;
char xml[MAXXMLLEN];
char value[MAXCMDLEN];
@ -1218,7 +1290,11 @@ static int flrig_get_split_freq(RIG *rig, vfo_t vfo, freq_t *tx_freq)
{
rig_debug(RIG_DEBUG_TRACE, "%s: vfo=%s\n", __FUNCTION__,
rig_strvfo(vfo));
struct flrig_priv_data *priv = (struct flrig_priv_data *) rig->state.priv;
int retval = flrig_get_freq(rig, RIG_VFO_B, tx_freq);
priv->curr_freqB = *tx_freq;
return retval;
}
@ -1238,21 +1314,15 @@ static int flrig_set_split_vfo(RIG *rig, vfo_t vfo, split_t split, vfo_t tx_vfo)
if (tx_vfo == RIG_VFO_SUB || tx_vfo == RIG_VFO_TX) {
tx_vfo = RIG_VFO_B;
}
// Don't touch split if PTT=true
ptt_t ptt;
retval = flrig_get_ptt(rig,RIG_VFO_A,&ptt);
if (ptt) {
priv->ptt = 1;
rig_debug(RIG_DEBUG_ERR,"%s call not made as PTT=1\n",__FUNCTION__);
return RIG_OK; // just return OK and ignore this
}
/* for flrig we have to be on VFOA when we set split for VFOB Tx */
/* we can keep the rig on VFOA since we can set freq by VFO now */
if (!vfo_curr(rig, RIG_VFO_A)) {
flrig_set_vfo(rig, RIG_VFO_A);
vfo_t qtx_vfo;
split_t qsplit;
retval = flrig_get_split_vfo(rig, RIG_VFO_A, &qsplit, &qtx_vfo);
if (retval != RIG_OK) return retval;
if (split == qsplit) return RIG_OK;
if (priv->ptt) {
priv->ptt = 1;
rig_debug(RIG_DEBUG_ERR,"%s call not made as PTT=1\n",__FUNCTION__);
return RIG_OK; // just return OK and ignore this
}
char xml[MAXXMLLEN];
@ -1264,7 +1334,7 @@ static int flrig_set_split_vfo(RIG *rig, vfo_t vfo, split_t split, vfo_t tx_vfo)
return retval;
}
priv->split = split;
read_transaction(rig, xml, sizeof(xml)); // get response but don't care
return RIG_OK;
@ -1316,25 +1386,22 @@ static int flrig_set_split_freq_mode(RIG *rig, vfo_t vfo, freq_t freq, rmode_t m
if (vfo != RIG_VFO_CURR && vfo != RIG_VFO_TX)
return -RIG_ENTARGET;
// Don't touch split if PTT=true
ptt_t ptt;
retval = flrig_get_ptt(rig,RIG_VFO_A,&ptt);
if (ptt) {
priv->ptt = 1;
rig_debug(RIG_DEBUG_ERR,"%s call not made as PTT=1\n",__FUNCTION__);
return RIG_OK; // just return OK and ignore this
if (priv->ptt) {
rig_debug(RIG_DEBUG_ERR,"%s call not made as PTT=1\n",__FUNCTION__);
return RIG_OK; // just return OK and ignore this
}
// assume split is on B
// swap to VFOB to prevent lots of vfo swapping while seting up VFOB
flrig_set_vfo(rig,RIG_VFO_B);
retval = flrig_set_freq (rig, RIG_VFO_B, freq);
if (retval != RIG_OK) {
rig_debug(RIG_DEBUG_ERR, "%s flrig_set_freq failed\n", __FUNCTION__);
return retval;
}
// Make VFOB mode match VFOA mode, keep VFOB width
rmode_t qmode;
pbwidth_t qwidth;
retval = flrig_get_mode(rig,RIG_VFO_B,&qmode,&qwidth);
if (retval != RIG_OK) return retval;
if (qmode == priv->curr_modeA) return RIG_OK;
retval = flrig_set_mode(rig,RIG_VFO_B,priv->curr_modeA,width);
if (retval != RIG_OK) {
rig_debug(RIG_DEBUG_ERR, "%s flrig_set_mode failed\n", __FUNCTION__);

2
dummy/flrig.h
View File

@ -28,7 +28,7 @@
#include <sys/time.h>
#endif
#define BACKEND_VER "1.0"
#define BACKEND_VER "1.5"
#define EOM "\r"
#define TRUE 1

6
dummy/netrigctl.c
View File

@ -68,11 +68,11 @@ static int netrigctl_transaction(RIG *rig, char *cmd, int len, char *buf)
ret = read_string(&rig->state.rigport, buf, BUF_MAX, "\n", 1);
if (ret < 0)
return ret;
if (memcmp(buf, NETRIGCTL_RET, strlen(NETRIGCTL_RET))==0)
if (strncmp(buf, NETRIGCTL_RET, strlen(NETRIGCTL_RET))==0) {
return atoi(buf+strlen(NETRIGCTL_RET));
}
return RIG_OK;
return ret;
}

12
elad/Android.mk Normal file
View File

@ -0,0 +1,12 @@
LOCAL_PATH:= $(call my-dir)
include $(CLEAR_VARS)
LOCAL_SRC_FILES := elad.c fdm_duo.c
LOCAL_MODULE := elad
LOCAL_CFLAGS := -DHAVE_CONFIG_H
LOCAL_C_INCLUDES := android include src
LOCAL_LDLIBS := -lhamlib -Lobj/local/armeabi
include $(BUILD_STATIC_LIBRARY)

6
elad/Makefile.am Normal file
View File

@ -0,0 +1,6 @@
ELADSRC = elad.c elad.h fdm_duo.c
noinst_LTLIBRARIES = libhamlib-elad.la
libhamlib_elad_la_SOURCES = $(ELADSRC)
EXTRA_DIST = Android.mk

3357
elad/elad.c Normal file
View File

File diff suppressed because it is too large Load Diff

174
elad/elad.h Normal file
View File

@ -0,0 +1,174 @@
/*
* Hamlib ELAD backend - main header
* Copyright (c) 2000-2011 by Stephane Fillod
* Copyright (C) 2009,2010 Alessandro Zummo <a.zummo@towertech.it>
* Copyright (C) 2009,2010,2011,2012,2013 by Nate Bargmann, n0nb@n0nb.us
* Copyright (C) 2018 by Giovanni Franza, info@hb9eik.ch
*
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifndef _ELAD_H
#define _ELAD_H 1
#include <string.h>
#include "token.h"
#define BACKEND_VER "1.0"
#define EOM_KEN ';'
#define EOM_TH '\r'
#define ELAD_MODE_TABLE_MAX 24
#define ELAD_MAX_BUF_LEN 128 /* max answer len, arbitrary */
/* Tokens for Parameters common to multiple rigs.
* Use token # >= 1 or <= 100. Defined here so they will be
* available in Kenwood name space.
*/
#define TOK_VOICE TOKEN_BACKEND(1)
#define TOK_FINE TOKEN_BACKEND(2)
#define TOK_XIT TOKEN_BACKEND(3)
#define TOK_RIT TOKEN_BACKEND(4)
/* Token structure assigned to .cfgparams in rig_caps */
extern const struct confparams elad_cfg_params[];
/*
* modes in use by the "MD" command
*/
#define MD_NONE '0'
#define MD_LSB '1'
#define MD_USB '2'
#define MD_CW '3'
#define MD_FM '4'
#define MD_AM '5'
#define MD_FSK '6'
#define MD_CWR '7'
#define MD_FSKR '9'
struct elad_priv_caps {
char cmdtrm; /* Command termination chars (ken=';' or th='\r') */
int if_len; /* length of IF; answer excluding ';' terminator */
rmode_t *mode_table;
};
struct elad_priv_data {
char info[ELAD_MAX_BUF_LEN];
split_t split; /* current split state */
int k2_ext_lvl; /* Initial K2 extension level */
int k3_ext_lvl; /* Initial K3 extension level */
int k2_md_rtty; /* K2 RTTY mode available flag, 1 = RTTY, 0 = N/A */
char *fw_rev; /* firmware revision level */
int trn_state; /* AI state discovered at startup */
unsigned fw_rev_uint; /* firmware revison as a number 1.07 -> 107 */
char verify_cmd[4]; /* command used to verify set commands */
int is_emulation; /* flag for TS-2000 emulations */
void * data; /* model specific data */
rmode_t curr_mode; /* used for is_emulation to avoid get_mode on VFOB */
};
#define elad_caps(rig) ((struct elad_priv_caps *)(rig)->caps->priv)
extern rmode_t elad_mode_table[ELAD_MODE_TABLE_MAX];
extern const tone_t elad38_ctcss_list[];
extern const tone_t elad42_ctcss_list[];
int elad_transaction(RIG *rig, const char *cmd, char *data, size_t data_len);
int elad_safe_transaction(RIG *rig, const char *cmd, char *buf,
size_t buf_size, size_t expected);
rmode_t elad2rmode(unsigned char mode, const rmode_t mode_table[]);
char rmode2elad(rmode_t mode, const rmode_t mode_table[]);
int elad_init(RIG *rig);
int elad_cleanup(RIG *rig);
int elad_open(RIG *rig);
int elad_close(RIG *rig);
int elad_set_vfo(RIG *rig, vfo_t vfo);
int elad_set_vfo_main_sub(RIG *rig, vfo_t vfo);
int elad_get_vfo_if(RIG *rig, vfo_t *vfo);
int elad_get_vfo_main_sub(RIG *rig, vfo_t *vfo);
int elad_set_split(RIG *rig, vfo_t vfo , split_t split, vfo_t txvfo);
int elad_set_split_vfo(RIG *rig, vfo_t vfo , split_t split, vfo_t txvfo);
int elad_get_split_vfo_if(RIG *rig, vfo_t rxvfo, split_t *split, vfo_t *txvfo);
int elad_set_freq(RIG *rig, vfo_t vfo, freq_t freq);
int elad_get_freq(RIG *rig, vfo_t vfo, freq_t *freq);
int elad_get_freq_if(RIG *rig, vfo_t vfo, freq_t *freq);
int elad_set_rit(RIG * rig, vfo_t vfo, shortfreq_t rit);
int elad_get_rit(RIG *rig, vfo_t vfo, shortfreq_t * rit);
int elad_set_xit(RIG * rig, vfo_t vfo, shortfreq_t rit);
int elad_get_xit(RIG *rig, vfo_t vfo, shortfreq_t * rit);
int elad_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width);
int elad_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width);
int elad_get_mode_if(RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width);
int elad_set_level(RIG *rig, vfo_t vfo, setting_t level, value_t val);
int elad_get_level(RIG *rig, vfo_t vfo, setting_t level, value_t *val);
int elad_set_func(RIG *rig, vfo_t vfo, setting_t func, int status);
int elad_get_func(RIG *rig, vfo_t vfo, setting_t func, int *status);
int elad_set_ext_parm(RIG *rig, token_t token, value_t val);
int elad_get_ext_parm(RIG *rig, token_t token, value_t *val);
int elad_set_ctcss_tone(RIG *rig, vfo_t vfo, tone_t tone);
int elad_set_ctcss_tone_tn(RIG *rig, vfo_t vfo, tone_t tone);
int elad_get_ctcss_tone(RIG *rig, vfo_t vfo, tone_t *tone);
int elad_set_ctcss_sql(RIG *rig, vfo_t vfo, tone_t tone);
int elad_get_ctcss_sql(RIG *rig, vfo_t vfo, tone_t *tone);
int elad_set_powerstat(RIG *rig, powerstat_t status);
int elad_get_powerstat(RIG *rig, powerstat_t *status);
int elad_reset(RIG *rig, reset_t reset);
int elad_send_morse(RIG *rig, vfo_t vfo, const char *msg);
int elad_set_ant (RIG * rig, vfo_t vfo, ant_t ant);
int elad_set_ant_no_ack(RIG * rig, vfo_t vfo, ant_t ant);
int elad_get_ant (RIG * rig, vfo_t vfo, ant_t * ant);
int elad_get_ptt(RIG *rig, vfo_t vfo, ptt_t *ptt);
int elad_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt);
int elad_set_ptt_safe(RIG *rig, vfo_t vfo, ptt_t ptt);
int elad_get_dcd(RIG *rig, vfo_t vfo, dcd_t *dcd);
int elad_vfo_op(RIG *rig, vfo_t vfo, vfo_op_t op);
int elad_set_mem(RIG *rig, vfo_t vfo, int ch);
int elad_get_mem(RIG *rig, vfo_t vfo, int *ch);
int elad_get_mem_if(RIG *rig, vfo_t vfo, int *ch);
int elad_get_channel(RIG *rig, channel_t *chan);
int elad_set_channel(RIG *rig, const channel_t *chan);
int elad_scan(RIG *rig, vfo_t vfo, scan_t scan, int ch);
const char * elad_get_info(RIG *rig);
int elad_get_id(RIG *rig, char *buf);
int elad_set_trn(RIG *rig, int trn);
int elad_get_trn(RIG *rig, int *trn);
/* only use if returned string has length 6, e.g. 'SQ011;' */
int get_elad_level(RIG *rig, const char *cmd, float *f);
int get_elad_func(RIG *rig, const char *cmd, int *status);
extern const struct rig_caps fdm_duo_caps;
/* use when not interested in the answer, but want to check its len */
static int inline elad_simple_transaction(RIG *rig, const char *cmd, size_t expected)
{
struct elad_priv_data *priv = rig->state.priv;
return elad_safe_transaction(rig, cmd, priv->info, ELAD_MAX_BUF_LEN, expected);
}
#endif /* _ELAD_H */

421
elad/fdm_duo.c Normal file
View File

@ -0,0 +1,421 @@
/*
* Hamlib ELAD backend - FDM_DUO description
* Copyright (c) 2000-2004 by Stephane Fillod and Juergen Rinas
* Copyright (c) 2018 by Giovanni Franza HB9EIK
*
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <stdlib.h>
#include <stdio.h>
#include <hamlib/rig.h>
#include "idx_builtin.h"
#include "elad.h"
#define FDM_DUO_ALL_MODES (RIG_MODE_AM|RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_SSB|RIG_MODE_FM|RIG_MODE_RTTY|RIG_MODE_RTTYR)
#define FDM_DUO_OTHER_TX_MODES (RIG_MODE_CW|RIG_MODE_SSB|RIG_MODE_FM|RIG_MODE_RTTY)
#define FDM_DUO_AM_TX_MODES RIG_MODE_AM
#define FDM_DUO_VFO (RIG_VFO_A|RIG_VFO_B)
#define FDM_DUO_LEVEL_ALL (RIG_LEVEL_RFPOWER|RIG_LEVEL_AF|RIG_LEVEL_RF|RIG_LEVEL_SQL|RIG_LEVEL_AGC)
#define FDM_DUO_FUNC_ALL (RIG_FUNC_NB|RIG_FUNC_COMP|RIG_FUNC_VOX|RIG_FUNC_NR|RIG_FUNC_NR|RIG_FUNC_BC)
/*
* elad_fdm_duo_get_info
* Assumes rig!=NULL
*/
static const char *
elad_fdm_duo_get_info (RIG * rig)
{
char firmbuf[50];
int retval;
retval = elad_transaction (rig, "TY", firmbuf, sizeof (firmbuf));
if (retval != RIG_OK)
return NULL;
size_t firm_len = strlen (firmbuf);
if (firm_len != 5)
{
rig_debug (RIG_DEBUG_ERR, "elad_get_info: wrong answer len=%d\n", firm_len);
return NULL;
}
switch (firmbuf[4])
{
case '0':
return "FDM-DUOHX (200W)";
case '1':
return "FDM-DUOSAT (100W + AT)";
case '2':
return "Japanese 50W type";
case '3':
return "Japanese 20W type";
default:
return "Firmware: unknown";
}
}
/*
* elad_fdm_duo_set_level
* Assumes rig!=NULL
*
* set levels of most functions
*
* WARNING: the commands differ slightly from the general versions in elad.c
* e.g.: "SQ"=>"SQ0" , "AG"=>"AG0"
*/
int
elad_fdm_duo_set_level (RIG * rig, vfo_t vfo, setting_t level, value_t val)
{
char levelbuf[16];
int elad_val;
switch (level)
{
case RIG_LEVEL_RFPOWER:
elad_val = val.f * 100; /* level for FDM_DUOSAT is from 0.. 100W in SSB */
sprintf (levelbuf, "PC%03d", elad_val);
break;
case RIG_LEVEL_AF:
elad_val = val.f * 255; /* possible values for FDM_DUO are 000.. 255 */
sprintf (levelbuf, "AG0%03d", elad_val);
break;
case RIG_LEVEL_RF:
elad_val = val.f * 100; /* possible values for FDM_DUO are 000.. 100 */
sprintf (levelbuf, "RG%03d", elad_val);
break;
case RIG_LEVEL_SQL:
elad_val = val.f * 255; /* possible values for FDM_DUO are 000.. 255 */
sprintf (levelbuf, "SQ0%03d", elad_val);
break;
case RIG_LEVEL_AGC: /* possible values for FDM_DUO 000(=off), 001(=fast), 002(=slow) */
/* hamlib argument is int, possible values rig.h:enum agc_level_e */
switch (val.i)
{
case RIG_AGC_OFF:
elad_val = 0;
break;
case RIG_AGC_FAST:
elad_val = 1;
break;
case RIG_AGC_SLOW:
elad_val = 2;
break;
default:
rig_debug (RIG_DEBUG_ERR, "Unsupported agc value");
return -RIG_EINVAL;
};
sprintf (levelbuf, "GT%03d", elad_val);
break;
default:
rig_debug (RIG_DEBUG_ERR, "Unsupported set_level %d", level);
return -RIG_EINVAL;
}
return elad_transaction(rig, levelbuf, NULL, 0);
}
/*
* elad_get_level
* Assumes rig!=NULL, val!=NULL
*/
int
elad_fdm_duo_get_level (RIG * rig, vfo_t vfo, setting_t level, value_t * val)
{
char ackbuf[50];
size_t ack_len;
int levelint;
int retval;
switch (level)
{
case RIG_LEVEL_RFPOWER:
retval = elad_transaction (rig, "PC", ackbuf, sizeof (ackbuf));
if (RIG_OK != retval)
return retval;
ack_len = strlen (ackbuf);
if (5 != ack_len)
return -RIG_EPROTO;
if (1 != sscanf (&ackbuf[2], "%d", &levelint))
return -RIG_EPROTO;
val->f = (float) levelint / 100.;
return RIG_OK;
case RIG_LEVEL_AF:
retval = elad_transaction (rig, "AG0", ackbuf, sizeof (ackbuf));
if (RIG_OK != retval)
return retval;
ack_len = strlen (ackbuf);
if (6 != ack_len)
return -RIG_EPROTO;
if (1 != sscanf (&ackbuf[3], "%d", &levelint))
return -RIG_EPROTO;
val->f = (float) levelint / 255.;
return RIG_OK;
case RIG_LEVEL_RF:
retval = elad_transaction (rig, "RG", ackbuf, sizeof (ackbuf));
if (RIG_OK != retval)
return retval;
ack_len = strlen (ackbuf);
if (5 != ack_len)
return -RIG_EPROTO;
if (1 != sscanf (&ackbuf[2], "%d", &levelint))
return -RIG_EPROTO;
val->f = (float) levelint / 100.;
return RIG_OK;
case RIG_LEVEL_SQL:
retval = elad_transaction (rig, "SQ0", ackbuf, sizeof (ackbuf));
if (RIG_OK != retval)
return retval;
ack_len = strlen (ackbuf);
if (6 != ack_len)
return -RIG_EPROTO;
if (1 != sscanf (&ackbuf[3], "%d", &levelint))
return -RIG_EPROTO;
val->f = (float) levelint / 255.;
return RIG_OK;
case RIG_LEVEL_AGC:
retval = elad_transaction (rig, "GT", ackbuf, sizeof (ackbuf));
if (RIG_OK != retval)
return retval;
ack_len = strlen (ackbuf);
if (5 != ack_len)
return -RIG_EPROTO;
switch (ackbuf[4])
{
case '0':
val->i = RIG_AGC_OFF;
break;
case '1':
val->i = RIG_AGC_FAST;
break;
case '2':
val->i = RIG_AGC_SLOW;
break;
default:
return -RIG_EPROTO;
}
return RIG_OK;
case RIG_LEVEL_MICGAIN:
case RIG_LEVEL_PREAMP:
case RIG_LEVEL_IF:
case RIG_LEVEL_APF:
case RIG_LEVEL_NR:
case RIG_LEVEL_PBT_IN:
case RIG_LEVEL_PBT_OUT:
case RIG_LEVEL_CWPITCH:
case RIG_LEVEL_KEYSPD:
case RIG_LEVEL_NOTCHF:
case RIG_LEVEL_COMP:
case RIG_LEVEL_BKINDL:
case RIG_LEVEL_BALANCE:
return -RIG_ENIMPL;
default:
rig_debug (RIG_DEBUG_ERR, "Unsupported get_level %d", level);
return -RIG_EINVAL;
}
return RIG_OK; /* never reached */
}
static struct elad_priv_caps fdm_duo_priv_caps = {
.cmdtrm = EOM_KEN,
};
/*
* fdm_duo rig capabilities.
* Notice that some rigs share the same functions.
* Also this struct is READONLY!
*/
const struct rig_caps fdm_duo_caps = {
.rig_model = RIG_MODEL_ELAD_FDM_DUO,
.model_name = "FDM-DUO",
.mfg_name = "ELAD",
.version = BACKEND_VER ".5",
.copyright = "LGPL",
.status = RIG_STATUS_UNTESTED,
.rig_type = RIG_TYPE_TRANSCEIVER,
.ptt_type = RIG_PTT_RIG_MICDATA,
.dcd_type = RIG_DCD_RIG,
.port_type = RIG_PORT_SERIAL,
.serial_rate_min = 4800,
.serial_rate_max = 115200,
.serial_data_bits = 8,
.serial_stop_bits = 1,
.serial_parity = RIG_PARITY_NONE,
.serial_handshake = RIG_HANDSHAKE_NONE,
.write_delay = 0,
.post_write_delay = 0,
.timeout = 200,
.retry = 10,
.preamp = {12, RIG_DBLST_END,},
.attenuator = {12, RIG_DBLST_END,},
.max_rit = kHz (9.99),
.max_xit = kHz (9.99),
.max_ifshift = Hz (0),
.targetable_vfo = RIG_TARGETABLE_FREQ,
.transceive = RIG_TRN_RIG,
.rx_range_list1 = {
{kHz(100), Hz(59999999), FDM_DUO_ALL_MODES, -1, -1, FDM_DUO_VFO},
RIG_FRNG_END,
}, /*!< Receive frequency range list for ITU region 1 */
.tx_range_list1 = {
{kHz(1810), kHz(1850), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO}, /* 100W class */
{kHz(1810), kHz(1850), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO}, /* 25W class */
{kHz(3500), kHz(3800), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{kHz(3500), kHz(3800), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{MHz(7), kHz(7200), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{MHz(7), kHz(7200), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{kHz(10100), kHz(10150), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{kHz(10100), kHz(10150), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{MHz(14), kHz(14350), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{MHz(14), kHz(14350), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{kHz(18068), kHz(18168), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{kHz(18068), kHz(18168), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{MHz(21), kHz(21450), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{MHz(21), kHz(21450), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{kHz(24890), kHz(24990), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{kHz(24890), kHz(24990), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{MHz(28), kHz(29700), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{MHz(28), kHz(29700), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{MHz(50), kHz(52000), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{MHz(50), kHz(52000), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
RIG_FRNG_END,
}, /*!< Transmit frequency range list for ITU region 1 */
.rx_range_list2 = {
{kHz(100), Hz(59999999), FDM_DUO_ALL_MODES, -1, -1, FDM_DUO_VFO},
RIG_FRNG_END,
}, /*!< Receive frequency range list for ITU region 2 */
.tx_range_list2 = {
{kHz(1800), MHz(2) - 1, FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO}, /* 100W class */
{kHz(1800), MHz(2) - 1, FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO}, /* 25W class */
{kHz(3500), MHz(4) - 1, FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{kHz(3500), MHz(4) - 1, FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{kHz(5250), kHz(5450), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{kHz(5250), kHz(5450), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{MHz(7), kHz(7300), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{MHz(7), kHz(7300), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{kHz(10100), kHz(10150), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{kHz(10100), kHz(10150), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{MHz(14), kHz(14350), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{MHz(14), kHz(14350), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{kHz(18068), kHz(18168), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{kHz(18068), kHz(18168), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{MHz(21), kHz(21450), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{MHz(21), kHz(21450), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{kHz(24890), kHz(24990), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{kHz(24890), kHz(24990), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{MHz(28), kHz(29700), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{MHz(28), kHz(29700), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
{MHz(50), kHz(52000), FDM_DUO_OTHER_TX_MODES, 5000, 100000, FDM_DUO_VFO},
{MHz(50), kHz(52000), FDM_DUO_AM_TX_MODES, 5000, 25000, FDM_DUO_VFO},
RIG_FRNG_END,
}, /*!< Transmit frequency range list for ITU region 2 */
.tuning_steps = {
{FDM_DUO_ALL_MODES,kHz(1)},
{FDM_DUO_ALL_MODES,Hz(2500)},
{FDM_DUO_ALL_MODES,kHz(5)},
{FDM_DUO_ALL_MODES,Hz(6250)},
{FDM_DUO_ALL_MODES,kHz(10)},
{FDM_DUO_ALL_MODES,Hz(12500)},
{FDM_DUO_ALL_MODES,kHz(15)},
{FDM_DUO_ALL_MODES,kHz(20)},
{FDM_DUO_ALL_MODES,kHz(25)},
{FDM_DUO_ALL_MODES,kHz(30)},
{FDM_DUO_ALL_MODES,kHz(100)},
{FDM_DUO_ALL_MODES,kHz(500)},
{FDM_DUO_ALL_MODES,MHz(1)},
{FDM_DUO_ALL_MODES,0}, /* any tuning step */
RIG_TS_END,
},
/* mode/filter list, remember: order matters! */
.filters = {
{RIG_MODE_SSB, kHz(2.4)},
{RIG_MODE_CW, Hz(200)},
{RIG_MODE_RTTY, Hz(500)},
{RIG_MODE_AM, kHz(9)},
{RIG_MODE_FM, kHz(14)},
RIG_FLT_END,
},
.priv = (void *) &fdm_duo_priv_caps,
.rig_init = elad_init,
.rig_cleanup = elad_cleanup,
.set_freq = elad_set_freq,
.get_freq = elad_get_freq,
.set_rit = elad_set_rit, /* FIXME should this switch to rit mode or just set the frequency? */
.get_rit = elad_get_rit,
.set_xit = elad_set_xit, /* FIXME should this switch to xit mode or just set the frequency? */
.get_xit = elad_get_xit,
.set_mode = elad_set_mode,
.get_mode = elad_get_mode,
.set_vfo = elad_set_vfo,
.get_vfo = elad_get_vfo_if,
.set_split_vfo = elad_set_split_vfo,
.get_split_vfo = elad_get_split_vfo_if,
.get_ptt = elad_get_ptt,
.set_ptt = elad_set_ptt,
.get_dcd = elad_get_dcd,
.set_powerstat = elad_set_powerstat,
.get_powerstat = elad_get_powerstat,
.get_info = elad_fdm_duo_get_info,
.reset = elad_reset,
.set_ant = elad_set_ant,
.get_ant = elad_get_ant,
.scan = elad_scan, /* not working, invalid arguments using rigctl; elad_scan does only support on/off and not tone and CTCSS scan */
.has_set_level = FDM_DUO_LEVEL_ALL,
.has_get_level = FDM_DUO_LEVEL_ALL,
.set_level = elad_fdm_duo_set_level,
.get_level = elad_fdm_duo_get_level,
.has_get_func = FDM_DUO_FUNC_ALL,
.has_set_func = FDM_DUO_FUNC_ALL,
.set_func = elad_set_func,
.get_func = elad_get_func,
};
/*
* my notes:
* format with: indent --line-length 200 fdm_duo.c
*
* for the FDM_DUO the function NR and BC have tree state: NR0,1,2 and BC0,1,2
* this cannot be send through the on/off logic of set_function!
*/
/*
* Function definitions below
*/

4
icmarine/icm802.c
View File

@ -58,9 +58,9 @@ const struct rig_caps icm802_caps = {
.rig_model = RIG_MODEL_IC_M802,
.model_name = "IC-M802",
.mfg_name = "Icom",
.version = BACKEND_VER,
.version = BACKEND_VER".1",
.copyright = "LGPL",
.status = RIG_STATUS_UNTESTED,
.status = RIG_STATUS_STABLE,
.rig_type = RIG_TYPE_TRANSCEIVER,
.ptt_type = RIG_PTT_RIG,
.dcd_type = RIG_DCD_RIG,

83
icmarine/icmarine.c
View File

@ -220,14 +220,14 @@ int icmarine_transaction(RIG *rig, const char *cmd, const char *param, char *res
int cmd_len = 0;
unsigned csum = 0;
rig_debug(RIG_DEBUG_TRACE, "%s: cmd='%s', param=%s\n",__FUNCTION__,cmd,param);
rs = &rig->state;
priv = (struct icmarine_priv_data *)rs->priv;
serial_flush(&rs->rigport);
/* command formating */
cmdbuf[BUFSZ]='\0';
cmd_len = snprintf(cmdbuf, BUFSZ, "$PICOA,%02u,%02u,%s",
CONTROLLER_ID,
priv->remote_id,
@ -258,8 +258,6 @@ int icmarine_transaction(RIG *rig, const char *cmd, const char *param, char *res
if (retval < OFFSET_CMD+5)
return -RIG_EPROTO;
respbuf[retval] = 0;
/* check response */
if (memcmp(respbuf, "$PICOA,", strlen("$PICOA,")))
return -RIG_EPROTO;
@ -274,20 +272,22 @@ int icmarine_transaction(RIG *rig, const char *cmd, const char *param, char *res
return -RIG_ERJCTED;
}
/* So this is a query */
retval = read_string(&rs->rigport, respbuf, BUFSZ, LF, strlen(LF));
if (retval < 0)
return retval;
/* strip *checksum and CR/LF from string */
respbuf[retval-5] = 0;
p = strchr(respbuf+OFFSET_CMD, ',');
/* strip from *checksum and after */
char *strip = strrchr(respbuf,'*');
if (strip) {
*strip = 0;
}
else {
rig_debug(RIG_DEBUG_ERR, "%s: checksum not in response? response='%s'\n",__FUNCTION__,respbuf);
return -RIG_EPROTO;
}
p = strrchr(respbuf, ',');
if (p)
strncpy(response, p+1, BUFSZ);
else
return -RIG_EPROTO;
rig_debug(RIG_DEBUG_VERBOSE, "%s: returning response='%s'\n", __FUNCTION__,response);
return RIG_OK;
}
@ -297,6 +297,8 @@ int icmarine_set_freq(RIG *rig, vfo_t vfo, freq_t freq)
char freqbuf[BUFSZ];
struct icmarine_priv_data *priv;
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
priv = (struct icmarine_priv_data*)rig->state.priv;
sprintf(freqbuf, "%.6f", freq/MHz(1));
@ -318,6 +320,8 @@ int icmarine_get_freq(RIG *rig, vfo_t vfo, freq_t *freq)
char freqbuf[BUFSZ] = "";
double d;
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
retval = icmarine_transaction (rig, CMD_RXFREQ, NULL, freqbuf);
if (retval != RIG_OK)
return retval;
@ -325,8 +329,10 @@ int icmarine_get_freq(RIG *rig, vfo_t vfo, freq_t *freq)
if (freqbuf[0] == '\0') {
*freq = 0;
} else {
if (sscanf(freqbuf, "%lf", &d) != 1)
if (sscanf(freqbuf, "%lf", &d) != 1) {
rig_debug(RIG_DEBUG_ERR,"%s: sscanf('%s') failed\n",__FUNCTION__,freqbuf);
return -RIG_EPROTO;
}
*freq = (freq_t)(d*MHz(1));
}
@ -338,6 +344,8 @@ int icmarine_set_tx_freq(RIG *rig, vfo_t vfo, freq_t freq)
{
char freqbuf[BUFSZ];
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
sprintf(freqbuf, "%.6f", freq/MHz(1));
return icmarine_transaction (rig, CMD_TXFREQ, freqbuf, NULL);
@ -349,6 +357,8 @@ int icmarine_get_tx_freq(RIG *rig, vfo_t vfo, freq_t *freq)
char freqbuf[BUFSZ] = "";
double d;
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
retval = icmarine_transaction (rig, CMD_TXFREQ, NULL, freqbuf);
if (retval != RIG_OK)
return retval;
@ -369,8 +379,9 @@ int icmarine_set_split_vfo(RIG *rig, vfo_t rx_vfo, split_t split, vfo_t tx_vfo)
{
struct icmarine_priv_data *priv;
priv = (struct icmarine_priv_data *)rig->state.priv;
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
priv = (struct icmarine_priv_data *)rig->state.priv;
/* when disabling split mode */
if (RIG_SPLIT_ON == priv->split &&
@ -390,6 +401,8 @@ int icmarine_get_split_vfo(RIG *rig, vfo_t rx_vfo, split_t *split, vfo_t *tx_vfo
{
struct icmarine_priv_data *priv;
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
priv = (struct icmarine_priv_data *)rig->state.priv;
*split = priv->split;
@ -403,6 +416,8 @@ int icmarine_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)
{
const char *pmode;
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
switch (mode) {
case RIG_MODE_CW: pmode = MD_CW; break;
case RIG_MODE_USB: pmode = MD_USB; break;
@ -424,11 +439,12 @@ int icmarine_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width)
int retval;
char modebuf[BUFSZ];
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
retval = icmarine_transaction (rig, CMD_MODE, NULL, modebuf);
if (retval != RIG_OK)
return retval;
if (!memcmp(modebuf, MD_LSB, strlen(MD_LSB)))
*mode = RIG_MODE_LSB;
else if (!memcmp(modebuf, MD_USB, strlen(MD_USB)))
@ -453,8 +469,15 @@ int icmarine_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width)
*/
int icmarine_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt)
{
return icmarine_transaction (rig, CMD_PTT,
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
int retval = icmarine_transaction (rig, CMD_PTT,
ptt == RIG_PTT_ON ? "TX" : "RX", NULL);
if (retval != RIG_OK) {
rig_debug(RIG_DEBUG_ERR, "%s: transaction failed\n",__FUNCTION__);
return retval;
}
return RIG_OK;
}
int icmarine_get_ptt(RIG *rig, vfo_t vfo, ptt_t *ptt)
@ -462,17 +485,23 @@ int icmarine_get_ptt(RIG *rig, vfo_t vfo, ptt_t *ptt)
char pttbuf[BUFSZ];
int retval;
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
retval = icmarine_transaction (rig, CMD_PTT, NULL, pttbuf);
if (retval != RIG_OK)
if (retval != RIG_OK) {
rig_debug(RIG_DEBUG_ERR, "%s: transaction failed\n",__FUNCTION__);
return retval;
}
if (!strcmp(pttbuf, "TX"))
if (strncmp(pttbuf, "TX",2)==0)
*ptt = RIG_PTT_ON;
else if (!strcmp(pttbuf, "RX"))
else if (strncmp(pttbuf, "RX",2)==0)
*ptt = RIG_PTT_OFF;
else
else {
rig_debug(RIG_DEBUG_ERR, "%s: invalid pttbuf='%s'\n",__FUNCTION__,pttbuf);
retval = -RIG_EPROTO;
}
return retval;
}
@ -482,6 +511,8 @@ int icmarine_get_dcd(RIG *rig, vfo_t vfo, dcd_t *dcd)
char dcdbuf[BUFSZ];
int retval;
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
retval = icmarine_transaction (rig, CMD_SQLS, NULL, dcdbuf);
if (retval != RIG_OK)
@ -499,6 +530,8 @@ int icmarine_get_dcd(RIG *rig, vfo_t vfo, dcd_t *dcd)
int icmarine_vfo_op(RIG *rig, vfo_t vfo, vfo_op_t op)
{
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
if (RIG_OP_TUNE != op && RIG_OP_NONE != op)
return -RIG_EINVAL;
@ -510,6 +543,8 @@ int icmarine_set_func(RIG *rig, vfo_t vfo, setting_t func, int status)
{
int retval;
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
switch(func) {
case RIG_FUNC_NB:
retval = icmarine_transaction (rig, CMD_NB, status ? "ON":"OFF", NULL);
@ -527,6 +562,8 @@ int icmarine_get_func(RIG *rig, vfo_t vfo, setting_t func, int *status)
char funcbuf[BUFSZ];
int retval;
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
switch(func) {
case RIG_FUNC_NB:
retval = icmarine_transaction (rig, CMD_NB, NULL, funcbuf);
@ -547,6 +584,8 @@ int icmarine_set_level(RIG *rig, vfo_t vfo, setting_t level, value_t val)
char lvlbuf[BUFSZ];
int retval;
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
switch(level) {
case RIG_LEVEL_AF:
sprintf(lvlbuf, "%u", (unsigned)(val.f * 255));
@ -580,6 +619,8 @@ int icmarine_get_level(RIG *rig, vfo_t vfo, setting_t level, value_t *val)
char lvlbuf[BUFSZ];
int retval;
rig_debug(RIG_DEBUG_TRACE, "%s:\n",__FUNCTION__);
switch(level) {
case RIG_LEVEL_RAWSTR:
retval = icmarine_transaction (rig, CMD_SMETER, NULL, lvlbuf);

2
icmarine/icmarine.h
View File

@ -30,7 +30,7 @@
#include <sys/time.h>
#endif
#define BACKEND_VER "0.1"
#define BACKEND_VER "0.2"
struct icmarine_priv_caps {
unsigned char default_remote_id; /* the remote default equipment's ID */

24
icom/ic7300.c
View File

@ -46,7 +46,7 @@
#define IC7300_OTHER_TX_MODES (RIG_MODE_FM|RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_SSB|RIG_MODE_RTTY|RIG_MODE_RTTYR)
#define IC7300_AM_TX_MODES (RIG_MODE_AM|RIG_MODE_PKTAM)
#define IC7300_FUNCS (RIG_FUNC_FAGC|RIG_FUNC_NB|RIG_FUNC_COMP|RIG_FUNC_VOX|RIG_FUNC_TONE|RIG_FUNC_TSQL|RIG_FUNC_SBKIN|RIG_FUNC_FBKIN|RIG_FUNC_NR|RIG_FUNC_MON|RIG_FUNC_MN|RIG_FUNC_ANF|RIG_FUNC_LOCK|RIG_FUNC_RIT|RIG_FUNC_XIT|RIG_FUNC_SCOPE)
#define IC7300_FUNCS (RIG_FUNC_FAGC|RIG_FUNC_NB|RIG_FUNC_COMP|RIG_FUNC_VOX|RIG_FUNC_TONE|RIG_FUNC_TSQL|RIG_FUNC_SBKIN|RIG_FUNC_FBKIN|RIG_FUNC_NR|RIG_FUNC_MON|RIG_FUNC_MN|RIG_FUNC_ANF|RIG_FUNC_LOCK|RIG_FUNC_RIT|RIG_FUNC_XIT|RIG_FUNC_SCOPE|RIG_FUNC_TUNER)
#define IC7300_LEVELS (RIG_LEVEL_PREAMP|RIG_LEVEL_ATT|RIG_LEVEL_AGC|RIG_LEVEL_COMP|RIG_LEVEL_BKINDL|RIG_LEVEL_NR|RIG_LEVEL_PBT_IN|RIG_LEVEL_PBT_OUT|RIG_LEVEL_CWPITCH|RIG_LEVEL_RFPOWER|RIG_LEVEL_MICGAIN|RIG_LEVEL_KEYSPD|RIG_LEVEL_NOTCHF|RIG_LEVEL_SQL|RIG_LEVEL_RAWSTR|RIG_LEVEL_AF|RIG_LEVEL_RF|RIG_LEVEL_VOXGAIN|RIG_LEVEL_ANTIVOX|RIG_LEVEL_VOXDELAY|RIG_LEVEL_SWR|RIG_LEVEL_ALC)
@ -379,7 +379,17 @@ int ic7300_get_func(RIG *rig, vfo_t vfo, setting_t func, int *status)
}
*status = ackbuf[2];
break;
case RIG_FUNC_TUNER:
retval = icom_transaction (rig, 0x1C, 0x01, NULL, 0, ackbuf, &ack_len);
if (ack_len == 3)
{
*status = ackbuf[2]; // 0x01 = enabled, 0x00 = disabled, 0x02 = tuning in progress
} else {
return RIG_BUSERROR;
}
break;
default:
return icom_get_func(rig, vfo, func, status);
}
@ -405,6 +415,16 @@ int ic7300_set_func(RIG *rig, vfo_t vfo, setting_t func, int status)
case RIG_FUNC_XIT:
ts_buf[0] = status;
return icom_transaction (rig, 0x21, 0x02, ts_buf, 1, ackbuf, &ack_len);
case RIG_FUNC_TUNER:
if(status==0 || status==1 || status==2)
{ // 0=off, 1 = on, 2 = begin tuning
ts_buf[0] = status;
return icom_transaction (rig, 0x1C, 0x01, ts_buf, 1, ackbuf, &ack_len);
} else {
return -1; // perhaps some other reply would be more informative
}
default:
return icom_set_func(rig, vfo, func, status);
}

3
icom/optoscan.c
View File

@ -735,7 +735,7 @@ static int optoscan_wait_timer(RIG *rig, pltstate_t *state)
gettimeofday(&(state->timer_current), NULL);
usec_diff = abs((state->timer_current.tv_usec) -
usec_diff = (int)labs((state->timer_current.tv_usec) -
(state->timer_start.tv_usec));
if (usec_diff < settle_usec) {
@ -744,4 +744,3 @@ static int optoscan_wait_timer(RIG *rig, pltstate_t *state)
return RIG_OK;
}

8
include/hamlib/rig.h
View File

@ -455,7 +455,9 @@ typedef enum {
RIG_DCD_SERIAL_CTS, /*!< DCD status from serial CTS signal */
RIG_DCD_SERIAL_CAR, /*!< DCD status from serial CD signal */
RIG_DCD_PARALLEL, /*!< DCD status from parallel port pin */
RIG_DCD_CM108 /*!< DCD status from CM108 vol dn pin */
RIG_DCD_CM108, /*!< DCD status from CM108 vol dn pin */
RIG_DCD_GPIO, /*!< DCD status from GPIO pin */
RIG_DCD_GPION, /*!< DCD status from inverted GPIO pin */
} dcd_type_t;
@ -595,7 +597,7 @@ enum rig_conf_e {
};
#define RIG_COMBO_MAX 8
#define RIG_COMBO_MAX 16
/**
* \brief Configuration parameter structure.
@ -1634,6 +1636,8 @@ struct rig_state {
int transmit; /*!< rig should be transmitting i.e. hard
wired PTT asserted - used by rigs that
don't do CAT while in Tx */
freq_t lo_freq; /*!< Local oscillator frequency of any
transverter */
};

8
include/hamlib/riglist.h
View File

@ -105,6 +105,7 @@
#define RIG_MODEL_FT1200 RIG_MAKE_MODEL(RIG_YAESU, 34)
#define RIG_MODEL_FT991 RIG_MAKE_MODEL(RIG_YAESU, 35)
#define RIG_MODEL_FT891 RIG_MAKE_MODEL(RIG_YAESU, 36)
#define RIG_MODEL_FTDX3000 RIG_MAKE_MODEL(RIG_YAESU, 37)
/*
@ -590,6 +591,13 @@
#define RIG_BACKEND_BARRETT "barrett"
#define RIG_MODEL_BARRETT_2050 RIG_MAKE_MODEL(RIG_BARRETT, 1)
/*
* Elad
*/
#define RIG_ELAD 33
#define RIG_BACKEND_ELAD "elad"
#define RIG_MODEL_ELAD_FDM_DUO RIG_MAKE_MODEL(RIG_ELAD, 1)
/*
* TODO:

12
include/hamlib/rotlist.h
View File

@ -350,6 +350,18 @@
#define ROT_MODEL_PROSISTEL ROT_MAKE_MODEL(ROT_PROSISTEL, 1)
/**
* \def ROT_MODEL_MEADE
* \brief A macro that returns the model number of the MEADE backend.
*
* The MEADE backen can be used with Meade telescope rotators like
* DS-2000
*/
#define ROT_MEADE 18
#define ROT_BACKEND_MEADE "meade"
#define ROT_MODEL_MEADE ROT_MAKE_MODEL(ROT_MEADE, 1)
/**
* \typedef typedef int rot_model_t
* \brief Convenience type definition for rotator model.

53
kenwood/kenwood.c
View File

@ -219,6 +219,9 @@ int kenwood_transaction(RIG *rig, const char *cmdstr, char *data, size_t datasiz
rs = &rig->state;
rs->hold_decode = 1;
/* Emulators don't need any post_write_delay */
if (priv->is_emulation) rs->rigport.post_write_delay = 0;
cmdtrm[0] = caps->cmdtrm;
cmdtrm[1] = '\0';
@ -497,6 +500,7 @@ int kenwood_init(RIG *rig)
strcpy (priv->verify_cmd, RIG_MODEL_XG3 == rig->caps->rig_model ? ";" : "ID;");
priv->split = RIG_SPLIT_OFF;
priv->trn_state = -1;
priv->curr_mode = 0;
rig->state.priv = priv;
/* default mode_table */
@ -714,6 +718,14 @@ int kenwood_set_vfo(RIG *rig, vfo_t vfo)
return -RIG_EINVAL;
struct kenwood_priv_data *priv = rig->state.priv;
/* Emulations do not need to set VFO since VFOB is a copy of VFOA
* except for frequency. And we can change freq without changing VFOS
* This prevents a 1.8 second delay in PowerSDR when switching VFOs
* We'll do this once if curr_mode has not been set yet
*/
if (priv->is_emulation && priv->curr_mode > 0) return RIG_OK;
char cmdbuf[6];
int retval;
char vfo_function;
@ -1416,7 +1428,7 @@ int kenwood_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)
}
}
if (priv->is_emulation)
if (priv->is_emulation || rig->caps->rig_model == RIG_MODEL_HPSDR)
{
/* emulations like PowerSDR and SmartSDR normally hijack the
RTTY modes for SSB-DATA AFSK modes */
@ -1565,6 +1577,12 @@ int kenwood_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width)
int offs;
int retval;
/* for emulation do not read mode from VFOB as it is copy of VFOA */
/* we avoid the VFO swapping most of the time this way */
/* only need to get it if it has to be initialized */
if (priv->curr_mode > 0 && priv->is_emulation && vfo == RIG_VFO_B) {
return priv->curr_mode;
}
if (RIG_MODEL_TS990S == rig->caps->rig_model)
{
char c;
@ -1607,7 +1625,7 @@ int kenwood_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width)
kmode = modebuf[offs] - 'A' + 10;
}
*mode = kenwood2rmode(kmode, caps->mode_table);
if (priv->is_emulation)
if (priv->is_emulation || rig->caps->rig_model == RIG_MODEL_HPSDR)
{
/* emulations like PowerSDR and SmartSDR normally hijack the
RTTY modes for SSB-DATA AFSK modes */
@ -1709,7 +1727,8 @@ int kenwood_set_level(RIG *rig, vfo_t vfo, setting_t level, value_t val)
break;
case RIG_LEVEL_SQL:
snprintf(levelbuf, sizeof (levelbuf), "SQ%03d", kenwood_val);
/* Default to RX#0 */
snprintf(levelbuf, sizeof (levelbuf), "SQ0%03d", kenwood_val);
break;
case RIG_LEVEL_AGC:
@ -1818,26 +1837,43 @@ int kenwood_get_level(RIG *rig, vfo_t vfo, setting_t level, value_t *val)
return -RIG_EINVAL;
char lvlbuf[KENWOOD_MAX_BUF_LEN];
char *cmd;
int retval;
int lvl;
int i, ret, agclevel;
int i, ret, agclevel, len;
switch (level) {
case RIG_LEVEL_RAWSTR:
retval = kenwood_safe_transaction(rig, "SM", lvlbuf, 10, 6);
if (RIG_MODEL_TS590S == rig->caps->rig_model || RIG_MODEL_TS590SG == rig->caps->rig_model) {
cmd = "SM0";
len= 3;
}
else {
cmd = "SM";
len = 2;
}
retval = kenwood_safe_transaction(rig, cmd, lvlbuf, 10, len+4);
if (retval != RIG_OK)
return retval;
/* XXX atoi ? */
sscanf(lvlbuf+2, "%d", &val->i); /* rawstr */
sscanf(lvlbuf+len, "%d", &val->i); /* rawstr */
break;
case RIG_LEVEL_STRENGTH:
retval = kenwood_safe_transaction(rig, "SM", lvlbuf, 10, 6);
if (RIG_MODEL_TS590S == rig->caps->rig_model || RIG_MODEL_TS590SG == rig->caps->rig_model) {
cmd = "SM0";
len = 3;
}
else {
cmd = "SM";
len = 2;
}
retval = kenwood_safe_transaction(rig, cmd, lvlbuf, 10, len+4);
if (retval != RIG_OK)
return retval;
sscanf(lvlbuf+2, "%d", &val->i); /* rawstr */
sscanf(lvlbuf+len, "%d", &val->i); /* rawstr */
if (rig->caps->str_cal.size)
val->i = (int) rig_raw2val(val->i, &rig->caps->str_cal);
@ -3352,6 +3388,7 @@ DECLARE_PROBERIG_BACKEND(kenwood)
"with ID %03d, please report to Hamlib "
"developers.\n", k_id);
rig_debug(RIG_DEBUG_TRACE, "%s: post_write_delay=%d\n", __func__, port->post_write_delay);
return RIG_MODEL_NONE;
}

3
kenwood/kenwood.h
View File

@ -27,7 +27,7 @@
#include <string.h>
#include "token.h"
#define BACKEND_VER "0.9"
#define BACKEND_VER "1.0"
#define EOM_KEN ';'
#define EOM_TH '\r'
@ -80,6 +80,7 @@ struct kenwood_priv_data {
char verify_cmd[4]; /* command used to verify set commands */
int is_emulation; /* flag for TS-2000 emulations */
void * data; /* model specific data */
rmode_t curr_mode; /* used for is_emulation to avoid get_mode on VFOB */
};

3
kenwood/pihpsdr.c
View File

@ -656,7 +656,8 @@ int pihpsdr_set_level(RIG *rig, vfo_t vfo, setting_t level, value_t val)
switch (level) {
case RIG_LEVEL_RFPOWER:
/* XXX check level range */
/* level is float between 0.0 and 1.0, maps to 0 ... 100 */
kenwood_val = val.f * 100;
sprintf(levelbuf, "PC%03d", kenwood_val);
break;

8
kenwood/thd72.c
View File

@ -657,14 +657,14 @@ static int thd72_get_level(RIG *rig, vfo_t vfo, setting_t level, value_t *val)
}
break;
case RIG_LEVEL_VOXGAIN:
retval = thd72_get_menu_item(rig, 8, '9', &l);
retval = thd72_get_menu_item(rig, 8, 9, &l);
if (retval != RIG_OK)
return retval;
/* FIXME - if VOX is off, what do we return */
val->f = l / 9.0;
break;
case RIG_LEVEL_VOXDELAY:
retval = thd72_get_menu_item(rig, 9, '7', &l);
retval = thd72_get_menu_item(rig, 9, 7, &l);
if (retval != RIG_OK)
return retval;
/* FIXME - if VOX is off, what do we return */
@ -683,7 +683,7 @@ static int thd72_get_level(RIG *rig, vfo_t vfo, setting_t level, value_t *val)
val->f = thd72sqlevel[l];
break;
case RIG_LEVEL_BALANCE:
retval = thd72_get_menu_item(rig, 13, '4', &l);
retval = thd72_get_menu_item(rig, 13, 4, &l);
if (retval != RIG_OK)
return retval;
/* FIXME - is balance 0.0 .. 1.0 or -1.0 .. 1.0? */
@ -782,7 +782,7 @@ static int thd72_get_parm(RIG *rig, setting_t parm, value_t *val)
switch (parm) {
case RIG_PARM_APO:
retval = thd72_get_menu_item(rig, 3, '3', &l);
retval = thd72_get_menu_item(rig, 3, 3, &l);
if (retval != RIG_OK)
return retval;
val->i = thd72apo[l];

2
kenwood/ts2000.c
View File

@ -126,7 +126,7 @@ const struct rig_caps ts2000_caps = {
.mfg_name = "Kenwood",
.version = BACKEND_VER ".4",
.copyright = "LGPL",
.status = RIG_STATUS_BETA,
.status = RIG_STATUS_STABLE,
.rig_type = RIG_TYPE_TRANSCEIVER,
.ptt_type = RIG_PTT_RIG,
.dcd_type = RIG_DCD_RIG,

17
kenwood/ts590.c
View File

@ -41,7 +41,7 @@ const char* ts590_get_info(RIG *rig);
#define TS590_LEVEL_ALL (RIG_LEVEL_RFPOWER|RIG_LEVEL_AF|RIG_LEVEL_RF|\
RIG_LEVEL_CWPITCH|RIG_LEVEL_METER|RIG_LEVEL_SWR|RIG_LEVEL_ALC|\
RIG_LEVEL_SQL|RIG_LEVEL_AGC|RIG_LEVEL_STRENGTH|RIG_LEVEL_KEYSPD)
RIG_LEVEL_SQL|RIG_LEVEL_AGC|RIG_LEVEL_RAWSTR|RIG_LEVEL_STRENGTH|RIG_LEVEL_KEYSPD)
#define TS590_FUNC_ALL (RIG_FUNC_LOCK|RIG_FUNC_AIP|RIG_FUNC_TONE|\
RIG_FUNC_NB|RIG_FUNC_COMP|RIG_FUNC_VOX|RIG_FUNC_NR|RIG_FUNC_NR|RIG_FUNC_BC)
@ -60,6 +60,19 @@ const char* ts590_get_info(RIG *rig);
.flags=RIG_CHFLAG_SKIP \
}
#define TS590_STR_CAL {9, {\
{ 0, -60},\
{ 3, -48},\
{ 6, -36},\
{ 9, -24},\
{12, -12},\
{15, 0},\
{20, 20},\
{25, 40},\
{30, 60}}\
}
static struct kenwood_priv_caps ts590_priv_caps = {
.cmdtrm = EOM_KEN,
};
@ -187,6 +200,7 @@ const struct rig_caps ts590_caps = {
{RIG_MODE_FM, kHz(12)},
RIG_FLT_END,
},
.str_cal = TS590_STR_CAL,
.priv = (void *) &ts590_priv_caps,
.rig_init = kenwood_init,
.rig_cleanup = kenwood_cleanup,
@ -354,6 +368,7 @@ const struct rig_caps ts590sg_caps = {
{RIG_MODE_FM, kHz(12)},
RIG_FLT_END,
},
.str_cal = TS590_STR_CAL,
.priv = (void *) &ts590_priv_caps,
.rig_init = kenwood_init,
.rig_cleanup = kenwood_cleanup,

20
kit/funcube.c
View File

@ -174,12 +174,12 @@ const struct rig_caps funcubeplus_caps = {
.has_get_level = RIG_LEVEL_ATT | RIG_LEVEL_PREAMP | RIG_LEVEL_RF, // RIG_LEVEL_ATT: Mixer gain on/off
// RIG_LEVEL_PREAMP: LNA gain on/off
// RIG_LEVEL_RF 0..1 : IF gain 0 .. 59 dB
.has_set_level = RIG_LEVEL_ATT | RIG_LEVEL_PREAMP | RIG_LEVEL_RF, // RIG_LEVEL_ATT: Mixer gain on/off
// RIG_LEVEL_PREAMP: LNA gain on/off
// RIG_LEVEL_RF 0..1 : IF gain 0 .. 59 dB
// so values have to be mapped
// so values have to be mapped
.has_get_parm = RIG_PARM_NONE,
.has_set_parm = RIG_PARM_NONE,
.level_gran = {},
@ -700,8 +700,8 @@ int funcubepro_set_level(RIG *rig, vfo_t vfo, setting_t level, value_t val)
libusb_device_handle *udh = rig->state.rigport.handle;
int ret;
int actual_length;
unsigned char au8BufOut[64]; // endpoint size
unsigned char au8BufIn[64]; // endpoint size
unsigned char au8BufOut[64] = { 0 }; // endpoint size
unsigned char au8BufIn[64] = { 0 }; // endpoint size
switch (level) {
case RIG_LEVEL_PREAMP:
@ -719,7 +719,7 @@ int funcubepro_set_level(RIG *rig, vfo_t vfo, setting_t level, value_t val)
if( au8BufOut[1] > 59 )
au8BufOut[1]= 59;
break;
default:
rig_debug(RIG_DEBUG_ERR, "%s: Unsupported level %d\n", __func__, level);
@ -761,8 +761,8 @@ int funcubepro_get_level(RIG *rig, vfo_t vfo, setting_t level, value_t *val)
libusb_device_handle *udh = rig->state.rigport.handle;
int ret;
int actual_length;
unsigned char au8BufOut[64]; // endpoint size
unsigned char au8BufIn[64]; // endpoint size
unsigned char au8BufOut[64] = { 0 }; // endpoint size
unsigned char au8BufIn[64] = { 0 }; // endpoint size
switch (level) {
case RIG_LEVEL_ATT:
@ -773,7 +773,7 @@ int funcubepro_get_level(RIG *rig, vfo_t vfo, setting_t level, value_t *val)
break;
case RIG_LEVEL_RF:
au8BufOut[0] = REQUEST_GET_IF_GAIN;
break;
break;
default:
rig_debug(RIG_DEBUG_ERR, "%s: Unsupported level %d\n", __func__, level);
return -RIG_EINVAL;
@ -809,7 +809,7 @@ int funcubepro_get_level(RIG *rig, vfo_t vfo, setting_t level, value_t *val)
switch (level) {
case RIG_LEVEL_PREAMP:
case RIG_LEVEL_ATT:
val->i = au8BufIn[2] &0x01;
val->i = au8BufIn[2] &0x01;
break;
case RIG_LEVEL_RF:

12
meade/Android.mk Normal file
View File

@ -0,0 +1,12 @@
LOCAL_PATH:= $(call my-dir)
include $(CLEAR_VARS)
LOCAL_SRC_FILES := meade.c
LOCAL_MODULE := meade
LOCAL_CFLAGS := -DHAVE_CONFIG_H
LOCAL_C_INCLUDES := android include src
LOCAL_LDLIBS := -lhamlib -Lobj/local/armeabi
include $(BUILD_STATIC_LIBRARY)

6
meade/Makefile.am Normal file
View File

@ -0,0 +1,6 @@
MEADESRC = meade.c meade.h
noinst_LTLIBRARIES = libhamlib-meade.la
libhamlib_meade_la_SOURCES = $(MEADESRC)
EXTRA_DIST = README.md Android.mk

45
meade/README.md Normal file
View File

@ -0,0 +1,45 @@
# Meade Telescope Rotator Module
This module interfaces Meade telescope rotator via the LX200 serial protocol.
These rotators can easily be modified to carry antennas instead of telescopes.
## Usage
1. Set the telescope manually to show to north with 0 degree elevation
1. Connect the Autosar and the serial cable with the telescope and control PC
1. Turn on telescope rotator
1. Press `Speed` on the Autosar to accept "Don't look into the sun" warning
1. Press `Mode` a couple of times until the Autosar display shows `Object`
1. Start `rigctl` or `rigctld` with the arguments `-m 1801 -s <Serial Interface>`
Have Fun.
### Hints
1. The rotator has no lock on 360 degree azimuth. For example, if you go form 359 degree to 002 degree, it will go the short way. That means it is possible to make several rotations in the same directions. Please have a kind look on your cables and don't use the rotator unattended!
2. If a new position gets sent to the rotor while it is in movement, it moves immediately to the new position, but stores the old one and moves again to the old one after the new position is reached. To avoid this, a `Stop all movement` command gets executed if a position update reaches the rotator while in movement. That can cause a choppy movement when going to a new position which is far away.
## LX200 Protocol
[2003 Protocol Verison](https://www.meade.com/support/LX200CommandSet.pdf)
[2010 Protocol Verison](https://www.meade.com/support/TelescopeProtocol_2010-10.pdf)
## Current Status
The current status is ALPHA. It is tested with Meade DS-2000 with Autosar 494 (2003 Firmware) and Meade 506 i2c to RS232 interface cable, tested under Linux with rotctl and gpredict.
### What works good:
* `set_position` works for azimuth and elevation (0-360,0-90 degree), high frequent update (<2s) can cause sometimes unexpected behavior.
* `get_position` works mostly fine, sometime the elevation gets not read properly
* `init`, `cleanup`, `get_info` work as expected
* `open` sends all setup commands needed for now
* `close` stops all movement of the rotor
* `meade_stop` stops fine
* `park`, `reset` move the rotor to home position (north, elevation 0)
### What works with some problems:
* `move` works fine for elevation, but for azimuth it will sometimes move in the wrong direction caused by the short way movement.

407
meade/meade.c Normal file
View File

@ -0,0 +1,407 @@
/*
* Hamlib Meade telescope rotor backend - main file
* Copyright (c) 2018 by Andreas Mueller (DC1MIL)
*
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <stdlib.h>
#include <string.h> /* String function definitions */
#include <unistd.h> /* UNIX standard function definitions */
#include <math.h>
#include <sys/time.h>
#include <time.h>
#include <hamlib/rotator.h>
#include <num_stdio.h>
#include "serial.h"
#include "misc.h"
#include "register.h"
#include "meade.h"
struct meade_priv_data {
azimuth_t az;
elevation_t el;
struct timeval tv; /* time last az/el update */
azimuth_t target_az;
elevation_t target_el;
};
/**
* Command list:
* See https://www.meade.com/support/LX200CommandSet.pdf
* and https://www.meade.com/support/TelescopeProtocol_2010-10.pdf for newer
* Firmware Versions
*
* Not the full set of available commands is used, the list here shows
* only the commands of the telescope used by hamlib
*
* All used Commands are supportet by Meade Telescopes with LX-200 protocol
* (e.g. DS-2000 with Autostar) and should also work with the LX16 and
* LX200GPS.
* Tested only with DS-2000 and AutoStar 494 together with Meade 506 i2c to
* Serial cable. But should also work with other AutoStars and the regular
* Serial Cable.
*
* | Command | Atribute | Return value | Description |
* --------------------------------------------------------------------
* | :Me# | - | - | Moves telescope east |
* | :Mn# | - | - | Moves telescope north |
* | :Ms# | - | - | Moves telescope south |
* | :Mw# | - | - | Moves telescope west |
* | :AL# | - | - | Set to Land mode |
* | :Sz DDD*MM# | D,M | 1' == OK | Set Target azimuth |
* | :SasDD*MM# | s,D,M | 1' == OK | Set Target elevation |
* | :Mw# | - | - | Moves telescope west |
* | :Q# | - | - | Halt all slewing |
* | :SoDD# | D | '1' == OK | Set minimal elevation |
* | :ShDD# | D | '1' == OK | Set maximal elevation |
* | :MA# | - | '0' == OK | GoTo Target |
* | :D# | - | 0x7F == YES | Check if active movement |
*
*/
/**
* meade_transaction
*
* cmdstr - Command to be sent to the rig.
* data - Buffer for reply string. Can be NULL, indicating that no reply is
* is needed, but answer will still be read.
* data_len - in: Size of buffer. It is the caller's responsibily to provide
* a large enough buffer for all possible replies for a command.
*
* returns:
* RIG_OK - if no error occurred.
* RIG_EIO - if an I/O error occurred while sending/receiving data.
* RIG_ETIMEOUT - if timeout expires without any characters received.
*/
static int meade_transaction (ROT *rot, const char *cmdstr,
char *data, size_t *data_len, size_t expected_return_length)
{
struct rot_state *rs;
int return_value;
int retry_read = 0;
rs = &rot->state;
while(1) {
serial_flush(&rs->rotport);
if (cmdstr) {
return_value = write_block(&rs->rotport, cmdstr, strlen(cmdstr));
if (return_value != RIG_OK) {
return return_value;
}
}
/* Not all commands will send a return value, so use data = NULL if no
return value is expected, Strings end with '#' */
if (data != NULL) {
memset(data,0,BUFSIZE);
*data_len = read_string(&rs->rotport, data, expected_return_length + 1, "\n", strlen("\n"));
if (*data_len < 0) {
if (retry_read++ >= rot->state.rotport.retry) {
return RIG_ETIMEOUT;
}
}
else {
return RIG_OK;
}
}
else {
return RIG_OK;
}
}
}
/*
* Initialization
*/
static int meade_init(ROT *rot)
{
struct meade_priv_data *priv;
priv = (struct meade_priv_data*)
malloc(sizeof(struct meade_priv_data));
if (!priv)
return -RIG_ENOMEM;
rot->state.priv = (void*)priv;
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
rot->state.rotport.type.rig = RIG_PORT_SERIAL;
priv->az = priv->el = 0;
priv->target_az = priv->target_el = 0;
return RIG_OK;
}
/*
* Cleanup
*/
static int meade_cleanup(ROT *rot)
{
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
if (rot->state.priv)
free(rot->state.priv);
rot->state.priv = NULL;
return RIG_OK;
}
/*
* Opens the Port and sets all needed parametes for operation
*/
static int meade_open(ROT *rot)
{
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
/* Set Telescope to Land alignment mode to deactivate sloping */
/* Allow 0-90 Degree Elevation */
return meade_transaction(rot, ":AL#:So00#:Sh90#" , NULL, 0, 0);
}
/*
* Closes the port and stops all movement
*/
static int meade_close(ROT *rot)
{
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
/* Stop all Movement */
return meade_transaction(rot, ":Q#" , NULL, 0, 0);
}
/*
* Sets the target position and starts movement
*
* az: Target azimuth
* el: Target elevation
*/
static int meade_set_position(ROT *rot, azimuth_t az, elevation_t el)
{
struct meade_priv_data *priv = (struct meade_priv_data *)rot->state.priv;
char cmd_str[BUFSIZE];
char return_str[BUFSIZE];
size_t return_str_size;
float az_degrees, az_minutes, el_degrees, el_minutes;
rig_debug(RIG_DEBUG_VERBOSE,"%s called: %.2f %.2f\n", __func__,
az, el);
az_degrees = floor(az);
az_minutes = (az - az_degrees) * 60;
el_degrees = floor(el);
el_minutes = (el - el_degrees) * 60;
/* Check if there is an active movement, if yes, stop it if
new target is more than 5 Degrees away from old target
if not, don't accept new target*/
meade_transaction(rot, ":D#", return_str, &return_str_size, 1);
if(return_str_size > 0 && return_str[0] == 0x7F) {
if(fabsf(az - priv->target_az) > 5 || fabsf(el - priv->target_el) > 5)
meade_transaction(rot, ":Q#", NULL, 0, 0);
else
return RIG_OK;
}
priv->target_az = az;
priv->target_el = el;
num_sprintf(cmd_str, ":Sz %03.0f*%02.0f#:Sa+%02.0f*%02.0f#:MA#",
az_degrees, az_minutes, el_degrees, el_minutes);
meade_transaction(rot, cmd_str, return_str, &return_str_size, 3);
/* '1' == Azimuth accepted '1' == Elevation accepted '0' == No error */
if(return_str_size > 0 && strstr(return_str , "110") != NULL)
return RIG_OK;
else
return RIG_EINVAL;
}
/*
* Get position of rotor, simulating slow rotation
*/
static int meade_get_position(ROT *rot, azimuth_t *az, elevation_t *el)
{
char return_str[BUFSIZE];
size_t return_str_size;
int az_degree, az_minutes, el_degree, el_minutes;
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
meade_transaction(rot, ":GZ#:GA#", return_str, &return_str_size, 14);
if(return_str_size > 13 && return_str[return_str_size-1] == '#') { /* '#' == EOS */
az_degree = strtol(return_str, NULL, 10);
az_minutes = strtol(return_str + 4, NULL, 10);
el_degree = strtol(return_str + 8, NULL, 10);
el_minutes = strtol(return_str + 11, NULL, 10);
*az = dmmm2dec(az_degree, az_minutes, 0);
*el = dmmm2dec(el_degree, el_minutes, 0);
return RIG_OK;
}
else {
return RIG_EINVAL;
}
}
/*
* Stops all movement
*/
static int meade_stop(ROT *rot)
{
struct meade_priv_data *priv = (struct meade_priv_data *)rot->state.priv;
azimuth_t az;
elevation_t el;
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
meade_transaction(rot, ":Q#", NULL, 0, 0);
meade_get_position(rot, &az, &el);
priv->target_az = priv->az = az;
priv->target_el = priv->el = el;
return RIG_OK;
}
/*
* Moves to Home Position
*/
static int meade_park(ROT *rot)
{
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
/* Assume home is 0,0 */
meade_set_position(rot, 0, 0);
return RIG_OK;
}
/*
* Reset: Nothing to do exept parking
*/
static int meade_reset(ROT *rot, rot_reset_t reset)
{
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
meade_park(rot);
return RIG_OK;
}
/*
* Movement to direction
*/
static int meade_move(ROT *rot, int direction, int speed)
{
struct meade_priv_data *priv = (struct meade_priv_data *)rot->state.priv;
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
rig_debug(RIG_DEBUG_TRACE, "%s: Direction = %d, Speed = %d\n", __func__, direction, speed);
switch(direction) {
case ROT_MOVE_UP:
return meade_set_position(rot, priv->target_az, 90);
case ROT_MOVE_DOWN:
return meade_set_position(rot, priv->target_az, 0);
case ROT_MOVE_CCW:
return meade_set_position(rot, -180, priv->target_el);
case ROT_MOVE_CW:
return meade_set_position(rot, 180, priv->target_el);
default:
return -RIG_EINVAL;
}
return RIG_OK;
}
static const char *meade_get_info(ROT *rot)
{
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
return "Meade telescope rotator with LX200 protocol.";
}
/*
* Meade telescope rotator capabilities.
*/
const struct rot_caps meade_caps = {
.rot_model = ROT_MODEL_MEADE,
.model_name = "LX200",
.mfg_name = "Meade",
.version = "0.1",
.copyright = "LGPL",
.status = RIG_STATUS_ALPHA,
.rot_type = ROT_TYPE_AZEL,
.port_type = RIG_PORT_SERIAL,
.serial_rate_min = 9600,
.serial_rate_max = 9600,
.serial_data_bits = 8,
.serial_stop_bits = 1,
.serial_parity = RIG_PARITY_NONE,
.serial_handshake = RIG_HANDSHAKE_NONE,
.write_delay = 0,
.post_write_delay = 200,
.timeout = 400,
.retry = 5,
.min_az = 0.,
.max_az = 360.,
.min_el = 0.,
.max_el = 90.,
.priv = NULL, /* priv */
.rot_init = meade_init,
.rot_cleanup = meade_cleanup,
.rot_open = meade_open,
.rot_close = meade_close,
.set_position = meade_set_position,
.get_position = meade_get_position,
.park = meade_park,
.stop = meade_stop,
.reset = meade_reset,
.move = meade_move,
.get_info = meade_get_info,
};
DECLARE_INITROT_BACKEND(meade)
{
rig_debug(RIG_DEBUG_VERBOSE, "meade: _init called\n");
rot_register(&meade_caps);
return RIG_OK;
}

31
meade/meade.h Normal file
View File

@ -0,0 +1,31 @@
/*
* Hamlib Meade telescope rotor backend - main header
* Copyright (c) 2018 by Andreas Mueller (DC1MIL)
*
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
#ifndef _MEADE_H
#define _MEADE_H 1
#define BUFSIZE 128
#define CR "\r"
#define LF "\x0a"
extern const struct rot_caps meade_caps;
#endif /* _MEADE_H */

4
scripts/Makefile.am
View File

@ -1,2 +1,2 @@
EXTRA_DIST = README.scripts build-win32.sh README.build-win32 \
build-VB.NET.sh README.build-VB.NET
EXTRA_DIST = README.scripts build-w32.sh build-w64.sh README.build-Windows \
build-VB.NET.sh README.build-VB.NET astylerc

94
scripts/README.build-Windows Normal file
View File

@ -0,0 +1,94 @@
This file is a HOWTO for the cross-compiling of Windows 32 and 64 bit
binary DLLs built from a tarball generated by 'make dist' in a Git
checkout. The resulting DLLs are built with a cdecl interface compatible
with MS VC++.
Prerequisites
=============
In these steps the release or daily snapshot tarball is unpacked in ~/builds
for the Windows build and all operations are done from there unless
otherwise noted.
Under Linux you need at least the mingw-w64 package to cross-compile it, zip
to create the archive, the tofrodos or dos2unix package installed to convert
to DOS text format, and Wine plus the free MVC++Toolkit available from:
http://uploading.com/files/HNH73WB3/VCToolkitSetup%28v1.01%29%282004.07.06%29.zip.html
to create the Windows .LIB file (unzip and then install it with Wine in the
usual way).
On Debian Jesse the mingw-w64 package works and is being used to build
the daily Windows 32/64 snapshots and releases.
Finally, the Windows version of libusb 1.0 must be available for the USB backends
to be built. Download the latest libusb-1.0 from:
https://sourceforge.net/projects/libusb/files/libusb-1.0/
and unzip the archive in ~/builds
Any version of libusb from 1.0.20 is known to work.
Several variables may need to be set differently at the top of the script file
depending on your system.
The script now relies on a pair of environment variables to locate the needed
libusb files.
The script generates HTML documents for the included .EXE files using groff
to convert the nroff formatted man pages. On Debian and derivatives, the groff
package is likely already installed.
Build for Windows 32/64, cross-compile on Linux:
================================================
Extract the Hamlib tarball into ~/builds (if you prefer another directory
be sure to edit the BUILD_DIR variable in the build-w[32|64].sh script):
$ tar xvfz ~/Downloads/hamlib-3.3~git-???????-20180527.tar.gz
Invoke the build-w[32|64].sh script (it requires a Bash shell) with the
name of the directory/Hamlib version to build (you need not cd into the hamlib
directory, although it won't hurt. The build-w[32|64].sh script uses absolute
paths):
$ build-w32.sh hamlib-3.3~git
or:
$ build-w64.sh hamlib-3.3~git
Release Info
============
The structure of the archive is:
$ tree -d
.
|-- bin
|-- doc
|-- include
| `-- hamlib
|-- lib
|-- gcc
`-- msvc
8 directories
The bin/ directory is where the executables and DLL files are placed. Header
files are under include/Hamlib/ and compiler specific files are under lib/*.
HTML documents for the .EXE programs are in doc/ while text documents
(READMEs and such) are in the main archive directory. The doc/ directory
also contains the generated HTML texinfo manual. The embedded
README.w[32|64]-bin.txt file generated by the build-w[32|64].sh script
describes setting the PATH environment variable in Windows 2000, Windows XP,
and Windows 7.
73, Nate, N0NB

98
scripts/README.build-win32
View File

@ -1,98 +0,0 @@
This file is a HOWTO for the cross-compiling of Windows 32 bit binary DLLs
built from a tarball generated by 'make dist' in a Git checkout. The
resulting DLLs are built with a cdecl interface compatible with MS VC++.
Prerequisites
=============
In these steps the release or daily snapshot tarball is unpacked in ~/builds
for the Windows 32 build and all operations are done from there unless
otherwise noted.
Under Linux you need at least the mingw32 package to cross-compile it (although
mingw-w64-i696 is being used to build the daily snapshots) zip to create
the archive, the tofrodos or dos2unix package installed to convert to DOS
text format, and Wine plus the free MVC++Toolkit available from:
http://uploading.com/files/HNH73WB3/VCToolkitSetup%28v1.01%29%282004.07.06%29.zip.html
to create the Windows 32 .LIB file (unzip and then install it with Wine in the
usual way).
NB: Debian Squeeze and later users will need at least the mingw32-runtime
3.15 package as the 3.13 package is broken. You can manually install the
Ubuntu version from:
http://packages.ubuntu.com/maverick/devel/mingw32-runtime
On Debian Jesse the mingw-w64-i686 pacakge works and is being used to build
the daily Windows 32 snapshots.
Finally, the Windows 32 version of libusb must be available for the USB backends
to be built. Download the latest libusb-win32-bin-1.2.4.0.zip from:
https://sourceforge.net/projects/libusb-win32/files/libusb-win32-releases/1.2.4.0/
and unzip the archive in ~/builds/libusb-win32-bin-1.2.4.0
Any version of libusb from 1.2.3.0 is known to work.
Several variables may need to be set differently at the top of the script file
depending on your system.
The script now relies on a pair of environment variables to locate the needed
libusb files and the third party pkg-config utility is no longer used for
libusb.
The script generates PDF documents for the included .EXE files using the
groff and ps2pdf utilities to convert the nroff formatted man pages. On
Debian and derivatives, installing the groff and ghostscript packages will
provide them.
Build for Windows 32, cross-compile on Linux:
=============================================
Extract the Hamlib tarball into ~/builds (if you prefer another directory
be sure to edit the BUILD_DIR variable in the build-win32.sh script):
$ tar xvfz ~/Downloads/hamlib-3.0~git-???????-20121007.tar.gz
Invoke the build-win32.sh script (it requires a Bash shell) with the name of
the directory/Hamlib version to build (you need not cd into the hamlib
directory, although it won't hurt. The build-win32 script uses absolute
paths):
$ build-win32.sh hamlib-3.0~git
Release Info
============
The structure of the archive is:
$ tree -d
.
|-- bin
|-- doc
|-- include
| `-- hamlib
|-- lib
| |-- gcc
| `-- msvc
`-- pdf
8 directories
The bin directory is where the executables and DLL files are placed. Header
files are under include/Hamlib and compiler specific files are under lib/*.
PDF documents for the .EXE programs are in pdf/ while text documents
(READMEs and such) are in the main archive directory. The doc/ directory
contains the generated HTML manual. The embedded README.win32-bin file
generated by the build-win32.sh script describes setting the PATH
environment variable in Windows 2000, Windows XP, and Windows 7.
73, Nate, N0NB

10
scripts/README.scripts
View File

@ -1,11 +1,13 @@
The scripts/ directory will contain helper scripts for building Hamlib
binary releases for Win32 and possibly other target platforms. EAch
script should be accompanied by a companion README file with information
on the script and build requirements.
binary releases for Microsoft Windows 32 and 64 bit architectures and
possibly other target platforms. Each script should be accompanied by
a companion README file with information on the script and build
requirements.
Scripts:
build-win32.sh for building Win32 DLLs and EXEs for use with MS VC++.
build-w32.sh and build-w64.sh for building Microsoft Windows 32 and 64 bit
DLLs and EXEs for use with MS VC++.
build-VB.NET.sh for building Win32 DLLs and EXEs for use with MS VB.NET
2002 Framework 1.1

232
scripts/build-w32.sh Normal file
View File

@ -0,0 +1,232 @@
#!/bin/bash
# Builds Hamlib 3.x W32 binary distribution.
# A script to build a set of W32 binary DLLs from a Hamlib tarball.
# This script assumes that the Hamlib tarball has been extracted to the
# directory specified in $BUILD_DIR and that libusb-1.x.y has also
# been extracted to $BUILD_DIR. The MS VC++ Toolkit must also be installed
# and working with Wine.
#
# See README.build-win32 for complete details.
# Set this to a desired directory
BUILD_DIR=~/builds
# Set this to LibUSB archive extracted in $BUILD_DIR
LIBUSB_VER=libusb-1.0.20
# uncomment the correct HOST_ARCH= line for your minGW installation
HOST_ARCH=i686-w64-mingw32
# Set to the strip name for your version of minGW
HOST_ARCH_STRIP=i686-w64-mingw32-strip
# Error return codes. See /usr/include/sysexits.h
EX_USAGE=64
EX_NOINPUT=66
# Pass name of Hamlib archive extracted in $BUILD_DIR
if [ $# -ne 1 ]; then
echo -e "\nUsage: `basename $0` hamlib-version\n"
echo -e "See README.build-win32 for more information.\n"
exit ${EX_USAGE}
fi
# Make sure the Hamlib archive is where we expect
if [ -d ${BUILD_DIR}/$1 ]; then
echo -e "\nBuilding W32 binaries in ${BUILD_DIR}/$1\n\n"
cd ${BUILD_DIR}/$1
else
echo -e "\nBuild directory, ${BUILD_DIR}/$1 not found!\nCheck path for $1 or correct the version number.\n"
exit ${EX_NOINPUT}
fi
RELEASE=`/usr/bin/awk 'BEGIN{FS="["; RS="]"} /\[3\./ {print $2;exit}' ./configure.ac`
HL_FILENAME=hamlib-w32-${RELEASE}
INST_DIR=`pwd`/mingw32-inst
ZIP_DIR=`pwd`/${HL_FILENAME}
LIBUSB_1_0_BIN_PATH=${BUILD_DIR}/${LIBUSB_VER}
# Create W32 specific README.w32-bin file
cat > README.w32-bin <<END_OF_README
What is it?
===========
This ZIP archive or Windows installer contains a build of Hamlib-$RELEASE
cross-compiled for MS Windows 32 bit systems using MinGW under Debian
GNU/Linux 8 (nice, heh!).
The DLL has a cdecl interface for MS VC++.
This software is copyrighted. The library license is LGPL, and the *.EXE files
licenses are GPL. Hamlib comes WITHOUT ANY WARRANTY. See the LICENSE.txt,
COPYING.txt, and COPYING.LIB.txt files.
A draft user manual in HTML format is included in the doc directory. Supporting
documentation in the form of Unix manual pages have also been included after
being converted to HTML.
Installation and Configuration
==============================
Extract the ZIP archive into a convenient location, C:\Program Files is a
reasonable choice.
Make sure *all* the .DLL files are in your PATH (leave them in the bin
directory and set the PATH). To set the PATH environment variable in Windows
2000, Windows XP, and Windows 7 (need info on Vista and Windows 8/10) do the
following:
* W2k/XP: Right-click on "My Computer"
Win7: Right-click on "Computer"
* W2k/XP: Click the "Advanced" tab of the "System Properties" dialog
Win7: Click the "Advanced system settings" link in the System dialog
* Click the "Environment Variables" button of the pop-up dialog
* Select "Path" in the "System variables" box of the "Environment Variables"
dialog
NB: If you are not the administrator, system policy may not allow editing
the path variable. The complete path to an executable file will need to be
given to run one of the Hamlib programs.
* Click the Edit button
* Now add the Hamlib path in the "Variable Value:" edit box. Be sure to put
a semi-colon ';' after the last path before adding the Hamlib path (NB. The
entire path is highlighted and will be erased upon typing a character so
click in the box to unselect the text first. The PATH is important!!)
Append the Hamlib path, e.g. C:\Program Files\hamlib-w32-3.0~git\bin
* Click OK for all three dialog boxes to save your changes.
Testing with the Hamlib Utilities
=================================
To continue, be sure you have read the README.betatester file, especially the
"Testing Hamlib" section. The primary means of testing is by way of the rigctl
utility for radios and rotctl utility for rotators. Each is a command line
program that is interactive or can act on a single command and exit.
Documentation for each utility can be found as an HTML file in the doc
directory.
In short, the command syntax is of the form:
rigctl -m 120 -r COM1 -vvvvv
-m -> Radio model 120, or Yaesu FT-817 (use 'rigctl -l' for a list)
-r -> Radio device, in this case COM1
-v -> Verbosity level. For testing four or five v characters are required.
Five 'v's set a debug level of TRACE which generates a lot of screen
output showing communication to the radio and values of important
variables. These traces are vital information for Hamlib rig backend
development.
To run rigctl or rotctl open a cmd window (Start|Run|enter 'cmd' in the
dialog). If text scrolls off the screen, you can scroll back with the mouse.
To copy output text into a mailer or editor (I recommend Notepad++, a free
editor also licensed under the GPL), highlight the text as a rectangle in the
cmd window, press <Enter> (or right-click the window icon in the upper left
corner and select Edit, then Copy), and paste it into your editor with Ctl-V
(or Edit|Paste from the typical GUI menu).
All feedback is welcome to the mail address below.
Uninstall
=========
To uninstall, simply delete the Hamlib directory. You may wish to edit the
PATH as above to remove the Hamlib bin path, if desired.
Information for w32 Programmers
=================================
There is a .LIB import library for MS-VC++ in lib/msvc. Simply #include
<hamlib/rig.h> (add directory to include path), include the .LIB in your
project and you are done. Note: MS-VC++ cannot compile all the Hamlib code, but
the API defined by rig.h has been made MSVC friendly :-)
As the source code for the library DLLs is licensed under the LGPL, your
program is not considered a "derivative work" when using the published Hamlib
API and normal linking to the front-end library, and may be of a license of
your choosing. The published Hamlib API may be found at:
http://hamlib.sourceforge.net/manuals/3.0.1/index.html
Thank You!
==========
Patches, feedback, and contributions are welcome.
Please report problems or success to hamlib-developer@lists.sourceforge.net
Cheers,
Stephane Fillod - F8CFE
Nate Bargmann - N0NB
http://www.hamlib.org
END_OF_README
# Configure and build hamlib for mingw32, with libusb-win32
./configure --host=${HOST_ARCH} \
--prefix=${INST_DIR} \
--without-cxx-binding \
--disable-static \
CPPFLAGS="-I${LIBUSB_1_0_BIN_PATH}/include" \
LDFLAGS="-L${LIBUSB_1_0_BIN_PATH}/MinGW32/dll"
make install
mkdir -p ${ZIP_DIR}/bin ${ZIP_DIR}/lib/msvc ${ZIP_DIR}/lib/gcc ${ZIP_DIR}/include ${ZIP_DIR}/doc
cp -a src/libhamlib.def ${ZIP_DIR}/lib/msvc/libhamlib-2.def; todos ${ZIP_DIR}/lib/msvc/libhamlib-2.def
cp -a ${INST_DIR}/include/hamlib ${ZIP_DIR}/include/.; todos ${ZIP_DIR}/include/hamlib/*.h
cp -a doc/Hamlib_design.png ${ZIP_DIR}/doc
cp -a doc/hamlib.html ${ZIP_DIR}/doc
# C++ binding is useless on w32 because of ABI
rm ${ZIP_DIR}/include/hamlib/{rig,rot}class.h
for f in AUTHORS ChangeLog COPYING COPYING.LIB LICENSE README README.betatester README.w32-bin THANKS ; do \
cp -a ${f} ${ZIP_DIR}/${f}.txt ; todos ${ZIP_DIR}/${f}.txt ; done
# Generate HTML documents from nroff formatted man files
for f in doc/man1/*.1 doc/man7/*.7; do \
/usr/bin/groff -mandoc -Thtml >${f}.html ${f}
cp -a ${f}.html ${ZIP_DIR}/doc/. ; done
cd ${BUILD_DIR}/$1
# Copy build files into specific locations for Zip file
cp -a ${INST_DIR}/bin/{rigctld.exe,rigctl.exe,rigmem.exe,rigsmtr.exe,rigswr.exe,rotctld.exe,rotctl.exe} ${ZIP_DIR}/bin/.
cp -a ${INST_DIR}/bin/libhamlib-?.dll ${ZIP_DIR}/bin/.
cp -a ${INST_DIR}/lib/libhamlib.dll.a ${ZIP_DIR}/lib/gcc/.
# NB: Strip Hamlib DLLs and EXEs
${HOST_ARCH_STRIP} ${ZIP_DIR}/bin/*.exe ${ZIP_DIR}/bin/*hamlib-*.dll
# Copy needed third party DLLs
cp -a /usr/i686-w64-mingw32/lib/libwinpthread-1.dll ${ZIP_DIR}/bin/.
cp -a ${LIBUSB_1_0_BIN_PATH}/MinGW32/dll/libusb-1.0.dll ${ZIP_DIR}/bin/libusb-1.0.dll
# Required for MinGW with GCC 4.9
cp -a /usr/lib/gcc/i686-w64-mingw32/4.9-posix/libgcc_s_sjlj-1.dll ${ZIP_DIR}/bin/libgcc_s_sjlj-1.dll
## Need VC++ free toolkit installed (default Wine directory installation shown)
( cd ${ZIP_DIR}/lib/msvc/ && wine ~/.wine/drive_c/Program\ Files/Microsoft\ Visual\ C++\ Toolkit\ 2003/bin/link.exe /lib /machine:i386 /def:libhamlib-2.def )
/usr/bin/zip -r ${HL_FILENAME}.zip `basename ${ZIP_DIR}`

101
scripts/build-win32.sh → scripts/build-w64.sh
View File

@ -1,29 +1,29 @@
#!/bin/bash
# Builds Hamlib 3.x Win32 binary distribution.
# Builds Hamlib 3.x W64 binary distribution.
# A script to build a set of Win32 binary DLLs from a Hamlib tarball.
# A script to build a set of W64 binary DLLs from a Hamlib tarball.
# This script assumes that the Hamlib tarball has been extracted to the
# directory specified in $BUILD_DIR and that libusb-win32-bin-1.x.y.z has also
# been extracted to $BUILD_DIR. The MS VC++Toolkit must also be installed
# and working with Wine.
#
# See README.build-win32 for complete details.
# Requires libusb-1.0 to be accessible for USB backends to be built.
# See README.build-w64 for complete details.
# Set this to a desired directory
BUILD_DIR=~/builds
# Set this to LibUSB archive extracted in $BUILD_DIR
LIBUSB_VER=libusb-win32-bin-1.2.4.0
LIBUSB_VER=libusb-1.0.20
# uncomment the correct HOST_ARCH= line for your minGW installation
# HOST_ARCH=i586-mingw32msvc
HOST_ARCH=i686-w64-mingw32
HOST_ARCH=x86_64-w64-mingw32
# Set to the strip name for your version of minGW
# HOST_ARCH_STRIP=i586-mingw32msvc-strip
HOST_ARCH_STRIP=i686-w64-mingw32-strip
HOST_ARCH_STRIP=x86_64-w64-mingw32-strip
# Error return codes. See /usr/include/sysexits.h
EX_USAGE=64
@ -33,43 +33,46 @@ EX_NOINPUT=66
# Pass name of Hamlib archive extracted in $BUILD_DIR
if [ $# -ne 1 ]; then
echo -e "\nUsage: `basename $0` hamlib-version\n"
echo -e "See README.build-win32 for more information.\n"
exit $EX_USAGE
echo -e "See README.build-w64 for more information.\n"
exit ${EX_USAGE}
fi
# Make sure the Hamlib archive is where we expect
if [ -d ${BUILD_DIR}/$1 ]; then
echo -e "\nBuilding Win32 binaries in ${BUILD_DIR}/$1\n\n"
echo -e "\nBuilding w64 binaries in ${BUILD_DIR}/$1\n\n"
cd ${BUILD_DIR}/$1
else
echo -e "\nBuild directory, ${BUILD_DIR}/$1 not found!\nCheck path for $1 or correct the version number.\n"
exit $EX_NOINPUT
fi
RELEASE=`/usr/bin/awk 'BEGIN{FS="["; RS="]"} /\[3\./ {print $2}' ./configure.ac`
INST_DIR=`pwd`/mingw-inst
ZIP_DIR=`pwd`/hamlib-win32-${RELEASE}
LIBUSB_WIN32_BIN_PATH=${BUILD_DIR}/${LIBUSB_VER}
RELEASE=`/usr/bin/awk 'BEGIN{FS="["; RS="]"} /\[3\./ {print $2;exit}' ./configure.ac`
HL_FILENAME=hamlib-w64-${RELEASE}
INST_DIR=`pwd`/mingw64-inst
ZIP_DIR=`pwd`/${HL_FILENAME}
LIBUSB_1_0_BIN_PATH=${BUILD_DIR}/${LIBUSB_VER}
# Create Win32 specific README.win32_bin file
cat > README.win32-bin <<END_OF_README
# Create W64 specific README.w64-bin file
cat > README.w64-bin <<END_OF_README
What is it?
===========
This ZIP archive or Windows installer contains a build of Hamlib-$RELEASE
cross-compiled for MS Windows 32 bit using MinGW under Debian GNU/Linux
cross-compiled for MS Windows 64 bit using MinGW under Debian GNU/Linux 8
(nice, heh!).
The DLL has a cdecl interface for MS VC++.
NB: This Windows 64 bit release is EXPERIMENTAL! Some features such as USB
backends have been disabled at this time. Please report bugs, failures, and
success to the Hamlib mailing list below.
This software is copyrighted. The library license is LGPL, and the *.EXE
files licenses are GPL. Hamlib comes WITHOUT ANY WARRANTY. See the
LICENSE.txt, COPYING.txt, and COPYING.LIB.txt files.
A draft user manual in HTML format is included in the doc directory. As it
covers the four main Hamlib utilities the respective PDF files are no longer
included separately.
A draft user manual in HTML format is included in the doc directory. Supporting
documentation in the form of Unix manual pages have also been included after
being converted to HTML.
Installation and Configuration
@ -80,7 +83,7 @@ reasonable choice.
Make sure *all* the .DLL files are in your PATH (leave them in the bin
directory and set the PATH). To set the PATH environment variable in
Windows 2000, Windows XP, and Windows 7 (need info on Vista and Windows 8)
Windows 2000, Windows XP, and Windows 7 (need info on Vista and Windows 8/10)
do the following:
* W2k/XP: Right-click on "My Computer"
@ -104,7 +107,7 @@ do the following:
a semi-colon ';' after the last path before adding the Hamlib path (NB. The
entire path is highlighted and will be erased upon typing a character so
click in the box to unselect the text first. The PATH is important!!)
Append the Hamlib path, e.g. C:\Program Files\hamlib-win32-3.0~git\bin
Append the Hamlib path, e.g. C:\Program Files\hamlib-w64-3.0~git\bin
* Click OK for all three dialog boxes to save your changes.
@ -149,20 +152,17 @@ To uninstall, simply delete the Hamlib directory. You may wish to edit the
PATH as above to remove the Hamlib bin path, if desired.
Information for Win32 Programmers
Information for w64 Programmers
=================================
There is a .LIB import library for MS-VC++ in lib/msvc. Simply #include
<hamlib/rig.h> (add directory to include path), include the .LIB in your
project and you are done. Note: MS-VC++ cannot compile all the Hamlib code,
but the API defined by rig.h has been made MSVC friendly :-)
As the source code for the library DLLs is licensed under the LGPL, your
program is not considered a "derivative work" when using the published
Hamlib API and normal linking to the front-end library, and may be of a
license of your choosing. The published Hamlib API may be found at:
http://sourceforge.net/apps/mediawiki/hamlib/index.php?title=Documentation
http://hamlib.sourceforge.net/manuals/1.2.15/index.html
(The 3.0 API is unchanged although new documentation will be forthcoming.)
Thank You!
@ -180,36 +180,34 @@ http://www.hamlib.org
END_OF_README
# Configure and build hamlib for mingw32, with libusb-win32
# Configure and build hamlib for x86_64-w64-mingw32, with libusb-1.0
./configure --host=${HOST_ARCH} \
--prefix=`pwd`/mingw-inst \
--prefix=${INST_DIR} \
--without-cxx-binding \
--disable-static \
CPPFLAGS="-I${LIBUSB_WIN32_BIN_PATH}/include" \
LDFLAGS="-L${LIBUSB_WIN32_BIN_PATH}/lib/gcc"
CPPFLAGS="-I${LIBUSB_1_0_BIN_PATH}/include" \
LDFLAGS="-L${LIBUSB_1_0_BIN_PATH}/MinGW64/dll"
make install
mkdir -p ${ZIP_DIR}/bin ${ZIP_DIR}/lib/msvc ${ZIP_DIR}/lib/gcc ${ZIP_DIR}/include ${ZIP_DIR}/pdf ${ZIP_DIR}/doc
mkdir -p ${ZIP_DIR}/bin ${ZIP_DIR}/lib/gcc ${ZIP_DIR}/include ${ZIP_DIR}/doc ${ZIP_DIR}/lib/msvc # ${ZIP_DIR}/pdf
cp -a src/libhamlib.def ${ZIP_DIR}/lib/msvc/libhamlib-2.def; todos ${ZIP_DIR}/lib/msvc/libhamlib-2.def
cp -a ${INST_DIR}/include/hamlib ${ZIP_DIR}/include/.; todos ${ZIP_DIR}/include/hamlib/*.h
cp -a doc/Hamlib_design.png ${ZIP_DIR}/doc
cp -a doc/hamlib.html ${ZIP_DIR}/doc
# C++ binding is useless on win32 because of ABI
# C++ binding is useless on w64 because of ABI
rm ${ZIP_DIR}/include/hamlib/{rig,rot}class.h
for f in AUTHORS ChangeLog COPYING COPYING.LIB LICENSE README README.betatester README.win32-bin THANKS ; do \
for f in AUTHORS ChangeLog COPYING COPYING.LIB LICENSE README README.betatester README.w64-bin THANKS ; do \
cp -a ${f} ${ZIP_DIR}/${f}.txt ; todos ${ZIP_DIR}/${f}.txt ; done
# Generate PDF documents from nroff formatted man files
cd tests
for f in rigmem.1 rigsmtr.1 rigswr.1; do \
groff -mandoc >${f}.ps ${f} ; ps2pdf ${f}.ps ; rm ${f}.ps ; \
cp -a ${f}.pdf ${ZIP_DIR}/pdf/. ; done
# Generate HTML documents from nroff formatted man files
for f in doc/man1/*.1 doc/man7/*.7; do \
/usr/bin/groff -mandoc -Thtml >${f}.html ${f}
cp -a ${f}.html ${ZIP_DIR}/doc/. ; done
cd ${BUILD_DIR}/$1
@ -222,14 +220,13 @@ cp -a ${INST_DIR}/lib/libhamlib.dll.a ${ZIP_DIR}/lib/gcc/.
${HOST_ARCH_STRIP} ${ZIP_DIR}/bin/*.exe ${ZIP_DIR}/bin/*hamlib-*.dll
# Copy needed third party DLLs
cp -a /usr/i686-w64-mingw32/lib/libwinpthread-1.dll ${ZIP_DIR}/bin/.
cp -a ${LIBUSB_WIN32_BIN_PATH}/bin/x86/libusb0_x86.dll ${ZIP_DIR}/bin/libusb0.dll
cp -a /usr/x86_64-w64-mingw32/lib/libwinpthread-1.dll ${ZIP_DIR}/bin/.
cp -a ${LIBUSB_1_0_BIN_PATH}/MinGW64/dll/libusb-1.0.dll ${ZIP_DIR}/bin/libusb-1.0.dll
# Required for MinGW with GCC 4.8
cp -a /usr/lib/gcc/i686-w64-mingw32/4.8/libgcc_s_sjlj-1.dll ${ZIP_DIR}/bin/libgcc_s_sjlj-1.dll
# Required for MinGW with GCC 4.9
cp -a /usr/lib/gcc/x86_64-w64-mingw32/4.9-posix/libgcc_s_seh-1.dll ${ZIP_DIR}/bin/libgcc_s_seh-1.dll
# Need VC++ free toolkit installed (default Wine directory installation shown)
( cd ${ZIP_DIR}/lib/msvc/ && wine ~/.wine/drive_c/Program\ Files/Microsoft\ Visual\ C++\ Toolkit\ 2003/bin/link.exe /lib /machine:i386 /def:libhamlib-2.def )
zip -r hamlib-win32-${RELEASE}.zip `basename ${ZIP_DIR}`
## Need VC++ free toolkit installed (default Wine directory installation shown)
( cd ${ZIP_DIR}/lib/msvc/ && wine ~/.wine/drive_c/Program\ Files/Microsoft\ Visual\ C++\ Toolkit\ 2003/bin/link.exe /lib /machine:amd64 /def:libhamlib-2.def )
zip -r ${HL_FILENAME}.zip `basename ${ZIP_DIR}`

3
src/cm108.c
View File

@ -115,7 +115,8 @@ int cm108_open(hamlib_port_t *port)
&& ((hiddevinfo.product >= 0x0008
&& hiddevinfo.product <= 0x000f)
|| hiddevinfo.product == 0x0012
|| hiddevinfo.product == 0x013a))
|| hiddevinfo.product == 0x013a
|| hiddevinfo.product == 0x013c))
// SSS1621/23
|| (hiddevinfo.vendor == 0x0c76
&& (hiddevinfo.product == 0x1605

44
src/conf.c
View File

@ -91,7 +91,7 @@ static const struct confparams frontend_cfg_params[] =
{
TOK_PTT_TYPE, "ptt_type", "PTT type",
"Push-To-Talk interface type override",
"RIG", RIG_CONF_COMBO, { .c = {{ "RIG", "DTR", "RTS", "Parallel", "CM108", "None", NULL }} }
"RIG", RIG_CONF_COMBO, { .c = {{ "RIG", "DTR", "RTS", "Parallel", "CM108", "GPIO", "GPION", "None", NULL }} }
},
{
TOK_PTT_PATHNAME, "ptt_pathname", "PTT path name",
@ -106,13 +106,18 @@ static const struct confparams frontend_cfg_params[] =
{
TOK_DCD_TYPE, "dcd_type", "DCD type",
"Data Carrier Detect (or squelch) interface type override",
"RIG", RIG_CONF_COMBO, { .c = {{ "RIG", "DSR", "CTS", "CD", "Parallel", "CM108", "None", NULL }} }
"RIG", RIG_CONF_COMBO, { .c = {{ "RIG", "DSR", "CTS", "CD", "Parallel", "CM108", "GPIO", "GPION", "None", NULL }} }
},
{
TOK_DCD_PATHNAME, "dcd_pathname", "DCD path name",
"Path name to the device file of the Data Carrier Detect (or squelch)",
"/dev/rig", RIG_CONF_STRING,
},
{
TOK_LO_FREQ, "lo_freq", "LO Frequency",
"Frequency to add to the VFO frequency for use with a transverter",
"0", RIG_CONF_NUMERIC, { .n = {0.0, 1e9, .1}}
},
{ RIG_CONF_END, NULL, }
};
@ -422,6 +427,14 @@ static int frontend_set_conf(RIG *rig, token_t token, const char *val)
{
rs->pttport.type.ptt = RIG_PTT_CM108;
}
else if (!strcmp(val, "GPIO"))
{
rs->pttport.type.ptt = RIG_PTT_GPIO;
}
else if (!strcmp(val, "GPION"))
{
rs->pttport.type.ptt = RIG_PTT_GPION;
}
else if (!strcmp(val, "None"))
{
rs->pttport.type.ptt = RIG_PTT_NONE;
@ -471,6 +484,14 @@ static int frontend_set_conf(RIG *rig, token_t token, const char *val)
{
rs->dcdport.type.dcd = RIG_DCD_CM108;
}
else if (!strcmp(val, "GPIO"))
{
rs->dcdport.type.dcd = RIG_DCD_GPIO;
}
else if (!strcmp(val, "GPION"))
{
rs->dcdport.type.dcd = RIG_DCD_GPION;
}
else if (!strcmp(val, "None"))
{
rs->dcdport.type.dcd = RIG_DCD_NONE;
@ -494,6 +515,9 @@ static int frontend_set_conf(RIG *rig, token_t token, const char *val)
case TOK_POLL_INTERVAL:
rs->poll_interval = atof(val);
break;
case TOK_LO_FREQ:
rs->lo_freq = atof(val);
break;
default:
@ -720,6 +744,14 @@ static int frontend_get_conf(RIG *rig, token_t token, char *val)
s = "CM108";
break;
case RIG_PTT_GPIO:
s = "GPIO";
break;
case RIG_PTT_GPION:
s = "GPION";
break;
case RIG_PTT_NONE:
s = "None";
break;
@ -766,6 +798,14 @@ static int frontend_get_conf(RIG *rig, token_t token, char *val)
s = "CM108";
break;
case RIG_DCD_GPIO:
s = "GPIO";
break;
case RIG_DCD_GPION:
s = "GPION";
break;
case RIG_DCD_NONE:
s = "None";
break;

38
src/gpio.c
View File

@ -29,7 +29,7 @@
#include "gpio.h"
int gpio_open(hamlib_port_t *port, int on_value)
int gpio_open(hamlib_port_t *port, int output, int on_value)
{
char pathname[FILPATHLEN*2];
FILE *fexp, *fdir;
@ -69,14 +69,16 @@ int gpio_open(hamlib_port_t *port, int on_value)
return -RIG_EIO;
}
fprintf(fdir, "out\n");
char *dir = output ? "out" : "in";
rig_debug(RIG_DEBUG_VERBOSE, "Setting direction of GPIO%s to %s\n", port->pathname, dir);
fprintf(fdir, "%s\n", dir);
fclose(fdir);
snprintf(pathname,
sizeof(pathname),
"/sys/class/gpio/gpio%s/value",
port->pathname);
fd = open(pathname, O_WRONLY);
fd = open(pathname, O_RDWR);
if (fd < 0)
{
@ -127,10 +129,36 @@ int gpio_ptt_get(hamlib_port_t *port, ptt_t *pttx)
{
if (port->parm.gpio.value)
{
return RIG_PTT_ON;
*pttx = RIG_PTT_ON;
}
else
{
return RIG_PTT_OFF;
*pttx = RIG_PTT_OFF;
}
return RIG_OK;
}
int gpio_dcd_get(hamlib_port_t *port, dcd_t *dcdx)
{
char val;
int port_value;
lseek(port->fd, 0, SEEK_SET);
if (read(port->fd, &val, sizeof(val)) <= 0)
{
return -RIG_EIO;
}
rig_debug(RIG_DEBUG_VERBOSE, "DCD GPIO pin value: %c\n", val);
port_value = val - '0';
if (port_value == port->parm.gpio.on_value)
{
*dcdx = RIG_DCD_ON;
} else
{
*dcdx = RIG_DCD_OFF;
}
return RIG_OK;
}

3
src/gpio.h
View File

@ -28,10 +28,11 @@
__BEGIN_DECLS
/* Hamlib internal use, see rig.c */
int gpio_open(hamlib_port_t *p, int on_value);
int gpio_open(hamlib_port_t *p, int output, int on_value);
int gpio_close(hamlib_port_t *p);
int gpio_ptt_set(hamlib_port_t *p, ptt_t pttx);
int gpio_ptt_get(hamlib_port_t *p, ptt_t *pttx);
int gpio_dcd_get(hamlib_port_t *p, dcd_t *dcdx);
__END_DECLS

2
src/iofunc.c
View File

@ -692,6 +692,8 @@ int HAMLIB_API read_string(hamlib_port_t *p,
/* Store the time of the read loop start */
gettimeofday(&start_time, NULL);
rxbuffer[0] = 0; /* ensure string is terminated */
while (total_count < rxmax - 1)
{
tv = tv_timeout; /* select may have updated it */

31
src/microham.c
View File

@ -78,8 +78,10 @@
#define PATH_MAX 256
#endif
#if !(defined(WIN32) || !defined(HAVE_GLOB_H))
static char
uh_device_path[PATH_MAX]; // use PATH_MAX since udev names can be VERY long!
#endif
static int uh_device_fd = -1;
static int uh_is_initialized = 0;
@ -106,14 +108,18 @@ static pthread_t readthread;
#define freelock()
#endif
#if defined(HAVE_SELECT)
//
// time of last heartbeat. Updated by heartbeat()
//
static time_t lastbeat = 0;
#endif
#if defined(HAVE_PTHREAD) && defined(HAVE_SOCKETPAIR) && defined(HAVE_SELECT)
static time_t starttime;
#define TIME ((int) (time(NULL) - starttime))
#endif
//
// close all sockets and mark them free
@ -205,9 +211,12 @@ static void close_microham()
* number begins with MK, M2, CK, DK, D2, 2R, 2P or UR. Then, open the serial
* line with correct serial speed etc. and put a valid fd into uh_device_fd.
*/
static void finddevices()
{
}
/* Commenting out the following dummy function to quell the warning from
* MinGW's GCC of a defined but not used function.
*/
/* static void finddevices() */
/* { */
/* } */
#else
@ -381,6 +390,7 @@ static void finddevices()
#endif
#if defined(HAVE_SELECT)
//
// parse a frame received from the keyer
// This is called from the "device reading" thread
@ -500,8 +510,10 @@ static void parseFrame(unsigned char *frame)
}
}
}
#endif /* HAVE_SELECT */
#if defined(HAVE_SELECT)
//
// Send radio bytes to microHam device
//
@ -548,6 +560,7 @@ static void writeRadio(unsigned char *bytes, int len)
freelock();
}
#endif /* HAVE_SELECT */
//
@ -585,6 +598,7 @@ static void writeFlags()
}
#if defined(HAVE_SELECT)
//
// Send bytes to the WinKeyer within microHam device
//
@ -639,6 +653,7 @@ static void writeWkey(unsigned char *bytes, int len)
freelock();
}
#endif /* HAVE_SELECT */
//
@ -701,6 +716,7 @@ static void writeControl(unsigned char *data, int len)
}
#if defined(HAVE_PTHREAD) && defined(HAVE_SOCKETPAIR) && defined(HAVE_SELECT)
//
// send a heartbeat and record time
// The "last heartbeat" time is recorded in a global variable
@ -716,8 +732,10 @@ static void heartbeat()
writeControl(seq, 2);
lastbeat = time(NULL);
}
#endif /* defined(HAVE_PTHREAD) && defined(HAVE_SOCKETPAIR) && defined(HAVE_SELECT) */
#if defined(HAVE_SELECT)
//
// This thread reads from the microHam device and puts data on the sockets
// it also issues periodic heartbeat messages
@ -725,7 +743,6 @@ static void heartbeat()
//
static void *read_device(void *p)
{
#if defined(HAVE_SELECT)
unsigned char frame[4];
int framepos = 0;
int ret;
@ -862,9 +879,9 @@ static void *read_device(void *p)
}
}
#endif
return NULL;
// return NULL;
}
#endif
/*

2
src/network.c
View File

@ -241,7 +241,7 @@ int network_open(hamlib_port_t *rp, int default_port)
{
break;
}
char msg[555];
char msg[1024];
snprintf(msg,sizeof(msg),"connect to %s failed, (trying next interface)",rp->pathname);
handle_error(RIG_DEBUG_WARN, msg);

2
src/register.c
View File

@ -87,6 +87,7 @@ DEFINE_INITRIG_BACKEND(prm80);
DEFINE_INITRIG_BACKEND(adat);
DEFINE_INITRIG_BACKEND(dorji);
DEFINE_INITRIG_BACKEND(barrett);
DEFINE_INITRIG_BACKEND(elad);
#ifdef HAVE_WINRADIO
DEFINE_INITRIG_BACKEND(winradio);
@ -139,6 +140,7 @@ static struct
{ RIG_ADAT, RIG_BACKEND_ADAT, RIG_FUNCNAM(adat) },
{ RIG_DORJI, RIG_BACKEND_DORJI, RIG_FUNCNAMA(dorji) },
{ RIG_BARRETT, RIG_BACKEND_BARRETT, RIG_FUNCNAMA(barrett) },
{ RIG_ELAD, RIG_BACKEND_ELAD, RIG_FUNCNAMA(elad) },
{ 0, NULL }, /* end */
};

51
src/rig.c
View File

@ -406,6 +406,7 @@ RIG * HAMLIB_API rig_init(rig_model_t rig_model)
rs->poll_interval = 500;
/* should it be a parameter to rig_init ? --SF */
rs->itu_region = RIG_ITU_REGION2;
rs->lo_freq = 0;
switch (rs->itu_region)
{
@ -688,7 +689,7 @@ int HAMLIB_API rig_open(RIG *rig)
break;
case RIG_PTT_GPIO:
rs->pttport.fd = gpio_open(&rs->pttport, 1);
rs->pttport.fd = gpio_open(&rs->pttport, 1, 1);
if (rs->pttport.fd < 0)
{
@ -706,7 +707,7 @@ int HAMLIB_API rig_open(RIG *rig)
break;
case RIG_PTT_GPION:
rs->pttport.fd = gpio_open(&rs->pttport, 0);
rs->pttport.fd = gpio_open(&rs->pttport, 1, 0);
if (rs->pttport.fd < 0)
{
@ -780,6 +781,34 @@ int HAMLIB_API rig_open(RIG *rig)
break;
case RIG_DCD_GPIO:
rs->dcdport.fd = gpio_open(&rs->dcdport, 0, 1);
if (rs->dcdport.fd < 0)
{
rig_debug(RIG_DEBUG_ERR,
"%s: cannot open DCD device \"%s\"\n",
__func__,
rs->dcdport.pathname);
status = -RIG_EIO;
}
break;
case RIG_DCD_GPION:
rs->dcdport.fd = gpio_open(&rs->dcdport, 0, 0);
if (rs->dcdport.fd < 0)
{
rig_debug(RIG_DEBUG_ERR,
"%s: cannot open DCD device \"%s\"\n",
__func__,
rs->dcdport.pathname);
status = -RIG_EIO;
}
break;
default:
rig_debug(RIG_DEBUG_ERR,
"%s: unsupported DCD type %d\n",
@ -969,6 +998,10 @@ int HAMLIB_API rig_close(RIG *rig)
port_close(&rs->dcdport, RIG_PORT_PARALLEL);
break;
case RIG_DCD_GPIO:
case RIG_DCD_GPION:
port_close(&rs->dcdport, RIG_PORT_GPIO);
default:
rig_debug(RIG_DEBUG_ERR,
"%s: unsupported DCD type %d\n",
@ -1060,6 +1093,11 @@ int HAMLIB_API rig_set_freq(RIG *rig, vfo_t vfo, freq_t freq)
}
caps = rig->caps;
if (rig->state.lo_freq != 0.0)
{
freq -= rig->state.lo_freq;
}
if (rig->state.vfo_comp != 0.0)
{
@ -1191,7 +1229,10 @@ int HAMLIB_API rig_get_freq(RIG *rig, vfo_t vfo, freq_t *freq)
{
rig->state.current_freq = *freq;
}
if (rig->state.lo_freq != 0.0)
{
*freq += rig->state.lo_freq;
}
return retcode;
}
@ -2036,6 +2077,10 @@ int HAMLIB_API rig_get_dcd(RIG *rig, vfo_t vfo, dcd_t *dcd)
case RIG_DCD_PARALLEL:
return par_dcd_get(&rig->state.dcdport, dcd);
case RIG_DCD_GPIO:
case RIG_DCD_GPION:
return gpio_dcd_get(&rig->state.dcdport, dcd);
case RIG_DCD_NONE:
return -RIG_ENAVAIL; /* not available */

3
src/rot_reg.c
View File

@ -81,7 +81,7 @@ DEFINE_INITROT_BACKEND(celestron);
DEFINE_INITROT_BACKEND(ether6);
DEFINE_INITROT_BACKEND(cnctrk);
DEFINE_INITROT_BACKEND(prosistel);
DEFINE_INITROT_BACKEND(meade);
/**
* \def ROT_BACKEND_LIST
@ -118,6 +118,7 @@ static struct
{ ROT_ETHER6, ROT_BACKEND_ETHER6, ROT_FUNCNAMA(ether6) },
{ ROT_CNCTRK, ROT_BACKEND_CNCTRK, ROT_FUNCNAMA(cnctrk) },
{ ROT_PROSISTEL, ROT_BACKEND_PROSISTEL, ROT_FUNCNAMA(prosistel) },
{ ROT_MEADE, ROT_BACKEND_MEADE, ROT_FUNCNAMA(meade) },
{ 0, NULL }, /* end */
};

2
src/token.h
View File

@ -96,6 +96,8 @@
#define TOK_VFO_COMP TOKEN_FRONTEND(110)
/** \brief rig: polling interval (units?) */
#define TOK_POLL_INTERVAL TOKEN_FRONTEND(111)
/** \brief rig: lo frequency of any transverters */
#define TOK_LO_FREQ TOKEN_FRONTEND(112)
/** \brief rig: International Telecommunications Union region no. */
#define TOK_ITU_REGION TOKEN_FRONTEND(120)
/*

24
tests/rigctl.c
View File

@ -121,8 +121,6 @@ static struct option long_options[] =
/* variable for readline support */
#ifdef HAVE_LIBREADLINE
static const int have_rl = 1;
#else /* no readline */
static const int have_rl = 0;
#endif
@ -143,6 +141,7 @@ int main(int argc, char *argv[])
int verbose = 0;
int show_conf = 0;
int dump_caps_opt = 0;
#ifdef HAVE_READLINE_HISTORY
int rd_hist = 0;
int sv_hist = 0;
@ -150,7 +149,8 @@ int main(int argc, char *argv[])
const char hist_file[] = "/.rigctl_history";
char *hist_path = NULL;
struct stat hist_dir_stat;
#endif
#endif /* HAVE_READLINE_HISTORY */
const char *rig_file = NULL, *ptt_file = NULL, *dcd_file = NULL;
ptt_type_t ptt_type = RIG_PTT_NONE;
dcd_type_t dcd_type = RIG_DCD_NONE;
@ -301,6 +301,14 @@ int main(int argc, char *argv[])
{
dcd_type = RIG_DCD_CM108;
}
else if (!strcmp(optarg, "GPIO"))
{
dcd_type = RIG_DCD_GPIO;
}
else if (!strcmp(optarg, "GPION"))
{
dcd_type = RIG_DCD_GPION;
}
else if (!strcmp(optarg, "NONE"))
{
dcd_type = RIG_DCD_NONE;
@ -381,7 +389,7 @@ int main(int argc, char *argv[])
case 'I':
sv_hist++;
break;
#endif
#endif /* HAVE_READLINE_HISTORY */
case 'v':
verbose++;
@ -562,7 +570,7 @@ int main(int argc, char *argv[])
}
}
#endif
#endif /* HAVE_READLINE_HISTORY */
}
#endif /* HAVE_LIBREADLINE */
@ -600,11 +608,11 @@ int main(int argc, char *argv[])
hist_path = (char *)NULL;
}
#endif
#endif /* HAVE_READLINE_HISTORY */
}
#endif
rig_close(my_rig); /* close port */
#endif /* HAVE_LIBREADLINE */
rig_close(my_rig); /* close port */
rig_cleanup(my_rig); /* if you care about memory */
return exitcode;

16
tests/rotctl.c
View File

@ -109,8 +109,6 @@ static struct option long_options[] =
/* variable for readline support */
#ifdef HAVE_LIBREADLINE
static const int have_rl = 1;
#else /* no readline */
static const int have_rl = 0;
#endif
@ -131,6 +129,7 @@ int main(int argc, char *argv[])
int verbose = 0;
int show_conf = 0;
int dump_caps_opt = 0;
#ifdef HAVE_READLINE_HISTORY
int rd_hist = 0;
int sv_hist = 0;
@ -138,7 +137,8 @@ int main(int argc, char *argv[])
const char hist_file[] = "/.rotctl_history";
char *hist_path = NULL;
struct stat hist_dir_stat;
#endif
#endif /* HAVE_READLINE_HISTORY */
const char *rot_file = NULL;
int serial_rate = 0;
char conf_parms[MAXCONFLEN] = "";
@ -240,7 +240,7 @@ int main(int argc, char *argv[])
case 'I':
sv_hist++;
break;
#endif
#endif /* HAVE_READLINE_HISTORY */
case 'v':
verbose++;
@ -395,7 +395,7 @@ int main(int argc, char *argv[])
}
}
#endif
#endif /* HAVE_READLINE_HISTORY */
}
#endif /* HAVE_LIBREADLINE */
@ -433,11 +433,11 @@ int main(int argc, char *argv[])
hist_path = (char *)NULL;
}
#endif
#endif /* HAVE_READLINE_HISTORY */
}
#endif
rot_close(my_rot); /* close port */
#endif /* HAVE_LIBREADLINE */
rot_close(my_rot); /* close port */
rot_cleanup(my_rot); /* if you care about memory */
return exitcode;

6
tests/rotctl_parse.c
View File

@ -1007,9 +1007,9 @@ int rotctl_parse(ROT *my_rot, FILE *fin, FILE *fout, char *argv[], int argc)
#endif
/* The starting position of the source string is the first
* character past the initial '\'.
* character past the initial '\'.
*/
snprintf(cmd_name, sizeof(cmd_name), parsed_input[0] + 1);
snprintf(cmd_name, sizeof(cmd_name), "%s", parsed_input[0] + 1);
/* Sanity check as valid multiple character commands consist of
* alpha-numeric characters and the underscore ('_') character.
@ -1603,7 +1603,7 @@ void list_models()
rot_load_all_backends();
printf(" Rig # Mfg Model Version Status\n");
printf(" Rot # Mfg Model Version Status\n");
status = rot_list_foreach(hash_model_list, NULL);
if (status != RIG_OK)

16
yaesu/ft100.c
View File

@ -55,7 +55,7 @@ static int ft100_send_priv_cmd(RIG *rig, unsigned char ci);
/* kc2ivl - what works on a ft100 as of 02/27/2002 */
/* ptt on/off */
/* set mode AM,CW,USB,LSB,FM use RTTY for DIG mode */
/* set mode AM,CW,USB,LSB,FM use PKTUSB for DIG mode*/
/* set split on/off */
/* set repeater +, - splx */
/* set frequency of current vfo */
@ -140,11 +140,11 @@ static const tone_t ft100_dcs_list[] = {
662, 664, 703, 712, 723, 731, 732, 734, 743, 754, \
0,
};
#define FT100_ALL_RX_MODES (RIG_MODE_AM|RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_USB|RIG_MODE_LSB|RIG_MODE_RTTY|RIG_MODE_FM)
#define FT100_ALL_RX_MODES (RIG_MODE_AM|RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_USB|RIG_MODE_LSB|RIG_MODE_PKTUSB|RIG_MODE_FM)
#define FT100_SSB_CW_RX_MODES (RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_USB|RIG_MODE_LSB)
#define FT100_AM_FM_RX_MODES (RIG_MODE_AM|RIG_MODE_FM)
#define FT100_OTHER_TX_MODES (RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_USB|RIG_MODE_LSB|RIG_MODE_RTTY|RIG_MODE_FM)
#define FT100_OTHER_TX_MODES (RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_USB|RIG_MODE_LSB|RIG_MODE_PKTUSB|RIG_MODE_FM)
#define FT100_AM_TX_MODES (RIG_MODE_AM)
#define FT100_GET_RIG_LEVELS (RIG_LEVEL_RAWSTR|RIG_LEVEL_RFPOWER|\
RIG_LEVEL_SWR|RIG_LEVEL_ALC|RIG_LEVEL_MICGAIN|RIG_LEVEL_SQL)
@ -259,9 +259,9 @@ const struct rig_caps ft100_caps = {
},
.filters = {
{RIG_MODE_SSB|RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_RTTY, kHz(2.4)},
{RIG_MODE_SSB|RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_RTTY, Hz(300)},
{RIG_MODE_SSB|RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_RTTY, Hz(500)},
{RIG_MODE_SSB|RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_PKTUSB, kHz(2.4)},
{RIG_MODE_SSB|RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_PKTUSB, Hz(300)},
{RIG_MODE_SSB|RIG_MODE_CW|RIG_MODE_CWR|RIG_MODE_PKTUSB, Hz(500)},
{RIG_MODE_AM|RIG_MODE_FM, kHz(6)},
{RIG_MODE_WFM, kHz(230)},
RIG_FLT_END,
@ -519,7 +519,7 @@ int ft100_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width) {
case RIG_MODE_FM:
cmd_index = FT100_NATIVE_CAT_SET_MODE_FM;
break;
case RIG_MODE_RTTY:
case RIG_MODE_PKTUSB:
cmd_index = FT100_NATIVE_CAT_SET_MODE_DIG;
break;
case RIG_MODE_WFM:
@ -608,7 +608,7 @@ int ft100_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width) {
*mode = RIG_MODE_AM;
break;
case 0x05:
*mode = RIG_MODE_RTTY;
*mode = RIG_MODE_PKTUSB;
break;
case 0x06:
*mode = RIG_MODE_FM;

174
yaesu/ft5000.c
View File

@ -50,9 +50,9 @@ const struct rig_caps ftdx5000_caps = {
.rig_model = RIG_MODEL_FTDX5000,
.model_name = "FT-DX5000",
.mfg_name = "Yaesu",
.version = NEWCAT_VER,
.version = NEWCAT_VER ".1",
.copyright = "LGPL",
.status = RIG_STATUS_ALPHA,
.status = RIG_STATUS_STABLE,
.rig_type = RIG_TYPE_TRANSCEIVER,
.ptt_type = RIG_PTT_RIG,
.dcd_type = RIG_DCD_NONE,
@ -207,3 +207,173 @@ const struct rig_caps ftdx5000_caps = {
.get_channel = newcat_get_channel,
};
/*
* ft3000 rig capabilities.
* Largely compatible with the ft5000
* Found one exception where ft3000 does not have TARGETABLE_MODE
* Also this struct is READONLY!
*
*/
const struct rig_caps ftdx3000_caps = {
.rig_model = RIG_MODEL_FTDX3000,
.model_name = "FT-DX3000",
.mfg_name = "Yaesu",
.version = NEWCAT_VER ".1",
.copyright = "LGPL",
.status = RIG_STATUS_STABLE,
.rig_type = RIG_TYPE_TRANSCEIVER,
.ptt_type = RIG_PTT_RIG,
.dcd_type = RIG_DCD_NONE,
.port_type = RIG_PORT_SERIAL,
.serial_rate_min = 4800, /* Default rate per manual */
.serial_rate_max = 38400,
.serial_data_bits = 8,
.serial_stop_bits = 1, /* Assumed since manual makes no mention */
.serial_parity = RIG_PARITY_NONE,
.serial_handshake = RIG_HANDSHAKE_HARDWARE,
.write_delay = FTDX5000_WRITE_DELAY,
.post_write_delay = FTDX5000_POST_WRITE_DELAY,
.timeout = 2000,
.retry = 3,
.has_get_func = FTDX5000_FUNCS,
.has_set_func = FTDX5000_FUNCS,
.has_get_level = FTDX5000_LEVELS,
.has_set_level = RIG_LEVEL_SET(FTDX5000_LEVELS),
.has_get_parm = RIG_PARM_NONE,
.has_set_parm = RIG_PARM_NONE,
.level_gran = {
[LVL_RAWSTR] = { .min = { .i = 0 }, .max = { .i = 255 } },
[LVL_CWPITCH] = { .min = { .i = 300 }, .max = { .i = 1050 }, .step = { .i = 50 } },
},
.ctcss_list = common_ctcss_list,
.dcs_list = NULL,
.preamp = { 10, 20, RIG_DBLST_END, }, /* TBC */
.attenuator = { 6, 12, 18, RIG_DBLST_END, },
.max_rit = Hz(9999),
.max_xit = Hz(9999),
.max_ifshift = Hz(1000),
.vfo_ops = FTDX5000_VFO_OPS,
.targetable_vfo = RIG_TARGETABLE_FREQ,
.transceive = RIG_TRN_OFF, /* May enable later as the 5000 has an Auto Info command */
.bank_qty = 0,
.chan_desc_sz = 0,
.str_cal = FTDX5000_STR_CAL,
.chan_list = {
{ 1, 99, RIG_MTYPE_MEM, NEWCAT_MEM_CAP },
{ 100, 117, RIG_MTYPE_EDGE, NEWCAT_MEM_CAP }, /* two by two */
RIG_CHAN_END,
},
.rx_range_list1 = {
/* General coverage + ham, ANT_5 is RX only antenna */
{kHz(30), MHz(60), FTDX5000_ALL_RX_MODES, -1, -1, FTDX5000_VFO_ALL, FTDX5000_TX_ANTS|RIG_ANT_5},
RIG_FRNG_END,
},
.tx_range_list1 = {
FRQ_RNG_HF(1, FTDX5000_OTHER_TX_MODES, W(5), W(200), FTDX5000_VFO_ALL, FTDX5000_TX_ANTS),
FRQ_RNG_HF(1, FTDX5000_AM_TX_MODES, W(2), W(75), FTDX5000_VFO_ALL, FTDX5000_TX_ANTS), /* AM class */
FRQ_RNG_6m(1, FTDX5000_OTHER_TX_MODES, W(5), W(200), FTDX5000_VFO_ALL, FTDX5000_TX_ANTS),
FRQ_RNG_6m(1, FTDX5000_AM_TX_MODES, W(2), W(75), FTDX5000_VFO_ALL, FTDX5000_TX_ANTS), /* AM class */
RIG_FRNG_END,
},
.rx_range_list2 = {
{kHz(30), MHz(60), FTDX5000_ALL_RX_MODES, -1, -1, FTDX5000_VFO_ALL, FTDX5000_TX_ANTS|RIG_ANT_5},
RIG_FRNG_END,
},
.tx_range_list2 = {
FRQ_RNG_HF(2, FTDX5000_OTHER_TX_MODES, W(5), W(200), FTDX5000_VFO_ALL, FTDX5000_TX_ANTS),
FRQ_RNG_HF(2, FTDX5000_AM_TX_MODES, W(2), W(75), FTDX5000_VFO_ALL, FTDX5000_TX_ANTS), /* AM class */
FRQ_RNG_6m(2, FTDX5000_OTHER_TX_MODES, W(5), W(200), FTDX5000_VFO_ALL, FTDX5000_TX_ANTS),
FRQ_RNG_6m(2, FTDX5000_AM_TX_MODES, W(2), W(75), FTDX5000_VFO_ALL, FTDX5000_TX_ANTS), /* AM class */
RIG_FRNG_END,
},
.tuning_steps = {
{FTDX5000_SSB_CW_RX_MODES, Hz(10)}, /* Normal */
{FTDX5000_SSB_CW_RX_MODES, Hz(100)}, /* Fast */
{FTDX5000_AM_RX_MODES, Hz(100)}, /* Normal */
{FTDX5000_AM_RX_MODES, kHz(1)}, /* Fast */
{FTDX5000_FM_RX_MODES, Hz(100)}, /* Normal */
{FTDX5000_FM_RX_MODES, kHz(1)}, /* Fast */
RIG_TS_END,
},
/* mode/filter list, .remember = order matters! */
.filters = {
{FTDX5000_CW_RTTY_PKT_RX_MODES, Hz(1800)}, /* Normal CW, RTTY, PKT/USER */
{FTDX5000_CW_RTTY_PKT_RX_MODES, Hz(500)}, /* Narrow CW, RTTY, PKT/USER */
{FTDX5000_CW_RTTY_PKT_RX_MODES, Hz(2400)}, /* Wide CW, RTTY, PKT/USER */
{RIG_MODE_SSB, Hz(2400)}, /* Normal SSB */
{RIG_MODE_SSB, Hz(1800)}, /* Narrow SSB */
{RIG_MODE_SSB, Hz(3000)}, /* Wide SSB */
{RIG_MODE_AM, Hz(9000)}, /* Normal AM */
{RIG_MODE_AM, Hz(6000)}, /* Narrow AM */
{FTDX5000_FM_RX_MODES, Hz(15000)}, /* Normal FM */
{FTDX5000_FM_RX_MODES, Hz(8000)}, /* Narrow FM */
RIG_FLT_END,
},
.priv = NULL,
.rig_init = newcat_init,
.rig_cleanup = newcat_cleanup,
.rig_open = newcat_open, /* port opened */
.rig_close = newcat_close, /* port closed */
.cfgparams = newcat_cfg_params,
.set_conf = newcat_set_conf,
.get_conf = newcat_get_conf,
.set_freq = newcat_set_freq,
.get_freq = newcat_get_freq,
.set_mode = newcat_set_mode,
.get_mode = newcat_get_mode,
.set_vfo = newcat_set_vfo,
.get_vfo = newcat_get_vfo,
.set_ptt = newcat_set_ptt,
.get_ptt = newcat_get_ptt,
.set_split_vfo = newcat_set_split_vfo,
.get_split_vfo = newcat_get_split_vfo,
.set_rit = newcat_set_rit,
.get_rit = newcat_get_rit,
.set_xit = newcat_set_xit,
.get_xit = newcat_get_xit,
.set_ant = newcat_set_ant,
.get_ant = newcat_get_ant,
.get_func = newcat_get_func,
.set_func = newcat_set_func,
.get_level = newcat_get_level,
.set_level = newcat_set_level,
.get_mem = newcat_get_mem,
.set_mem = newcat_set_mem,
.vfo_op = newcat_vfo_op,
.get_info = newcat_get_info,
.power2mW = newcat_power2mW,
.mW2power = newcat_mW2power,
.set_rptr_shift = newcat_set_rptr_shift,
.get_rptr_shift = newcat_get_rptr_shift,
.set_ctcss_tone = newcat_set_ctcss_tone,
.get_ctcss_tone = newcat_get_ctcss_tone,
.set_ctcss_sql = newcat_set_ctcss_sql,
.get_ctcss_sql = newcat_get_ctcss_sql,
.set_powerstat = newcat_set_powerstat,
.get_powerstat = newcat_get_powerstat,
.get_ts = newcat_get_ts,
.set_ts = newcat_set_ts,
.set_trn = newcat_set_trn,
.get_trn = newcat_get_trn,
.set_channel = newcat_set_channel,
.get_channel = newcat_get_channel,
};

53
yaesu/ft817.c
View File

@ -177,7 +177,7 @@ const struct rig_caps ft817_caps = {
.write_delay = FT817_WRITE_DELAY,
.post_write_delay = FT817_POST_WRITE_DELAY,
.timeout = FT817_TIMEOUT,
.retry = 3,
.retry = 5,
.has_get_func = RIG_FUNC_NONE,
.has_set_func = RIG_FUNC_LOCK | RIG_FUNC_TONE | RIG_FUNC_TSQL,
.has_get_level = RIG_LEVEL_STRENGTH | RIG_LEVEL_RAWSTR | RIG_LEVEL_RFPOWER,
@ -456,17 +456,27 @@ int ft817_get_freq(RIG *rig, vfo_t vfo, freq_t *freq)
{
struct ft817_priv_data *p = (struct ft817_priv_data *) rig->state.priv;
int n;
freq_t f1 = 0, f2 = 0;
int retries = rig->state.rigport.retry + 1; // +1 because, because 2 steps are needed even in best scenario
if (vfo != RIG_VFO_CURR)
return -RIG_ENTARGET;
if (check_cache_timeout(&p->fm_status_tv))
if ((n = ft817_get_status(rig, FT817_NATIVE_CAT_GET_FREQ_MODE_STATUS)) < 0)
return n;
while ((f1 == 0 || f1 != f2) && retries-- > 0) {
if (check_cache_timeout(&p->fm_status_tv))
if ((n = ft817_get_status(rig, FT817_NATIVE_CAT_GET_FREQ_MODE_STATUS)) < 0)
return n;
f1 = f2;
f2 = from_bcd_be(p->fm_status, 8);
}
*freq = from_bcd_be(p->fm_status, 8) * 10;
if (retries >= 0) {
*freq = f1 * 10;
return RIG_OK;
} else {
return -RIG_EIO;
}
return RIG_OK;
}
int ft817_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width)
@ -842,6 +852,8 @@ int ft817_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)
int ft817_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt)
{
int index, n;
ptt_t ptt_response = -1;
int retries = rig->state.rigport.retry;
if (vfo != RIG_VFO_CURR)
return -RIG_ENTARGET;
@ -859,15 +871,32 @@ int ft817_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt)
return -RIG_EINVAL;
}
n = ft817_send_cmd(rig, index);
rig_force_cache_timeout(
&((struct ft817_priv_data *)rig->state.priv)->tx_status_tv);
do {
n = ft817_send_cmd(rig, index);
if (n < 0 && n != -RIG_ERJCTED)
return n;
rig_force_cache_timeout(
&((struct ft817_priv_data *)rig->state.priv)->tx_status_tv);
if (n < 0 && n != -RIG_ERJCTED)
return n;
if (ft817_get_ptt(rig, vfo, &ptt_response) != RIG_OK) {
ptt_response = -1;
}
if (ptt_response != ptt) {
usleep(1000l * FT817_RETRY_DELAY); // Wait before next try. Helps with slower rigs cloning FT817 protocol (e.g. MCHF)
}
} while (ptt_response != ptt && retries-- > 0);
if (retries >=0) {
return RIG_OK;
} else {
return -RIG_EIO;
}
return RIG_OK;
}
int ft817_set_func (RIG *rig, vfo_t vfo, setting_t func, int status)

9
yaesu/ft817.h
View File

@ -50,7 +50,14 @@
/*
* Read timeout.
*/
#define FT817_TIMEOUT 1000
#define FT817_TIMEOUT 3000
/*
* Return from TX to RX may have a delay. If status is not changed
* on the first attempt, wait this amount of milliseconds before
* each next next attempts.
*/
#define FT817_RETRY_DELAY 100
/*
* The time the TX, RX and FREQ/MODE status are cached (in millisec).

23
yaesu/ft900.c
View File

@ -1,4 +1,4 @@
/*
/*
* hamlib - (C) Frank Singleton 2000 (javabear at users.sourceforge.net)
*
* ft900.c - (C) Frank Singleton 2000 (javabear at users.sourceforge.net)
@ -37,6 +37,7 @@
#include "bandplan.h"
#include "serial.h"
#include "misc.h"
#include "cal.h"
#include "yaesu.h"
#include "ft900.h"
@ -138,7 +139,8 @@ struct ft900_priv_data {
unsigned char p_cmd[YAESU_CMD_LENGTH]; /* private copy of 1 constructed CAT cmd */
yaesu_cmd_set_t pcs[FT900_NATIVE_SIZE]; /* private cmd set */
unsigned char update_data[FT900_ALL_DATA_LENGTH]; /* returned data--max value, some are less */
unsigned char current_mem; /* private memory channel number */
unsigned char current_mem; /* private memory channel number */
int ptt; /* ptt status needed for meter reading */
};
/*
@ -151,9 +153,9 @@ const struct rig_caps ft900_caps = {
.rig_model = RIG_MODEL_FT900,
.model_name = "FT-900",
.mfg_name = "Yaesu",
.version = "0.1",
.version = "0.2",
.copyright = "LGPL",
.status = RIG_STATUS_UNTESTED,
.status = RIG_STATUS_STABLE,
.rig_type = RIG_TYPE_TRANSCEIVER,
.ptt_type = RIG_PTT_RIG,
.dcd_type = RIG_DCD_NONE,
@ -903,9 +905,11 @@ static int ft900_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt) {
switch (ptt) {
case RIG_PTT_OFF:
cmd_index = FT900_NATIVE_PTT_OFF;
priv->ptt = 0;
break;
case RIG_PTT_ON:
cmd_index = FT900_NATIVE_PTT_ON;
priv->ptt = 1;
break;
default:
return -RIG_EINVAL; /* wrong PTT state! */
@ -961,6 +965,7 @@ static int ft900_get_ptt(RIG *rig, vfo_t vfo, ptt_t *ptt) {
default: /* Oops! */
return -RIG_EINVAL; /* Invalid PTT bit?! */
}
priv->ptt = *ptt;
return RIG_OK;
}
@ -1297,13 +1302,11 @@ static int ft900_get_level(RIG *rig, vfo_t vfo, setting_t level, value_t *val) {
* is life when mapping non-linear S-meters to a linear scale.
*
*/
if (*p > 160) {
val->i = 60;
} else if (*p <= 72) {
val->i = ((72 - *p) / 1.3333) * -1;
} else {
val->i = ((*p - 72) / 1.4667);
cal_table_t cal=FT900_STR_CAL_SMETER;
if (priv->ptt) {
cal = (cal_table_t)FT900_STR_CAL_POWER;
}
val->i = (int)rig_raw2val(*p,&cal);
rig_debug(RIG_DEBUG_TRACE, "%s: calculated level = %i\n", __func__, val->i);

21
yaesu/ft900.h
View File

@ -71,7 +71,7 @@
#define FT900_PACING_INTERVAL 5
#define FT900_PACING_DEFAULT_VALUE 0
#define FT900_WRITE_DELAY 50
#define FT900_WRITE_DELAY 5
/* Delay sequential fast writes */
@ -315,6 +315,25 @@ typedef enum ft900_native_cmd_e ft900_native_cmd_t;
#define P3 1
#define P4 0
/*
* Two calibration sets for the smeter/power readings
*/
#define FT900_STR_CAL_SMETER { 3, \
{ \
{ 0, -54 }, /* S0 */ \
{0x44, 0 }, /* S9 */ \
{0x9d, 60 }, /* +60dB */ \
} }
#define FT900_STR_CAL_POWER { 5, \
{ \
{ 0, 0 }, /* 0W */ \
{0x44, 10 }, /* 10W */ \
{0x69, 25 }, /* 25W */ \
{0x92, 50 }, /* 50W */ \
{0xCE, 100 }, /* 100W */ \
} }
/*
* API local implementation

4
yaesu/ft991.c
View File

@ -289,7 +289,7 @@ int ft991_get_split_mode(RIG *rig, vfo_t vfo, rmode_t *tx_mode, pbwidth_t *tx_wi
* ------------------------------------------------------------------
* Returns RIG_OK on success or an error code on failure
*
* Comments: Passs band is not set here nor does it make sense as the
* Comments: Pass band is not set here nor does it make sense as the
* FT991 cannot receive on VFO B. The FT991 cannot set
* VFO B mode directly so we'll just set A and swap A
* into B but we must preserve the VFO A mode and VFO B
@ -333,7 +333,7 @@ int ft991_set_split_mode(RIG *rig, vfo_t vfo, rmode_t tx_mode, pbwidth_t tx_widt
{
return err;
}
strncat (restore_commands, priv->ret_data, NEWCAT_DATA_LEN-1);
strncpy(restore_commands, priv->ret_data, NEWCAT_DATA_LEN);
/* Change mode on VFOA */
if (RIG_OK != (err = newcat_set_mode (rig, RIG_VFO_A, tx_mode, RIG_PASSBAND_NOCHANGE)))

15
yaesu/newcat.c
View File

@ -59,6 +59,7 @@ static const char cat_term = ';'; /* Yaesu command terminator */
typedef enum nc_rigid_e {
NC_RIGID_NONE = 0,
NC_RIGID_FT450 = 241,
NC_RIGID_FT450D = 244,
NC_RIGID_FT950 = 310,
NC_RIGID_FT891 = 135,
NC_RIGID_FT991 = 135,
@ -340,6 +341,8 @@ int newcat_open(RIG *rig) {
last client left it on */
newcat_set_trn(rig, RIG_TRN_OFF); /* ignore status in case it's
not supported */
/* Initialize rig_id in case any subsequent commands need it */
(void)newcat_get_rigid(rig);
return RIG_OK;
}
@ -2018,8 +2021,10 @@ int newcat_set_level(RIG * rig, vfo_t vfo, setting_t level, value_t val)
case RIG_LEVEL_RFPOWER:
if (!newcat_valid_command(rig, "PC"))
return -RIG_ENAVAIL;
scale = (newcat_is_rig(rig, RIG_MODEL_FT950)) ? 100 : 255;
scale = (newcat_is_rig(rig, RIG_MODEL_FT1200)) ? 100 : scale;
scale = (newcat_is_rig(rig, RIG_MODEL_FT450)) &&
(newcat_get_rigid(rig) == NC_RIGID_FT450D) ? 100. : 255.;
scale = newcat_is_rig(rig, RIG_MODEL_FT950) ? 100. : scale ;
scale = newcat_is_rig(rig, RIG_MODEL_FT1200) ? 100. : scale ;
fpf = newcat_scale_float(scale, val.f);
snprintf(priv->cmd_str, sizeof(priv->cmd_str), "PC%03d%c", fpf, cat_term);
break;
@ -2449,6 +2454,12 @@ int newcat_get_level(RIG * rig, vfo_t vfo, setting_t level, value_t * val)
switch (level) {
case RIG_LEVEL_RFPOWER:
scale = (newcat_is_rig(rig, RIG_MODEL_FT450)) &&
(newcat_get_rigid(rig) == NC_RIGID_FT450D) ? 100. : 255.;
scale = newcat_is_rig(rig, RIG_MODEL_FT950) ? 100. : scale ;
scale = newcat_is_rig(rig, RIG_MODEL_FT1200) ? 100. : scale ;
val->f = (float)atoi(retlvl)/scale;
break;
case RIG_LEVEL_VOXGAIN:
case RIG_LEVEL_COMP:
case RIG_LEVEL_ANTIVOX:

1
yaesu/yaesu.c
View File

@ -96,6 +96,7 @@ DECLARE_INITRIG_BACKEND(yaesu)
rig_register(&ft1000mpmkv_caps);
rig_register(&ft1000mpmkvfld_caps);
rig_register(&ft2000_caps);
rig_register(&ftdx3000_caps);
rig_register(&ftdx5000_caps);
rig_register(&ft9000_caps);
rig_register(&frg100_caps);

1
yaesu/yaesu.h
View File

@ -69,6 +69,7 @@ extern const struct rig_caps ft1000mpmkv_caps;
extern const struct rig_caps ft1000mpmkvfld_caps;
extern const struct rig_caps ft1000d_caps;
extern const struct rig_caps ft2000_caps;
extern const struct rig_caps ftdx3000_caps;
extern const struct rig_caps ftdx5000_caps;
extern const struct rig_caps ft9000_caps;
extern const struct rig_caps frg100_caps;