BerofixDocuV2

From berofix - professional SIP gateway

Jump to: navigation, search

Contents

1 berofix product family
2 Network Setup
3 berofix WebInterface

berofix product family

The berofix product family is a powerful and flexible hardware solution to connect ISDN (BRI, PRI), analog (FXO/FXS) as well as GSM lines to any SIP based VoIP system. The berofix product family consist of a baseboard and the so called Modules. The berofix baseboards are available as PCI ,PCIexpress cards as well as an external Box. The baseboard is modular where you can plug and mix different Modules in analog (FXO/FXS), digital ISDN (BRI/PRI) as well as GSM all on the same baseboard. A PCM Bus interconnection between berofix baseboards enables you to bridge hardware for building mixed and high-density transparent Voice, Video, Data and Fax transmissions.

Berofix PCI/PCIe cards are OS independent and can be used for Linux, Unix, Windows as well as MAC OS. This new advancement in technology incorporates a proprietary beronet OS on the baseboards which is automatically detected by your system as a ‘Network card’. All necessary drivers are automatically loaded by the host machine’s OS.

berofix baseboard overview

Independend of the type (PCI/PCIe card or external Box) the berofix baseboard has 2 Lineinterface sockets ("Lineinterface Socket 1" / "Lineinterface Socket 2"). While "Lineinterface Socket 1" has access to Jack 1 & 2 "Lineinterface Socket 2" is applied to jacks 3 & 4. The following picture will show you the schema of the berofix-baseboards.

Depending on the Modules you are using, different slots with different Pin Out's are used which will be described in the following Chapters regarding the modules.

bf4S0 4 Port ISDN / BRI module

The bf4S0 Module has 4 ISDN/BRI Ports. The bf4S0 Module can be configured individually for each port to NT (Network Termination) or TE (Terminal Equipment) mode. In either modes the module supports Point-To-Multi-Point (PMP) or Point-To-Point (PTP). The TE/NT mode as well as the Line termination of 100 ohms are selectable via software (Jumperfree).

Depending on which Lineinterface socket you plug the bf4S0 Module, the pinout is different. To fit best to your need the use of the bfBridge or the bfTAdapters are neccessary. The following Examples gives you an overview about it:
PinOut Port 1 and 2 of bf4S0 module through Jack 1

Port 1:

PIN 3

PIN 4

PIN 5

PIN 6

Port 2:

PIN 1

PIN 2

PIN 7

PIN 8

Port 3 and 4 are similar to the above mentioned schema only this Jack 2.

Example1:single bf4S0

Lineinterfacesocket 0: bf4S0

Lineinterfacesocket 1: none


Example2:bf4S0 with a bfBridge

Lineinterfacesocket 0: bf4S0

Lineinterfacesocket 1: bfbridge


Example3: 2x bf4S0

Lineinterfacesocket 0: bf4S0

Lineinterfacesocket 1: bf4S0

bfXE1 1-2 Port ISDN PRI Module

The bfXE1 PRI modules are available as 1 Port bf1E1 or as 2 Port bf2E1 LineInterfaces. The bfXE1 module can be configured individually for each port to NT (Network Termination) or TE (Terminal Equipment) mode. If you want to use NT-mode you may need a cross cable which is optional available (the bnE1Cross). Line termination (120 ohms) is selectable for each port by DIP switches (2 per port).

PinOut of bfXE1 module

PIN 1: RX- 

PIN 2: RX+ 

PIN 4: TX- 

PIN 5: TX+

The following examples will show you again the diffrent combinations of the module:

Example1: 1x bf2E1

Lineinterfacesocket 0: bf2E1

Lineinterfacesocket 1: none


Example2: 1x bf1E1 and 1x bf4S0

Lineinterfacesocket 0: bf1E1

Lineinterfacesocket 1: bf4S0

bf4FXS 4 Port Analog Module

The BF4FXS Module is a 4 port FXS Module for the berofix Baseboards and Boxes. The BF4FXS Module is used for small and medium enterprises who need internal Analog FXS Ports to connect Analog Phones, Faxes and Modems. Our 4 Port FXS Module is fully compatible and combinable with all berofix Modules, Cards and Boxes.

The pinout of the bf4FXS module is similar to the bf4S0 module. Depending on the module configuration the use of the bfBridge or the bfTAdapters could be neccessary. The following Examples gives you an overview about the Pinout of this module:

PinOut Port 1 and 2 of bf4FXS module through Jack 1

Port 1:

PIN 4

PIN 5

Port 2:

PIN 2

PIN 7

Port 3 and 4 are similar to the above mentioned schema but uses Jack 2.

Attention: When using this module on a beroFix PCI/PCIe card, the card has to be powered additionally, by using the 12V Molex Connector (See berofix product overview)

bf4FXO 4 Port Analog Module

The bf4FXO module is a 4 port FXO module for the berofix Mainboards and Boxes. The bf4FXO provides 4 Port FXO (Foreign Exchange Office) for the beroFix. It can be used to connect a Softpbx to the PSTN Network as well as a traditional PSTN based PBX. It is fully compatible and combinable with all berofix Modules, Cards and Boxes.

The pinout of the bf4FXO module is similar to the bf4S0 module. Depending on the module configuration the use of the bfBridge or the bfTAdapters could be neccessary. The following Examples gives you an overview about the Pinout of this module:

PinOut Port 1 and 2 of bf4FXO module through Jack 1

Port 1:

PIN 4

PIN 5

Port 2:

PIN 2

PIN 7

Port 3 and 4 are similar to the above mentioned schema but uses Jack 2.

bf2S02FXS 2 ISDN BRI Ports / 2 Analog FXS Ports Hybrid module

The BF2S02FXS Hybrid Module is a 2 Port BRI and 2 Port FXS Module for the berofix Baseboards and Boxes. Each BRI port of the BF2S02FXS can be configured as NT (Network Termination) or TE (Terminal Equipment). In both modes, each BRI port can operate in Point-to-Multi-Point (PMP) or in Point-to Point (PTP) mode. The switching of the TE / NT mode and the deactivation of the termination resistors can easily be set in the software (Jumper Free) which makes the troublesome repositioning of jumpers unnecessary. Additionally to the above mentioned 2 BRI Ports the BF2S02FXS module provides 2 Ports FXS (Foreign Exchange Station) for the berofix. FXS interfaces are used to connect devices like analog phones or faxmachines to your berofix.
Attention: When using this module on a beroFix PCI/PCIe card, the card has to be powered additionally, by using the 12V Molex Connector (See berofix product overview)
Depending on the module configuration the use of the bfBridge or the bfTAdapters could be neccessary. The following Examples gives you an overview about the Pinout of this module:

PinOut BRI Port 1 and FXS Port 1 of bf2S02FXS module through Jack 1

BRI Port 1:

PIN 3

PIN 4

PIN 5

PIN 6

FXS Port 1:

PIN 2

PIN 7

BRI Port 2 and FXS Port 2 are similar to the above mentioned schema but uses Jack 2.

Example1:single bf2S02FXS

Lineinterfacesocket 0: bf4S0

Lineinterfacesocket 1: none


Example2:bf2S02FXS with a bfBridge

Lineinterfacesocket 0: bf4S0

Lineinterfacesocket 1: bfbridge

bf2GSM 2 Port GSM Module

The bf2GSM module is a 2 port (QuadBand(850/900/1800/1900 Mhz) GSM module for the berofix Mainboards and Boxes. The BF2GSM is used for small enterprises which need up to 2 concurrent GSM calls. It can also be used for mobile convergence, LCR and SMS. Our GSM Module is fully compatible and combinable with all other berofix Modules and Cards.

Attention: When using this module on a beroFix PCI/PCIe card, the card has to be powered additionally, by using the 12V Molex Connector (See berofix product overview)

Regarding Voice Calls, the GSM Module behaves like all other modules. For SMS it has multiple interfaces:

1. WebInterface
2. REST-API
3. eMail Interface

The WebInterface is explained below in this document: [GSM Options]. The REST Api makes it possible to Send and Receive SMS by external Application via HTTP Requests, for more details look at: [SMS API]

The eMail Interface is realized as a beroFix App called "smgw". It can be installed via the Firmware Installer and has it's own configuration Webinterface. Details on this coming soon..

Upgrade beroFix box/card to be GSM Ready box/card

The GSM Module can only be used with one of 3 different GSM Kits:

1. BFEXTGSMBOX
2. BFEXTGSMCARD
3. BFGSMBracket

To upgrade a berofix box with such a Kit see the Upgrade Howto:

http://www.beronet.com/downloads/berofix/docs/Howto-GSM-Upgrade-box.pdf

To upgrade a berofix card with such a Kit see the Upgrade Howto:

http://www.beronet.com/downloads/berofix/docs/Howto-GSM-Upgrade-card.pdf

NOTE: The GSM Module behaves like a BFBridge, which means that in combination with 
      a 4 Port Module (BF4S0,BF4FXO,BF4FXS,BF2S02FXS) it should always be in slot 2.
      That way you don't need to use the BFTadapter, but you can directly use all
      4 RJ45 Ports.

LED Status

The BF2GSM Module uses always the right hand LED from the RJ45.

 _________
|*       *| <-- GSM Port Led
|         |
 --     --
   |____|

If the BF2GSM Module is on Slot 2 and a 4 Port Module is on Slot 1 (eg. 4 BRI) then the RJ45 3 and 4 look like:

                 _________
BRI Port Led -> |*       *| <-- GSM Port Led
                |         |
                 --     --
                   |____|

The GSM Port Led states are:

OFF         - Not initialized
Blinking    - initialized, trying to connect to network
ON          - Network in Reach (not necessarly registered to network)

Network Setup

The next chapters will describe the basic steps that are necessary to bring your new berofix Box or card into your network, so that you can access the web-interface for further configurations.

berofix Box Network Setup

By default all berofix devices use the same following network settings:

IP Address 10.0.0.2
Subnet mask 255.0.0.0

You can access the berofix Box WebInterface by typing http://10.0.0.2 in your favourite Webbrowser. To be able to do this, the machine on which you want to use your favourite webbrowser has to be in the same network segment. Please check your Operating System manual for information on how to change the IP address / Subnet mask of your Network devices. You can log into the web-interface using the following default login credentials:

username:admin
password:admin

berofix PCI/PCIe cards Network Setup

The berofix PCI/PCIe cards use Realtek Network Chip-sets to communicate with the Host PC. This means that the berofix PCI/PCIe cards is recognized as a network card from your Operating System. You don't have to compile or load any additional driver except the network card driver for berofix PCI/PCIe cards, which should normally be done automatically by your Operating System. The berofix PCI cards use a RTL8139 Chipset and the berofix PCIe cards use a RTL8111 Chip-set. If you plug the berofix PCI/PCIe card into your computer it will have a new Network device. You can identify this new Network device by its MAC address, because all berofix devices use MAC addresses beginning with D8:DF:0D or 00:50:C2.

By default the berofix PCI/PCIe cards have the IP-Address 10.0.0.2 with the Subnet mask 255.0.0.0. To be able to reach the berofix PCI/PCIe card you have to give your new Network device an IP-address in the same Network segment, e.g. IP: 10.0.0.1 with the same Subnet mask (255.0.0.0). Please check in your Operating System manual for information on how to change the IP address / Subnet mask of a device. After you have done these steps, you should be able to access the web-interface of the berofix PCI/PCIe card by typing http://10.0.0.2 in your preferred browser. You can log into the web-interface by using the default login credentials username:admin and password:admin.

Keep in mind that in this scenario the berofix card is only accessible from your machine, but not over the network. For several reasons, especially for SIP re-invites, it might make sense to advance your network settings so that the berofix PCI/PCIe card is reachable from your whole network. There are 2 common ways how to do this.

Ethernet Bridge (recommended way)
IP-Forwarding with a Static Route

These two ways will be described in more detail in the following chapters. We recommend to use the bridge setup, since this is the easiest to setup and allows the most flexibility.

berofix PCI/PCIe Network Setup using IP-Forwarding

Linux IP-Forwarding

Before we start explaining how to setup IP-Forwarding, we need to give the berofix card an IP address. We will use 'ifconfig' to check out network settings.

berofix:#ifconfig -a

 eth0   Link encap:Ethernet  HWaddr 00:0C:6E:D3:86:C6  
           UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
           RX packets:797562 errors:0 dropped:0 overruns:0 frame:0
           TX packets:35206 errors:20 dropped:0 overruns:0 carrier:20
           collisions:7447 txqueuelen:1000 
           RX bytes:141351732 (134.8 MiB)  TX bytes:19431622 (18.5 MiB)
           Interrupt:11 Base address:0xc000 
 
 eth1   Link encap:Ethernet  HWaddr 00:50:C2:83:D0:01
           UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
           RX packets:35124 errors:0 dropped:0 overruns:0 frame:0
           TX packets:276362 errors:0 dropped:0 overruns:0 carrier:0
           collisions:0 txqueuelen:1000 
           RX bytes:20636164 (19.6 MiB)  TX bytes:28931756 (27.5 MiB)
           Interrupt:11 Base address:0xa000 
 
 lo       Link encap:Local Loopback  
           inet addr:127.0.0.1  Mask:255.0.0.0
           UP LOOPBACK RUNNING  MTU:16436  Metric:1
           RX packets:9 errors:0 dropped:0 overruns:0 frame:0
           TX packets:9 errors:0 dropped:0 overruns:0 carrier:0
           collisions:0 txqueuelen:0 
           RX bytes:720 (720.0 b)  TX bytes:720 (720.0 b)

In this example eth0 is the NIC in our computer and eth1 is the berofix NIC. The default internal IP-address of the berofix Card is 10.0.0.2. So need to give eth1 an IP address like 10.0.0.1, to access the berofix device. Take a look at the small scenario to make this more clear:

scenario missing<<

We can change the IP-Address of eth1 (berofix) by using ifconfig as described in the following example: berofix:#ifconfig eth1 10.0.0.1 up

To check this is working, try to ping 10.0.0.2

berofix:#ping 10.0.0.2
PING 10.0.0.2 (10.0.0.2) 56(84) bytes of data.
64 Bytes from 10.0.0.2: icmp_seq=1 ttl=63 time=1.12 ms

By default any modern Linux distribution will have IP Forwarding disabled. This is normally a good idea, as most people will not need IP Forwarding, but in our case we need it to support SIP reinvites. We can query the sysctl kernel value 'net.ipv4.ip_forward' to see if IP Forwarding is enabled or not. See the next examples:

sysclt net.ipv4.ip_forward
net.ipv4.ip_forward = 0

or just check out the value yourself in the /proc system

cat /proc/sys/net/ipv4/ip_forward

As we can see in the examples above IP Forwarding is disabled and represented by the value 0 for 'net.ipv4.ip_forward'. To Enable IP Forwarding you can use sysclt again, like described in the next example:

sysclt -w net.ipv4.ip_forward=1
or
echo 1 > /proc/sys/net/net/ipv4/ip_forward

Note that if you use sysctl as described in the above mentioned examples, IP-Fowarding will only be activated temporarily, that means this change will not be saved persistent. To make this setting persistent you should edit the configuration file /etc/sysclt.conf and add the following line:

net.ipv4.ip_forward = 1

If you already have an entry 'net.ipv4.ip_forward' with the value "0" you can change it to "1". To activate this changes it's necessary to run the command:

sysclt -p /etc/sysclt.conf

On Red Hat based systems this is also done by restarting the network service:

service network restart

On Debian/Ubuntu systems this can also be achieved by restarting the procps service:

/etc/init.d/procps.sh restart

After activating IP-Forwarding the berofix device will still not be accessible from other devices in your LAN. To make it accessible you have to add a route either by adding a static route in your router or just change the standard gateway of the device from where you want to reach berofix:

route add 10.0.0.2 <ip-eth0-of-berofix-host>

or change standard gateway

route add default gw <ip-eth0-of-berofix-host>

If everything was successfully configured, you should be able to reach the berofix device from your network

Windows IP-Forwarding

Before explaining how to setup IP-Forwarding we need to assign an IP Address to the berofix PCI/PCIe card. Windows based systems can use ipconfig, from the command line interface, to check the network settings:

C:\Documents and Settings\Administrator>ipconfig -all

Windows-IP Configuration 

   Hostname  . . . . . . . . . . . . : test-li3hfoglbs
   Primary Dns Suffix  . . . . . . . :
   Node Type . . . . . . . . . . . . : Mixed
   IP Routing Enabled  . . . . . . . : No
   WINS Proxy Enabled  . . . . . . . : No
   DNS Suffix Search List  . . . . . : beronetoffice.local

Ethernet adapter Local Area Network Connection 2: this is our berofix PCI card as you can see looking at it's MAC-Address
   Connection-specific Dns Suffix  . :
   Description . . . . . . . . . . . : Realtek RTL8139-Familie-PCI-Fast Ethernet-NIC #2
   Physical Address  . . . . . . . . : 00-50-C2-83-D0-00
   DHCP Enabled  . . . . . . . . . . : No
   IP Address  . . . . . . . . . . . : 10.0.0.1
   Subnet Mask . . . . . . . . . . . : 255.0.0.0
   Default Gateway . . . . . . . . . :
 
Ethernet adapter Local Area Network Connection: this is the standard NIC. It has the same RTL Chip but a different MAC-Address

   Connection-specific Dns Suffix  . : beronetoffice.local
   Description . . . . . . . . . . . : Realtek RTL8139-Familie-PCI-Fast Ethernet-NIC
   Physical Address  . . . . . . . . : 00-0B-6A-EE-E7-4F
   DHCP Enabled  . . . . . . . . . . : Yes
   Autoconfiguration Enabled . . . . : Yes
   IP Address  . . . . . . . . . . . : 172.20.5.75
   Subnet Mask . . . . . . . . . . . : 255.255.0.0
   Default Gateway . . . . . . . . . : 172.20.0.1
   DHCP Server . . . . . . . . . . . : 172.20.0.1
   DNS Server  . . . . . . . . . . . : 172.20.0.11
                                       172.20.0.1
   Primary WINS Server . . . . . . . : 172.20.0.11
   Lease Obtained  . . . . . . . . . : Monday, 15. June 2009 11:58:46
   Lease Expires . . . . . . . . . . : Monday, 15. June 2009 23:58:46

To assign an IP-address to the berofix device go to "Control Panel" and open "Network connections". Double click on "Local Area Network Connection 2" (Realtek RTL8139-Familie-PCI-Fast Ethernet-NIC #2), which is our berofix PCI card. Go to "Preferences" and choose "Internetprotocol (TCP/IP)" to get to the IP-Configuration dialog::

As seen in the picture above we have assigned the IP Address, the Subnet mask as well as the default gateway. After the network connection has been restarted, you can open the command line interface and use the "ping" command to verify that the IP Connection is working:

As you can see the berofix device is now reachable from this particular machine. To enable Windows IP-Forwarding you can use "regedit" in the command prompt to get the RegEdit32-Tool:

To enable IP-Forwarding please go to "HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\Tcpip\ Parameters" and change the entry "IPEnableRouter" (Type REG_DWORD) and change it to "1".
After activating IP-Forwarding the berofix device will still not be accessible from other devices in your LAN. To make it accessible you have to add a corresponding route. You can add a static route by entering the following in the command prompt:

route add 10.0.0.2 <ip-eth0-of-berofix-host>

If you want to make this settings persistent please give the "-p" parameter to the route tool. If everything was successfully configured, you should be able to reach the berofix device from your network.

berofix PCI/PCIe Network Bridge Setup

Linux Network Bridge

You can setup the Network Bridge under Linux with the "brctl" utility. This utility is provided by the "bridge-utils" package on debian based systems (like Ubuntu). As mentioned above the berofix PCI/PCIe cards use MAC Addresses beginning with D8:DF:0D or 00:50:C2, so you can again use the "ifconfig -a" command to identify berofix PCI/PCIe cards:

beropbx:#ifconfig -a 
   
   eth0   Link encap:Ethernet  HWaddr 00:0C:6E:D3:86:C6  this is standard NIC
             UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
             RX packets:797562 errors:0 dropped:0 overruns:0 frame:0
             TX packets:35206 errors:20 dropped:0 overruns:0 carrier:20
             collisions:7447 txqueuelen:1000 
             RX bytes:141351732 (134.8 MiB)  TX bytes:19431622 (18.5 MiB)
             Interrupt:11 Base address:0xc000 
   
   eth1   Link encap:Ethernet  HWaddr 00:50:C2:83:D0:01 this is our berofix PCI card as you can see on the MAC-Address
             UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
             RX packets:35124 errors:0 dropped:0 overruns:0 frame:0
             TX packets:276362 errors:0 dropped:0 overruns:0 carrier:0
             collisions:0 txqueuelen:1000 
             RX bytes:20636164 (19.6 MiB)  TX bytes:28931756 (27.5 MiB)
             Interrupt:11 Base address:0xa000 
   
  lo       Link encap:Local Loopback  
             inet addr:127.0.0.1  Mask:255.0.0.0
             UP LOOPBACK RUNNING  MTU:16436  Metric:1
             RX packets:9 errors:0 dropped:0 overruns:0 frame:0
             TX packets:9 errors:0 dropped:0 overruns:0 carrier:0
             collisions:0 txqueuelen:0 
             RX bytes:720 (720.0 b)  TX bytes:720 (720.0 b)

In this example eth1 is the berofix PCI card and eth0 is our default network interface which is connected to our LAN. We want to assign the IP Address 192.168.0.2 to our LAN interface and the IP Address 192.168.0.3 to our berofix device. After we have setup the Network Bridge we want to access the berofix PCI card from all machines in our LAN, which are located in our network 192.168.0.1-254. To establish the Network Bridge, you have to use a few commands like described in the following example:

berofix:# ifconfig eth0 0.0.0.0 up
berofix:# ifconfig eth1 0.0.0.0 up
berofix:# brctl addbr br0
berofix:# brctl addif br0 eth0
berofix:# brctl addif br0 eth1
berofix:# ifconfig br0 192.168.0.3 up

These commands will first remove the IP-Addresses from the network devices and then will create the Network Bridge and add your standard network card (eth0) as well as the berofix PCI card (eth1) to this newly created Network Bridge (br0). In the example above we applied the 192.168.0.3 to the Network Bridge. The default IP settings of the berofix PCI/PCIe cards are 10.0.0.2 netmask 255.0.0.0. To make the berofix reachable from our LAN the IP-Address of the berofix device has to be changed. This can be done using the bfdetect tool (which is described in the next chapter) or through the webinterface of the berofix device. So we assume the berofix IP Address is changed to 192.168.0.3 with Netmask 255.255.255.0 . If everything was setup as it should, you should be able to reach the berofix device(192.168.0.3) from any machine in your Lan. Unfortunately this described way is not persistent and will be deleted after rebooting the machine.
To setup this Network Bridge in a persistent way, you can modify your "/etc/network/interfaces" file on debian based systems (like ubuntu):

auto lo
iface lo inet loopback

auto br0
iface br0 inet static
address 192.168.0.2
netmask 255.255.255.0
gateway 192.168.0.1
bridge_ports eth0 eth1

After that you have to restart your networking:

berofix:#/etc/init.d/networking restart

After everything is up and running, you should be able to reach the berofix device (192.168.0.3) from any machine in your LAN.

Windows Network Bridge

To use the Network Brigde under Windows based Systems (Windows SBS Versions don't seem to support Network Bridging) open "network connections" Window. As already seen in the chapter IP-Forwarding, you will see two Network controllers. Your standard Host Network Controller ("Local Area Network Connection 1") and the berofix Network Controller ("Local Area Network Connection 2"). To create the Network Bridge please mark both connections and click the right mouse button. The following context menu will appear:

Click on "Bridge connections" and a third Controller will appear, our Network Bridge:

As you might notice the Network Controllers don't have IP Address's any more. You can only assign an IP-Address to the Bridge Controller. By default the Bridge is in DHCP mode. If you please mark the Bridge, click the right mouse button, choose "Preferences" and configure an IP-Address. At that moment the Network Bridge is reachable throughout the LAN - you can also reach the berofix web-interface. For example:
Let's assume your LAN is 172.20.0.0/255.255.0.0, your bridge got an IP 172.20.5.194 and you configured berofix internal IP address to 172.20.70.11. Through the configured bridge, berofix is reachable from the whole network now, if your firewall is not blocking it!

bfdetect tool to detect berofix devices

The bfdetect tool is a small command line tool, runable under Linux and Windows, which helps you to detect any berofix device in your network. It can also be used to configure some basic network settings, like IP-Address etc. before starting to use the Web-Interface. The bfdetect tool can be downloaded from our Website:

For Linux:

http://www.beronet.com/downloads/berofix/tools/bfdetect.tar.gz

For Windows:

http://www.beronet.com/downloads/berofix/tools/bfdetect_win_x86.zip

In Windows based environments bfdetect_win_x86.zip will include a bfdetect.exe, which can be executed in the "command prompt", after extracting the archive. Under Linux based systems the archive has to be compiled after extracting it. See the follwing example:

beropbx:#tar xzf bfdetect.tar.gz
beropbx:#cd bfdetect
beropbx:#make install (just in  case, don't forget to change permissions of the file to be executable)

To detect any berofix device in your network, the bfdetect tool will send an UDP Packet to the broadcast address of your default network adapter. Any berofix device in the network will reply to this request. If your berofix device is not located behind your default network adapter (e.g. berofix PCI/PCIe card), you have to specify the network adapter, which should be used to send out the Broadcast packet. See the following example:

beropbx:#bfdetect 10.0.0.1
Scanning network for bero*fix devices...
[1] mac:00:50:C2:83:D3:36 ip:10.0.0.2
[2] mac:00:50:C2:83:D2:AE ip:172.20.22.110
[3] mac:00:50:C2:83:D8:31 ip:172.20.22.203
[4] mac:D8:DF:0D:00:01:86 ip:172.20.22.101
[5] mac:00:50:C2:83:D5:42 ip:172.20.0.104

Select a device: 1
 
Configuration of selected device:

 mac: 00:50:C2:83:D3:36
 ip: 10.0.0.2
 netmask: 255.0.0.0
 gateway: 10.0.0.1
 dhcp: no

 [i] change ip
 [n] change netmask
 [g] change gateway
 [d] switch dhcp on
 [s] save and quit
 [q] quit

What would you like to do?

All the rest is menu driven and pretty much explains itself. To get more help about the bfdetect tool, you can use the "-h" option.

berofix WebInterface

If you have successfully setup the network as described in chapter 2, you can completely configure the berofix device via the web interface. Simply enter the IP-address of berofix in your favorite browser, for instance:

Default IP-Address
http://10.0.0.2

As already mentioned above, the default login username and password for berofix devices is:

Default UsernName / Password
username:    admin
password:    admin

Note: You should change the password for security reasons immediatly after the first login

The berofix WebInterface consists of the following major menu-points:

Dialplan (manage Dialplan related stuff)
SIP+ (manage SIP Accounts like registrations and proxy's)
PSTN (manage PRI/BRI/ANALOG/GSM Ports)
Hardware (manage Module related settings)
Preferences (manage Preferences like network and time -setting, logging etc.)
Management (Small Statistics, Debug, Firmware-Update, Reboot/Reset etc.)
Logout (Logout)

But before going in details with the above mentioned menu points, there are some general things.

Activating Changes

When Settings in the Webinterface are modified and saved, they don't apply immediately. A small "activate" Link appears on the top. The changes you have made take effect after pressing this "activate" button. Take a look at the following picture.

The "activate" button is available in three colors with the following meanings:

Yellow Reload of the Configuration. No influence to current calls.
Orange Parts of the Gateway-Software has to be restarted. All Current calls are going to be dropped.
Red Reboot berofix. All current calls are going to be dropped. This can take up to 30sec..

This Document will describe every details of the GUI per Menupoint.

Hardware

The menu point “Hardware”, will give you an overview about all modules, plugged on your berofix device. Before going into detail, take a look at the following picture, it shows an overview of the Hardware section:

As you can see in the example above there are two Line Interface slots (LIS), LIS_0 and LIS_1. On LIS_0 is a BF2S02FXS modules shown, indicated by "Card Type", while LIS_1 shows an activated "Portswitch Option". Further more you can see the options "MASTER" and "Synchronization Port" on LIS_0. The "MASTER" Option has two possible values 'master' and 'slave'. If it is set to "master", this module will generate its own clock and can provide this to all slave modules (also via PCM to another berofix device). In case it is a BRI or PRI module and master is selected, you can also define the additional option "Synchronization Port". If this option is set to a valid port, the module will retrieve its clock from the selected port (external PSTN Line) instead of generating it itself. It is always good or even necessary to set the first module to master (in case of ISDN also with "Synchronization Port") connected to the PSTN (external Lines), and the second one to slave. This configuration will assure you an interconnection between the modules, to enable hardware bridging for transparent voice, data and fax transmissions.

Graphical Representation

The graphical representation is an useful source, shows you how the Ports from the module are aligned to the 4 RJ45 Ports of your berofix device. This overview will also show you the necessity of BFTAdapters or of a BFBRIDGE. The next picture will make this more clear.

Modules and Line Interface Slots

Below the graphical representation bar, you can see a summary of the modules which are connected to their respective Line Interface Slots (LIS). The following examples will show you all specialized settings for each module.

BF4S0 / BF2S02FXS ISDN BRI modules







When using ISDN BRI  modules (i.e. BF4S0 or BF2S02FXS) you have the following options as seen in the above picture:


*TYPE: TE / NT (Terminal Endpoint  / Network Termination) In general TE mode is used to connect your berofix to
 external lines provided by your provider, and NT Mode is used to connect phones or PBX's.
*Protocol: PTP / PTMP (Point-to-Point or Point-to-Multipoint) In general PTP is used for DID based connections and
 PTMP for MSN based.
*Termination: 0 / 1 (activates or deactivate 100 Ohm Linetermination) In general Linetermination 100 Ohm has to be
 turned on.

BF1E1 / BF2E1 ISDN PRI modules




When using ISDN PRI modules  (i.e. BF1E1 or BF2E1) you have the following options as seen in the above picture:


*TYPE: TE / NT (Terminal Endpoint  / Network Termination) In general TE mode is used to connect your berofix to
 external lines provided by your provider, and NT Mode is used to connect internal PBX's.
*Protocol: PTP (Point-to-Point) PRI modules supports only PTP.
*Line termination 120 Ohms is selectable for each port by DIP switches on the module itself.

BF4FXO Analog module




When using FXO Analog modules  (i.e. BF4FXO) you have the following options as seen in the above picture:


*Country Setting: Each Country has is own settings regarding signals and tones.

BFBridge module




The BFBridge is not really a module but it behaves like one. The BFBridge is useful when you only have a
single module BF4S0, BF2S02FXS, BF4FXO or BF4XS and want to use all 4 RJ45 of your berofix device, instead
of the BFTAdapters. If you use one of this modules (BF4S0, BF2S02FXS, BF4FXO or BF4XS) on LIS 0 while LIS 1
is empty (expect the BFBridge itself), berofix will provide the "Portswitch Option" on LIS 1 as you can see
in the above picture. You have to enable this option, when you want to use the BFBridge. Activating this 
option without plugging the BFBridge or vice versa will result in a not expected behavior.

PCM Bridging

Since berofix Firmware 2.X berofix devices can be interconnected via a PCM cable to enable hardware bridging for transparent voice, data and fax transmissions across two berofix devices. That means that the Audio part is transmitted in TDM over the PCM cable, and not send using RTP over the network. The signaling is still send via SIP.

PCM-Master
To activate this feature log into the first berofix device which we call PCM-Master. As mentioned before (section Hardware) one module on the PCM-Master has to be set to 'master'. That means that this module will generate the clock for all other slaves.

All you have to do to configure the PCM-Master is to activate the "PCM Master bridging" option and select a Port for the "PCM Master port" option as seen in the above picture.

PCM-Slave
It is very similar to configure the second berofix device, which we call the PCM-Slave. Again as mentioned before (Section Hardware) all modules on the PCM-Slave have to be configured as "slave" to retrieve the clock. If you do so you will see following configuration options.

In the Fields "PCM master IP-Address" you have to enter the IP-Address of you PCM-Master and set the "PCM Master Port" to the same value as you have entered on the PCM Master.

PCM-Overview
To proove if the PCM interconnection is configured corretly, you can use the menu point 'State' which you can find under the management section. Depending on which berofix you are logged in you can see the following pictures.

In this example our PCM-Master has the IP-Address 172.20.70.41 while the PCM-Slave has the 172.20.70.42. The green light on this screens indicates that communication between the PCM-Master and PCM-Slave is established.

PSTN+

The menu point PSTN+ gives you an overview about the Ports which are provided by the plugged modules you are using on this particular berofix. For each technology you will find a sub menu point, like 'ISDN PRI' / 'ISDN BRI' / 'Analog FXO' / 'Analog FXS' / GSM. The sub menu entries are dynamic, and you will only see these which are provided by your modules. These sub menu points or technologies can be grouped together in so called 'Port-Groups'. As you can see in the next picture, you can add, modify and delete 'Port-Groups' by clicking on the corresponding button.

You can add Ports to the 'Port-Group' by selecting available available Ports. A Port which is already assigned to a 'Port-Group' will be displayed grey as shown in the next picture.

Each configured 'Port-Group' has technology specific settings. The settings on the 'Port-Groups' will apply to all Ports, which are member of this 'Port-Group'. Furthermore if you Dial out on a 'Port-Group' the system will automatically find the next free channel in this 'Port-Group', regardless if it is a BRI/PRI, Analog or GSM Port. We always recommend to put the Ports in 'Port-Groups' even if you have only one Port.

As mentioned before, depending of the technologies you are using, different settings will be available. In the next chapters we are going to explain this in detail:

ISDN PRI / BRI options

General ISDN PRI / BRI settings
The picture below will show you ISDN PRI / BRI 'Port-Groups' specific basic settings:

Group Name

Unique name of the 'Port-Group'

Ports

Ports which are member of the 'Port-Group'.

ChanSel

Channel Selection schemes: [standard|Random|Round Robin] default: standard

-Standard - selects the next free channel in ascending order

-Random - selects the next free channel at random

-Round Robin - selects the next free channel base on the round-robin principle

Tones

ISDN Tone sets which are categorized by country

Interdigit timeout

(default is 3 sec. For every incoming call a inter digit collect timer will be started. After this specified timeout, without getting a digit, the call will be processed to the Dialplan. Note this Timer is only started if 'Overlap Dialing' is deactivated.

Interdigit timeout initial

(default is 15sec.)This Timer is the initial inter digit timer, that means before we got any digit. This Timer will be stopped after the first digit and the above mentioned Interdigit timeout Timer will apply. During this time a Dialtone will be generated. Note this Timer is only started if 'Overlap Dialing' is deactivated.

Overlap Dialing

This Option will activate real Overlap Dialing, for instance in ISDN Environments. By activating this option the 'Interdigit' as well as the 'Interdigit timeout initial' Timer will be deactivated.

QSIG support

Enable or disable QSIG support.

Link Down behavior

LinkDownBehavior:[Nothing|Pull Link Up (2s)|Pull Link Up (2s)|Pull Link Up (once)]

-Nothing

-Pull Link Up (2s) will try to get UP Links up to 2 seconds

-Pull Link Up (once) will try to get UP Links once

In some countries like Cyprus the behavior of ISDN PTP Pots regarding Layer1 and Layer2 are different. They deactivate Layer 1 and Layer 2 after a while of inactivity. With this option you can solve this issue.

Advanced ISDN PRI / BRI settings (more)
Behind the more button you will find more advanced ISDN PRI / BRI settings as shown in the picture below.

EC

0=off,1=on (default value is 1=on) this will activate or deactivate the onboard Hardware Echocanceler

EC tail length

EC tail length [0=8ms,1=16ms,...,15=128ms] (default value is 15=128ms) 16 tabs each 8ms.

dnumplan

dnumplan [0=unknown, 1=international, 2=national, 4=subscriber). dnumplan is the 'Type of Number' in terms of ISDN for the Destination Address (DAD). This options :defines the number format of the DAD for an outgoing call. Be aware that the remote end have to support this feature.

onumplan

onumplan [0=unknown, 1=international, 2=national, 4=subscriber). onumplan is the 'Type of Number' in terms of ISDN for the Originating Address (OAD). This options :defines the number format of the OAD for an outgoing call. If you want to use 'CLIP_NO_SCREENING' you have to set this to national,international or subscriber, :depending on how you are going to send your OAD.

screening

screening (default is 0 = off) these are the exact ISDN screening and presentation indicators.

Screening=0 and presentation=0 means callerID presented but not screened(the remote end does see the callerID).

Screening=1 and presentation=1 means callerID presented but screened(the remote end does not see the callerID)

presentation

presentation (default is 0=off) see option screening

Bearer

ISDN Bearer capability to use for outbound calls on this 'Port-Group'

-speech (default for standard Voice calls)

-Audio_3.1K (useful for outbound Fax calls)

-Audio_7K

-Video

-Digital_Unrestricted (useful for ISDN digital calls)

-Digital_Restricted

-Digital_Unrestricted_Tones

Call deflection (default is disabled): Call deflection / Partial Routing is used to redirect calls on the provider site, without using B-Channels on the berofix. If 'Call deflection' is enabled you can use :a SIP 302 'Move temporarily' to Redirect the call on the provider site.
CLIR on OAD: CLIR on OAD (default=empty) to dynamically hide the CallerID in direction of this 'Port-Group' (ISDN). For instance if berofix detects a call to this 'Port-Group' with an OAD=CLIR_on_OAD (after the call left the dialplan), the CallerID will be hidden, that means the remote end doesn't see it. For calls originated from this

'Port-Group' with an empty OAD or with screening and presentation set to "1", the CallerID will be replaced by the CLIR_ON_OAD value.

Dialplan Source

The Dialplan Source is used as 'Source' for matching in the 'Dialplan'. That means if a call is initiated from this 'Port-Group' you can use 'Dialplan Source', to tell the Dialplan, which value should be used for the 'Source' in the Dialplan. Dialplan Source can have the following values

-OAD (by default it is set to OAD)

-OAD2 (OAD2 in case you have 2 OAD's you can choose with which value you want to go in the Dialpan)

-Qsigname (Qsigname to use it at source in the Dialplan)

-Redirectednr

Caller ID Mapping

+oad (Caller ID)

oad (Caller ID) gives you the possibility to tell berofix, which Field should be used for the OAD for calls to this 'Port-Group'. oad (Caller ID) could be applied to the following fields

-new_source (use new_source from the Dialplan as OAD for calls to this 'Port-Group')

-from_user (use SIP from_user as OAD for calls to this 'Port-Group')

-from_display (use SIP from_display as OAD for calls to this 'Port-Group')

-pai_all (use P-Asserted-Identities as OAD for calls to this 'Port-Group')

-pai_user

-pai_display

-ppi_all

-ppi_user

-ppi_display

-none (use nothing for the OAD)

-manual (use a constant string for as OAD for calls to this 'Port-Group')

+oad2 (second Caller ID)

oad2 (second Caller ID) (no default value). The oad2 defines which Field should be used for the second OAD (oad2(second Caller ID)). The oad2(second Caller ID) could be applied to the same fields already mentioned at oad(CalleriID) above.

+qsigname

qsigname (no default value). This defines which Field should be used for the qsigname. The qsigname could be applied to the same fields already mentioned at oad(CalleriID) above.

+Redirected Nr (default is none) Redirected Nr defines what the Redirected Nr should contain

Redirected Nr (no default value). This defines which Field should be used for the Redirected Nr . Redirected Nr could be applied to the same fields already mentioned at oad(CalleriID) above

The above mentioned settings are mostly used and they are directly outputted through the WebInterface. But berofix has a lot of more settings, which are used in very special scenarios. These settings can be found at the additional configuration options (see picture below).

The lower Box 'Additional configuration options description' contains the possible settings including a small description. For instance if you want to use the settings nationalprefix=0 and internationalprefix=00, you have to enter these in the upper Box Line by Line as shown in the above picture.

Analog FXO options

General Analog FXO Basic settings
The picture below will show you Analog FXO 'Port-Group' specific basic settings:

Group Name

Unique name of the 'Port-Group'

Ports

Ports which are member of the 'Port-Group'.

Interdigit timeout

(default is 3 sec. For every call from FXO an inter digit collect timer will be started. After this specified timeout, without getting a digit, the call will be processed to the Dialplan. Note this Timer is only started if 'Overlap Dialing' is deactivated.

Interdigit timeout initial

(default is 15sec.) This Timer is the initial inter digit timer, that means before we got any digit. This Timer will be stopped after the first digit and the above mentioned Interdigit timeout Timer will apply. During this time a Dialtone will be generated. Note this Timer is only started if 'Overlap Dialing' is deactivated.

Overlap Dialing

This Option will activate real Overlap Dialing. By activating this option the 'Interdigit' as well as the 'Interdigit timeout initial' Timer will be deactivated.

Tones

Tone sets which are categorized by country

Connect

(default is instant)

How berofix should detect a FXO connect

-instant (default. After Dialing the state will immediately change to 'connect')

-polarity (the opposite site send a polarity reversal to detect a 'connect')

Wait for CLIP

-wait (default: wait 2sec. to detect the CLIP)

-dontwait (will immediately process without waiting for the CLIP)

Dialtone passthrough

Dialtone passthrough:(default is disabled)

Analog call ending signal

How berofix should detect the end of a call

-unobtainable (default unobtainable)

-busy

Advanced Analog FXO settings (more)
Behind the more button you will find more advanced Analog FXO settings as shown in the picture.

EC

0=off,1=on (default value is 1=on) this will activate or deactivate the onboard Hardware Echocanceler

EC tail length

EC tail length [0=8ms,1=16ms,...,15=128ms] (default value is 15=128ms) 16 tabs each 8ms.

CLIR on CLIP

CLIR on CLIP (default=empty) to dynamically hide the CallerID in direction of this 'Port-Group' (FXO). For instance if berofix detects a call to this 'Port-Group' with

with a CLIP=CLIR_on_CLIP (after the dialplan), the CallerID will be hidden, that means the remote end doesn't see it.

Caller ID Mapping

+CLIP

CLIP gives you the possibility to tell berofix, which Field should be used as CLIP for calls to this 'Port-Group'. CLIP could be applied to the following fields:

-new_source (use new_source from the Dialplan for the CLIP for call to this 'Port-Group')

-from_user (use SIP from_user as CLIP for calls to this 'Port-Group')

-from_display (use SIP from_display as CLIP for calls to this 'Port-Group')

-pai_all (use P-Asserted-Identities as CLIP for calls to this 'Port-Group')

-pai_user

-pai_display

-ppi_all

-ppi_user

-ppi_display

-none (use nothing as CLIP)

-manual (use a constant string as CLIP for calls to this 'Port-Group')

+CNIP

CNIP (no default value). The CNIP defines which Field should be used as CNIP. The CNIP could be applied to the same fields already mentioned at CLIP above.

The above mentioned settings are mostly used and are directly outputted through the WebInterface. But berofix has a lot of more settings, which are used in very special scenarios. These settings can be found at additional configuration options (see picture below).

Analog FXS options

General Analog FXS Basic settings
The picture below will show you Analog FXS 'Port-Group' specific basic settings:

Group Name: Unique name of the 'Port-Group'
Ports: Ports which are member of the 'Port-Group'.
Interdigit timeout: (default is 3 sec. For every call from FXS an inter digit collect timer will be started. After this specified timeout, without getting a digit, the call will be processed to the Dialplan. Note this Timer is only started if 'Overlap Dialing' is deactivated.
Interdigit timeout initial: (default is 15sec.) This Timer is the initial inter digit timer, that means before we got any digit. This Timer will be stopped after the first digit and the above mentioned Interdigit timeout Timer will apply. During this time a Dialtone will be generated. Note this Timer is only started if 'Overlap Dialing' is deactivated.
Overlap Dialing: This Option will activate real Overlap Dialing. By activating this option the 'Interdigit' as well as the 'Interdigit timeout initial' Timer will be deactivated.
Tones: Tone sets which are categorized by country
CLIP: CLIP of this Trunk. Specify the Trunk Extension or any Number that you can later use in the Dialplan as Destination.
CNIP: CNIP of this Trunk. Specify the Trunk Extension or any Number that you can later use in the Dialplan as Destination

Advanced Analog FXS settings (more)
Behind the more button you will find more advanced Analog FXS settings as shown in the picture.

EC

0=off,1=on (default value is 1=on) this will activate or deactivate the onboard Hardware Echocanceler

EC tail length

EC tail length [0=8ms,1=16ms,...,15=128ms] (default value is 15=128ms) 16 tabs each 8ms.

CLIR on CLIP

CLIR on CLIP (default=empty) to dynamically hide the CallerID in direction of this 'Port-Group' (FXS). For instance if berofix detects a call to this 'Port-Group' with

with a CLIP=CLIR_on_CLIP (after the dialplan), the CallerID will be hidden, that means the remote end doesn't see it.

Caller ID Mapping

+CLIP (CallerID)

CLIP gives you the possibility to tell berofix, which Field should be used as CLIP for calls to this 'Port-Group'. CLIP could be applied to the following fields:

-new_source (use new_source from the Dialplan for the CLIP for call to this 'Port-Group')

-from_user (use SIP from_user as CLIP for calls to this 'Port-Group')

-from_display (use SIP from_display as CLIP for calls to this 'Port-Group')

-pai_all (use P-Asserted-Identities as CLIP for calls to this 'Port-Group')

-pai_user

-pai_display

-ppi_all

-ppi_user

-ppi_display

-none (use nothing as CLIP)

-manual (use a constant string as CLIP for calls to this 'Port-Group')

+CNIP (Caller Name)

CNIP (no default value). The CNIP defines which Field should be used as CNIP. The CNIP could be applied to the same fields already mentioned at CLIP above.

The above mentioned settings are mostly used and are directly outputted through the WebInterface. But berofix has a lot of more settings, which are used in very special scenarios. These settings can be found at additional configuration options (see picture below).

GSM options

GSM has 3 Different Setting Pages:

1) GSM              (Port Groups, like in ISDN or ANALOG)
2) GSM General      (PIN and SMSC Settings per Port and SMS to Mail Settings)
3) SMS              (SMS GUI Frontend)

1) GSM

The GSM Module behaves like all the other modules, which means it's ports need to be grouped, so that they can be used in the dialplan.

2) GSM General

Every GSM Port has some unique configuration which is done in this Setting Page. These configurations are for example the PIN of the SIM Card or the SMSC (SMS Center) for the sim card.

NOTE: The PIN can be left blank if no PIN is stored for the Sim Card.

The SMSC needs to be configured and is different for each provider. Lists can be downloaded on the internet, here are some germans providers SMSCs:

O2  +491760000443
D1  +491710760000 
D2  +491722270000

This information is supplied without liability, you should contact your mobile provider.

3) SMS

The SMS GUI shows the 3 different SMS Directories in beroFix (in, out, failout). It has also an option to send an SMS directly by choosing the GSM Port, entering a Destination Phone Number and the Text of the SMS.

Incoming SMS are displayed in the "inbox" table and can be viewed and deleted. Failed SMS will be stored in the "failout box", the reason and the content of each failed SMS can be viewed.

SMS to Mail

Sample SMS Sender Mail:

Subject: 
 smsto:+4917624251234;port:2
Body: 
 Hello, this is an SMS
SMSEND

When an SMS is received it will be look like:

Subject: 
 smsfrom:+4917624251234;port:2
Body: 
 Hello, this is an SMS
SMSEND

you can simply reply by mail to a received SMS.

SIP+

By selecting the menu point SIP, you could set all options regarding SIP like for instance 'Registrar'/'Proxy', RTP-Port-Range and many others. There are 2 menu-point, SIP and SIP General which will be explained in detail in the next chapters.

SIP

General SIP Basic settings
Under the menu point SIP you will get an overview about all SIP accounts, as you can see in the next picture. As already mentioned in the chapter 'Port-Groups', you can add, modify and delete SIP accounts by clicking on the corresponding button.

A SIP accounts consist always of the following settings, which you can see in the next picture.

Name: Name you want to use for this SIP account (berofix internal)
Server address: IP address of the SIP server (for instance your 3CX or Asterisk Server). You can also set an alternative udp Port in the format sip.beronet.com:5061 if requuired (default is 5060)
User: SIP Username used for SIP authentication
Secret: SIP authentication password
Register: When activated, berofix will register at the SIP Server by sending out SIP REGISTER Messages.; Note: If you enable this option, berofix changes the following settings automatically:; -Dialplan Source = from_display (Dialplan uses from_displayname for matching for call originated by this SIP account); -From User part = account_username (use account username as From_User for Calls in SIP direction); -From Display part = new_source (use NewSource from the Dialplan as From Displayname for the CallerID Transmission in SIP direction); Note2: If you deactivate this option, berofix changes the following settings automatically:; -Dialplan Source = from_user (Dialplan uses from_displayname for matching for call originated by this SIP account); -From User Part = new_source (use NewSource as From_User for Calls in SIP direction); -From Display Part = new_source (use NewSource from the Dialplan as From Displayname for the CallerID Transmission in SIP direction)
Registration Interval: Frequency interval in seconds, to refresh Registration by sending register messages.
Register option: If the Registration should be validated or not. Only available if Regististration is checked

Advanced SIP settings (more)

Behind the more button you will find more advanced SIP settings as shown in the picture.

T38 support

Check for Fax Tones and try a T.38 reinvite to make a reliable Fax-Over-IP Connection. The SIP Device which is connected to beroFix must support T.38. Most ATA's and some SIP Softpbxes support T.38. Default is active.

DTMF Mode

DTMF Mode over SIP (default is rfc2833).

-rfc2833 DTMF tones are transmitted outband via RTP packet

-inband DTMF tones are transmitted inband n(inside the audio channel)

-info DTMF tones are transmitted outband via SIP-Info packet

IE on SIP

IE on SIP activates the possibility to send additional ISDN Information Elements over SIP-Headers. If set to active beroFix will encode ISDN Information Elements like the 'Bearer Capability', 'Type of Number' or the 'Release Cause' etc. as X-BF SIP Headers. beroFix will also look for X-BF Headers on incoming SIP Messages to decode them into ISDN Information Elements. See Howto to use X-BF Headers for more details. Default=0.

Codecs

Define which codecs are allowed and in which order they should be offered . By default codecs is set to "G.711 Alaw'.

Wait for Cancel

When the PSTN Network Releases a call with a proper reason and with inband information, this setting will be reviewed. If set to active berofix will not immediately send the corresponding SIP response, instead it will make the inband audio information available, so that the user can hear this message. berofix will wait until the user cancels this call while providing the inband-audio (wait_for_cancel). If set to deactive berofix will immediately finish the call by sending the corresponding SIP response that is mapped for the PSTN Release reason. See beroFix ISDN Cause/SIP Response map for details of this mapping. Default is 1.

Call Progress Table

You can define which Call Progress Table should be used for this SIP account. By default (when left empty) the berofix build-in Call-Progress Table would be used.

Failover Account

Failover Account

Failover Timeout

Failover Timeout

Dialplan Source

The Dialplan Source is used as 'Source' for matching in the 'Dialplan'. That means if a call is originated from this SIP account you can use 'Dialplan Source', to tell the Dialplan, which field should be used for the 'Source' in the Dialplan. Dialplan Source can have the following values

-from_user (use SIP from_user as as source)

-from_display (use SIP from_display as source)

-pai_all (use P-Asserted-Identities as source)

-pai_user

-pai_display

-ppi_all

-ppi_user

-ppi_display

CallerID Mapping

The CallerID Mapping is used to assign several possible values to the SIP From_User part and the SIP From_Display part for flexible transmission of the CallerID in direction SIP. With this option you can change the standard CallerID transmission behaviour of the berofix and adjust it to the needs of your SIP-Server. Note: A SIP account which should register at the SIP Server uses account_username for SIP from_user and and new_source as from_displayname, while an account which doesn't register uses new_source as from_user and from_displayname.

From: User part This setting is used to tell the berofix which value should be used for the from_user Part of the SIP FROM Header. From: User Part could contain the following values:

-new source (use new source from the Dialplan as SIP from_user)

-oad (use OAD as SIP from_user)

-oad2 (use OAD2 as SIP from_user)

-qsigname (use the QSigName as SIP from_user)

-account_username (use account_username from this SIP-account as SIP from_user)

-manual (enter a manual value to be used as SIP from_user)

-none

From: Display part This setting is used to tell the berofix which value should be used for the from_display Part of the SIP FROM Header. 'From_Display part' ::could contain the following values:

-oad (use OAD as SIP from_displayname)

-oad2 (use OAD2 as SIP from_displayname)

-qsigname (use the QSigName as SIP from_displayname)

-account_username (use account_username from this SIP-account as SIP from_displayname)

-manual (enter a manual value to be used as SIP from_displayname)

-none

SIP General

Under SIP General settings you can set the following values as you can see in the next picture:

Bind Port: The Port on which the berofix device should listen for SIP traffic. Default is 5060
RTP Port Range: RTP Port range which should be used for RTP Traffic. Default is (5000-5059,5062-6000)
Extern IP: If you are behind a Firewall or NAT, you can enter the external IP address (for instance your external IP of your Router).
TOS RTP: Type of service for RTP traffic. Useful for prioritization of the RTP Traffic. Default is 160
TOS SIP: Type of service for SIP traffic. Useful for prioritization of the SIP Traffic. Default is 160
SIP transport: berofix support the following SIP transport modes:; -udp (SIP Transport via UDP); -tcp (SIP Transport via TCP); -tls (SIP Transport via TCP with TLS and Certificate)

Dialplan

The Dialplan is one of the most important things during the configuration of a berofix device. The Dialplan defines rules how calls should be routed under certain circumstances. The berofix Dialplan engine is based on Regular Expressions ('Howto RegEx'.)and reads the dialplan entries from the top to the bottom. After the first match berofix will leave the Dialplan and execute rule. That fore it is important to know that special Dialplan rules should be placed on top while the general ones should be placed below them. This can be done by the Position arrows. The next picture will show you the Dialplan overview.

As you can see you can add, modify, copy and delete a Dialplan rules by pressing on the corresponding buttons on the right of the Grid. Furthermore you access the the advanced option for a particular Dialplan rule by pressing the 'tooling icon' also on the right of the Grid. On the Header of the Grid you can place some Filters for the Dialplan Grid like 'Direction' or 'Entries per page' or even search for a special character inside all fields of a Dialplan rule. As you can also see that there are several columns. Before explain the meaning of each colum, it is important to know that some of these columns are matching criterias and the others are executing ones. Matching columns are into account to decide if a particular Dialplan rule matches while the executing columns would be executed when a dialplan rule has matched. Only if all matching columns are true the particular Dialplan rule will be executed.

Matching Columns:

Direction: Direction of the call. Shows you the direction from where the “Call” is originated and to where it is routed. For instance in the first row you see that the “Call” is originated from SIP and will be routed to ISDN. In the the second row it is vice versa.
FromID ID from where the call is originated. Depending of the direction that is choosen the FromID could be the name of a 'SIP-account', a 'PSTN-Port-Group' or a manual value like an ip-address.
Destination Also called CalledID or DAD. This is the number which was dialed.
Source Also called CallerID or OAD. This is the number of the device which have dialed.

Execution Columns:

ToID: The ID where the call should be routed to. Depending on the direction this could be a particular 'PSTN-Port' a 'PSTN-Port-Group', the name of a SIP account or just even an ip-address
New Destination The new Destination after we executed the Dialplan (see 'Destination' above)
New Source The new Source after we executed the Dialplan (see 'Source' above)

New Dialplan rule

You can add,modify or copy a Dialplan rule by pressing the corresponding buttons.The next picture show you the input form.

On the left site you will find all matching fields while the executing fields are on the right site. Each matching field has one executing field, that means there is always a pair of both.

From and To Direction: The first pair is the Direction pair, consisting of the fields From direction and To direction. From direction is the matching field and relevant from where the call is originated while the To direction field (executing field) is relevant to where the call should be routed. In the above picture you have chosen Direction SIP-to-ISDN. Depending on which modules are plugged the fields 'From direction' and 'To direction' could have the following values::; -SIP; -Analog (FXS/FXO); -ISDN (PRI/BRI); -GSM; For instance if don't plugged a GSM module, you will not see the GSM option in 'From direction' and 'To direction' pair.; Note: You can combine every technology to each other except the direction SIP-to-SIP.

From and To ID: The next pair are the From ID and To ID fields. Depending on what is chosen in the 'From direction' field, you will have different values in the 'From ID Box'.

From ID

From Direction is set to PSTN: (ISDN / Analog / GSM):

In this case the From_ID is a list of all configured PSTN Port-Groups indicated by their names. For instance if you select ISDN you will only see the ISDN Port-Groups in the list. Alternatively to the Port-Group you could also select a single Port, indicated by the port number. But this port have to be a member of a Port-Group, otherwise you could not select it. All calls which are originated from this single Port or the Port-Group would match the criteria 'From_ID'.

From Direction is set to SIP:

If 'From Direction' is set to SIP, the 'From ID' is a list of all SIP-Accounts, configured on the berofix, indicated by their 'Names'. In this case the a new field called 'Match type' would be added. The 'Match type' give you the possibility to choose how berofix should match for the From_ID. The Match type have the following options and meanings:

-From_IP: By choosing this option, the IP-Address from where the call is originated has to match to the 'Server address' of the SIP account, which has been chosen in the From_ID Field.

-From User: By choosing this option, additionaly to the IP-Adress (see From_IP), the SIP From_user part, of the a call has to match to the the 'user' field of the SIP-account, which has been choosen in the From_ID Field.

-Manual Address: By choosing this option, you can set a manual address (IP-Address) which should be used instead of a existing SIP-account. Matching is the same like described in 'From_IP' above. This field also could contain Regular Expressions like (172.20.0.2|172.20.0.3).

To ID

The To ID field is a bit easier, because it is the execution part. If 'To direction' set to PSTN (ISDN / Analog / GSM) a list of the corresponding configured PSTN Ports Groups or PSTN ports can be selected. If 'To direction' is set to SIP you can select from a list of configured SIP accounts or just enter a manual Address as described above.

Destination / New Destination: This pair 'Destination / New Destination' is one of the most important matching criterias. The Destination is the CalledID (the number which was originally dialed) also called DAD, this means the Number with which we enter in the Dialplan. While New Destination is the CalledID, when we leave the Dialplan. Both Destination and New Destination are based on Regular expressions.

Source / New Source: This pair 'Source / New Source' very similar to the pair 'Destination / New Destination' but applies to the CallerID (OAD)

Comments: For each Dialplan rule you can leave a small comment. You can see the comment as a tooltip Box in the 'Dialplan overview', when you hoover with the mouse over a particular Dialplan rule.

First position: If you enable option while creating a new dialplan rule, the rules will be added at the first position instead of the last one.

Active: Each Dialplan rule could activated or deactivated. You can see a deactivated rule in the Dialplan overview, indicated by a grey background.

Advanced Dialplan options

When you have created a Dialplan rule you can customise it more advanced by clicking on the toolbox icon on the right side of the Dialplan overview screen (the fourth icon on the right). Depending on what is set for 'From' and 'To Direction' you will have corresponding buttons to reach the more advanced options for ISDN / Analog / GSM and SIP.

The picture above shows you the advanced option's in this case for ISDN. These settings are exact the same like described in the Chapter 'Advanced ISDN PRI / BRI options' , which are attached to the 'ISDN Port Group'. In the Dialplan we have the possibility to make special settings for one particular setting. This means on the 'ISDN-Port-Group' we have the default settings while in the Dialplan we can overwrite a single value for a single Dialplan rule. On the right column of the above picture you can see the default button. By default this is activated. For instance if we check the option EC (Echhocancanceler) you will see that the value EC itself and the Default column are activated. This means that the default on the ISDN-Port-Group for the Option EC is activated and the Dialplan inherits this value. Do change this particular value you have to deactivate the Default and then deactivate the value EC, as you can see in the next picture.

This way illustrates how you can make very special Dialplan rules.

Note: The Dialplan has always the highest priority. For instance in the above mentioned example EC is deactivated in the Dialplan but activated on the 'ISDN-Port-Group'. If the Dialplan matches the value EC would be 'off' although this value is set to 'on' by the ISDN-Port-Group.

All other options (Analog / GSM / SIP) following the same mechanism as described before. For more information please read their respective Part in Chapter 3.

Example: Dialplan rule

The best way to explain how to handle berofix dialplan rules, is to make some examples.

Example1: Incoming call from SIP with the following settings

SourceIP:    172.20.0.1
CallerID:    2593890
CalledID:    025938912

Dialplan entry values:

Direction:          “SIP->ISDN”
FromID:             “(.*)”    matches any IP-Address
ToID:               “(g:te)”  routed to ISDNPort-Group g:te
Destination:        “0(.*)”   matches any CalledID starting with '0'
New Destination:    “\1 “    \1 will reference to parameter 1 ( \1 the value in the first parenthesize of Destination )
Source:             “(.*)”    matches any CallerID
New Source:         “\1 “    \1 is the value in the first parenthesize of Source

With this settings the the “Call” will be routed to ISDNPort Group “g:te”. The CalledID will be changed to 25938912, that means the first '0' will be stripped while the CallerID will routed transparent and still is 2593890.

Example2: Incoming call from SIP with the following settings

SourceIP:    172.20.0.1
CallerID:    12
CalledID:    0176242XXXXX.

Dialplan entry values:

Direction:         “SIP->ISDN”
FromID:            “172.20.0.1”  matches if source IP-Address is 172.20.0.1
ToID:              “1”           routed to ISDNPort 1
Destination:       “0176(.*)”    matches if CalledID is starting with 0176
New Destination:   “0049176\1”   will cut 0176 from CalledID and add 0049176 to the CalledID, followed by reference to parameter 1 
Source:            “(..)”        matches CallerIDs with exact 2 Digits.
New Source:        “25938912”    CallerID will be overwritten by 25938912

With this settings the the “Call” will be routed to ISDNPort 1”. The CalledID will be modified to 0049176XXXXX. The CallerID will be changed to 25938912.

Example3: Incoming call from ISDN with the following settings

ISDNPort:    g:teports
CallerID:    0176242XXXX
CalledID:    25938912

Dialplan entry values:

Direction:         “ISDN->SIP”
FromID:            ”g:teports”           matches if the call is originated from the ISDNPort-Group named 'teports'
ToID:              “p:mysipserver”       routed to the SIP account named 'mysipserver'
Destination:       ”259389([0-8][0-9])”  matches all numbers starting with 259389 followed by 2 digits in the range from [00-89]
New Destination:   “\1”                  will cut 259389 from CalledID and add the 2 digits referenced by parameter 1
Source             “(.*)”                matches any CallerID
New Source:        “\1 “                 \1 is the value in the first parenthesize of 'Source'

With this settings the the “Call” will be routed to SIP account p:mysipserver. The CalledID will be changed to 12. The CallerID will routed transparent and still is 0176242XXXX.

Example4: Incoming call from ISDN with the following settings

ISDNPort:    1
CallerID:    12
CalledID:    02593890

Dialplan entry values:

Direction:         “ISDN->SIP”
FromID:            ”1”                matches  the call is originated from the ISDNPort '1'
ToID:              “p:mysipserver”    routed to the SIP account named 'mysipserver'
Destination:       ”0([2-9])(.*))”    matches all numbers starting with 0. The second digit has to be in range[2-9] followed by the any digits.
New Destination:   “\1\2”             will cut 0 from CalledID and add the parameter 1 (\1 the value in the first parenthesizes) followed by parameter 2 (\2 the value in the second parenthesizes)
Source             “(.*)”             will match any CallerID
New Source:        “\1 “              \1 is the value in the first parenthesize of 'Source'

With this settings the the “Call” will be routed to SIP account p:mysipserver. The CalledID will be changed to 2593890. The CallerID is untouched.
With the above examples you should be able to handle almost every situation in the real world. If this is not enough and you need some special things, feel free to implement more complex Regular Expressions. For each Dialplan rule you can set the special features like enable Echocanceler or turn on T.38. More informations about this can be found in the corresponding chapters.

Preferences

Network settings

By selecting the menu point “Network” you can handle all network options like IP-Address, Netmask as well as the default Gateway, as you can see on the next picture.

DHCP / Static IP: Choose to manually coinfigure the berofix network settings or use DHCP to get them from a DHCP server.
IP-Address: If you using Static IP you can enter the berofix IP-Address
NETMASK: If you using Static IP you can enter you can the berofix subnet mask.
Gateway: If you using Static IP you can enter the berofix default gaetway
MTU size: Maximum transmission unit. A value between 0-1500. Default is 1500.
VLAN Enable: If you want you add the berofix device to a VLAN then enable this option.
VLAN ID: To set the ID of the VLAN
VLAN Priority: Here you can set the flag of the VLAN packet priority. High priority can result in better transmission because the packets are handled with priority over other packets.

Time settings

This is what the time settings look like:

NTP Host: IF you want to get the time for your berofix device from a server using hosting ntp, enter it's IP address here.
Timezone: Please select the time zone you are using the berofix device in.
Summer / Winter change: Enable this option if you want the berofix to automatically adjust the time to summer / winter changes
Time from ISDN: If you want the berofix device to get it's system time from ISDN, you can do so by enabling this option. You have to choose a specific port. All incoming ISDN calls are checked for the time and if they differ from the current system time, the system time is set to the new time.

Provisioning

This is what the provisioning interface looks like:

If you want to enable provisioning, you can choose either TFTP or HTTP provisioning.

TFTP / HTTP Host: Here you have to enter the IP address of the respective TFTP / HTTP host. (The host that provides configuration. )
TFTP / HTTP URL: Here you have to enter the URL of the configuration file in question of the respective TFTP / HTTP server.
Use boot TFTP / HTTP: If this option is activated, berofix will try to start provisioning process during the bootup.
API password: The password to the beroAPI of the berofix. You can access the API via HTTP 'http://IP-Address/app/api/beroFix.php' . The default username and passowrd is admin.
enable UserAppfs: TODO

berofos Heartbeat

This is what the berofos heartbeat interface looks like:

IP-Address: If you want to use the berofos heartbeat feature, you need to enter the IP address of the berofos device here.
MAC address: If you want to use the berofos heartbeat feature, you need to enter the MAC address of the berofos device here.
Interval (sec.): Here you can set the interval in which the berofix device sends a heartbeat signal.
Heartbeat on boot: Enable this option if you want the berofix device to send a heartbeat while and after booting automatically. (Alternatively you can also manually start the heartbeat)
berofos Heartbeat state: Here you can see what the current heartbeat setting is.

Logging

This is what the logging interface looks like:

Logging Server: The IP-Address where the berofix should send their logging informations to.
Logging Server Port: The UDP Port of the Logging Server
Logging Active: Here you can enable / disable the logging feature.
Log level: Here you can set the logging level. Log Level 1 is very low while Log Level 9 is very high.
Syslog facility: Syslog Facility is one information field associated with a syslog message. It is defined by the syslog protocol. It is meant to provide a very through clue from what part of a system the message originated from. LOCAL_0 to LOCAL_7 facilities, are traditionally reserved for administrator and application use.The facility can be very helpful to define rules that split messages for example to different log files based on the facility level. syslog_facility=[16-23] local0-local7

Security

This is what the security interface looks like:

Security:

Old password: If you want to change your password, you must first enter the current one here as authentication.
New password: If you want to change your password, you can enter the new one here.
Confirm new password: If you want to change your password, you have to enter the new one here a second time to verify.
Disable sessions: By default the berofix WebGui is under session management. For some reasons you can deactivate sessions.

Access Control List

Telnet ACL: Enter an IP-Address or an IP-Address range, to allow access to the Telnet interface.
HTTP ACL: Enter an IP-Address or an IP-Address range, to allow access to the HTTP interface.
SIP ACL: Enter an IP-Address or an IP-Address range, to allow access to the berofix SIP listining Port.
bfdetect ACL: Enter an IP-Address or an IP-Address range, to allow respondses to the bfdetect requests
SSH ACL: Enter an IP-Address or an IP-Address range, to allow access via SSH (only for the beroNet Support Team).

Some Example:

ACL 127.0.0.1 / 32 will limit the access to the IP-address 127.0.0.1 (localhost)
ACL 192.168.1.0 / 24 will limit the access to the network 192.168.1.1-192.168.1.254
ACL 172.20.0.0 / 16 will limit the access to the network 172.20.0.1-172.20.254.254

Causes Map

Modifying the causes map This is a example what you could see when clicking on the modify button on the right hand side (in the row of the cause you want to modify):

Call direction: Here you can choose the direction of call that a call has to be for this cause to be relevant.
To cause (SIP): Here you choose a cause to which the original cause should be translated to.
From cause (ISGW): Here you choose a cause which is to be converted to the different cause set above.
SIP response message: Here you can set a message which is also sent as part of SIP transmission if the cause applies. Very useful if you know of some error in the SIP transmission process but can't locate it.

Please find more detailed info here: BeroFix_ISDN_Cause/SIP_Response_map

Call Progress

Here you can define what should happen when ISDN events occur. What you can configure depends on the modules in use. So far this feature only supports SIP - ISDN and vise versa. Here is an example to make it more clear:

Interface type: Here you can choose the type of interface that this call progress table should be applied to.

ISDN event: Here you can set which ISDN event is meant, by this call progress table entry.

ISDN channel details: Here you can define a certain state the ISDN channels have to be in for this call progress table entry to apply.

SIP response: Here you can define to what SIP response the ISDN event should be translated.

Response text: Here you can add a response text. It is also sent to the respective SIP device for instance an 3cx telephone system, which could then forward the packet to some SIP phone which would then display this response e.g. "Ringing" (depending on ISDN event is being translated).

Please find more info here: BeroFix Call Progress Tables

Management

Under the menu point 'Management' you can reach the state view, activate debugging as well as reboot or reset the berofix to its factory defaults. In the following Chapters we will go into details for each point.

State

The the menu point “State” will give you an overview about the PSTN, SIP and PCM interconnection state. As you can see in the next picture you will get the state overview of the PSTN-Ports.

The first Box in the picture above shows you the ISDN Ports which are member of an ISDN-Port Group. Furthermore you can see that the state for Layer 1 and Layer 2 is down for ISDN Port 1 and 2. You can get more informations regarding the state of these ports by hoovering over the L1 Link and L2 Link field. The second Box in the above mentioned picture show you a list of all Analog Ports which are member of an Analog-Port-Group. On FXO and FXS Ports you can see the Line Voltage a

As you can see in the section ISDN Status, that ports 1-3 are configured and the state for Layer 1 and Layer 2 is up.

Active Calls

“Active Channels” on the berofix.

Port Statistics

Minimum Call Statistics

Backup and Restore

You can backup the configuration of berofix to an external file by just downloading it. These backup files could be used to restore the settings of berofix. Be aware that this could be depending on the berofix firmware version. So if you try to restore a backup file from an older version of the firmware, the restore process could fail.

Firmware Update

By selecting the menu point “Update Tool” you can update the firmware of berofix. Under the following URL

http://www.beronet.com/downloads/berofix/

You can always find the newest available firmwares.

The firmware update tool can be found under "Management->Firmware Update" and looks like:

The rest should be straight forward.

Dialplan Debug

This page is to give the user the opportunity to debug the dialplan if something is not working as expected.

Full Trace

The menu point “Full Trace” will give you the opportunity to report us problems with the berofix card on a defined way. This will help us to reproduce, analyse and fix your problem quite fast. On all ISDN Ports you can start a so called “Fulltrace” by pressing the Button “Start"”. By starting the debug process the system will start tracing all ISDN and SIP protocol elements. After you have finished your tests you can press “stop” and download the trace file. All relevant information about the callflow are stored in this debug file. Send this debug file to support@beronet.com with a small description about your test and we will be able to reproduce your problem.

Info

This Info page give you some general Informations about the System as you can see in the following picture.

CDR

TODO

Reboot / Reset

By select the menu point “Reboot / Reset”, you can reboot or reset the device to “factory defaults”.

Remote Managment

TODO

Retrieved from "http://www.beronet.biz/index.php/BerofixDocuV2"

Views

Personal tools

Log in / create account

Search

Toolbox