LIbrary for Amateur Radio Equipment Control Applications.
 
 
 
 
 
 
Go to file
(no author) e0b82d8581 This commit was manufactured by cvs2svn to create tag 'HAMLIB-1-2-9'.
git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/tags/HAMLIB-1-2-9@2666 7ae35d74-ebe9-4afe-98af-79ac388436b8
2009-02-25 19:15:02 +00:00
alinco Cast unsigned char to char in order to avoid compiler warnings. Incremented backend version number. 2006-10-07 16:55:04 +00:00
aor implemented scanning 2008-04-11 17:10:45 +00:00
bindings Heathkit HD 1780 Intellirotor backend, by Rob Frohne, KL7NA 2009-01-20 19:44:04 +00:00
c++ drop the release version from shared library name 2006-03-06 23:02:38 +00:00
debian another debian update: use 'make distclean' in the rules file 2007-11-29 20:47:52 +00:00
doc distribute footer.html 2007-01-31 20:36:51 +00:00
drake fix error code in drake_set_mem() 2008-12-16 22:40:02 +00:00
dummy emulate rotator slowly rotating 2009-02-18 20:56:45 +00:00
easycomm - Cast/change unsigned char to char in order to fix compile warnings. 2006-10-07 19:00:05 +00:00
flexradio changed RIG_STATUS_NEW into RIG_STATUS_UNTESTED. 2008-10-26 13:38:51 +00:00
fodtrack renamed port_t as hamlib_port_t 2005-04-03 12:27:17 +00:00
gnuradio changed RIG_STATUS_NEW into RIG_STATUS_UNTESTED. 2008-10-26 13:38:51 +00:00
gs232a changed RIG_STATUS_NEW into RIG_STATUS_UNTESTED. 2008-10-26 13:38:51 +00:00
heathkit Heathkit HD 1780 Intellirotor backend, by Rob Frohne, KL7NA 2009-01-20 19:44:04 +00:00
icom bug in ic706_r2i_mode() 2009-02-20 14:20:23 +00:00
include set/get_split_{freq,mode} assisted by frontend 2009-02-20 14:14:31 +00:00
jrc added NRD-525 2009-02-18 22:51:47 +00:00
kachina - Cast unsigned char to char in order to avoid compiler warnings. 2006-10-07 17:42:14 +00:00
kenwood This commit was manufactured by cvs2svn to create tag 'HAMLIB-1-2-9'. 2009-02-25 19:15:02 +00:00
kit RIG_LEVEL_STRENGTH fix from Andrew Murphy 2008-12-09 22:07:21 +00:00
kylix 20060718: 2006-07-18 23:06:44 +00:00
lib fix DEBUG_VERBOSE code 2009-02-20 12:22:52 +00:00
libltdl build fix 2009-02-23 22:03:52 +00:00
lowe - Cast/change unsigned char to char in order to fix compile warnings. 2006-10-07 18:01:31 +00:00
macros Use newer version, to enable OpenSolaris to find the correct '-pthreads' switch. 2008-12-01 15:25:54 +00:00
microtune renamed port_t as hamlib_port_t 2005-04-03 12:27:17 +00:00
miniVNA Initial release 2008-03-05 20:31:09 +00:00
pcr support ANL through ext_level 2009-02-06 17:31:33 +00:00
perl deprecated, use swig bindings/ instead 2002-11-05 21:33:16 +00:00
racal fix warning with old compilers 2009-02-23 21:53:51 +00:00
rft new URL for documentation 2009-02-20 12:23:46 +00:00
rotorez enumaration of backend tokens 2009-01-25 16:14:39 +00:00
rpcrig changed to RIG_STATUS_BETA 2008-10-31 22:14:10 +00:00
rpcrot changed to RIG_STATUS_BETA 2008-10-31 22:14:10 +00:00
sartek - Cast/change unsigned char to char in order to fix compile warnings. 2006-10-07 19:08:46 +00:00
skanti reflect backend change 2005-04-10 21:57:13 +00:00
src set/get_split_{freq,mode} assisted by frontend 2009-02-20 14:14:31 +00:00
tapr - Cast/change unsigned char to char in order to fix compile warnings. 2006-10-07 19:00:05 +00:00
tentec increase version number 2009-02-20 15:21:52 +00:00
tests copyright year 2009-02-20 12:26:13 +00:00
tuner typo 2004-09-25 14:33:52 +00:00
uniden Add additional comments for improved reading. 2008-10-22 04:11:28 +00:00
winradio remove double binding of dll symbol 2009-02-20 12:38:29 +00:00
wj - Cast/change unsigned char to char in order to fix compile warnings. 2006-10-07 19:00:05 +00:00
yaesu old compilers don't like mixed variable declaration and code 2009-02-23 21:52:56 +00:00
AUTHORS Added my call sign 2009-02-09 20:37:06 +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 for 1.2.9 release 2009-02-25 19:15:01 +00:00
INSTALL Made a comment that 'make check' needs an installed hamlib library. 2008-11-09 14:26:04 +00:00
LICENSE Bump copyright year to 2008. 2008-01-04 17:43:36 +00:00
Makefile.am do not distribute any more the gnuradio backend (out of date) 2009-01-24 13:33:49 +00:00
NEWS Update for 1.2.9 release 2009-02-25 19:15:01 +00:00
PLAN * cosmetic changes 2000-11-01 23:18:11 +00:00
README Bump copyright year to 2008. 2008-01-04 17:43:36 +00:00
README.betatester Documentation updates. 2009-01-09 23:03:37 +00:00
README.developer Made a comment that 'make check' needs an installed hamlib library. 2008-11-09 14:26:04 +00:00
README.release details, new sf upload method 2008-12-14 19:25:50 +00:00
README.win32 Updated to reflect recent changes within v1.2.2cvs-2 2004-08-17 23:01:17 +00:00
Segfault-award typo fixed 2002-09-30 14:55:25 +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 - These should have been commented out. 2007-02-15 12:50:04 +00:00
configure.ac Update for 1.2.9 release 2009-02-25 19:15:01 +00:00
cvs2cl.pl Initial import for ChangeLog handling 2001-02-01 00:20:12 +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
ltmain.sh Debian libtool-1.5.6-6 update 2005-04-03 21:40:24 +00:00

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