LIbrary for Amateur Radio Equipment Control Applications.
 
 
 
 
 
 
Go to file
Stéphane Fillod, F8CFE f3a54f143b quote definitions to make automake-1.9 happy
git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@2080 7ae35d74-ebe9-4afe-98af-79ac388436b8
2006-02-26 19:37:20 +00:00
alinco reflect backend change 2005-04-10 21:57:13 +00:00
aor filter fix after Rolf Wernli suggestion 2006-02-26 19:21:53 +00:00
bindings example how to change baud rate 2006-02-20 22:40:26 +00:00
c++ follow frontend ABI version 2004-02-09 22:05:51 +00:00
debian sync with latest debian release 2005-01-28 19:14:36 +00:00
doc add some Internet links, fixes Debian Bug#263287 2004-08-09 20:55:31 +00:00
drake reflect backend change 2005-04-10 21:57:13 +00:00
dummy Prefixed misc str* and parse_* calls with rig_ to export them in rig.h 2004-05-17 21:09:45 +00:00
easycomm Patch from Luc Langehegermann: 2005-11-19 14:45:54 +00:00
flexradio renamed port_t as hamlib_port_t 2005-04-03 12:27:17 +00:00
fodtrack renamed port_t as hamlib_port_t 2005-04-03 12:27:17 +00:00
gnuradio Prefixed misc str* and parse_* calls with rig_ to export them in rig.h 2004-05-17 21:09:45 +00:00
icom change status 2006-02-26 19:22:31 +00:00
include values passed to rig_set_mem_all are supposed to be constant 2006-01-15 14:23:16 +00:00
jrc Added missing manual notch switch for the NRD-545 2005-05-04 20:57:52 +00:00
kachina initial support for raw S-Meter reading 2004-11-15 18:51:37 +00:00
kenwood misc 2006-02-26 19:23:31 +00:00
kit usb.h to needed for the DWT 2006-01-09 21:40:17 +00:00
kylix removed autogenerated files, use autogen.sh instead 2002-07-02 18:03:25 +00:00
lib Fixes for BRK/RTS/DTR handling under win32 2004-08-01 23:13:17 +00:00
libltdl dummy check-in to make timestamps past aclocal.m4 2005-04-04 22:00:54 +00:00
lowe reflect backend change 2005-04-10 21:57:13 +00:00
macros quote definitions to make automake-1.9 happy 2006-02-26 19:37:20 +00:00
microtune renamed port_t as hamlib_port_t 2005-04-03 12:27:17 +00:00
pcr reflect backend change 2005-04-10 21:57:13 +00:00
perl deprecated, use swig bindings/ instead 2002-11-05 21:33:16 +00:00
racal Initial release 2004-09-12 21:30:21 +00:00
rft reflect backend change 2005-04-10 21:57:13 +00:00
rotorez include fixup, stdio.h is not included by rig.h anymore 2003-10-01 19:32:04 +00:00
rpcrig cleanup 2006-01-09 21:41:39 +00:00
rpcrot Added missing symbol for MacOSX, patch by Marv 2005-03-28 09:37:24 +00:00
sartek include fixup, stdio.h is not included by rig.h anymore 2003-10-01 19:32:04 +00:00
skanti reflect backend change 2005-04-10 21:57:13 +00:00
src bump (c) date 2006-02-26 19:30:49 +00:00
tapr added skelton for new backends: tapr(DSP10) and rft(EKD500). 2003-10-07 22:15:49 +00:00
tentec Added Orion, Orion 2 info 2006-02-26 19:18:54 +00:00
tests bump (c) date 2006-02-26 19:30:49 +00:00
tuner typo 2004-09-25 14:33:52 +00:00
uniden fix proprer read_string() return code error handling 2005-04-10 21:47:14 +00:00
winradio correct SignalStrength computation and function pointer types 2004-08-23 19:48:41 +00:00
wj fix error code return convention, which is negative when failed 2005-04-10 21:49:38 +00:00
yaesu Fixed bug in ft990_set_mode that caused RTTY interchanged modes USB/LSB 2006-02-26 06:25:32 +00:00
AUTHORS welcome to Lars 2006-02-26 19:31:56 +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, release update 2003-04-28 06:56:36 +00:00
INSTALL Win32 notes 2004-02-08 17:39:38 +00:00
LICENSE converted to LGPL 2001-07-14 10:16:10 +00:00
Makefile.am added racal,wj and tuner backends 2004-09-12 21:27:16 +00:00
NEWS 1.2.4 release 2005-04-03 22:10:55 +00:00
PLAN * cosmetic changes 2000-11-01 23:18:11 +00:00
README updates before release 2003-04-28 06:34:58 +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 select optimization level and debugging for dev 2005-04-10 21:55:27 +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 misc 2002-06-17 20:59:51 +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 grr 2002-11-28 22:45:10 +00:00
configure.ac make libusb usage optional 2005-11-19 14:41:37 +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)
and (C) Stephane Fillod 2000-2003

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.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'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