LIbrary for Amateur Radio Equipment Control Applications.
 
 
 
 
 
 
Go to file
Nate Bargmann 97366d966b Distribute kit/README.funcubedongle 2011-05-29 07:32:57 -05:00
alinco Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
aor source warnings cleanup: #if-0 out a few unused routines 2011-02-27 22:42:17 +00:00
ars Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
bindings added TRM8060 2010-10-26 20:47:35 +00:00
c++ Set versions for 1.2.13.1 release 2011-05-28 07:39:53 -05:00
doc Move files into their relevant directories 2011-02-14 03:04:19 +00:00
drake Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
dummy Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
easycomm Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
flexradio source warnings cleanup: #if-0 out a few unused routines 2011-02-27 22:42:17 +00:00
fodtrack Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
gnuradio Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
gs232a F1TE tracker's protocol looks more like GS232 than GS232A 2010-11-29 21:56:05 +00:00
heathkit Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
icom Skeleton for IC-E92D model. 2011-01-05 21:59:48 +00:00
include Add Vertex Standard VX-1700 transceiver support 2011-02-16 23:49:58 +00:00
jrc Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
kachina Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
kenwood Correct K3 set_ant 2011-05-28 20:53:38 -05:00
kit Distribute kit/README.funcubedongle 2011-05-29 07:32:57 -05:00
kylix 20060718: 2006-07-18 23:06:44 +00:00
lib mingw portability 2010-05-05 19:55:13 +00:00
lowe Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
m2 Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
macros Remove bundled libltdl (libtool) 2011-02-13 19:01:28 +00:00
microtune Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
miniVNA Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
pcr source warnings cleanup: #if-0 out a few unused routines 2011-02-27 22:42:17 +00:00
perl deprecated, use swig bindings/ instead 2002-11-05 21:33:16 +00:00
prm80 - Clear MSB of data read on 7-bit serial port, 2010-10-29 07:50:57 +00:00
racal Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
rft Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
rotorez source warnings cleanup: rotorez_rot_reset wrapper for stop 2011-02-27 23:26:13 +00:00
rpcrig source warnings cleanup: rpcgen-generated code 2011-02-27 21:19:47 +00:00
rpcrot source warnings cleanup: rpcgen-generated code 2011-02-27 21:19:47 +00:00
rs Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
sartek Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
skanti Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
spid Updated SPID patch from Norvald H. Ryeng 2011-01-29 19:58:21 +00:00
src Set versions for 1.2.13.1 release 2011-05-28 07:39:53 -05:00
tapr Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
tentec Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
tests Port rigctld/rotctld to Mingw32 2011-04-04 15:35:51 -05:00
tuner Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
uniden Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
winradio Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
wj Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
yaesu source warnings cleanup: #ifdef out unused FT-840 routines 2011-02-27 22:43:06 +00:00
.gitignore Useful .gitignore to quiet Git when building 2011-03-13 09:55:37 -05:00
AUTHORS Correct some copy and paste errors. 2011-01-11 00:30:39 +00:00
COPYING Release of 1.2.6.2 2007-06-30 12:58:11 +00:00
COPYING.LIB Release of 1.2.6.2 2007-06-30 12:58:11 +00:00
ChangeLog Update NEWS and ChangeLog for 1.2.13.1 release 2011-05-28 21:32:29 -05:00
INSTALL Update documentation. 2011-02-01 16:31:20 +00:00
LICENSE Removed obsolete files, configure.ac.ltv2 and cvs2cl.pl 2010-01-28 18:20:20 +00:00
Makefile.am added TRM8060 2010-10-26 20:47:35 +00:00
NEWS Update NEWS and ChangeLog for 1.2.13.1 release 2011-05-28 21:32:29 -05:00
PLAN * cosmetic changes 2000-11-01 23:18:11 +00:00
README Remove bundled libltdl (libtool) 2011-02-13 19:01:28 +00:00
README.betatester Updates for change to Git SCM. 2011-04-04 15:46:41 -05:00
README.developer Updates for change to Git SCM. 2011-04-04 15:46:41 -05:00
README.release Fix mingw32 cross-compilation procedure and config 2011-04-04 15:43:40 -05:00
README.win32 Updated to reflect recent changes within v1.2.2cvs-2 2004-08-17 23:01:17 +00:00
Segfault-award Congrats Charles 2011-02-21 22:15:12 +00:00
THANKS minor changes 2008-07-14 01:31:55 +00:00
TODO misc 2004-02-16 21:44:37 +00:00
TODO.skeleton Initial revision 2000-07-18 20:55:08 +00:00
autogen.sh Remove bundled libltdl (libtool) 2011-02-13 19:01:28 +00:00
configure.ac Set versions for 1.2.13.1 release 2011-05-28 07:39:53 -05:00
hamlib.m4 added quoting for newer autoconf [supplied by Thomas Klausner] 2005-09-28 21:07:59 +00:00
hamlib.pc.in Update copyright year in README files. 2011-01-13 12:08:12 +00:00
hamlib.spec.in Remove bundled libltdl (libtool) 2011-02-13 19:01:28 +00:00
install-sh Update bundled libltdl (libtool) to version 2.2.6b to address CVE-2009-3736. 2010-03-01 18:43:38 +00:00
ltmain.sh Update bundled libltdl (libtool) to version 2.2.6b to address CVE-2009-3736. 2010-03-01 18:43:38 +00:00

README

Hamlib - (C) Frank Singleton 2000 (vk3fcs@ix.netcom.com)
         (C) Stephane Fillod 2000-2011
         (C) The Hamlib Group 2000-2011

The purpose of this project is to provide stable, flexible, shared libraries
that enable quicker development of Amateur Radio Equipment Control
Applications.

Many Amateur Radio Transceivers come with serial interfaces that allows
software to control the radio. This project will endeavour to provide shared
libraries that greatly simplify the application programmer's interaction
with radio equipment and other controllable devices such as rotators,
switches, etc.

Supported Radios
----------------

The Hamlib Wiki page, Supported Radios, contains a snapshot of the supported
radio at the time of the last Hamlib release.  Go to http://www.hamlib.org
to reach the Wiki.

Hamlib Design
-------------

The shared libs will provide functions for both radio control,
and data retrieval from the radio.

The structure of the libraries will be as follows.

(1)  There will be 1 frontend library "libhamlib" that
     provides the generic API for user applications.

(2)  There will be "n" backend libraries that "wrap"
     rig specific communications inside frontend API.

(3)  Frontend lib will load (on demand) the appropriate
     backend lib as required.

Frontend Library
----------------

libhamlib.so -  frontend lib that provides generic API
                for all RIG types. This is what Application
                programmers will "see".

Backend Examples are:
---------------------

1.hamlib-yaesu.so will provide connectivity to Yaesu
  FT 747GX Transceiver, FT 847 "Earth Station", etc. via a standard API.

2. hamlib-xxxx.so will provide connectivity to the Wiz-bang
   moon-melter 101A (yikes..)

Hamlib will also enable developers to develop professional looking GUI's
towards a standard control library API, and they would not have to worry
about the underlying connection towards physical hardware.

Initially serial (RS232) connectivity will be handled, but we expect that IP
(and other) connectivity will follow afterwards.  Connection via a USB port
is accomplished via the Linux kernel support.  USB to serial converters are
well supported.  Other such devices may be supported as long as they present
a serial (RS-232) interface to Hamlib.

Recompiling
-----------

Hamlib is entirely developed using GNU tools, under various Linux systems.
That is, if you want to take part in the development of Hamlib, you'll need
at least the following tools:
    * autoconf > 2.54
    * automake > 1.7
    * libtool  >= 2.2.6b
    * doxygen
    * svn and ssh to connect to http://sourceforge.net/

There are also the README.betatester and README.developer files in this
directory if you feel like testing or hacking Hamlib.  Otherwise,
contributions of rig specifications and protocol documentation are highly
encouraged.  Do keep in mind that in some cases the manufacturer may not
provide complete control information or it is only available under a
Non-Disclosure Agreement (NDA).  Any documentation *must* be publicly
available so we can legally write and distribute Free Software supporting a
given device.

However, if you just want to recompile the library, please refer to the
INSTALL and README.betatester files.

IMPORTANT: If autoconf or automake are installed on your system, make sure
they are matching *at least* the version shown above.  The Hamlib team is
very interested to hear from you, how Hamlib builds and works on your
system, especially on non-Linux system or non-PC systems. We try to make
Hamlib as portable as possible.

Please report in case of problems at hamlib-developer@lists.sourceforge.net
Patches in unified diff format are welcome too!

Most distributions have the latest Hamlib release in their testing or alpha
versions of their distribution.  Check your package manager for the Hamlib
version included in your distribution.

Take a look at tests/README for more info on simple programming examples and
test programs.

Also, take a look at http://sourceforge.net/projects/hamlib/ Here you will
find a mail list, and the latest releases.  Feedback, questions, etc. about
Hamlib are very welcome at the mail list:
<hamlib-developer@lists.sourceforge.net>

Have Fun / Frank S / Stephane F / The Hamlib Group

  73's de vk3fcs/km5ws / f8cfe