LIbrary for Amateur Radio Equipment Control Applications.
 
 
 
 
 
 
Go to file
Stéphane Fillod, F8CFE cf781224f4 misc doxygen fix
git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@1250 7ae35d74-ebe9-4afe-98af-79ac388436b8
2002-11-04 22:37:53 +00:00
alinco libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
aor libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
bindings VPATH build, avoid version on modules 2002-11-04 22:16:19 +00:00
c++ bump version info, testcpp is TEST 2002-11-04 22:17:48 +00:00
debian
doc split rig.c 2002-11-04 22:22:30 +00:00
drake libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
dummy added mem_cap, missing filters, and first dummy level_gran 2002-11-04 22:36:57 +00:00
easycomm libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
gnuradio libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
icom remove icall, added mem_cap initializer 2002-11-04 22:26:49 +00:00
include * added VFO_UPLINK and VFO_DOWNLINK (backend-wise) aliases 2002-11-04 22:32:09 +00:00
jrc libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
kachina libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
kenwood libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +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 updated to libtool-1.4.3 2002-10-29 22:13:45 +00:00
macros missed 2002-10-29 22:18:20 +00:00
pcr libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
perl implemented more calls 2002-08-26 22:31:44 +00:00
rpcrig libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
rpcrot libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
src misc doxygen fix 2002-11-04 22:37:53 +00:00
tcl WARNING: renamed strmode to strrmode because the symbol is already in use on BSD systems 2002-08-26 21:26:06 +00:00
tentec libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
tests dump chan_caps 2002-11-04 22:28:46 +00:00
uniden libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
winradio libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
yaesu libhamlib-backend.so.x.y.z -> hamlib-backend.so, avoid version info for modules 2002-11-04 22:19:31 +00:00
AUTHORS thanks to all of you guys 2002-05-28 21:43:28 +00:00
COPYING
COPYING.LIB
ChangeLog
INSTALL
LICENSE
Makefile.am tcl and perl subdir are gone in favor of bindings, added pkg support, fixed from gnuradio stuff 2002-10-07 21:40:34 +00:00
NEWS 1.1.3 release 2002-06-17 20:51:16 +00:00
PLAN
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 more info on autogen.sh, moved cvs checkout info from README.betatester to README.developer 2002-10-29 22:14:58 +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
TODO.skeleton
acinclude.m4 updated to libtool-1.4.3 2002-10-29 22:26:33 +00:00
autogen.sh customize the script to your own needs! 2002-10-29 22:43:39 +00:00
configure.ac * libhamlib-backend.so.x.y.z -> hamlib-backend.so 2002-11-04 22:14:36 +00:00
cvs2cl.pl
hamlib.m4
hamlib.pc.in initial release 2002-10-07 21:37:40 +00:00
hamlib.spec.in preliminary work for 1.1.3 release 2002-06-17 21:00:32 +00:00
install-sh updated to automake-1.7 2002-10-29 22:38:04 +00:00
ltmain.sh updated to libtool-1.4.3 2002-10-29 22:13:45 +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