LIbrary for Amateur Radio Equipment Control Applications.
 
 
 
 
 
 
Go to file
Stéphane Fillod, F8CFE 484235b463 doxygen fixes
git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@1459 7ae35d74-ebe9-4afe-98af-79ac388436b8
2003-04-27 22:15:06 +00:00
alinco * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
aor * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
bindings VPATH build fix, tcl build fix 2003-04-23 22:17:19 +00:00
c++ Adopt new split_vfo handling. Basically, rename set_split/get_split 2003-04-06 18:40:36 +00:00
debian fix the debian build script, new maintainer 2003-04-20 18:39:47 +00:00
doc 2003-04-04: 2003-04-05 04:13:53 +00:00
drake * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
dummy * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
easycomm * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
fodtrack * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
gnuradio * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
icom OS456 has no passband data in set_mode/get_mode 2003-04-26 09:54:49 +00:00
include doxygen fixes 2003-04-27 22:15:06 +00:00
jrc * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
kachina * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
kenwood * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
kylix removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
lib portability fixes, will have to better fix the getopt_long 2002-10-31 00:16:17 +00:00
libltdl upgrade to libtool 1.5 2003-04-19 13:47:57 +00:00
macros upgrade libtool-1.5 2003-04-23 20:57:27 +00:00
microtune * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
pcr * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
perl deprecated, use swig bindings/ instead 2002-11-05 21:33:16 +00:00
rotorez * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
rpcrig Tell rpcgen to generate code in ANSI C, with conventional stub names 2003-04-23 21:05:39 +00:00
rpcrot Tell rpcgen to generate code in ANSI C, with conventional stub names 2003-04-23 21:05:39 +00:00
src doxygen fixes 2003-04-27 22:15:06 +00:00
tentec * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
tests misc fixes 2003-04-07 20:54:18 +00:00
uniden * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
winradio * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
yaesu * added ABI VERSION to backend entry point symbol name 2003-04-16 22:30:43 +00:00
AUTHORS added Michael 2003-04-10 18:25:06 +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 microtune backend 2003-01-29 23:04:05 +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 more info on autogen.sh, moved cvs checkout info from README.betatester to README.developer 2002-10-29 22:14:58 +00:00
README.developer 2002-11-30 2002-12-01 03:35:14 +00:00
Segfault-award typo fixed 2002-09-30 14:55:25 +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
autogen.sh grr 2002-11-28 22:45:10 +00:00
configure.ac re-enable c++ binding, fix tcl build, bindings build requires perl *and* tcl 2003-04-23 22:15:25 +00:00
cvs2cl.pl Initial import for ChangeLog handling 2001-02-01 00:20:12 +00:00
hamlib.m4 cloned from Alsa project, still not thouroughly tested 2002-05-28 21:33:10 +00:00
hamlib.pc.in initial release 2002-10-07 21:37:40 +00:00
hamlib.spec.in a working spec file 2003-01-15 19:42:22 +00:00
ltmain.sh upgrade to libtool 1.5 2003-04-19 13:47:57 +00:00
missing updated to automake-1.7 2002-10-29 22:38:04 +00:00
mkinstalldirs updated to automake-1.7 2002-10-29 22:38:04 +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