Gerdes PrimuX User manual

PrimuX
PROFESSIONAL COMMUNICATION
Gerdes Aktiengesellschaft
Fon
Fax
Email
Internet
Bergerwiesenstraße 9
D-53340 Meckenheim / Bonn
[phone]
[phone]
[email protected]
www.gerdes-ag.de
www.TeleScout.de
www.connuX.de
www.primuxisdn.de
www.EnterNow.de

Preface
Congratulations to your new PrimuX ISDN card, a high performance adapter for professional
communications. This manual will guide you through installation and configuration of the
PrimuX ISDN adapter.
We wish you lots of success with our ISDN adapters!
Sincerely, Gerdes AG
Preface 1

Contents
Preface 1
Contents 2
Copyright notice 3
License Agreement 4
Copyright 4
License 4
Upgrades 5
Term 5
Limited Warranty 5
Customer Remedies 6
No Other Warranties 6
No Liability for Consequential Damage 6
Limit of Liability 6
Right to Audit 6
Supplementary Software 7
U.S. Government Restricted Rights 7
Contractor/ manufacturer is: 7
News and Updates 8
Customer Services 8
Software 9
Requirements 9
Installation 9
CAPICFG 11
ISDN over LAN 22
CAPI Extensions 23
NT Mode 24
2 Contents

Copyright notice
Copyright (c) 2000-2014 Gerdes Aktiengesellschaft, Meckenheim, Germany. All Rights Reserved.
You may not reproduce this document in whole or in part without permission in writing from
Gerdes Aktiengesellschaft.
All contents of this document are subject to change without notice and do not represent a
commitment on the part of Gerdes Aktiengesellschaft. Reasonable effort is made to ensure
the accuracy of the information contained in the document. However, due to ongoing product
improvements and revisions, Gerdes Aktiengesellschaft does not warrant the accuracy of this
information and cannot accept responsibility for errors or omissions that may be contained
in this document. It is possible that the use or implementation of any one of the concepts,
applications, or ideas described in this document, in marketing collateral produced by or on
web pages maintained by Gerdes Aktiengesellschaft or its subsidiaries may infringe one or more
patents or other intellectual property rights owned by third parties. Gerdes Aktiengesellschaft
does not provide any intellectual property licenses with the sale of PrimuX products other than a
license to use such product in accordance with intellectual property owned or validly licensed by
Gerdes Aktiengesellschaft or its subsidiaries. More detailed information about such intellectual
property is available from Gerdes Aktiengesellschaft's legal department at Bergerwiesenstr. 9,
D-53340 Meckenheim, Germany.
Gerdes Aktiengesellschaft encourages all users of its products to procure all necessary intellectual
property licenses required to implement any concepts or applications and does not condone or
encourage any intellectual property infringement and disclaims any responsibility related thereto.
These intellectual property licenses may differ from country to country and it is the responsibility
of those who develop the concepts or applications to be aware of and comply with different
national license requirements. In the United States, patents which may need to be licensed for
some applications or concepts include but are not limited to U.S. Patent Nos. 5,488,651 and
5,291,546. The software referred to in this document is provided under a Software License
Agreement. Refer to the Software License Agreement for complete details governing the use of
the software.
All names, products, and services mentioned herein are the trademarks or registered trademarks
of their respective organizations and are the sole property of their respective owners. Gerdes,
Gerdes Aktiengesellschaft and PrimuX are registered trademarks or trademarks of Gerdes Akti-
engesellschaft or its subsidiaries.
To contact Gerdes Customer Support, refer to the `Customer Services' section in the prin-
ted guide that came with the Gerdes product which you purchased or visit our Web site at
www.primuxisdn.de.
Copyright notice 3

License Agreement
This is an Agreement between you the Company and your Affiliates (referred to in some instan-
ces as ''You'' and in other instances as ''Company'') and all your Authorized Users and Gerdes
Aktiengesellschaft (''Gerdes'').
YOU SHOULD CAREFULLY READ THE FOLLOWING TERMS AND CONDITIONS BEFORE INSTALLING
OR DOWNLOADING THE SOFTWARE. IF YOU AGREE WITH THESE TERMS YOU MAY PROCEED
WITH THE DOWNLOAD OR INSTALLATION OF THE SOFTWARE. IF YOU DO NOT AGREE WITH
THESE TERMS, PLEASE RETURN THE PACKAGE IN ''AS NEW'' CONDITION (INCLUDING DOCU-
MENTATION AND BINDERS OR OTHER CONTAINERS) AND YOUR MONEY WILL BE REFUNDED.
DOWNLOADING OR INSTALLING THE SOFTWARE CONSTITUTES YOUR ACCEPTANCE OF THESE
TERMS AND CONDITIONS. YOU ASSUME RESPONSIBILITY FOR THE SELECTION OF THE PRO-
GRAM TO ACHIEVE YOUR INTENDED RESULTS, AND FOR THE INSTALLATION, USE, AND RESULTS
OBTAINED FROM THE PACKAGE.
Copyright
The enclosed Software (''Program'') and documents are owned by Gerdes Aktiengesellschaft
(''Gerdes'') and its suppliers and are protected by copyright laws and international treaty provisi-
ons. Therefore, You and your Authorized Users must treat the Program and documentation like
any other copyrighted material except as expressly permitted in this License Agreement.
License
Under the terms and conditions of this License Agreement:
•You may install and use one copy of the Program on a single-user computer, file server, or
on a workstation of a local area network, and only in conjunction with a legally acquired
Gerdes hardware product;
•The primary Authorized User on the computer on which the ''Program'' is installed may
make a second copy for his/her exclusive use on either a home or portable computer;
•You may copy the Program into any machine readable or printed form for backup or
modification purposes in support of your use of one copy of the Program;
•You may make one copy of Gerdes's documentation provided that all copyright notices
contained within the documentation are retained;
•You may modify the Program and/or merge it into another Program for your use in one
computer; (any portion of this Program will continue to be subject to the terms and
conditions of this Agreement);
4 License Agreement

•You may transfer the Program, documentation and the license to another eligible party
within your Company if the other party agrees to accept the terms and conditions of this
Agreement. If You transfer the Program and documentation, You must at the same time
either transfer all copies whether in printed or machine readable form to the same party
or destroy any copies not transferred; this includes all modifications and portions of the
Program contained in or merged into other Programs;
•You must reproduce and include the copyright notice on any copy, modification or
portion of the Program merged into another Program;
•You may not rent or lease the Program. You may not reverse engineer, decompile or
disassemble the Program. You may not use, copy, modify or transfer the Program and
documentation, or any copy, modification or merged portion, in whole or in part, except
as expressly provided for in this License Agreement;
•If You transfer possession of any copy, modification or merged portion of the Program
or documentation to another party in any way other than as expressly permitted in this
License Agreement, this license is automatically terminated.
Upgrades
If the Program is provided as an upgrade and the upgrade is an upgrade from another software
product licensed to You and Your Authorized Users by Gerdes, the upgrade is governed by the
License Agreement earlier provided with that software product package and the present License
Agreement does not grant you additional license(s).
Term
The license is effective until terminated. You may terminate it at any time by destroying the
Program and documentation together with all copies, modifications and merged portions in
any form. It will also terminate upon conditions set forth elsewhere in this Agreement or if you
fail to comply with any terms or conditions of this Agreement. You agree upon such termination
to destroy the Program and documentation together with all copies, modifications and merged
portions in any form.
Limited Warranty
The only warranty Gerdes makes is that the medium on which the Program is recorded will be
replaced without charge if Gerdes, in good faith, determines that it was defective in materials or
workmanship and if returned to your supplier with a copy of your receipt within ninety (90) days
from the date you received it. Gerdes offers no warranty for your reproduction of the Program.
This Limited Warranty is void if failure of the Program has resulted from accident, misuse, abuse
or misapplication.
Upgrades 5

Customer Remedies
Gerdes's entire liability and You and Your Authorized Users exclusive remedy shall be, at Gerdes's
option, either (a) return of the price paid or (b) repair or replacement of the Program that
does not meet the above Limited Warranty. Any replacement Program will be warranted for the
remainder of the original Warranty period.
No Other Warranties
Gerdes disclaims all other warranties, either expressed or implied, including but not limited to
implied warranties or merchantability and fitness for a particular purpose and the warranty
against latent defects, with respect to the Program and the accompanying documentation. This
limited warranty gives You specific legal rights. You may have others, which may vary from
jurisdiction to jurisdiction.
No Liability for Consequential Damage
In no event shall Gerdes or its suppliers be liable for any damages whatsoever (including without
limitation, damages for loss of business profits, business interruption, loss of information, or
other pecuniary loss and indirect, consequential, incidental, economic or punitive damages)
arising out of the use of or inability to use this Program, even if Gerdes has been advised of the
possibility of such damages. As some jurisdictions do not allow the exclusion or limitation for
certain damages, some of the above limitations may not apply to You or your Authorized Users.
Limit of Liability
Gerdes's entire aggregate liability under any provision of this agreement shall be limited to the
amount actually paid by You for the affected Program.
Right to Audit
If this Program is licensed for use in a Company, your Company agrees to keep all usual and
proper records and books of accounts and all usual proper entries relating to each reproduction
and Authorized User of the Program during the term of this Agreement and for a period of three
(3) years thereafter. During this period, Gerdes may cause an audit to be made of the applicable
records in order to verify Your compliance with this Agreement and prompt adjustment shall be
made to compensate for any errors or omissions disclosed by such audit. Any such audit shall
be conducted by an independent certified public accountant selected by Gerdes and shall be
conducted during the regular business hours at Your offices and in such a manner as not to
interfere with Your normal business activities. Any such audit shall be paid for by Gerdes unless
material discrepancies are disclosed. For such purposes, ''material discrepancies'' shall mean three
6 Customer Remedies

percent (3%) or more of the Authorized Users within the Company. If material discrepancies
are disclosed, Your Company agrees to pay Gerdes for the costs associated with the audit as
well as the license fees for the additional Authorized Users. In no event shall audits be made
more frequently than semi-annually unless the immediately preceding audit disclosed a material
discrepancy.
Supplementary Software
Any Supplementary Software provided with the Gerdes Program referred to in this License
Agreement is provided ''as is'' with no warranty of any kind.
U.S. Government Restricted Rights
The Program and documentation are provided with RESTRICTED RIGHTS. Use, duplication or
disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph c)
1) ii) of The Rights in Technical Data and Computer Software clause at DFARS 252.227-7013
or subparagraph c) 1) and 2) of the Commercial Computer Software-Restricted Rights at 48
CFR52.227-19, as applicable.
Contractor/ manufacturer is:
Gerdes Aktiengesellschaft
Bergerwiesenstr. 9, D-53340 Meckenheim, Germany
Supplementary Software 7

News and Updates
You can find up-to-date information, software and add-on products for your PrimuX card on
the internet at
www.primuxisdn.de
We highly recommend that regularly check this web site for updates or upgrades.
Customer Services
Your PrimuX ISDN adapter is very easy to install and use. This manual should contain all
information you need. As every PC is different, it is always possible that problems occur that are
due to specific configurations of your PC.
Answers to frequently asked questions and tips concerning ISDN or the internet are available on
our web site
www.primuxisdn.de
If you can't find the answer to your questions there please call or mail our service team:
Phone + 49 2225 / 916030
Fax +49 2225 / 91601899
Mail [email protected]
8 News and Updates

Software
Requirements
MS Windows
The driver software for the PrimuX adapters can be used on Windows XP, Windows Server
2003, Windows 7, 8, 8.1, 2008 Server and 2012 Server.
Linux
The driver software for the PrimuX adapters can be used with a Linux kernel version 2.4.x
(2.4.10 or higher) or 2.6.x and 3.x. The CAPICFG and TRACER tools need the GTK libraries 1.2
or higher.
Please note that it is possible to use the GUI configuration tool to configure console-only PC
connected to a LAN by using the RMTCAPI daemon. As these tools are TCP/IP based it is even
possible to configure Linux PCs from Windows or the other way around. Tools like HylaFAX (using
CAPI4HylaFAX), CapiSuite or pppd (using capiplugin.so) can be used without any modifications.
kisdnwatch is supported but needs a patch in the manufacturer check (replace ''avm'' by ''gerdes'').
Installation
MS Windows
Please install the PrimuX software before adding the PrimuX adapter. This way you can
configure your PCs first and install different PrimuX adapters at a later time.
Run primux.exe from the driver CD. Follow the instructions on screen. During installation
Windows will ask if you trust software from Gerdes AG. Please acknowledge these prompts by
clicking Yes. After the installation has finished all components needed for the PrimuX adapters
have been installed.
After installing/connecting your hardware Windows will show a New hardware found dialog.
Please select Install the software automatically (Recommended) and click Next. For each added
ISDN WAN MiniPort a New hardware found dialog will appear. Select Install the software
automatically (Recommended) and click Next each time. Acknowledge the following Hardware
has not passed Windows Logo testing message by clicking Continue Anyway.
Deinstalling the drivers
To deinstall the driver software for your PrimuX adapter select Start / Programs / PrimuX ISDN
/ Remove software and follow the instructions on screen.
Software 9

WARNING: The deinstallation process will remove all installed PrimuX adapters whether they
are currently active or not. All driver settings will be lost. To reuse your settings at a later time
you have to save them before deinstallation. After deinstallation you need to reboot your PC to
completely remove all driver files.
Linux
Introduction
Because of dependencies between the driver and the kernel version used on your machine the
OS dependent part of the driver has to be compiled during installation. The necessary kernel
include files should have been installed by your distribution.
The PrimuX software doesn't need any distribution specific configuration applications (i.e.
YaST2 with SuSE). These application won't be able to configure the PrimuX adapters and in
most cases won't even show them in their list of installed hardware. You can configure your
PrimuX adapter using CAPICFG.
Installation
To install the driver software run setup.sh from the installation CD. Depending on your system
(graphical desktop or console) a compatible installation routine will start up:
•The text mode installation asks you to answer a few questions. Please keep the default
settings by simply pressing ENTER. Based on these settings the driver and utilities will be
installed, compiled and loaded
•In the GTK based installation program simply click Begin Install. The driver and utilities
will be installed, compiled and loaded
As the PrimuX drivers are not licensed under the GPL, recent Linux kernels may show a warning
message (tainted kernel) when loading the drivers. You can safely ignore this message, though.
Deinstalling the drivers
To deinstall the driver software for your PrimuX adapter please enter
/usr/lib/primux/uninstall
at a bash prompt. This will remove all files and settings made by the installation process.
WARNING: The deinstallation process will remove all installed PrimuX adapters whether they
are currently active or not. All driver settings will be lost. To reuse your settings at a later time
you have to save them before deinstallation.
10 Installation

CAPICFG
On the left hande side of the CAPICFG main window a list of all available services and ISDN
adapters is shown. The right hand side will show settings for the selected item on the left hand
side.
The 'File' menu
New
This command will create a new empty configuration. CAPICFG will query you to save your
changes before deleting the current configuration.
Open active configuration
This command loads the current configuration from the driver. CAPICFG will query you to save
your changes before deleting the current configuration.
Open remote configuration
This command opens a connection to a PrimuX driver loaded on another PC and loads its
configuration. On the other PC the RMTCAPI daemon has to be started for this to work. CAPICFG
will query you to save your changes before deleting the current configuration.
CAPICFG 11

Please input the IP address of the remote PC and the port used by the RMTCAPI daemon. Then
click on Ok.
Open
This command loads a previously saved configuration from disk. CAPICFG will query you to
save your changes before deleting the current configuration.
Save
This command saves the current configuration to disk.
Save as...
This command saves the current configuration to disk using a new or different file name.
Activate
This command reconfigures the driver with the current configuration. If you originally loaded
the configuration using the Open remote configuration command the driver on the remote PC
will be reconfigured.
Exit
This command will close the program. CAPICFG will query you to save your changes before
deleting the current configuration.
The 'Edit' menu
12 CAPICFG

Cut
Copy selected data to the clipboard and delete it from the configuration.
Copy
Copy selected data to the clipboard.
Paste
Insert clipboard contents into the configuration.
Delete
Delete selected data.
The 'Insert' menu
CAPI Service
The CAPI service can be added only once. It enables access to the ISDN adapters using the CAPI
2.0 (and CAPI 1.1) interface.
RAS (WAN miniport)
The WAN miniport can be added only once. It enables access to the ISDN adapters for internet
dial up services. On Windows additional devices will be created that can be used with the
Windows RAS service. On Linux you can access adapters configured for RAS by using different
controller numbers (129, 130, ... instead of 1, 2, ...).
Add adapters
The lower part of this menu contains a list of all adapter types supported by the driver. You
can add these adapters to a configuration manually. This way you can preconfigure a PC before
installing the hardware for real.
CAPICFG 13

The 'View' menu
Toolbar
Toggle the toolbar display.
Statusbar
Toggle the status bar display.
Advanced
Toggle availability of the advanced settings page. This page shows some technical settings that
you can modify on your own risk...
The 'Help' menu
Content
Open the contents page of the online help.
Context help
Open the help page for the current selection.
14 CAPICFG

CAPI Service
These pages show information about the features supported by the CAPI service. You can use
this list to check if the driver supports specific features some applications require.
General
This page shows the manufacturer data, version and revision information and an optional serial
number the adapter reports to applications. Furthermore you will find the number of controllers
and B channels configured for the CAPI service here.
Features
The CAPI service reports supported features in a standardized way. You will find a list of supported
features on this page.
Protocols
The CAPI service reports supported B channel protocols in a standardized way. You will find a
list of supported protocols on this page.
CAPICFG 15

RAS service
On this page you will find the number of channels available for internet dial up connections.
Adapter settings
On this page you will find some general information about the selected adapter.
Some adapter types (i.e. adapters connected to the serial port) need additional settings. These
settings will be shown on this page, too.
Port settings
An ISDN adapter supports one or more ISDN ports. For every port you will need to specify some
information about the ISDN line it is connected to.
General
16 CAPICFG

Line type Some technical data about the kind of line this port can be connected to.
Switch Type You can get information about the switch and interface type from your phone
provider. As most countries today use the ETSI-DSS1 standard the default setting should be a
good start.
Interface Type ISDN lines in private homes usually are of the Point-to-Multipoint (PTMP) type.
If the line is configured for a PABX it may be a Point-to-Point (PTP) line. Please ask your phone
provider if you are not sure what kind of line you have.
Inbound calls This settings should be 'No Phone Numbers' at first. This way all inbound calls
will immediately be signaled to the application software. When you use some software that
will always accept all calls regardless of the called party number you can enable a filter in the
driver. This way the application will only be notified of calls that matched your settings. The MSN
(Multiple Subscriber Number) setting allows specification of those numbers the driver should
pass through; the Range of Extensions setting allows selection of a range of numbers in a PTP
setting.
Diagnostics By pressing this button you can check if the line can connect to the phone company
using the selected settings. Please keep in mind, that all your current settings will be activated
in the driver for this test.
List of MSNs
On this page you can add up to 10 numbers to the list which the driver should pass through.
Dial-In numbers
On this page you can specify a lowest and a highest extension. The driver will pass all calls
directed to an extension in this range to the application. Both numbers have to be of the
CAPICFG 17

same length and the lowest extension has to be numerically smaller than the highest extension.
Depending on the port it may be necessary to add a trunk number to both numbers.
Advanced
The advanced settings are quite technical and require some basic knowledge of ISDN hardware.
Adapters for the S0 bus offer the following advanced settings:
Direct Dial In (NT2) If you set this to Yes the driver will automatically generate a SETUP ACK
message on incomplete numbers. This way there won't be a timeout when the caller manually
dials a long extension number.
The default on a PTMP line is No, on a PTP line it is Yes.
TEI Here you can select the TEI value to use for layer 2 connections. The default on a PTMP line
is Automatic, on a PTP line it is 0.
Layer 2 Connect Mode This setting specfies how the layer 2 connection is managed. On PTMP
lines the default is On Demand; with this setting layer 2 will be established when a call is being
made and released as soon as the last call is terminated. On PTP lines (and on PRI lines) the
default is No Disconnect; with this setting layer2 will be established when a call is being made
but it will never be (actively) released. With the Permanent setting layer 2 will be established
immediately when a layer 1 connection is established.
Cause Value for Rejected Calls Here you can specify how the driver handles inbound calls that
are not signalled to any application. Usually those calls are simply ignored but in special cases
it may be necessary to reject them with a specific cause value (i.e. for call redirecting services to
work).
Voice Coding Here you can specify whether the driver should use the a-Law or u-Law coding
standard for generated tone signals (fax modulation, DTMF etc.). The default setting Protocol
default sets the coding standard based on the selected switch type; usually there should be no
need to manually change this setting.
Device Mode This setting selects if the ISDN port should be activated immediately upon loading
the driver (setting Default) or onyl when an application is registered with the driver (setting Hunt
18 CAPICFG

Group). The Hunt Group setting makes sense when a PBX can sense a deactivated line and will
automatically distribute inbound calls only to active lines.
Operating Mode [only available on adapters with NT mode support] Here you can select if the
port should be used as terminal equipment (setting TE- Terminal Equipment (recommended))
or network termination. If you select NT - Network Termination [simple] the driver will handle
almost all differences between NT and TE mode so that there are virtually no software changes
necessary. The driver will generate all progress tones at the appropriate times without application
intervention. These features can be disabled by selecting NT - Network Termination [full]. Now
the application has complete control over the ISDN line (for this to work you will need to change
your software). You will find more information about the NT mode support in the chapter NT
Mode.
Adapters for the primary rate interface offer some additional settings:
Fractional T1/E1 Line An E1 line usually supports 30 B channels numbered 0 to 29 (T1: 23
channels). Fractional lines offer a reduced number of channels for a lower price. If you use a
fractional line please select Yes and specify the available channels.
No. of Available B Channels Please enter the number of available channels on your fractional
line (you can request this information from your phone company).
Lowest B Channel Please enter the number of the lowest available channel on your fractional
line (you can request this information from your phone company).
Layer 1 Framing Here you can select what line framing to use. The Procotol default setting selects
the framing depending on the selected switch type and should usually be correct. If your phone
company specifies a different framing please choose the corresponding setting.
Layer 1 Coding Here you can select what line coding to use. The Procotol default setting selects
the coding depending on the selected switch type and should usually be correct. If your phone
company specifies a different coding please choose the corresponding setting.
CAPICFG 19