Logo Search packages:      
Sourcecode: hamlib version File versions  Download package

token.h

Go to the documentation of this file.
/*
 *  Hamlib Interface - token header
 *  Copyright (c) 2000-2003 by Stephane Fillod
 *
 *    $Id: token.h,v 1.5 2006/10/28 03:49:46 aa6e Exp $
 *
 *   This library is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Library General Public License as
 *   published by the Free Software Foundation; either version 2 of
 *   the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Library General Public License for more details.
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this library; if not, write to the Free Software
 *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 */

/**
 * \addtogroup rig_internal
 * @{
 */

/**
 * \brief Token definitions
 * \file token.h
 * 
 */

#ifndef _TOKEN_H

#define _TOKEN_H 1

#include <hamlib/rig.h>

/** \brief Create a backend token, \a t */
00041 #define TOKEN_BACKEND(t) (t)
/** \brief Create a frontend token, \a t */
00043 #define TOKEN_FRONTEND(t) ((t)|(1<<30))
/** \brief Test for token - frontend? */
00045 #define IS_TOKEN_FRONTEND(t) ((t)&(1<<30))

/** \brief Null frontend token */
00048 #define TOK_FRONTEND_NONE     TOKEN_FRONTEND(0)
/** \brief Null backend token */
00050 #define TOK_BACKEND_NONE      TOKEN_BACKEND(0)

/*
 * tokens shared among rig and rotator,
 * Numbers go from TOKEN_FRONTEND(1) to TOKEN_FRONTEND(99)
 */

/** \brief Pathname is device for rig control, e.g. /dev/ttyS0 */
00058 #define TOK_PATHNAME    TOKEN_FRONTEND(10)
/** \brief Delay before serial output (units?) */
00060 #define TOK_WRITE_DELAY TOKEN_FRONTEND(12)
/** \brief Delay after serial output (units?) */
00062 #define TOK_POST_WRITE_DELAY  TOKEN_FRONTEND(13)
/** \brief Timeout delay (units?) */
00064 #define TOK_TIMEOUT           TOKEN_FRONTEND(14)
/** \brief Number of retries permitted */
00066 #define TOK_RETRY       TOKEN_FRONTEND(15)
/** \brief Serial speed - "baud rate" */
00068 #define TOK_SERIAL_SPEED      TOKEN_FRONTEND(20)
/** \brief No. data bits per serial character */
00070 #define TOK_DATA_BITS   TOKEN_FRONTEND(21)
/** \brief  No. stop bits per serial character */
00072 #define TOK_STOP_BITS   TOKEN_FRONTEND(22)
/** \brief  Serial parity (format?) */
00074 #define TOK_PARITY            TOKEN_FRONTEND(23)
/** \brief Serial Handshake (format?)  */
00076 #define TOK_HANDSHAKE   TOKEN_FRONTEND(24)
/** \brief Serial Req. To Send status */
00078 #define TOK_RTS_STATE   TOKEN_FRONTEND(25)
/** \brief  Serial Data Terminal Ready status */
00080 #define TOK_DTR_STATE   TOKEN_FRONTEND(26)

/*
 * rig specific tokens
 */
/* rx_range_list/tx_range_list, filters, announces, has(func,lvl,..) */

/** \brief rig: ?? */
00088 #define TOK_VFO_COMP    TOKEN_FRONTEND(110)
/** \brief rig: polling interval (units?) */
00090 #define TOK_POLL_INTERVAL     TOKEN_FRONTEND(111)
/** \brief rig: International Telecommunications Union region no. */
00092 #define TOK_ITU_REGION  TOKEN_FRONTEND(120)
/*
 * rotator specific tokens
 * (strictly, should be documented as rotator_internal)
 */
/** \brief rot: Minimum Azimuth */
00098 #define TOK_MIN_AZ      TOKEN_FRONTEND(110)
/** \brief rot: Maximum Azimuth */
00100 #define TOK_MAX_AZ      TOKEN_FRONTEND(111)
/** \brief rot: Minimum Elevation */
00102 #define TOK_MIN_EL      TOKEN_FRONTEND(112)
/** \brief rot: Maximum Elevation */
00104 #define TOK_MAX_EL      TOKEN_FRONTEND(113)


#endif /* _TOKEN_H */

/** @} */ /* rig_internal definitions */

Generated by  Doxygen 1.6.0   Back to index