2002-01-27 14:48:49 +00:00
/*
* Hamlib Interface - token header
2009-04-15 17:34:16 +00:00
* Copyright ( c ) 2000 - 2009 by Stephane Fillod
2002-01-27 14:48:49 +00:00
*
*
2011-08-22 01:07:57 +00:00
* This library is free software ; you can redistribute it and / or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation ; either
* version 2.1 of the License , or ( at your option ) any later version .
2002-01-27 14:48:49 +00:00
*
2011-08-22 01:07:57 +00:00
* This library is distributed in the hope that it will be useful ,
2002-01-27 14:48:49 +00:00
* but WITHOUT ANY WARRANTY ; without even the implied warranty of
2011-08-22 01:07:57 +00:00
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the GNU
* Lesser General Public License for more details .
2002-01-27 14:48:49 +00:00
*
2011-08-22 01:07:57 +00:00
* You should have received a copy of the GNU Lesser General Public
2002-01-27 14:48:49 +00:00
* License along with this library ; if not , write to the Free Software
2011-08-22 01:07:57 +00:00
* Foundation , Inc . , 51 Franklin Street , Fifth Floor , Boston , MA 02110 - 1301 USA
2002-01-27 14:48:49 +00:00
*
*/
2006-10-17 14:28:52 +00:00
/**
2006-10-28 03:49:46 +00:00
* \ addtogroup rig_internal
2006-10-17 14:28:52 +00:00
* @ {
*/
/**
* \ brief Token definitions
* \ file token . h
2011-08-22 01:07:57 +00:00
*
2006-10-17 14:28:52 +00:00
*/
2002-01-27 14:48:49 +00:00
# ifndef _TOKEN_H
2006-10-17 14:28:52 +00:00
2002-01-27 14:48:49 +00:00
# define _TOKEN_H 1
# include <hamlib/rig.h>
2006-10-17 14:28:52 +00:00
/** \brief Create a backend token, \a t */
2002-01-27 14:48:49 +00:00
# define TOKEN_BACKEND(t) (t)
2006-10-17 14:28:52 +00:00
/** \brief Create a frontend token, \a t */
2002-01-27 14:48:49 +00:00
# define TOKEN_FRONTEND(t) ((t)|(1<<30))
2006-10-17 14:28:52 +00:00
/** \brief Test for token - frontend? */
2002-01-27 14:48:49 +00:00
# define IS_TOKEN_FRONTEND(t) ((t)&(1<<30))
2006-10-17 14:28:52 +00:00
/** \brief Null frontend token */
2017-08-05 14:09:12 +00:00
# define TOK_FRONTEND_NONE TOKEN_FRONTEND(0)
2006-10-17 14:28:52 +00:00
/** \brief Null backend token */
2017-08-05 14:09:12 +00:00
# define TOK_BACKEND_NONE TOKEN_BACKEND(0)
2002-01-27 14:48:49 +00:00
/*
* tokens shared among rig and rotator ,
* Numbers go from TOKEN_FRONTEND ( 1 ) to TOKEN_FRONTEND ( 99 )
*/
2006-10-17 14:28:52 +00:00
/** \brief Pathname is device for rig control, e.g. /dev/ttyS0 */
2017-08-05 14:09:12 +00:00
# define TOK_PATHNAME TOKEN_FRONTEND(10)
2006-10-17 14:28:52 +00:00
/** \brief Delay before serial output (units?) */
2017-08-05 14:09:12 +00:00
# define TOK_WRITE_DELAY TOKEN_FRONTEND(12)
2006-10-17 14:28:52 +00:00
/** \brief Delay after serial output (units?) */
2017-08-05 14:09:12 +00:00
# define TOK_POST_WRITE_DELAY TOKEN_FRONTEND(13)
2006-10-17 14:28:52 +00:00
/** \brief Timeout delay (units?) */
2017-08-05 14:09:12 +00:00
# define TOK_TIMEOUT TOKEN_FRONTEND(14)
2006-10-17 14:28:52 +00:00
/** \brief Number of retries permitted */
2017-08-05 14:09:12 +00:00
# define TOK_RETRY TOKEN_FRONTEND(15)
2006-10-17 14:28:52 +00:00
/** \brief Serial speed - "baud rate" */
2017-08-05 14:09:12 +00:00
# define TOK_SERIAL_SPEED TOKEN_FRONTEND(20)
2006-10-17 14:28:52 +00:00
/** \brief No. data bits per serial character */
2017-08-05 14:09:12 +00:00
# define TOK_DATA_BITS TOKEN_FRONTEND(21)
2006-10-17 14:28:52 +00:00
/** \brief No. stop bits per serial character */
2017-08-05 14:09:12 +00:00
# define TOK_STOP_BITS TOKEN_FRONTEND(22)
2006-10-17 14:28:52 +00:00
/** \brief Serial parity (format?) */
2017-08-05 14:09:12 +00:00
# define TOK_PARITY TOKEN_FRONTEND(23)
2023-04-08 18:31:40 +00:00
/** \brief Serial Handshake (format?) */
2017-08-05 14:09:12 +00:00
# define TOK_HANDSHAKE TOKEN_FRONTEND(24)
2006-10-17 14:28:52 +00:00
/** \brief Serial Req. To Send status */
2017-08-05 14:09:12 +00:00
# define TOK_RTS_STATE TOKEN_FRONTEND(25)
2006-10-17 14:28:52 +00:00
/** \brief Serial Data Terminal Ready status */
2017-08-05 14:09:12 +00:00
# define TOK_DTR_STATE TOKEN_FRONTEND(26)
2009-04-15 17:34:16 +00:00
/** \brief PTT type override */
2017-08-05 14:09:12 +00:00
# define TOK_PTT_TYPE TOKEN_FRONTEND(30)
2009-04-15 17:34:16 +00:00
/** \brief PTT pathname override */
2017-08-05 14:09:12 +00:00
# define TOK_PTT_PATHNAME TOKEN_FRONTEND(31)
2009-04-15 17:34:16 +00:00
/** \brief DCD type override */
2017-08-05 14:09:12 +00:00
# define TOK_DCD_TYPE TOKEN_FRONTEND(32)
2009-04-15 17:34:16 +00:00
/** \brief DCD pathname override */
2017-08-05 14:09:12 +00:00
# define TOK_DCD_PATHNAME TOKEN_FRONTEND(33)
2012-01-08 23:22:59 +00:00
/** \brief CM108 GPIO bit number for PTT */
# define TOK_PTT_BITNUM TOKEN_FRONTEND(34)
2020-10-13 04:27:13 +00:00
/** \brief PTT share with other applications */
# define TOK_PTT_SHARE TOKEN_FRONTEND(35)
2023-04-08 18:31:40 +00:00
/** \brief Flush with read instead of TCFLUSH */
2020-11-25 14:40:24 +00:00
# define TOK_FLUSHX TOKEN_FRONTEND(36)
2022-01-05 17:12:43 +00:00
/** \brief Asynchronous data transfer support */
# define TOK_ASYNC TOKEN_FRONTEND(37)
2022-12-19 18:55:18 +00:00
/** \brief Tuner external control pathname */
# define TOK_TUNER_CONTROL_PATHNAME TOKEN_FRONTEND(38)
2023-05-14 08:52:48 +00:00
/** \brief Number of retries permitted in case of read timeouts */
# define TOK_TIMEOUT_RETRY TOKEN_FRONTEND(39)
2023-10-31 22:34:31 +00:00
# define TOK_POST_PTT_DELAY TOKEN_FRONTEND(40)
2023-11-05 22:42:02 +00:00
# define TOK_DEVICE_ID TOKEN_FRONTEND(41)
2022-01-05 17:12:43 +00:00
2002-01-27 14:48:49 +00:00
/*
* rig specific tokens
*/
/* rx_range_list/tx_range_list, filters, announces, has(func,lvl,..) */
2023-04-08 18:31:40 +00:00
/** \brief rig: VFO compensation in ppm */
2017-08-05 14:09:12 +00:00
# define TOK_VFO_COMP TOKEN_FRONTEND(110)
2021-11-28 18:52:29 +00:00
/** \brief rig: Rig state poll interval in milliseconds */
2017-08-05 14:09:12 +00:00
# define TOK_POLL_INTERVAL TOKEN_FRONTEND(111)
2018-11-07 16:11:58 +00:00
/** \brief rig: lo frequency of any transverters */
# define TOK_LO_FREQ TOKEN_FRONTEND(112)
2020-03-06 14:49:21 +00:00
/** \brief rig: Range index 1-5 */
# define TOK_RANGE_SELECTED TOKEN_FRONTEND(121)
/** \brief rig: Range Name */
# define TOK_RANGE_NAME TOKEN_FRONTEND(122)
2021-11-28 18:52:29 +00:00
/** \brief rig: Cache timeout in milliseconds */
2020-05-01 17:03:54 +00:00
# define TOK_CACHE_TIMEOUT TOKEN_FRONTEND(123)
2020-07-04 22:23:39 +00:00
/** \brief rig: Auto power on rig_open when supported */
# define TOK_AUTO_POWER_ON TOKEN_FRONTEND(124)
2021-03-02 19:02:13 +00:00
/** \brief rig: Auto power off rig_close when supported */
# define TOK_AUTO_POWER_OFF TOKEN_FRONTEND(125)
2020-07-04 16:26:54 +00:00
/** \brief rig: Auto disable screensaver */
2021-03-02 19:02:13 +00:00
# define TOK_AUTO_DISABLE_SCREENSAVER TOKEN_FRONTEND(126)
2021-01-20 17:34:30 +00:00
/** \brief rig: Disable Yaesu band select logic */
2021-03-02 19:02:13 +00:00
# define TOK_DISABLE_YAESU_BANDSELECT TOKEN_FRONTEND(127)
2023-04-08 18:31:40 +00:00
/** \brief rig: Suppress get_freq on VFOB for satellite RIT tuning */
2021-03-02 19:02:13 +00:00
# define TOK_TWIDDLE_TIMEOUT TOKEN_FRONTEND(128)
2023-04-08 18:31:40 +00:00
/** \brief rig: Suppress get_freq on VFOB for satellite RIT tuning */
2021-03-02 19:02:13 +00:00
# define TOK_TWIDDLE_RIT TOKEN_FRONTEND(129)
2023-04-08 18:31:40 +00:00
/** \brief rig: Add Hz to VFOA/Main frequency set */
2023-02-17 18:33:14 +00:00
# define TOK_OFFSET_VFOA TOKEN_FRONTEND(130)
2023-04-08 18:31:40 +00:00
/** \brief rig: Add Hz to VFOB/Sub frequency set */
2023-02-17 18:33:14 +00:00
# define TOK_OFFSET_VFOB TOKEN_FRONTEND(131)
2023-10-31 22:26:37 +00:00
/** \brief rig: Multicast data UDP address for publishing rig data and state, default 224.0.0.1, value of 0.0.0.0 disables multicast data publishing */
# define TOK_MULTICAST_DATA_ADDR TOKEN_FRONTEND(132)
/** \brief rig: Multicast data UDP port, default 4532 */
# define TOK_MULTICAST_DATA_PORT TOKEN_FRONTEND(133)
/** \brief rig: Multicast command server UDP address for sending commands to rig, default 224.0.0.2, value of 0.0.0.0 disables multicast command server */
# define TOK_MULTICAST_CMD_ADDR TOKEN_FRONTEND(134)
/** \brief rig: Multicast command server UDP port, default 4532 */
# define TOK_MULTICAST_CMD_PORT TOKEN_FRONTEND(135)
2024-03-08 23:09:47 +00:00
/** \brief rig: Skip setting freq on opposite VFO when in split mode */
# define TOK_FREQ_SKIP TOKEN_FRONTEND(136)
2023-10-31 22:26:37 +00:00
2002-01-27 14:48:49 +00:00
/*
* rotator specific tokens
2006-10-28 03:49:46 +00:00
* ( strictly , should be documented as rotator_internal )
2002-01-27 14:48:49 +00:00
*/
2006-10-17 14:28:52 +00:00
/** \brief rot: Minimum Azimuth */
2017-08-05 14:09:12 +00:00
# define TOK_MIN_AZ TOKEN_FRONTEND(110)
2006-10-17 14:28:52 +00:00
/** \brief rot: Maximum Azimuth */
2017-08-05 14:09:12 +00:00
# define TOK_MAX_AZ TOKEN_FRONTEND(111)
2006-10-17 14:28:52 +00:00
/** \brief rot: Minimum Elevation */
2017-08-05 14:09:12 +00:00
# define TOK_MIN_EL TOKEN_FRONTEND(112)
2006-10-17 14:28:52 +00:00
/** \brief rot: Maximum Elevation */
2017-08-05 14:09:12 +00:00
# define TOK_MAX_EL TOKEN_FRONTEND(113)
2019-11-24 05:10:21 +00:00
/** \brief rot: South is zero degrees */
# define TOK_SOUTH_ZERO TOKEN_FRONTEND(114)
2002-01-27 14:48:49 +00:00
# endif /* _TOKEN_H */
2006-10-17 14:28:52 +00:00
2006-10-28 03:49:46 +00:00
/** @} */ /* rig_internal definitions */