LIbrary for Amateur Radio Equipment Control Applications.
 
 
 
 
 
 
Go to file
Nate Bargmann, N0NB 1d307be4b5 Update several developers who were not listed.
git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@3018 7ae35d74-ebe9-4afe-98af-79ac388436b8
2011-01-11 00:13:45 +00:00
alinco Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
aor Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +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++ more example code 2010-04-05 10:10:16 +00:00
doc distribute footer.html 2007-01-31 20:36:51 +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 Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +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 Patch from SF user rolfm adding support for the FiFi-SDR, an Si570 2010-12-27 15:20:29 +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 Modify test for K2 and K3 in elecraft_open() 2010-12-06 23:53:50 +00:00
kit Patch from SF user rolfm adding support for the FiFi-SDR, an Si570 2010-12-27 15:20:29 +00:00
kylix 20060718: 2006-07-18 23:06:44 +00:00
lib mingw portability 2010-05-05 19:55:13 +00:00
libltdl Update bundled libltdl (libtool) to version 2.2.6b to address CVE-2009-3736. 2010-03-01 18:43:38 +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 Fix build --with-python-binding breakage introduced by Python 2.6: 2010-06-09 20:00:50 +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 Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +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 Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
rpcrig Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
rpcrot Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +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 Move backend libraries into /usr/lib/hamlib directory. 2010-09-26 02:23:50 +00:00
src - Clear MSB of data read on 7-bit serial port, 2010-10-29 07:50:57 +00: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 Improve description of -t command option and w command and provided 2010-12-09 01:27:50 +00: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 Correct long standing bugs where hardware handshake was not the default 2010-12-05 23:46:03 +00:00
AUTHORS Update several developers who were not listed. 2011-01-11 00:13:45 +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 release 1.2.12 2010-09-03 21:21:53 +00:00
INSTALL Made a comment that 'make check' needs an installed hamlib library. 2008-11-09 14:26:04 +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 release 1.2.12 2010-09-03 21:21:53 +00:00
PLAN * cosmetic changes 2000-11-01 23:18:11 +00:00
README Update copyright date. Revise documents as needed for Wiki. 2010-01-28 22:44:56 +00:00
README.betatester Document that Swig bindings for Perl and Python are no longer built 2010-04-16 22:14:10 +00:00
README.developer Update required and optional package names and presence tests. 2010-12-24 23:06:22 +00:00
README.release misc cleanup 2010-08-23 21:44:34 +00:00
README.win32 Updated to reflect recent changes within v1.2.2cvs-2 2004-08-17 23:01:17 +00:00
Segfault-award fix segfault and allow mode listing in rigctl 2010-04-05 10:01:09 +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 Fix echo command for embedded newline. 2010-03-11 23:24:41 +00:00
configure.ac added TRM8060 2010-10-26 20:47:35 +00:00
hamlib.m4 added quoting for newer autoconf [supplied by Thomas Klausner] 2005-09-28 21:07:59 +00:00
hamlib.pc.in initial release 2002-10-07 21:37:40 +00:00
hamlib.spec.in extend API to support save/load memory at once 2005-04-20 14:44:04 +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-2007
         (C) The Hamlib Group 2000-2010

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  > 1.5|2.2.6
    * 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 interrested 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 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