LIbrary for Amateur Radio Equipment Control Applications.
 
 
 
 
 
 
Go to file
Thomas Beierlein, DL1JBE 21688d442d Changed backend status to RIG_STATUS_BETA to reflect stable work of the rig for most commands.
git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@2416 7ae35d74-ebe9-4afe-98af-79ac388436b8
2008-10-25 08:51:43 +00:00
alinco
aor implemented scanning 2008-04-11 17:10:45 +00:00
bindings fix for gcc warnings: dereferencing type-punned pointer will break strict-aliasing rules" 2008-06-26 15:23:06 +00:00
c++
debian another debian update: use 'make distclean' in the rules file 2007-11-29 20:47:52 +00:00
doc
drake
dummy new backend ala rpcrig/rpcrot, but using rigctld/rotctld and simpler protocol 2008-09-21 19:34:16 +00:00
easycomm
flexradio prevent invalid free() in cleanup 2008-05-07 22:18:25 +00:00
fodtrack
gnuradio
gs232a added GS-232A rotator controller 2008-05-23 14:14:17 +00:00
icom Changed backend status to RIG_STATUS_BETA to reflect stable work of the rig for most commands. 2008-10-25 08:51:43 +00:00
include Newer Uniden models 2008-10-06 18:16:35 +00:00
jrc
kachina
kenwood new backend for the Elekraft K3 2008-09-01 19:01:13 +00:00
kit url of the kit 2008-04-26 09:00:30 +00:00
kylix
lib
libltdl
lowe
macros
microtune
miniVNA Initial release 2008-03-05 20:31:09 +00:00
pcr
perl
racal
rft
rotorez
rpcrig Many man page updates to provide needed information and (hopefully) 2007-02-24 20:24:34 +00:00
rpcrot Many man page updates to provide needed information and (hopefully) 2007-02-24 20:24:34 +00:00
sartek
skanti
src accept partial 'pathname' for PORT_NETWORK 2008-09-23 22:02:40 +00:00
tapr
tentec Switch back to ASCII freq. setting because of hardware(?) bug. 2008-06-19 04:26:52 +00:00
tests restrict listening IP address 2008-09-21 20:32:08 +00:00
tuner
uniden Add additional comments for improved reading. 2008-10-22 04:11:28 +00:00
winradio fix memory access after freeing 2007-09-18 19:34:43 +00:00
wj
yaesu Support table of newcat, patch by Mark N1VQW 2008-09-22 21:34:45 +00:00
AUTHORS Add author. (credits info added to web page, also) 2008-06-11 17:53:47 +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 of 1.2.7.1 2008-04-11 18:18:38 +00:00
INSTALL Added info about `ldconfig' to INSTALL. 2008-01-12 00:36:58 +00:00
LICENSE Bump copyright year to 2008. 2008-01-04 17:43:36 +00:00
Makefile.am Added gs232a to Makefile.am DIST_SUBDIRS variable 2008-06-20 03:11:41 +00:00
NEWS Update for 1.2.7.1 release 2008-04-11 17:58:35 +00:00
PLAN
README Bump copyright year to 2008. 2008-01-04 17:43:36 +00:00
README.betatester Bump copyright year to 2008. 2008-01-04 17:43:36 +00:00
README.developer Added gs232a to Makefile.am DIST_SUBDIRS variable 2008-06-20 03:11:41 +00:00
README.release some more fixes 2008-02-18 21:17:32 +00:00
README.win32
Segfault-award
THANKS minor changes 2008-07-14 01:31:55 +00:00
TODO
TODO.skeleton
autogen.sh
configure.ac added GS-232A rotator controller 2008-05-23 14:14:17 +00:00
cvs2cl.pl
hamlib.m4
hamlib.pc.in
hamlib.spec.in
ltmain.sh

README

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

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.

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
I expect that IP (and other) connectivity will follow afterwards. 

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

Hamlib is entirely developped 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.50
	* automake > 1.7
	* libtool  > 1.5
	* doxygen
	* cvs 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 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 publically 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 file. 

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!

And for those who were brave enough to read until here, but not lucky enough
to rebuild the lib, there is good news. The RPM and deb packages are
available at the sourceforge.net site. Enjoy!

Take a look at tests/README for more info on simple examples.

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

Have Fun / Frank S / Stephane F

  73's de vk3fcs/km5ws / f8cfe