updated the documentation and the sample config to meet the present

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@7446 65c4cc65-6c06-0410-ace0-fbb531ad65f3

configs/misdn.conf.sample

@@ -20,6 +20,7 @@
 ;
 debug=0
 
+
 ; the big trace
 ;
 ; default value: [not set]
@@ -40,7 +41,7 @@ trace_dir=/var/log/
 ;
 ; default value: yes
 ;
-bridging=yes
+bridging=no
 
 ; stops dialtone after getting first digit on nt Port
 ;
@@ -68,15 +69,6 @@ l1_info_ok=yes
 ;
 clear_l3=no
 
-; set the method to use for channel selection:
-;   standard    - always choose the first free channel with the lowest number
-;   round_robin - use the round robin algorithm to select a channel. use this
-;                 if you want to balance your load.
-;
-; default value: standard
-;
-method=standard
-
 ;;; CRYPTION STUFF
 
 ; Wether to look for dynamic crypting attempt
@@ -125,6 +117,16 @@ context=misdn
 ;
 language=en
 
+;
+; sets the musiconhold class
+;
+musicclass=default
+
+;
+; Either if we should produce DTMF Tones ourselve
+; 
+senddtmf=yes
+
 ; Prefixes for national and international, those are put before the 
 ; oad if an according dialplan is set by the other end. 
 ;
@@ -149,11 +151,23 @@ txgain=0
 ;
 te_choose_channel=no
 
+; set the method to use for channel selection:
+;   standard    - always choose the first free channel with the lowest number
+;   round_robin - use the round robin algorithm to select a channel. use this
+;                 if you want to balance your load.
+;
+; default value: standard
+;
+method=standard
+
+;
+; dialplan means Type Of Number in ISDN Terms (for outgoing calls)
+;
 ; dialplan options: 
 ;
 ; 0 - unknown
-; 1 - National
+; 1 - International
-; 2 - International
+; 2 - National
 ; 4 - Subscriber
 ;
 ; This setting is used for outgoing calls
@@ -161,6 +175,7 @@ te_choose_channel=no
 ; default value: 0
 ;
 dialplan=0
+localdialplan=0
 
 ; This is only for asterisk head and will result in only considering 
 ; misdn.confs and misdn_set_opts callingpresentation informations if set to no.
@@ -170,6 +185,13 @@ dialplan=0
 ;
 use_callingpres=yes
 
+
+
+;
+; turn this to no if you don't mind correct handling of Progress Indicators  
+;
+early_bconnect=yes
+
 ; uncomment the following to get into s extension at extension conf
 ; there you can use DigitTimeout if you can't or don't want to use
 ; isdn overlap dial. 
@@ -236,6 +258,17 @@ echocancelwhenbridged=no
 ;
 echotraining=yes
 
+;
+; chan_misdns jitterbuffer, default 1000
+; 
+jitterbuffer=1000
+
+;
+; change this threshold to enable dejitter functionality
+;
+jitterbuffer_upper_threshold=0
+
+
 [intern]
 ; define your ports, e.g. 1,2 (depends on mISDN-driver loading order) 
 ports=1,2

doc/README.misdn

@@ -21,13 +21,13 @@ Features:
 * Data (HDLC) callthrough 
 * Data Calling (with app_ptyfork +pppd)
 * Echo cancellation
+* CallDeflection
 * Some other
 
 Supported Hardware:
 -------------------
 
-chan_misdn supports any mISDN compatible Hardware. Especially the 1-8 Port
+chan_misdn supports any mISDN compatible Hardware.
-BRI Cards available from http://shop.beronet.com
 
 Overview
 --------
@@ -49,48 +49,28 @@ Overview
 Fast Installation Guide
 -----------------------
 
-You have two options on how to install chan_misdn.
+It is easy to install mISDN and mISDNuser. Using the Makefile from
+channels/misdn. You just need to type:
 
-(1) Requirements: 
+cd channels/misdn 
-      - mISDN and mISDNuser from jolly (see Pre-Requisites below)
+make misdn
-    Installation: 
-	  - cd <asterisk-src-dir>/channels/misdn
-	  - edit Makefile so that MISDNUSER points to your mISDNuser directory
-	  - run 'make'
-	  - cd <asterisk-src-dir>
-	  - compile and install asterisk via 'make install'
 
-(2) Requirements:
+Then all the necessary files are fetched from isdn4linux.de.
-      - Asterisk headers and Kernel headers
-    Description:
-      The Makefile gets the newest mISDN and mISDNuser Sources from 
-	  jollys webpage and the newest release of chan_misdn from beronets 
-	  Servers. After that it compiles and installs everything (hopefully).
-    Installation:
-      - cd /usr/src
-      - wget http://www.beronet.com/downloads/install-misdn.tar.gz
-	  - tar zxf install-misdn.tar.gz
-	  - cd install-misdn
-	  - make install
 
 
 Pre-Requisites
 --------------
 
-To compile and install this driver, you'll need at least one mISDN Driver, the
+To compile and install this driver, you'll need at least one mISDN Driver and
-mISDNuser package and the Asterisk includes (which will be inside of the
+the mISDNuser package. Chan_misdn works with both, the current release version
-sources). Chan_misdn works with both, the current release version and the 
+and the development (svn trunk) version of Asterisk. mISDNuser and mISDN must
-development (svn trunk) version of Asterisk.
+be fetched from cvs.isdn4linux.de (mqueue branch).
 
-To get the mISDN stuff please follow the instructions at
+Please Note that mISDN works good for the linux-2.6.x kernels. Some of the
-http://www.isdn4linux.de.  Please Note that mISDN works good for the
+mISDN drivers do not compile against the 2.4.x or older kernels, you can patch
-linux-2.6.x kernels. Some of the mISDN drivers do not compile against the
+them, but than you'll get mysterious errors.
-2.4.x or older kernels, you can patch them, but than you'll get mysterious
-errors.
 
-I use Kernels > 2.6.9 and it works perfect. with kernels >= 2.6.10 there is a
+Using Kernels > 2.6.9 works perfect. 
-very litle bug in hfc_multi.c which causes the module not to compile, it can
-be easily fixed by changing pci_findsubsys to pci_getsubsys in code.
 
 Ok so far so good, now follow the compilation instructions.
 
@@ -99,46 +79,26 @@ Ok so far so good, now follow the compilation instructions.
 Compilation 
 -----------
 
-!! Be aware, in the actual mISDNuser package theres a bug in the Makefile
+The compilation of chan_misdn requires a library which will be generated under
-!! the compilation stops near iapplication.h, this isn't very important
+channels/misdn/.
-!! at this step you are ready. 
 
-After you've successfully installed mISDN, mISDNuser and Asterisk, you should
+To compile this library you just need to go into this directory and type
-modify the Makefile in the chan_misdn source path. There you can tell the
+make. Now you can go back to the asterisk source root and type make install
-Makefile where to install the driver, sample-conf, and most important where it
+again, which now should compile and install chan_misdn.
-can find the linux kernel includes, the mISDNuser package and the Asterisk
-includes.  If you use the development version of Asterisk (or at least a newer
-version than release) uncomment the CCFLAGS+=-DASTERISK_STABLE, the release
-version of Asterisk is at the moment v1-2 as subversion branch.
 
-Now you can type in: 
-
-make
-
-This should compile chan_misdn.so, if there's an error check the paths in the
-Makefile again.
 
 
 Installation
 ------------
 
-After successful compilation of chan_misdn, you should simply type in:
+Chan_misdn is automatically installed by the asterisk installation process.
 
-make install 
+There is a sample init.d script for loading the mISDN modules (mISDN.sample),
-
+5Asimply copy it to /etc/init.d/ and modify it, there you can enter your cards.
-as privileged user to put chan_misdn.so in the Asterisk modules
-directory.
-
-You should see a message like: "Successfully installed chan_misdn". 
-Congratulations. 
-
-Theres a sample init.d script for loading the mISDN modules (mISDN.sample),
-simply copy it to /etc/init.d/ and modify it, there you can enter your cards.
 
 !! Forget to use capi together with chan_misdn. 
 
 
-
 Configuration
 -------------
 
@@ -162,6 +122,11 @@ configuration file, bigger numbers will lead to more debug output. There's also
 tracefile option, which takes a path+filename where debug output is written
 to.
 
+- misdn.conf: [default] section 
+The default section is another special section which can contain all the
+options available int the usr/port sections. the user/port section inherit
+their parameters from the default section.
+
 - misdn.conf: user/port sections
 The user sections have names which are unequal to "general". Those sections
 contain the ports variable which mean the mISDN Ports. Here you can add
@@ -205,8 +170,8 @@ The available Optchars are:
 	vt - txgain control
 
 
-chan_misdn registers a new dial plan application "misdn_set_opt" when loaded. This 
+chan_misdn registers a new dial plan application "misdn_set_opt" when
-application takes the Optionsstring as argument. The Syntax is:
+loaded. This application takes the Optionsstring as argument. The Syntax is:
 
 misdn_set_opt(<OPTIONSSTRING>)
 
@@ -343,6 +308,11 @@ it, you can just change pci_find_subsys to pci_get_subsys, this works.
 	* asterisk >= v1-0.2 , also CVS Head
 	* mISDN/mISDNuser (3.0-beta) from isdn.jolly.de
 
+- chan_misdn-0.2.1
+	* linux-kernel >= 2.6.8 (but at least 2.6) 
+	* asterisk >= v1.2 , also CVS Head
+	* mISDN/mISDNuser (3.0) from isdn.jolly.de
+
 
 Known Problems
 --------------