LIbrary for Amateur Radio Equipment Control Applications.
 
 
 
 
 
 
Go to file
Nate Bargmann, N0NB 50a0449dcd Add Hamlib Group to Copyright line.
git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@2222 7ae35d74-ebe9-4afe-98af-79ac388436b8
2007-10-15 00:50:53 +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 status: alpha->beta 2007-09-18 19:31:56 +00:00
bindings Revert change in bindings/Makefile.am that broke autogen.sh 2007-01-27 02:14:00 +00:00
c++ drop the release version from shared library name 2006-03-06 23:02:38 +00:00
debian sync with latest debian release 2005-01-28 19:14:36 +00:00
doc distribute footer.html 2007-01-31 20:36:51 +00:00
drake - Cast/change unsigned char to char in order to fix compile warnings. 2006-10-07 17:56:26 +00:00
dummy Added RIT, XIT and IF shift ranges to dummy backend. 2006-07-02 17:05:26 +00:00
easycomm - Cast/change unsigned char to char in order to fix compile warnings. 2006-10-07 19:00:05 +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 IC910H has different meaning of command 1A, subcommand 03. So we should not ask for DSP filter settings in 'icom_get_mode'. 2007-03-05 09:01:03 +00:00
include new model ELEKTOR507 (SDR USB) 2007-09-18 19:33:00 +00:00
jrc - Cast/change unsigned char to char in order to fix compile warnings. 2006-10-07 17:51:00 +00:00
kachina - Cast unsigned char to char in order to avoid compiler warnings. 2006-10-07 17:42:14 +00:00
kenwood fixed bug in kenwood_transaction() 2007-09-04 15:01:23 +00:00
kit new backend elektor 5/07 (SDR USB) 2007-10-07 20:31:24 +00:00
kylix 20060718: 2006-07-18 23:06:44 +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 - Cast/change unsigned char to char in order to fix compile warnings. 2006-10-07 18:01:31 +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 Use tone_t for pcr1_ctcss_list. Changed arg 4 of pcr_transaction to unsigned. Cast the other mismatches to (char *). 2006-10-07 16:42:19 +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 - Cast/change unsigned char to char in order to fix compile warnings. 2006-10-07 19:00:05 +00:00
rotorez - Cast/change unsigned char to char in order to fix compile warnings. 2006-10-07 19:08:46 +00:00
rpcrig Many man page updates to provide needed information and (hopefully) 2007-02-24 20:24:34 +00:00
rpcrot Many man page updates to provide needed information and (hopefully) 2007-02-24 20:24:34 +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 * call missing usb_find_devices() 2007-10-07 20:12:36 +00:00
tapr - Cast/change unsigned char to char in order to fix compile warnings. 2006-10-07 19:00:05 +00:00
tentec use binary mode VFO requests 2007-03-02 16:29:11 +00:00
tests Dead simple sample Hamlib program 2007-09-04 21:53:40 +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 fix memory access after freeing 2007-09-18 19:34:43 +00:00
wj - Cast/change unsigned char to char in order to fix compile warnings. 2006-10-07 19:00:05 +00:00
yaesu Added support for the Yaesu FT-767GX. The following are implemented: 2007-10-05 04:19:18 +00:00
AUTHORS Added support for the Yaesu FT-767GX. The following are implemented: 2007-10-05 04:19:18 +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 Release of 1.2.6.2 2007-06-30 12:58:11 +00:00
INSTALL info on generating docs 2006-10-13 14:33:52 +00:00
LICENSE
Makefile.am add comment 2006-10-13 18:24:42 +00:00
NEWS Update NEWS and configure.ac for 1.2.6 release. 2006-12-22 13:52:45 +00:00
PLAN
README 20060710: 2006-07-10 16:15:12 +00:00
README.betatester 20061107: 2006-11-07 21:57:57 +00:00
README.developer Add Hamlib Group to Copyright line. 2007-10-15 00:50:53 +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
autogen.sh - These should have been commented out. 2007-02-15 12:50:04 +00:00
configure.ac - gt_HEADER_INTTYPES_H is definitely bogus here, leftover from what? 2007-02-13 22:32:47 +00:00
cvs2cl.pl
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-2006

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