CAS R1 E&M - Revision history

Abrassard at 20:40, 22 November 2013

2013-11-22T20:40:33Z

Abrassard at 15:43, 8 August 2013

2013-08-08T15:43:29Z

Abrassard: moved E&M to CAS R1 E&M: Missing "CAS" in the title, "E&M" is too short!

2013-08-08T15:15:32Z

moved E&M to CAS R1 E&M: Missing "CAS" in the title, "E&M" is too short!

Abrassard: Improved doc

2013-08-05T17:23:32Z

Improved doc

Clod Patry: basic page for E&M

2013-07-31T19:45:02Z

basic page for E&M

Clod Patry: moved E&M to CASr1 scripting: this page is what's needed for all CASr1 script, not specific to E&M.

2013-07-31T19:11:36Z

moved E&M to CASr1 scripting: this page is what's needed for all CASr1 script, not specific to E&M.

New page

#REDIRECT [[CASr1 scripting]]

@@ Line 56: / Line 56: @@
 * DNIS stands for "Dialed Number Identification Service" (or "called number").
-In the E&M variants, ANI (calling number) is optional, while DNIS (called number) is mandatory.
+In the E&M variants, ANI (calling number) is optional, while DNIS (called number) is most of the time mandatory (though in some cases may be omitted).
 ==== Detection of ANI and/or DNIS ====
@@ Line 82: / Line 82: @@
 ==== Enabling/disabling usage of ANI ====
-To enable detection of ANI, enable one of the 3 detection methods above (prefix/suffix, expected number of digits, or inter-digit timeout).
+To enable detection of ANI, enable one of the 3 detection methods above in the "ANI" configuration (prefix/suffix, expected number of digits, or inter-digit timeout).
 If none is used, ANI won't be sent or received by the script.

@@ Line 44: / Line 44: @@
 Depending if you want to use 0, 1 or 2 winks.
 === Configuring exchange of ANI/DNIS ===
@@ Line 65: / Line 72: @@
 		suffix = "#",
 		expected_digits = 0,
-		inter_digit_timeout = 0,
+		inter_digit_timeout = 5000,
 	},
 </pre>
-* ANI/DNIS may be surrounded by separator digits (most of the time "KP" and "ST" MFR1 tones).
-** Prefix/suffix are automatically added by the script when the digits are being sent
+Please read detailed information about configuration of ANI/DNIS reception and transmission using the variables above:
-** Prefix/suffix are detected by the script and removed from the collected digits before being reported to the application as calling/called numbers
+* [[CASr1_scripting#ACTION_SEND_ANI|Options for sending ANI]]
-* Expected number of digits is generally used in cases where no prefix/suffix are used, but instead a well-known (and fixed) number of digits are expected to be received
+* [[CASr1_scripting#ACTION_WAIT_ANI|Options for receiving ANI]]
-* The inter-digit timeout allows to declare ANI/DNIS complete after a delay without receiving subsequent digits. This is generally used with prefix/suffix separators are not used.
 ==== Enabling/disabling usage of ANI ====

@@ Line 1: / Line 1: @@
-E&M is a CASr1 family.
+E&M "Wink Start" is a CASr1 variant.
-This script is used to configure the following variants:
-* Immediate delay
-* Wink-start
-* Double-ack
-* EANA
 == Overview ==
-E&M scripts use the same logic specified in [[CASr1 scripting]].
 == Configuration ==
 To specify a script to use E&M, you MUST specify one of the following:
 <pre>
@@ Line 17: / Line 40: @@
 CasR1.Variant = CasR1.VariantTypes.WINK_START
 CasR1.Variant = CasR1.VariantTypes.WINK_START_ACK
 </pre>
-Depending if you want to use 0, 1 or 2 winks and if you plan to receive or not the ANI.
+Depending if you want to use 0, 1 or 2 winks.
-== Subvariants ==
+In the E&M variants, ANI (calling number) is optional, while DNIS (called number) is mandatory.
-Here are the differences between the subvariants:
-=== Delay Start ===
+==== Detection of ANI and/or DNIS ====
-there's no wink before receiving ANI/DNIS.
+Configuration of reception/transmission of ANI/DNIS is controlled by the following variables:
-=== Wink Start ===
+* ANI/DNIS may be surrounded by separator digits (most of the time "KP" and "ST" MFR1 tones).
-There's 1 wink before receiving ANI/DNIS.
+** Prefix/suffix are automatically added by the script when the digits are being sent
-=== Wink Start ACK ===
+==== Enabling/disabling usage of ANI ====
-There's 1 wink before receiving ANI/DNIS.
+To enable detection of ANI, enable one of the 3 detection methods above (prefix/suffix, expected number of digits, or inter-digit timeout).
-There's 1 wink after receiving ANI/DNIS.
-=== EANA ===
+If none is used, ANI won't be sent or received by the script.
-This variant is similar to wink start, but it contains ANI, while wink-start has no ANI.
-This is the Automic Number Identification, commonly called the "calling number".
+== Subvariants ==
 <pre>
-ANI = {
+	OUTGOING_DELAY_TIMEOUT	= 500
-	prefix = "*",
-	suffix = "*",
-	expected_digits = 0,
-	inter_digit_timeout = 0,
-−
 </pre>
-== DNIS ==
+Wink duration can be configured by the following script constant (in milliseconds):
-−
-This is the Dialed Number Identification Service, commonly called the "called number".
 <pre>
-DNIS = {
+	INCOMING_WINK_DURATION 	= 200
-		prefix = "*",
-		suffix = "#",
-		expected_digits = 0,
-		inter_digit_timeout = 0,
-−
 </pre>
-By using the 2 above sections, you're expecting to receive:
+=== Wink Start ACK ===
-<pre>
+There's 1 wink before receiving ANI/DNIS.
-*ANI*DNIS#
+There's 1 wink after receiving ANI/DNIS.
-</pre>
-when you're in the incoming addressing state.
+== Detailed information about the E&M script and state machines ==

← Older revision		Revision as of 19:45, 31 July 2013
Line 1:		Line 1:
−	~~#REDIRECT~~ [[CASr1 scripting]]	+
		+	E&M is a CASr1 family.
		+	This script is used to configure the following variants:
		+	* Immediate delay
		+	* Wink-start
		+	* Double-ack
		+	* EANA
		+
		+	== Overview ==
		+	E&M scripts use the same logic specified in [[CASr1 scripting]].
		+
		+
		+	== Configuration ==
		+	To specify a script to use E&M, you MUST specify one of the following:
		+	<pre>
		+	CasR1.Variant = CasR1.VariantTypes.DELAY_START
		+	CasR1.Variant = CasR1.VariantTypes.WINK_START
		+	CasR1.Variant = CasR1.VariantTypes.WINK_START_ACK
		+	CasR1.Variant = CasR1.VariantTypes.EANA
		+	</pre>
		+
		+	Depending if you want to use 0, 1 or 2 winks and if you plan to receive or not the ANI.
		+
		+
		+
		+	== Subvariants ==
		+	Here are the differences between the subvariants:
		+
		+	=== Delay Start ===
		+	there's no wink before receiving ANI/DNIS.
		+
		+	=== Wink Start ===
		+	There's 1 wink before receiving ANI/DNIS.
		+
		+	=== Wink Start ACK ===
		+	There's 1 wink before receiving ANI/DNIS.
		+	There's 1 wink after receiving ANI/DNIS.
		+
		+	=== EANA ===
		+	This variant is similar to wink start, but it contains ANI, while wink-start has no ANI.
		+
		+
		+	== ANI ==
		+
		+	This is the Automic Number Identification, commonly called the "calling number".
		+
		+	<pre>
		+	ANI = {
		+	prefix = "*",
		+	suffix = "*",
		+	expected_digits = 0,
		+	inter_digit_timeout = 0,
		+	}
		+	</pre>
		+
		+
		+	== DNIS ==
		+
		+	This is the Dialed Number Identification Service, commonly called the "called number".
		+	<pre>
		+	DNIS = {
		+	prefix = "*",
		+	suffix = "#",
		+	expected_digits = 0,
		+	inter_digit_timeout = 0,
		+	}
		+	</pre>
		+
		+	By using the 2 above sections, you're expecting to receive:
		+	<pre>
		+	ANIDNIS#
		+	</pre>
		+	when you're in the incoming addressing state.