2002-05-28 21:28:15 +00:00
|
|
|
Hamlib - (C) Frank Singleton 2000 (vk3fcs@ix.netcom.com)
|
2008-01-04 17:43:36 +00:00
|
|
|
(C) Stephane Fillod 2000-2007
|
|
|
|
(C) The Hamlib Group 2000-2008
|
2000-07-18 21:09:51 +00:00
|
|
|
|
2000-08-20 21:52:27 +00:00
|
|
|
Take a look at http://sourceforge.net/projects/hamlib/
|
2002-05-28 21:28:15 +00:00
|
|
|
Here you will find a mail list, and the latest CVS releases.
|
2000-08-20 21:52:27 +00:00
|
|
|
|
2000-09-24 02:19:42 +00:00
|
|
|
See README for frontend/backend outline.
|
|
|
|
|
2000-07-18 21:09:51 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
The shared libs provide functions for both radio control,
|
|
|
|
and data retrieval from the radio.
|
2000-07-18 21:16:49 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
The structure of the libraries is as follows.
|
2000-07-18 21:16:49 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
(1) There is one frontend library "libhamlib" that
|
|
|
|
provides the generic API for user applications.
|
2000-07-18 21:16:49 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
(2) There are "n" backend libraries that "wrap"
|
|
|
|
rig specific communications inside frontend API.
|
2000-07-18 21:16:49 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
(3) Frontend lib loads (on demand) the appropriate
|
|
|
|
backend lib as required.
|
2000-07-18 21:19:57 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
Frontend Library
|
|
|
|
----------------
|
2000-07-18 21:19:57 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
libhamlib.so - frontend lib that provides generic API
|
|
|
|
for all RIG types. This is what Application
|
|
|
|
programmers will "see".
|
2000-08-20 21:52:27 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
Backend Examples are:
|
|
|
|
---------------------
|
|
|
|
|
2003-04-28 06:34:58 +00:00
|
|
|
1.hamlib-yaesu.so will provide connectivity to Yaesu
|
2002-05-28 21:28:15 +00:00
|
|
|
FT 747GX Transceiver, FT 847 "Earth Station", etc. via a standard API.
|
2000-09-24 02:19:42 +00:00
|
|
|
|
2003-04-28 06:34:58 +00:00
|
|
|
2. hamlib-xxxx.so will provide connectivity to the Wiz-bang
|
2002-05-28 21:28:15 +00:00
|
|
|
moon-melter 101A (yikes..)
|
2000-08-20 21:52:27 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
Hamlib also enables 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
|
2006-11-07 21:57:57 +00:00
|
|
|
I expect that IP, USB, and other connectivity will follow afterwards.
|
2000-08-20 21:52:27 +00:00
|
|
|
|
2000-09-24 02:19:42 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
General Guidelines.
|
|
|
|
-------------------
|
2000-09-24 02:19:42 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
0. The top level directory looks like this as of 06 Jan 2008
|
|
|
|
(Note, it has grown considerably).
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
~/test/hamlib $ tree -d -I CVS
|
|
|
|
.
|
2002-05-28 21:28:15 +00:00
|
|
|
|-- alinco
|
|
|
|
|-- aor
|
2003-04-28 06:34:58 +00:00
|
|
|
|-- bindings
|
2002-05-28 21:28:15 +00:00
|
|
|
|-- c++
|
|
|
|
|-- debian
|
|
|
|
|-- doc
|
|
|
|
| `-- sgml
|
2003-04-28 06:34:58 +00:00
|
|
|
|-- drake
|
2002-05-28 21:28:15 +00:00
|
|
|
|-- dummy
|
|
|
|
|-- easycomm
|
2008-01-06 14:38:37 +00:00
|
|
|
|-- flexradio
|
2003-04-28 06:34:58 +00:00
|
|
|
|-- fodtrack
|
|
|
|
|-- gnuradio
|
2002-05-28 21:28:15 +00:00
|
|
|
|-- icom
|
|
|
|
|-- include
|
|
|
|
| `-- hamlib
|
|
|
|
|-- jrc
|
|
|
|
|-- kachina
|
|
|
|
|-- kenwood
|
2008-01-06 14:38:37 +00:00
|
|
|
|-- kit
|
2002-05-28 21:28:15 +00:00
|
|
|
|-- kylix
|
|
|
|
| `-- tests
|
|
|
|
|-- lib
|
|
|
|
|-- libltdl
|
2008-01-06 14:38:37 +00:00
|
|
|
|-- lowe
|
2003-04-28 06:34:58 +00:00
|
|
|
|-- macros
|
|
|
|
|-- microtune
|
2002-05-28 21:28:15 +00:00
|
|
|
|-- pcr
|
2008-01-06 14:38:37 +00:00
|
|
|
|-- perl
|
|
|
|
|-- racal
|
|
|
|
|-- rft
|
2003-04-28 06:34:58 +00:00
|
|
|
|-- rotorez
|
2002-05-28 21:28:15 +00:00
|
|
|
|-- rpcrig
|
|
|
|
|-- rpcrot
|
2008-01-06 14:38:37 +00:00
|
|
|
|-- sartek
|
|
|
|
|-- skanti
|
2002-05-28 21:28:15 +00:00
|
|
|
|-- src
|
2008-01-06 14:38:37 +00:00
|
|
|
|-- tapr
|
2002-05-28 21:28:15 +00:00
|
|
|
|-- tentec
|
|
|
|
|-- tests
|
2008-01-06 14:38:37 +00:00
|
|
|
| |-- config
|
|
|
|
| |-- rigctl.test
|
|
|
|
| |-- testbcd.test
|
|
|
|
| |-- testfreq.test
|
|
|
|
| `-- testloc.test
|
|
|
|
|-- tuner
|
2002-05-28 21:28:15 +00:00
|
|
|
|-- uniden
|
|
|
|
|-- winradio
|
|
|
|
| `-- linradio
|
2008-01-06 14:38:37 +00:00
|
|
|
|-- wj
|
2002-05-28 21:28:15 +00:00
|
|
|
`-- yaesu
|
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
51 directories
|
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2002-09-10 06:43:05 +00:00
|
|
|
1. Building
|
2002-10-29 22:14:58 +00:00
|
|
|
|
|
|
|
If you just want to recompile the library, please refer
|
2006-07-10 16:15:12 +00:00
|
|
|
to the INSTALL file. This document introduces hacking the code of Hamlib.
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
|
2002-10-29 22:14:58 +00:00
|
|
|
1.1 Obtaining sources: anonymous (pserver) cvs checkout
|
|
|
|
|
2006-07-10 04:01:15 +00:00
|
|
|
cvs -d:pserver:anonymous@hamlib.cvs.sourceforge.net:/cvsroot/hamlib login
|
|
|
|
cvs -z3 -d:pserver:anonymous@hamlib.cvs.sourceforge.net:/cvsroot/hamlib co -P hamlib
|
2002-10-29 22:14:58 +00:00
|
|
|
|
|
|
|
When prompted for a password for anonymous, simply press the Enter key.
|
2006-11-07 21:57:57 +00:00
|
|
|
The check out has only to be done the first time.
|
2006-07-10 16:15:12 +00:00
|
|
|
|
2002-10-29 22:14:58 +00:00
|
|
|
After the initial retrieval, whenever you want to update your local
|
|
|
|
version, issue the following command in the root directory of hamlib.
|
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
cvs -z3 update -Pd
|
|
|
|
|
|
|
|
This provides a level of data compression (values are from 0, off, to 9, full,
|
|
|
|
feel free to experiment) deletes empty directories (yes some do exist :-) )
|
|
|
|
and adds any new directories added to the repository since your last
|
|
|
|
checkout.
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
|
2005-03-25 22:27:32 +00:00
|
|
|
1.1.1 Obtaining more info on CVS
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2005-03-25 22:27:32 +00:00
|
|
|
Check out the sourceforge page at https://sourceforge.net/cvs/?group_id=8305
|
|
|
|
for more information about how to use the CVS repository of Hamlib.
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2006-12-10 14:41:35 +00:00
|
|
|
A CVS manual is online at http://ximbiot.com/cvs/manual/
|
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
|
2002-10-29 22:14:58 +00:00
|
|
|
1.2. Requirements
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
Hamlib is entirely developed using GNU tools, under various Linux systems.
|
2002-05-28 21:28:15 +00:00
|
|
|
Note that it is not restricted to Linux systems. We welcome anyone who
|
2006-11-07 21:57:57 +00:00
|
|
|
has access to a POSIXish system to port Hamlib. Contact us for help.
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
That is, if you want to take part in the development of Hamlib,
|
2002-10-29 22:14:58 +00:00
|
|
|
you'll need the following tools. Make sure you have at least the required
|
|
|
|
version or you won't even be able to build from the cvs checkout.
|
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
* Gnu C or any C99 compliant compiler # gcc --version
|
|
|
|
* Gnu make (or any modern one, BSD okay) # make --version
|
|
|
|
* autoconf 2.54 # autoconf --version
|
|
|
|
* automake 1.7 # automake --version
|
|
|
|
* libtool 1.5 # libtool --version
|
2005-03-25 22:27:32 +00:00
|
|
|
* cvs and ssh for connection to cvs.sourceforge.net
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
Optional:
|
2008-01-06 14:38:37 +00:00
|
|
|
* GNU C++ # g++ --version
|
|
|
|
* swig (for bindings) 1.3.14 # swig -version
|
|
|
|
* perl devel # h2xs
|
2002-10-29 22:14:58 +00:00
|
|
|
* tcl devel
|
2005-03-25 22:27:32 +00:00
|
|
|
* python devel
|
2008-01-06 14:38:37 +00:00
|
|
|
* libxml2 devel # xml2-config --version
|
2002-10-29 22:14:58 +00:00
|
|
|
* libgd devel
|
2007-09-03 03:34:45 +00:00
|
|
|
* libusb devel
|
2008-01-06 14:38:37 +00:00
|
|
|
* RPC devel (libc-dev) # rpcgen --version
|
2002-05-28 21:28:15 +00:00
|
|
|
|
|
|
|
Documentation:
|
2008-01-06 14:38:37 +00:00
|
|
|
* doxygen
|
|
|
|
* DocBook
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
Note: Some systems can have several versions of the autotools installed.
|
|
|
|
In that case, autoconf may be called "autoconf2.50", autoheader
|
|
|
|
"autoheader2.50", and automake "automake-1.7", aclocal "aclocal-1.7" or a
|
|
|
|
newer version.
|
2002-05-28 21:28:15 +00:00
|
|
|
|
|
|
|
IMPORTANT: If autoconf or automake are installed on your system,
|
|
|
|
make sure they are matching *at least* the version shown above.
|
2002-11-13 20:36:17 +00:00
|
|
|
Some people experience troubles with automake 1.5, if you're one of those,
|
2006-11-07 21:57:57 +00:00
|
|
|
it's recommended to upgrade to automake 1.7, which is a lot more stable.
|
2002-10-29 22:14:58 +00:00
|
|
|
|
|
|
|
|
|
|
|
1.3. configure and build stage
|
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
It has to be known the CVS repository holds no autogenerated files, i.e.
|
|
|
|
configure, config.guess, etc. Hence after a fresh checkout, you'll have to
|
|
|
|
generate those files.
|
|
|
|
|
|
|
|
To proceed, first edit the autogen.sh, and set appropriately the AUTOCONF,
|
|
|
|
AUTOHEADER, AUTOHEADER, and ACLOCAL variables with the required versions
|
|
|
|
seen in the previous section (most systems will be fine with the default
|
|
|
|
names).
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
sh ./autogen.sh --disable-static --prefix=/usr/local CFLAGS="-g -O0"
|
|
|
|
make
|
|
|
|
make install
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2007-11-14 03:15:31 +00:00
|
|
|
If you don't want the build files cluttering the source directories, do the
|
|
|
|
following in the same parent directory of hamlib:
|
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
mkdir build && cd build
|
|
|
|
sh ../hamlib/autogen.sh --disable-static --prefix=/usr/local CFLAGS="-g -O0"
|
|
|
|
make
|
|
|
|
make install
|
2007-11-14 03:15:31 +00:00
|
|
|
|
|
|
|
This will keep the binary output files seperate from the source tree and aid
|
2008-01-06 14:38:37 +00:00
|
|
|
in development by reducing clutter in the source tree.
|
2007-11-14 03:15:31 +00:00
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
Once you've run autogen.sh, make sure you've got some recent config.guess and
|
|
|
|
config.sub (needed to guess your system type). Anything of at least year 2004
|
|
|
|
should be fine, unless you run some exotic hardware/software system:
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
./config.guess --version
|
|
|
|
./config.sub --version
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
The prefix argument is optional. Convention is that local packages be placed
|
|
|
|
in /usr/local away from distribution installed packages. The --disable-static
|
|
|
|
and CFLAGS="-g -O0" speeds up compilation if you don't plan to use static
|
|
|
|
libraries and can bear less optimized binaries while the -g option adds
|
|
|
|
debugging info which can be changed to -ggdb to generate debugging info for
|
|
|
|
gdb.
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
NOTE: autogen.sh has only to be run the first time after a fresh checkout or
|
|
|
|
when a Makefile.am or other build file is modified or added.
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
The difference between building as a tester and a developer is in the
|
|
|
|
'--enable-maintainer-mode' option passed to configure. This option will add
|
|
|
|
new Makefile targets and dependencies and not force a rebuild of the Makefiles
|
|
|
|
when make is executed.
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
For a Tcl build, add this if needed:
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
--with-tcl=/usr/lib/tcl8.2
|
2002-10-29 22:14:58 +00:00
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
Note: C-shell users may have to run autogen.sh and make through a bourne shell
|
|
|
|
instead, or pass "SHELL=bash" as a parameter to make.
|
2002-10-29 22:14:58 +00:00
|
|
|
|
|
|
|
|
|
|
|
1.4. Feedback
|
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
The Hamlib team is very interested to hear from you, how Hamlib builds and
|
|
|
|
works on your system, especially on non-Linux or non-PC systems. We are trying
|
|
|
|
to make Hamlib as portable as possible. Please report problems to our developer
|
|
|
|
mailing list, hamlib-developer@lists.sourceforge.net
|
|
|
|
|
2007-11-14 03:15:31 +00:00
|
|
|
Patches are welcome too! Just send them to the mailing list.
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2006-07-10 16:15:12 +00:00
|
|
|
So far, Hamlib has been tested successfully under the following systems:
|
2004-02-08 17:40:55 +00:00
|
|
|
(if your system is not present, please report to the mailing list)
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
* Debian i386
|
|
|
|
* Debian sid mipsel
|
|
|
|
* RedHat i386
|
|
|
|
* Linux ppc
|
|
|
|
* Slackware i386
|
|
|
|
* FreeBSD & NetBSD
|
|
|
|
* Solaris 2.6
|
|
|
|
* Mac OS X
|
|
|
|
* win32: Cygwin, Mingw
|
2002-09-10 06:43:05 +00:00
|
|
|
|
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
2. How to add a new backend
|
2006-11-07 21:57:57 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
The rule is one backend per protocol family.
|
|
|
|
Try to share code between rigs of the same family, if applicable.
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
2.1. mkdir mybackend
|
|
|
|
Create a new subdir, of the name of the protocol backend.
|
|
|
|
NB: the directory MUST be the same as the backend name.
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
2.2. Add <mybackend> to the SUBDIRS variable in the topdir Makefile.am,
|
|
|
|
2.3. Add the backend name to the BACKEND_LIST variable in configure.ac
|
|
|
|
2.4. Add "mybackend/Makefile" in the AC_CONFIG_FILES macro at the bottom
|
|
|
|
of configure.ac
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
2.5. Create mybackend/Makefile.am, mybackend.c mybackend.h
|
|
|
|
Use 'dummy' backend as a template.
|
|
|
|
Here are commands for the bourne shell:
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
$ automake mybackend/Makefile
|
|
|
|
$ CONFIG_HEADERS= CONFIG_LINKS= CONFIG_FILES=mybackend/Makefile ./config.status
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
make in topdir to rebuild all
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
2.6. Commit your work (developer access to Hamlib CVS required):
|
|
|
|
$ cvs add mybackend
|
|
|
|
$ cd mybackend
|
|
|
|
$ cvs add Makefile.am mybackend.c mybackend.h
|
|
|
|
$ cvs commit -m "Initial release" Makefile.am mybackend.c mybackend.h
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
Note: The `-m' switch passes a short message to the CVS repository
|
|
|
|
upon a commit. If a longer message is desired, do not use the
|
|
|
|
`-m' option. The editor specified in the EDITOR or VISUAL
|
|
|
|
environment variables will be started where a more detailed message
|
|
|
|
may be composed.
|
2002-05-28 21:28:15 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
3. How to add a new model to and existing backend
|
2000-09-24 02:19:42 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
3.1. make sure there's already a (unique) ID for the model to be added
|
|
|
|
in include/hamlib/riglist.h
|
|
|
|
|
|
|
|
3.2. locate the existing backend
|
|
|
|
3.3. Clone the most similar model in the backend
|
|
|
|
3.4. Add the new C file to the _SOURCES variable
|
|
|
|
of the backend's Makefile.am
|
|
|
|
|
|
|
|
3.5. Add "extern const struct rig_caps <mymodel>_caps;" to mybackend.h
|
|
|
|
3.6. In initrigs_<mybackend> of mybackend.c,
|
|
|
|
add "rig_register(&<mymodel>_caps);"
|
|
|
|
|
|
|
|
3.7. Run `make' if you have dependencies, or the following to regenerate
|
|
|
|
the makefile:
|
|
|
|
$ automake mybackend/Makefile
|
|
|
|
$ CONFIG_HEADERS= CONFIG_LINKS= CONFIG_FILES=mybackend/Makefile ./config.status
|
|
|
|
|
|
|
|
Run `make' in topdir to rebuild all.
|
|
|
|
|
|
|
|
3.8. Commit your work (once tests are satisfactory):
|
|
|
|
$ cd mybackend
|
|
|
|
$ cvs add mymodel.c
|
|
|
|
$ cvs commit -m "added <mymodel> to <mybackend>" Makefile.am mybackend.c mybackend.h mymodel.c
|
|
|
|
|
|
|
|
Note: See Note in section 2.6 above.
|
|
|
|
|
2000-09-24 02:19:42 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
4. Read README.betatester to test the new backend/model.
|
|
|
|
Report to mailing list.
|
2000-09-24 02:19:42 +00:00
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
|
2007-11-14 03:15:31 +00:00
|
|
|
5. Basic functions: set/get_freq, set/get_mode, and set/get_vfo would be a
|
|
|
|
good starting point for your new backend.
|
2000-08-20 21:52:27 +00:00
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
6. C code examples.
|
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
A C code snippet to connect to a FT847 and set the frequency of the main VFO
|
|
|
|
to 439,700,000 Hz, using FM as the required mode, would look something like
|
|
|
|
this. The error checking is removed for simplicity.
|
2002-05-28 21:28:15 +00:00
|
|
|
|
|
|
|
See tests/testrig.c
|
2000-08-20 21:52:27 +00:00
|
|
|
|
|
|
|
|
2002-05-28 21:28:15 +00:00
|
|
|
7. Where are the GUI's?
|
2000-08-20 21:52:27 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
"Build it and they will come ..."
|
|
|
|
|
|
|
|
Seriously, I am hoping the API's will provide a solid framework for some
|
|
|
|
cool GUI development. I would like to see some GTK or Qt apps that use the
|
|
|
|
hamlib API's so they can be used by end users as a nice part of the Ham
|
|
|
|
shack.
|
2000-08-20 21:52:27 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
Starting points (not exhaustive):
|
|
|
|
gmfsk, gpredict, grig, klog, kontakt, ktrack, xlog, xtlf
|
2006-07-10 16:15:12 +00:00
|
|
|
|
2000-08-20 21:52:27 +00:00
|
|
|
|
2005-03-25 22:27:32 +00:00
|
|
|
8. Contributing code
|
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
8.1 License
|
|
|
|
|
|
|
|
Contributed code to the Hamlib frontend must be released under the LGPL.
|
|
|
|
Contributed code to Hamlib backends must follow backend current license.
|
|
|
|
Needless to say, the LGPL is the license of choice.
|
|
|
|
|
|
|
|
End user applications like rigctl, rotctl and RPC daemons should be released
|
|
|
|
under the GPL, so any contributed code must follow the rule.
|
|
|
|
|
|
|
|
8.2 Coding guidelines and style
|
2005-03-25 22:27:32 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
Try to keep current style of existing code. Improvements are welcome though.
|
|
|
|
Contributed code should always keep the source base in a compilable
|
|
|
|
state, and not regress unless stated otherwise.
|
2006-07-10 16:15:12 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
There's no need to tag the source in a patch with your name in comments
|
|
|
|
behind each modification, we already know the culprit :-)
|
2002-11-28 22:34:22 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
Patches should take care of portability issues.
|
|
|
|
Keep in mind Hamlib has to run under:
|
2000-08-20 21:52:27 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
* various Linux's
|
|
|
|
* NetBSD, FreeBSD
|
|
|
|
* MacOS X
|
|
|
|
* Windows: MinGW/Cygwin, and VisualC++ support for rig.h
|
2005-03-25 22:27:32 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
Hamlib should also compile with the following common compilers:
|
2005-03-25 22:27:32 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
* gcc-2.9x (most likely deprecated)
|
|
|
|
* gcc-3.0 and gcc-3.2+ (nearly deprecated?)
|
|
|
|
* gcc-4.x and newer
|
|
|
|
* in shared and static
|
|
|
|
* C++ compiler against rig.h, riglist.h, rotator.h
|
2005-03-25 22:27:32 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
Portability issues to watch:
|
2000-09-24 02:19:42 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
* little vs. big endian systems (use shifts or adhoc functions)
|
|
|
|
* 64 bit int: avoid them in API
|
|
|
|
* printf/scanf of 64bit int: use PRIll and SCNll
|
|
|
|
* printf/scanf of freq_t: use PRIfreq and SCNfreq
|
2005-03-25 22:27:32 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
8.3 Submitting patches
|
2005-03-25 22:27:32 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
Patches should be in unified format (diff -u), against CVS head or
|
|
|
|
latest release. This format makes it easily readable.
|
|
|
|
The patches are to be sent to the hamlib-developer
|
|
|
|
mailing list. If the file is too big, you can send it as a compressed
|
|
|
|
attachement.
|
2006-12-10 14:41:35 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
8.3.1 Changelog
|
2006-12-10 14:41:35 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
Caveat: The cvs2cl.pl script is used before each release to generate
|
|
|
|
the Changelog file so any changes made directly to it WILL BE LOST!
|
|
|
|
Simply summarize your changes when the files are committed to CVS or,
|
|
|
|
if providing patches to the mailing list, provide a summary so the
|
|
|
|
uploader can include it in the commit message.
|
2005-03-25 22:27:32 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
8.4 CVS commit access
|
2005-03-25 22:27:32 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
Generally, volunteers can get access to SourceForge Hamlib CVS upon
|
|
|
|
asking one of the project administrators. Sometimes we'll ask you!
|
2007-11-14 03:15:31 +00:00
|
|
|
|
2008-01-06 14:38:37 +00:00
|
|
|
However, before your start commiting, the project admins would like
|
|
|
|
first to have a look at your "style", just to make sure you have grok
|
|
|
|
the Hamlib approach (c.f. previous section on submitting a patch).
|
|
|
|
Then you'll be able to commit by yourself to the backend you have
|
|
|
|
maintainance of. Please follow the rules hereunder:
|
|
|
|
|
|
|
|
* Always keep the CVS repository in a compilable state.
|
|
|
|
* Follow the coding guidelines
|
|
|
|
* Touching the frontend (files in src/ and include/hamlib) always
|
|
|
|
requires discussion beforehand on the hamlib-developer list.
|
|
|
|
* Announce on the hamlib-developer list if you're about to do serious
|
|
|
|
maintainance work
|
|
|
|
|
|
|
|
Thanks for contributing and have fun!
|
2005-03-25 22:27:32 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
2006-11-07 21:57:57 +00:00
|
|
|
Stephane Fillod f8cfe and The Hamlib Group
|