LIbrary for Amateur Radio Equipment Control Applications.
 
 
 
 
 
 
Go to file
Stéphane Fillod, F8CFE 51ea94cdb5 removed autogenerated files, use autogen.sh instead
git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@1088 7ae35d74-ebe9-4afe-98af-79ac388436b8
2002-07-02 18:03:25 +00:00
alinco removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
aor removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
c++ removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
debian initial release 2001-07-21 13:10:12 +00:00
doc removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
dummy removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
easycomm removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
icom removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
include removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
jrc removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
kachina removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
kenwood removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
kylix removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
lib removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
libltdl updated to libtool-1.4.2-6 2002-06-17 20:59:09 +00:00
pcr removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
perl removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
rpcrig removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
rpcrot removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
src removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
tcl removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
tentec removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
tests removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
uniden removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
winradio removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
yaesu removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
AUTHORS thanks to all of you guys 2002-05-28 21:43:28 +00:00
COPYING file creation, basically scratch notes 2000-09-14 00:48:00 +00:00
COPYING.LIB converted to LGPL 2001-07-14 10:16:10 +00:00
ChangeLog regenerated for 1.1.2 2001-09-23 11:03:28 +00:00
INSTALL new install notes, ala autoconf 2000-11-04 21:37:27 +00:00
LICENSE converted to LGPL 2001-07-14 10:16:10 +00:00
Makefile.am added early perl binding 2002-02-09 21:55:45 +00:00
NEWS 1.1.3 release 2002-06-17 20:51:16 +00:00
PLAN * cosmetic changes 2000-11-01 23:18:11 +00:00
README misc update before release 2002-06-17 20:52:48 +00:00
README.betatester misc addition 2002-05-28 21:39:13 +00:00
README.developer much needed update on lib arch 2002-05-28 21:28:15 +00:00
THANKS misc 2002-06-17 20:59:51 +00:00
TODO misc update before 1.1.2 2001-09-23 10:40:26 +00:00
TODO.skeleton Initial revision 2000-07-18 20:55:08 +00:00
acinclude.m4 updated to libtool-1.4.2-6 2002-06-17 20:59:09 +00:00
aclocal.m4 updated to libtool-1.4.2-6 2002-06-17 20:59:09 +00:00
autogen.sh Initial release 2002-07-01 22:11:24 +00:00
compile Initial revision from automake-1.5 2001-12-16 11:04:42 +00:00
config.guess updated scripts to 20020320.1 2002-05-14 21:53:51 +00:00
config.sub updated scripts to 20020320.1 2002-05-14 21:53:51 +00:00
configure.ac disabled perl default building, and also changes to make autoconf-2.53 happy 2002-05-28 21:32:26 +00:00
cvs2cl.pl Initial import for ChangeLog handling 2001-02-01 00:20:12 +00:00
depcomp Initial release 2001-10-07 21:42:13 +00:00
hamlib.m4 cloned from Alsa project, still not thouroughly tested 2002-05-28 21:33:10 +00:00
hamlib.spec.in preliminary work for 1.1.3 release 2002-06-17 21:00:32 +00:00
install-sh Initial release 2000-10-01 12:52:17 +00:00
ltmain.sh updated to libtool-1.4.2-6 2002-06-17 20:59:09 +00:00
missing upgraded to libtool-1.4.2 2001-09-19 21:33:48 +00:00
mkinstalldirs Initial release 2000-10-01 12:52:17 +00:00

README

hamlib - (C) Frank Singleton 2000 (vk3fcs@ix.netcom.com)
and (C) Stephane Fillod 2000-2002

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 programmers interaction with radio equipment.
 

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.libhamlib-yaesu.so will provide connectivity to Yaesu
  FT 747GX Transceiver, FT 847 "Earth Station", etc. via a standard API.

2. libhamlib-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.5
	* libtool  > 1.4.2
	* doxygen
	* cvs and ssh to connect to http://sourceforge.net/

There's also a README.betatester and README.developer files in this directory
if you feel like hacking hamlib.

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 then, but not lucky enough
to rebuild the lib, there're 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