Versions Compared

Old Version 1

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Noprint
Panel
borderColorgreen
bgColortransparent
borderWidth2

Back to Table of Contents

Back to CLI Configure Mode

Back to Profiles - CLI

Back to Media - CLI

...

Panel

In this section:

Table of Contents
maxLevel2

 

Use this object to create and configure a single, dual, composite (set of tones) or amplitude-modulated tone profile:

For more information on Tone Profile and signal characteristics, refer to Tones and Announcements.

Command Syntax

To create custom tone profile:

Code Block
languagenone
% set profiles media toneProfile <profile name> 
	break1 <-1 to 8000, in milliseconds> 
	break2 <-1 to 8000, in milliseconds> 
	break3 <-1 to 8000, in milliseconds> 
	generationMethod 
		compositeTone compositeTone
		dualTone
			tone1Frequency <0-3999, in Hertz> 
			tone1Power <-50-3, in dBm> 
			tone2Frequency <0-3999, in Hertz> 
			tone2Power <-50-3, in dBm> 
		modulatedTone
			carrierFrequency <0-3999, in Hertz>
			carrierPower <-50-3 dBM>
			signalFrequency <0-3999, in Hertz>
			signalModulationIndex <0-300, in 1% units>
		singleTone
			tone1Frequency <0-3999, in Hertz> 
			tone1Power <-50-3, in dBm> 
	make1 <-1-8000, in milliseconds> 
	make2 <-1-8000, in milliseconds> 
	make3 <-1-8000, in milliseconds> 
	repeat <#> 
	repeat1 <#> 
	repeat2 <#> 
	repeat3 <#> 

% set profiles media toneProfile <choose a default profile>
	defBusy | defCallWaiting1 | defCallWaiting2 | defCallWaiting3 | defCallWaiting4 | 
	defCpeAlerting | defDial | defReorder | defRing | defSit1 | defSit2 | defSit3 | 
	fccBusy | fccDial  | fccRingback

Command Parameters

The Tone Profile Parameters are as shown:

Caption
0Table
1Tone Profile Parameters

Parameter

Length/Range

Description

toneProfile

N/A

Use this object to define tone profiles for the node. Enter a tone profile name, or select a default profile:

defBusy

defCallWaiting1

defCallWaiting2

defCallWaiting3

defCallWaiting4

defCpeAlerting

defDial

defReorder

defRing

defSit1

defSit2

defSit3

fccBusy

fccDial

fccRingback

break1

-1-8000

Use this parameter to specify duration of the first off cadence, in milliseconds. (default = 500).

  • If duration = 0, silence is not generated between the on cadences.
  • If duration = -1, silence is generated continuously.

break2

-1-8000

Use this parameter to specify duration of the second off cadence, in milliseconds. (default = 0).

  • If duration = 0, silence is not generated between the on cadences.
  • If duration = -1, silence is generated continuously.

break3

-1-8000

Use this parameter to specify duration of the third off cadence, in milliseconds. (default = 0).

  • If duration = 0, silence is not generated between the on cadences.
  • If duration = -1, silence is generated continuously.

generationMethod

N/A

This parameter determines the tone generation method. The value is specified at object creation time and cannot be modified afterwards. See Table 2 for attribute descriptions.

  • compositeTone
  • dualTone (default)
  • modulatedTone
  • singleTone

make1

-1-8000

Use this parameter to specify duration of the first on cadence, in milliseconds. (default = 500).

  • If make1 = 0, duration of first on cadence = 0 milliseconds.
  • If make1 = -1, the tone plays continuously.

make2

-1-8000

Use this parameter to specify duration of the second on cadence, in milliseconds. (default = 0).

  • If make2 = 0, duration of first on cadence = 0 milliseconds.
  • If make2 = -1, the tone plays continuously.

make3

-1-8000

Use this parameter to specify duration of the third on cadence, in milliseconds. (default = 0).

  • If make3 = 0, duration of first on cadence = 0 milliseconds.
  • If make3 = -1, the tone plays continuously.

repeat

N/A

Number of overall cadence cycles to generate. (default = 0).

  • If repeat = 0, the tone pattern repeats indefinitely.

repeat1

N/A

Number of cadence 1 cycles to generate. (default = 1)

repeat2

N/A

Number of cadence 2 cycles to generate. (default = 1)

repeat3

N/A

Number of cadence 3 cycles to generate. (default = 1)

Caption
0Table
1generationMethod attributes of Tone Profile

Parameter

...

Length/Range

Description

compositeTone

...

Composite tone settings include:

  • decayApplyToneBitMap – Use this attribute to identify the tones to which decay and frequency rate change are applied. Application is by bitmap (see bitmap table below). <range: 0-15>
  • decayFrequencyDelta – The frequency rate of change (Hertz/s) of the tone <range: 0-1000>. If 0, no rate change is applied.
  • decayTimeConstant – The exponential decay time constant in milliseconds <range: 0-2000>. If 0, no decay is applied.
  • tone1ApplyCadence – Specifies the cadences to which Tone 1 is applied.
    • allCadence 
    • cadence1
    • cadence2
    • cadence3
  • tone1Frequency – Tone 1 frequency, in Hertz. <range: 0-3999>. If set to "0", silence is generated.
  • tone1Power – Tone 1 power, in dBm. <range: -50-3>
  • tone2ApplyCadence – The cadences to which Tone 2 is applied (same options as tone1ApplyCadence above).
  • tone2Frequency – Tone 2 Frequency in Hertz. If set to "0", silence is generated.
  • tone2Power – Tone 2 Power in dBm. <range: -50-3>
  • tone3ApplyCadence – The cadences to which Tone 3 is applied (same options as tone1ApplyCadence above).

  • tone3Frequency – Tone 3 Frequency in Hertz. If set to "0", silence is generated.

  • tone3Power – Tone 3 Power in dBm. <range: -50-3>

  • tone4ApplyCadence – The cadences to which Tone 4 is applied (same options as tone1ApplyCadence above).

  • tone4Frequency – Tone 4 Frequency in Hertz. If set to "0", silence is generated.

  • tone4Power – Tone 4 Power in dBm. <range: -50-3>

dualTone

...

Use this parameter to configure dual tone attributes.

  • tone1Frequency – Tone 1 frequency, in Hertz. <range: 0-3999 / default = 440>. If set to "0", silence is generated.
  • tone1Power – Tone 1 power, in dBm. <range: -50-3 / default = -13>
  • tone2Frequency Tone 2 frequency, in Hertz. <range: 0-3999 / default = 0>. If set to "0", silence is generated.
  • tone2Power Tone 2 power, in dBm. <range: -50-3 / default = 0>
modulatedTone

...

Use this parameter to configure modulated tone attributes.

  • carrierFrequency – The carrier frequency in Hertz for the modulated signal. <range: 0-3999>
  • carrierPower – The Carrier power in dBm. <range: -50-3 / default = 0>
  • signalFrequency – The frequency in Hertz of the sinusoid modulating the carrier <range: 0-3999>.
  • signalModulationIndex – The signal modulation index as a percentage. <range: 0-300, in 1% increments>.
singleTone

...

  • tone1Frequency – Tone 1 frequency, in Hertz. <range: 0-3999>. If set to "0", silence is generated.
  • tone1Power – Tone 1 power, in dBm. <range: -50-3>

Bitmap Table:

ValueDecay/frequency rate change
is applied to:
0Not applied.
1Tone  1
2Tone  2
3Tones 1 and 2
4Tone 3
5Tones 1, 3
6Tones 2, 3
7Tones 1, 2, 3
8Tone 4
9Tones 1, 4
10Tones 2, 4
11Tones 1, 2, 4
12Tones 3, 4
13Tones 1, 3, 4
14Tones 2, 3, 4
15

Tones 1, 2, 3, 4

Command Examples

To show seeded tone profile:

Code Block
languagenone
% show profiles media toneProfile 
	defBusy - The user name of this tone profile.  
	defCallWaiting1 - The user name of this tone profile.  
	defCallWaiting2 - The user name of this tone profile.  
	defCallWaiting3 - The user name of this tone profile.  
	defCallWaiting4 - The user name of this tone profile.  
	defCpeAlerting - The user name of this tone profile. 
	defDial - The user name of this tone profile.  
	defReorder - The user name of this tone profile.  
	defRing - The user name of this tone profile.  
	defSit1 - The user name of this tone profile.  
	defSit2 - The user name of this tone profile.  
	defSit3 - The user name of this tone profile.  
	fccBusy - The user name of this tone profile.  
	fccDial - The user name of this tone profile.  
	fccRingback - The user name of this tone profile.
Possible match completions:
	break1 - Duration of the first off cadence in milliseconds.  
	break2 - Duration of the second off cadence in milliseconds.  
	break3 - Duration of the third off cadence in milliseconds.  
	compositeTone - Configuration of conposite tone attributes.  
	dualTone - Configuration of dual tone attributes.  
	generationMethod - Determines the generation method for the tone. 
	make1 - Duration of the first on cadence in milliseconds.  
	make2 - Duration of the second on cadence in milliseconds.  
	make3 - Duration of the thrid on cadence in milliseconds.  
	modulatedTone - Configuration of modulated tone attributes.  
	repeat - Number of overall cadence (1, 2, and 3 in sequence) cycles to generate.  
	repeat1 - Number of cadence 1 cycles to generate.  
	repeat2 - Number of cadence 2 cycles to generate.  
	repeat3 - Number of cadence 3 cycles to generate. 
	singleTone - Configuration of single tone attributes.

To delete the custom tone profile crearted:

Code Block
languagenone
 % delete profiles media toneProfile <toneProfile>

...

 

...

defBusy
defCallWaiting1
defCallWaiting2
defCallWaiting3
defCallWaiting4
defCpeAlerting
defDial
defReorder
defRing
defSit1
defSit2
defSit3
fccBusy
fccDial
fccRingback