tones.c File Reference

CTCSS and DCS interface and tables. More...

#include <stdlib.h>
#include "hamlib/rig.h"

Functions
int HAMLIB_API	rig_set_ctcss_tone (RIG *rig, vfo_t vfo, tone_t tone)
	set CTCSS sub-tone frequency
int HAMLIB_API	rig_get_ctcss_tone (RIG *rig, vfo_t vfo, tone_t *tone)
	get the current CTCSS sub-tone frequency
int HAMLIB_API	rig_set_dcs_code (RIG *rig, vfo_t vfo, tone_t code)
	set the current encoding DCS code
int HAMLIB_API	rig_get_dcs_code (RIG *rig, vfo_t vfo, tone_t *code)
	get the current encoding DCS code
int HAMLIB_API	rig_set_ctcss_sql (RIG *rig, vfo_t vfo, tone_t tone)
	set CTCSS squelch
int HAMLIB_API	rig_get_ctcss_sql (RIG *rig, vfo_t vfo, tone_t *tone)
	get the current CTCSS squelch
int HAMLIB_API	rig_set_dcs_sql (RIG *rig, vfo_t vfo, tone_t code)
	set the current DCS code
int HAMLIB_API	rig_get_dcs_sql (RIG *rig, vfo_t vfo, tone_t *code)
	get the current DCS code
Variables
const tone_t	full_ctcss_list [] = { FULL_CTCSS_LIST }
const tone_t	common_ctcss_list [] = { COMMON_CTCSS_LIST }
const tone_t	full_dcs_list [] = { FULL_DCS_LIST }

---

Detailed Description

CTCSS and DCS interface and tables.

Author:

Stephane Fillod

Date:

2000-2005

---

Function Documentation

int HAMLIB_API rig_get_ctcss_sql (  RIG *  rig, vfo_t  vfo, tone_t *  tone )

get the current CTCSS squelch Parameters: rig  The rig handle vfo  The target VFO tone  The location where to store the current tone Retrieves the current Continuous Tone Controlled Squelch System (CTCSS) sub-audible *squelch* tone. Note: *tone is NOT in Hz, but in tenth of Hz! This way, if the function rig_get_ctcss_sql() returns a subaudible tone of 885 for example, then the real tone is 88.5 Hz. Also, a value of 0 for tone means the Tone squelch is disabled. Returns: RIG_OK if the operation has been sucessful, otherwise a negative value if an error occured (in which case, cause is set appropriately). See also: rig_set_ctcss_sql(), rig_get_ctcss_tone()

int HAMLIB_API rig_get_ctcss_tone (  RIG *  rig, vfo_t  vfo, tone_t *  tone )

get the current CTCSS sub-tone frequency Parameters: rig  The rig handle vfo  The target VFO tone  The location where to store the current tone Retrieves the current Continuous Tone Controlled Squelch System (CTCSS) sub-audible tone frequency. Note: the *tone integer is NOT in Hz, but in tenth of Hz! This way, if the function rig_get_ctcss_tone() returns a subaudible tone of 885 for example, then the real tone is 88.5 Hz. Also, a value of 0 for *tone means the Tone encoding is disabled. Returns: RIG_OK if the operation has been sucessful, otherwise a negative value if an error occured (in which case, cause is set appropriately). See also: rig_set_ctcss_tone(), rig_get_ctcss_sql()

int HAMLIB_API rig_get_dcs_code (  RIG *  rig, vfo_t  vfo, tone_t *  code )

get the current encoding DCS code Parameters: rig  The rig handle vfo  The target VFO code  The location where to store the current tone Retrieves the current encoding Digitally-Coded Squelch code. Returns: RIG_OK if the operation has been sucessful, otherwise a negative value if an error occured (in which case, cause is set appropriately). See also: rig_set_dcs_code(), rig_get_dcs_sql()

int HAMLIB_API rig_get_dcs_sql (  RIG *  rig, vfo_t  vfo, tone_t *  code )

get the current DCS code Parameters: rig  The rig handle vfo  The target VFO code  The location where to store the current tone Retrieves the current Digitally-Coded *Squelch* code. Returns: RIG_OK if the operation has been sucessful, ortherwise a negative value if an error occured (in which case, cause is set appropriately). See also: rig_set_dcs_sql(), rig_get_dcs_code()

int HAMLIB_API rig_set_ctcss_sql (  RIG *  rig, vfo_t  vfo, tone_t  tone )

set CTCSS squelch Parameters: rig  The rig handle vfo  The target VFO tone  The PL tone to set the squelch to Sets the current Continuous Tone Controlled Squelch System (CTCSS) sub-audible *squelch* tone. Note: tone is NOT in Hz, but in tenth of Hz! This way, if you want to set subaudible squelch tone of 88.5 Hz for example, then pass 885 to this function. Also, to disable Tone squelch, set tone to 0 (FIXME: not clear in API). Returns: RIG_OK if the operation has been sucessful, otherwise a negative value if an error occured (in which case, cause is set appropriately). See also: rig_get_ctcss_sql(), rig_set_ctcss_tone()

int HAMLIB_API rig_set_ctcss_tone (  RIG *  rig, vfo_t  vfo, tone_t  tone )

set CTCSS sub-tone frequency Parameters: rig  The rig handle vfo  The target VFO tone  The tone to set to Sets the current Continuous Tone Controlled Squelch System (CTCSS) sub-audible tone frequency. Note: the tone integer is NOT in Hz, but in tenth of Hz! This way, if you want to set a subaudible tone of 88.5 Hz for example, then pass 885 to this function. Also, to disable Tone encoding, set tone to 0 (FIXME: not clear in API). Returns: RIG_OK if the operation has been sucessful, otherwise a negative value if an error occured (in which case, cause is set appropriately). See also: rig_get_ctcss_tone(), rig_set_ctcss_sql()

int HAMLIB_API rig_set_dcs_code (  RIG *  rig, vfo_t  vfo, tone_t  code )

set the current encoding DCS code Parameters: rig  The rig handle vfo  The target VFO code  The tone to set to Sets the current encoding Digitally-Coded Squelch code. Returns: RIG_OK if the operation has been sucessful, otherwise a negative value if an error occured (in which case, cause is set appropriately). See also: rig_get_dcs_code(), rig_set_dcs_sql()

int HAMLIB_API rig_set_dcs_sql (  RIG *  rig, vfo_t  vfo, tone_t  code )

set the current DCS code Parameters: rig  The rig handle vfo  The target VFO code  The tone to set to Sets the current Digitally-Coded *Squelch* code. Returns: returns RIG_OK if the operation has been sucessful, ortherwise a negative value if an error occured (in which case, cause is set appropriately). See also: rig_get_dcs_sql(), rig_set_dcs_code()

---

Variable Documentation

const tone_t common_ctcss_list[] = { COMMON_CTCSS_LIST }

50 CTCSS sub-audible tones, from 67.0Hz to 254.1Hz Note: Don't even think about changing a bit of this array, several backends depend on it. If you need to, create a copy for your own caps. --SF

const tone_t full_ctcss_list[] = { FULL_CTCSS_LIST }

52 CTCSS sub-audible tones

const tone_t full_dcs_list[] = { FULL_DCS_LIST }

106 DCS codes

---