Sip User Manual v2.18-20161123
Sip User Manual v2.18-20161123
2
Date Version Who Change
25/04/13 1.17 ASI Adapted for SIP v2.12
- changed document and SIP client versions
- added about using DTMF and SIP INFO dialling from third party phones
- changed formatting and pictures with the new Barix template
17/10/13 1.18 ASI Adapted for SIP v2.13
- changed document and SIP client versions
13/01/14 1.19 ASI Fixing minor formatting issues
16/01/14 1.20 ASI Fixed some spelling mistakes and replace all the occurrences of the old Barix logo
with the new one
25/08/15 1.21 ASI Adapted for SIP v2.14:
- relay control and set dial target API commands
- information about using Authentication ID, Call Timeout and the updated Auto
Hangup timeout behaviour
- updated document and SIP client versions
26/08/15 1.22 ASI Added a paragraph for server compatibility and updated device compatibility list
13/06/16 1.23 ASI - Added information about the call answer (DA) CGI command
- Increased the SIP Client version to 2.15
21/07/16 1.24 ASI Adapted for SIP v2.16:
- added info about the backup SIP server entry
- increased the SIP Client version to 2.16
- fixed the formatting of some paragraphs
21/10/16 1.25 ASI Adapted for SIP v2.17
- changed document and SIP client versions
01/11/16 1.26 ASI Adapted for SIP v2.17a
-added info about using the Blind Call Transfer feature
15/03/17 1.27 ASI Adapted for SIP v2.18
- changed document and SIP client versions
- update d the info about auto hangup/pickup feature
- replaced all occurences of “Helvetica Neue LT Pro” font with “Helvetica Neue”
3
Table of Contents
1 Introduction.................................................................................................................................................. 7
1.1 About “SIP Client”....................................................................................................................................... 7
1.2 Features...................................................................................................................................................... 7
1.3 SIP features................................................................................................................................................ 8
1.4 Supported hardware................................................................................................................................... 8
1.5 Additional documents................................................................................................................................. 8
1.6 ABCL SIP firmware..................................................................................................................................... 8
1.7 About this manual....................................................................................................................................... 8
Links to chapters...................................................................................................................................... 8
Bookmarks pane in Adobe Acrobat.......................................................................................................... 8
Chapter overview...................................................................................................................................... 8
2 System requirements................................................................................................................................. 10
2.1 SIP environment........................................................................................................................................ 10
2.2 SIP server compatibility............................................................................................................................ 11
4
5.2 SIP calls (INVITE method)......................................................................................................................... 38
7 Common issues......................................................................................................................................... 52
7.1 SIP server compatibility............................................................................................................................ 52
Early SDP Offer vs. Late SDP Offer................................................................................................ 52
Authentication ID............................................................................................................................ 52
SIP Proxies and Virtual IP configurations....................................................................................... 52
7.2 SIP REGISTER fail.................................................................................................................................... 52
7.3 Remote peer don't receive any audio after call established..................................................................... 52
7.4 Nothing audible after call established....................................................................................................... 52
7.5 Internet dialog, audio missing after call established................................................................................. 53
7.6 Internet dialog, call terminate early........................................................................................................... 53
7.7 Background music does not start............................................................................................................. 53
7.8 DTMF command not executed, or the door relay is not opened.............................................................. 53
8 Additional Information............................................................................................................................... 54
8.1 WEB UI “ABCL SIP” firmware update....................................................................................................... 54
8.2 Updating a device using the RS-232 serial port....................................................................................... 54
8.3 BIN / DEC / HEX conversion..................................................................................................................... 55
5
9 Dictionary................................................................................................................................................... 56
10 Legal Information.................................................................................................................................... 61
6
1 Introduction
1.1 About “SIP Client”
SIP Client application has been developed to allow Barix devices supporting a standard
“telephone fashion” voice over IP communication, using the widely used application-layer control
protocol known as "SIP" (Session Initiation Protocol, RFC 3261).
To understand part of this document, a basic knowledge of the SIP protocol features and
terminologies is required.
The SIP Client application can be configured to work either in a peer to peer mode or in a proxy
based (PBX) connection .
Over the basic features of the SIP call dialogs, additional features has been added, like
background music, audio rebroadcasting and special DTMF commands.
1.2 Features
• SIP (RFC 3261) compliant architecture
• Supporting profiles for easy configuration
• Configurable destination number to call for every input contact
• Configurable call “pick up”/”hang off” timeout interval
• Configurable “call/close on level” feature
• Configurable “peer to peer” or “proxy based” connections
• Configurable SIP and audio RTP ports
• Support for G.711 audio
• Audio rebroadcasting
• Priority based notification audio messaging
• DTMF door open key sequence
• Configurable relay to switch on at call answer/call ring
• Configurable beep on call answer
• Serial, UDP, TCP or CGI control interface
• Transparent bidirectional Serial-To-TCP gateway
• Background music (BGM)
• Friendly profile based WEB configuration UI
• 10/100 Mbit Ethernet connection supports automatic network configuration
(BOOTP, DHCP, IPzator, and as well as manual static IP configuration)
• Syslog debugging messages
• X8 support, 8 additional inputs for predefined calls
7 Introduction
ACK,REFER (for Blind Call Transfer via the SIP server only)
• Processed status messages: 200, 180, 401, 403, 407, 503, 603
The SIP Client Application has been developed in BCL and is distributed with its source code
enabling users to further customise it. For detailed technical information about the programming
language please download the “Barix Control Language (BCL) Programmers Manual” from Barix
website.
8 Introduction
how to rescue a device via the serial port, and illustrate a BIN/DEC/HEX
conversion table.
• Chapter Dictionary giving a short explanation of some of the most important
terms used in this manual.
9 Introduction
2 System requirements
2.1 SIP environment
The SIP Client application can run through a 10/100 Mbit Network, as a peer to peer application,
or as a standard SIP “user agent client/server” (UAC/UAS) in a PBX environment.
10 System requirements
2.2 SIP server compatibility
The SIP Client application has been tested with the following list of SIP Registrar Server/PBX:
• Asterisk 1.4.29
• OpenSER 1.3.2-notls (i386/linux)
• FreeSWITCH 1.0.head (git-00207ce 2010-09-30 02-37-57 -0400)
The following SIP servers have been confirmed to work by our partners with some limitations
(see chapter SIP server compatibility for more details):
11 System requirements
3 Quick Start Guide
This chapter explains how to do the initial setup of the SIP client assuming that you have already
pre-loaded it on the device. If this is not the case, then please refer to chapters WEB UI ABCL
SIP firmware update and “Updating advice using the RS-232 serial port“ for more information
about loading the SW on the device and revert to factory defaults.
STEP 1
Plug a standard (straight) network cable into the LAN port of the Annuncicom and the other end into your
switch connected to your LAN.
STEP 2
Annuncicom 100 is designed to work with electret microphones by providing 2.7V (max 300μA) bias
power. Connect your electret microphone as shown on Illustration 2: Connecting Annuncicom 100.
In most of the cases, for 2 pin microphones you need to shorten the Mic and + pins as the internal circuitry
of Ann 100 provides the separating capacitor of 390 nF.
If your mic has 3 pins (output, bias/power, ground) then connect them to pins Mic, +, and ground
accordingly. For more information about the specific microphone you might be using, please refer to its
technical specification and proposed wiring diagram.
STEP 3
Connect your speaker to pins 5 and 6 of the upper connector. The Annuncicom 100 built-in amplifier is
able to drive 2W on 4Ω speakers. If more power is needed, then use the Line Out on the front panel to
connect the Annuncicom 100 to your external audio amplifier.
STEP 4
Last, you need to connect one button to be able to call a predefined number and answer/close incoming
calls. Connect your button on pins 1 and 3 of the lower connector thus shortening input 0 (IN0) to ground
to activate the digital input.
With this step, your Annuncicom 100 is ready to be configured for SIP communication.
There is no information shown because the SIP client is not yet configured. The registration
status is with red colour showing that the device is not registered.
Next, please click on the “Configuration” tab from the navigation menu. The Basic configuration
menu page will show up.
Server Name (PBX) The server name or the IP address of your 192.168.11.203
SIP server. The IP be a public (WAN), or or
private (LAN) IP address. This can be empty in Peer-to-peer
either Asterisk or FreeSWITCH box. In the mode
example a local FreeSWITCH SIP server
is used
SIP password (secret) The password for your SIP account 1234 (not displayed
while typing)
Leave the other fields (Peer to peer, Phone pick up mode, and Pick/Hang up time) unchanged,
click the “Apply” button, and wait the device to reboot. If the SIP account settings are correct, the
device should register, and its status displayed in green colour on the home page.
1 Make sure that ID 9246 is existing and registered to the same SIP server. This could be another BARIX
SIP client, or any HW or SW SIP phone.
The Home page displays the most essential configuration and status information grouped in the
following sections:
APPLICATION STATUS
Application mode
Shows the current mode of the application, and may take the following values:
- SIP mode
The device is in SIP mode. The SIP server name, and the SIP ID are also shown in this
case. Direct IP (P2P) calls are ignored;
Shows the remaining time till the next registration attempt. The current registration status is
shown with different colours of the text:
Call Status
Shows the current call state, and may take one of the following values:
- Idle:
No audio stream is received, and the SIP client is accepting calls;
- Getting incoming call:
The SIP client has received an INVITE message and is ringing. The ID of the remote
party is also displayed;
- Outgoing call:
The SIP client has initiated an outgoing call, and the remote party ID is displayed as
well;
- In active call:
The SIP client is in a call session with the displayed remote party.
Device I/O
Device I/O enumeration, bit "0" correspond to the first device input, for example IN0 for
Annuncicom 100.
Inputs
Disconnected Shorted
If Annuncicom 155 is not detected, the “Disconnected” and “Shorted” icons are not shown:
Relays
NOTE: please read the ABCL Firmware documentation and the product manual to understand
how input, output and relays are mapped, and where they are available.
X8 I/O Status
X8 pin configuration
For more information how to change the pin configuration please refer to the X8 manual.
X8 input register
X8 output register
AUDIO STATUS
- Volume:
Displays the current left output peak level in dBFS (dB full scale);
Displays the current right output peak level in dBFS (dB full scale);
Displays the current left input peak level in dBFS (dB full scale);
Displays the current right input peak level in dBFS (dB full scale);
All profiles have in common access to the complete set of settings from the following sections:
SIP Phone
This is the typical use of the SIP client. In this mode you can:
– Close on timeout;
– Close on Input 0-7 and X8 Input 0-7;
– Input audio buffer level;
– Input audio source;
– Encoding;
– Volume;
– Mic and AD gains
In this mode the SIP client is used as an end point for getting SIP Paging messages. The typical
use scenario in this case is to configure the SIP server to call a group of SIP clients which will
auto-reply and play locally the sent audio. While in idle mode, the SIP paging station may play
background music.
– Encoding;
– Volume;
– BGM IP Address and Port;
– BGM volume and input audio buffer
In this mode the SIP client is used to rebroadcast the incoming call to a specific multicast
address, and port number. All Outbound Calls related settings are reset to the factory defaults.
The following additional options are enabled in this mode:
– Encoding;
– Volume;
– Audio Rebroadcast Address and Port.
The device is to be used as a door intercom station. Pushing the button causes the device to
ring, and closes the call automatically after some time if not answered. In this mode the SIP
client can be used in half duplex mode with AI Phone door panels. The phone pickup mode is
preset to “auto answer” and cannot be changed.
– Close on timeout;
– Close on Input 0-7 and X8 Input 0-7;
– Input audio buffer level;
– Input audio source;
– Encoding;
– Volume;
– Mic and AD gains;
– Talk mode (HDX or FDX);
– Output trigger level and trigger level timeout for the Voice Activity Detection
(VAD);
– AI Phone support (On/Off)
In this mode the SIP client is used to call a predefined number if the input audio level exceeds
certain level. As here only the Call/Close on level options are used, all IDs to be called on digital
input are cleared (reset the factory defaults). The audio source input is preset to “Mic” and
cannot be changed.
–
–
–
The configuration page consists of three frames - the menu navigation section, the settings
section, and the help section.
The menu navigation section contains two menus - Basic and Advanced. While the Basic menu
shows only the most essential settings needed to initially configure the application, the Advanced
menu gives access to all settings available for the selected application profile.
Clicking on the selected menu options shows the configuration options, and their relevant help
page. After configuring the needed options, click the “Apply” button to save the changes.
NOTE: Settings are not preserved if you switch between the Basic and Advanced menus. Make
sure you apply the changes you have already done before switching to the other menu!
Below is the full list of configuration options available in the Advanced menu. Please be aware
that not all of them may be visible depending on your selected profile.
NETWORK SETTINGS
Use SonicIP
If set to "yes", the device will announce its IP address over the audio output during device
startup.
Default: "yes"
IP Address
Gateway IP Address
Primary DNS
In this field you can give the desired primary and alternative DNS IP address to be able to
connect to URLs (e.g. www.radio.com).
Example: "195.186.1.111"
Default: "0.0.0.0"
Alternative DNS
In this field you can give the desired alternative DNS IP address in case the primary DNS is not
reachable.
Example: "195.186.4.111"
Default: "0.0.0.0"
Syslog Address
Destination address for syslog messages sent by the BCL program via the SYSLOG command.
Set this to your syslog logging machine, if your syslog messages are recorded centrally.
If set to 0.0.0.0, syslog messages are broadcast.
Default: "0.0.0.0"
Name of the device sent in DHCP request. If left empty, a name based on the device's MAC
address is generated automatically. Enter up to 15 Characters.
Defines the port where the web server of the device can be reached. If set to "0" the default
HTTP port (80) is used.
Peer to Peer
Enter either the hostname/IP address of a SIP server, or of the remote peer.
Enter either the hostname/IP address of of the backup SIP server if you have one. In case when
the main server is not available, the device will try to register to the second one.
NOTE: The backup server shall be configured to require the same credentials as on the first one.
SIP ID
Enter the SIP ID (username) that has been created for this device.
SIP Password
SIP Display ID
Enter the description that you like to have displayed on the remote peer when ringing.
Authentication ID
Enter the Authentication ID given by your SIP provider to use for authentication (if it is different
than the SIP ID). Most often you do not need to fill in anything, just leave it empty to use the SIP
ID for authentication.
Listening port for the SIP protocol messages. A value of 0 means a default value of 5060.
Listening port for the RTP audio blocks. A value of 0 means a default value of 5004.
The value that the SIP client suggests to the SIP server when sending the REGISTER request. If
this value is accepted by the SIP server, the SIP client has to register after this amount of time.
NOTE: The SIP server may overwrite this value in its reply to the REGISTER request.
Send NAT-Keepalives
If enabled, it will force the SIP client to renew the DNS of the SIP server every time the
registration to the server fails. Use this feature if you have a backup SIP server with the same
DNS name and you wish to enable the SIP client to switch to it if the main server fails.
NOTE: This option is mutually exclusive with the "Backup SIP Server (PBX)" setting. When this
option is enabled, it will prevent the SIP client from switching to the backup SIP server, and it will
stay to the one that has been selected at boot time. In this case the SIP client will keep on
resolving the same SIP server name.
The SIP client will automatically resolve the DNS of the SIP server if the REGISTER request
fails. However, if the SIP server is down, or the REGISTER message gets lost, the SIP client will
not get reply from the server. So configure here the timeout after sending a REGISTER request
on the expiry of which the registration will be considered as "failed" in case of no reply from the
SIP server.
NOTE 1: Use this feature with caution. Setting this value too low may result in registration
malfunctioning. If unsure, leave it to the default value.
NOTE 2: This timeout is shared with the "Backup SIP server (PBX)" setting.
Default: 10 seconds
Call Timeout
Enter here in minutes (1-255) the maximum time duration of the call. After the expiry of this
timeout the call will be unconditionally closed.
Default: 0 (disabled)
Enables the support for the SIP REFER method that is needed to perform the blind call transfer.
This option is available only in "SIP Phone" profile. When activated, the user cannot use
anymore any button to close the call. Instead, only the button, that has been pressed to start the
call, can be used to close it. Pressing any other button will transfer the remote party to the peer
with the associated to that button ID.
NOTE: This setting is ignored if "Peer to Peer" mode is enabled.
Default: Disabled
Debug Mode
If enabled, the device will automatically hang-up after the configured amount of time if no one
answers the call. This option is suitable for door station panels that have only one ring button,
and no button to cancel the initiated call.
Values: 5 to 240 seconds.
Default: 0 (disabled)
NOTE: When the Auto Hangup Time is disabled, a second press on the Input0/1 button will
cancel the started call setup. Please do not disable it if the device is intended to be used as
doorstation. If the call is not cancelled with a second button press, the SIP client will anyway
unconditionally drop the call after 120 seconds.enabled, the device will automatically hang-up
after the configured amount of time if no one answers the call. This option is suitable for door
station panels that have only one ring button, and no button to cancel the initiated call.
Call on Level
If enabled, call can be initiated by audio level. If set to "Yes", then Call on Level ID, Level
Threshold and Close Call on Level options are also visible.
NOTE: Call on level is unsupported with "Background Music" enabled.
Extensions to be called when the correspondent input is closed. The available number of inputs
depends from the Barix hardware model.
In "Peer to Peer" mode this field is used to assign the IP of the remote peer to be called. I can
contain just remote peer ID, or the IP preceded with its callID.
For example [email protected] or just 192.168.0.1
Call on Level ID
SIP extension of the device that will be called on audio level detection.
Level Threshold
Minimal audio level to initiate a call. If the input audio level reaches at least the configured
threshold, a call will be initiated. The same threshold level is used to terminate the call if the
Close Call on Level option is enabled
Values: 0 to 32767.
Default: 1000
If enabled, the SIP client will play a short beep sound when the remote party answers the call.
Default: Off
Extensions to be called when the correspondent input is closed. The available number of inputs
Call on X8 Inputs
Fields allow to assign a SIP extension to be called when an input contact closes, for every
available X8 input.
NOTE: these fields are visible and can be set only if the X8 hardware extension is detected.
Maximum delay of the input audio buffer in milliseconds. Decrease this value to minimise delay,
increase this value to prevent audio dropouts.
Default setting is "300" ms.
auto-pick-up after timeout: in this mode the bell button is used to answer and terminate a call. If
the call is not answered inside "Pick/Hang up After" time period, the device will answer;
auto-hang-up after timeout: (default) in this mode the bell button is used to answer and
terminate the call. If the call is not answered inside "Pick/hang up after" time period, the device
will decline the call;
Pick/Hang up After
Set pick/hang up delay if no answer. Only active if the phone pick-up mode is set to manual.
Stream Timeout
In some scenarios the remote party may go offline without explicitly closing the active call. In this
case the SIP client may stay in active call state for unlimited amount of time. Set here the time in
minutes after which the SIP client will close the active call if there is no audio stream received.
You can change between 0 and 600 minutes.
NOTE: Please have in mind that this setting is ignored and reset to "disabled" if you select SIP
Monitoring Point profile. Default setting is "0 min (disabled)".
If enabled, the SIP client will play a short beep sound when the incoming call is answered.
Default: Off
Set the secret code to open the door by entering this DTMF sequence while communicating with
Set the contact closure duration. After this period, the relay contact is switched back to open.
Enable Relay
Select here when you would like to have the relay enabled. You can choose between “on call
answer” and “on call ring”
Default setting is "on call answer" terminated.
Select here the relay number that you would like to have automatically switched on depending
on the "Enable Relay" setting. The number of the available relays varies for the different Barix
devices. If invalid relay number is selected, it will be ignored.
Default setting is "disabled"
NOTE: The status of the relay can still be modified with a DTMF command.
AUDIO SETTINGS
Input Source
Encoding
Volume
Microphone Gain
Microphone gain dB, increase if your microphone is too faint, decrease if it's too loud or over-
driven.
Default: "21dB"
A/D converter pre-amplification in dB. Increase if the audio signal too faint, decrease if it's too
loud or over-driven.
Default: "0dB"
Choose between full-duplex” and half-duplex talk mode. This option is available only in SIP Door
Station profile. When selected, the user has also the possibility to enable the support for AI
Phone door panels. Default: "FDX" at factory defaults, and "HDX" when the SIP Door Station
Profile is applied.
Defines the audio level from the incoming audio RTP stream which will trigger the SIP client in
"listen" mode. This setting is ignored if the door station is configured in FDX mode.
Values: 0 to 32767.
Default: "1000"
Defines the timeout in milliseconds, after which if no audio is detected from the incoming RTP
stream, the SIP Client should switch back to "talk" mode. This setting is ignored if the door
station is configured in FDX mode.
Default: "200 ms"
AI Phone Support
Enable or disable the support for AI Phone door panels. This option is available only in SIP Door
Station mode and is automatically set to "No" if FDX talk mode or other profile is selected.
Default: "No"
Note: The AEC option is visible only if supported by the HW (IPAM 102 based devices).
Default: "Off"
STREAMING
AUDIO REBROADCAST
Rebroadcast IP Address
Rebroadcast Port
Set the audio rebroadcasting port. A value of 0 disable the audio rebroadcasting feature.
NOTE: Rebroadcast will start only if rebroadcast IP:PORT fields are set, using the DTMF
start/stop commands.
BGM Address
Set the BGM listening address.
Set the BGM listening port. If this field is not 0, the BGM listening service is enabled. BGM
service listen for a RTP-MP3 incoming stream.
BGM Volume
BGM Buffer
Set the BGM playback delay buffer in milliseconds. NOTE: Using both rebroadcast and
background music playback is not supported!
Configure the notification audio listening address here. Multicast is also supported.
Notification Port
Set the notification audio listening port. If this field is not 0, the notification message listening
service is enabled.
Note: The notification audio incoming stream must be RTP. For the supported RTP payload
types refer to Chapter Notification Messaging.
Notification Volume
Notification Buffer
If set to Yes, and Relay Number to Enable at Call Answer from the Inbound Calls section is
enabled, then the specified relay will be activated while the notification message is active. Note:
This configuration option is not visible if Relay Number to Enable at Call Answer is set to
disabled.
CONTROL INTERFACES
Set the UDP control port. A value of 0 disables UDP control support.
Set the UDP control port. A value of 0 disables UDP control support.
Set the TCP control port. A value of 0 disables TCP control support.
These settings adjust the purpose of the serial port. You can use between the following values:
X8 Extension: In this mode the serial port is used to connect the Barix X8 extension.
Serial Control Interface: In this mode the serial port is used to send commands to the SIP client.
For more information how to use it please refer to the SIP User Manual.
Serial GW, TCP, passive: When enabled, the SIP client is waiting for a telnet connection on the
specified port. Once established, data can be transmitted between COM port 1, and the host
that has established the TCP connection.
Default: "X8 Extension"
Configure here the TCP port for the passive TCP Serial Gateway. This option is visible only if
passive TCP GW is selected.
Default: "0 (disabled)"
Baud Rate
Data Bits
Parity
Stop Bits
Flow Control
Select the type of flow control:
RTS/CTS signals not used: "none";
RS232: "Software flow control(XON/XOFF)" or "Hardware flow control (RTS/CTS)";
RS485: "RS485 direction control";
Default: "none".
Reset Function
Enable or disable the "Reset" function on the Reset button and on the WEB UI. In order to
restart the device press the Reset button once.
Default: "enabled"
Factory Defaults
Enable or disable the "Factory Defaults" function on the Reset button. In order to revert all
settings to factory defaults keep the Reset button pressed until the red LED starts blinking
(approx. 10 seconds).
Default: "enabled"
Update Function
Enable or disable the WEB Update function of the device. If the Update function is disabled, the
only way to update the firmware is to use the serial rescue.
Default: "enabled"
Set Password
Note: After applying the changes for the password, please restart your browser and reload the
home page of the device. If you do not do this, the browser may enter into endless loop asking
for the password because of the non protected configuration page still stored in its cache.
To allow free access (clearing the password) enter the old password and leave the field "New
Password" empty, then hit the "Apply" button.
After the restart you will not be asked for user name and password anymore.
To change the password enter the old password and enter the new password in the field "New
Password", then hit the "Apply" button.
After the restart you will be asked for user name and password. The user name can be omitted
but the new password has to be supplied in order to see the web configuration.
This page prints all available configuration options, and can be used for diagnostic purpose. It
consists of three sections, split with line separators:
Device Information section, showing all information about the device HW:
This page helps you to revert to factory default if needed. To do so please click on "Revert to
defaults" link to restore all factory settings except "Network configuration".
While restarting the device a screen appears showing a number counting down. On device start
up a screen appears stating the successful reverting to factory defaults.
If you need to revert also the "Network configuration" settings to factory defaults please press
and hold the Reset button for about 10 seconds while the device is powered.
This page helps you to do a full, or partial FW update of your device. For more details how to do
it please refer to WEB UI ABCL SIP Firmware update chapter.
Updating files
Click on "Please click here to continue" to launch the update process. Please have in mind that
the update process can ONLY be cancelled by power cycling the device.
The device will restart in a special mode called “Bootloader”, and a screen appears showing a
number counting down.
To upload a resource click on "Browse..." to locate the file you want to update. Once selected,
click on "Upload".This upload process can take a few seconds.
If you choose "update" you may upload another resource or click the "reboot" button.
The device takes a few seconds to reboot. If you have a fixed IP address or DHCP resolves to
the IP address used before, the main page will appear.
In “peer to peer” mode, a basic SIP dialog can be established just setting up “Remote Peer” and
“SIP Id” fields.
To establish a SIP dialog through a SIP PBX/Server, “SIP Server”, “SIP Id” and “SIP Password”
must be set, and the registration process must succeed.
A correspondent entry for this account must be created on the server side. Server configuration
depend from the brand and model of the SIP PBX, please see the server side documentation for
this.
Below is reported a server configuration example for the Asterisk open-source PBX, supposing
that both the Barix device and the Asterisk PBX are in the same local network, that both are in
the same network subnet (192.168.0.XXX) and that the server network address is 192.168.0.20.
[ann01]
type=friend
username=ann01
secret=1234
host=dynamic
After the Asterisk server is configured and restarted, Barix device should successfully register to
the PBX using the following settings:
The “Debug mode” option set to “On” allow to verify if the Barix device has correctly registered to
the SIP server. Using a common Syslog application, like for example “Kiwi Syslog Daemon”
(www.kiwisyslog.com) or a similar tool, after a successful registration process the following
debug messages will be displayed:
[OUT] REGISTER
[in ] 100
[in ] 401
[OUT] REGISTER
[in ] 100
[in ] 200
Note: before performing any call through a PBX server, please be sure the registration process
has succeeded, as shown in the section above.
Calls can be issued using the “Call on Level” feature, or closing an input contact, as
preconfigured on the WEB interface. Until the remote peer answer or reject the call, a bell ring
sound will be audible.
After the call has been answered, full duplex audio communication starts immediately. Any input
contact closure will terminate (BYE method) the current call.
SIP Client support different Barix devices, every hardware type have different Input, Output and
Relay capabilities.
The WEB UI shows the device input, output and relay states, and if a Barix X8 is connected, the
related input, output and relay states will be shown.
Graphically, inputs, relays and outputs are always numbered from 0 to 7. First input, output, or
relay (number 0) corresponds to the first Barix device input, output or relay.
For more information about the available number of inputs, outputs and relays, please refer to
the “ABCL Firmware” technical documentation; it can be downloaded at www.barix.com.
After a dialog is successfully established, SIP Client application can accept commands sent by
the remote party in the call. These commands can be transmitted either using DTMF tones, or
by using the SIP INFO message.
NOTE 1: The remote SIP telephone/client must be configured to use either DTMF or SIP info for
transmitting commands, but not both at the same time because this will result in decoding
duplicated key presses on the Barix SIP client. For more details have to do that please refer to
the documentation of the specific SIP phone/client;
NOTE 2: Every sequence must be entered with a maximum 5 seconds delay between every key,
otherwise the sequence will be cleared, and the command must be entered from the start. The
supported commands are listed in the table below:
#2*2*
mask, to be applied. 2 mean binary “00000010”
so the command set relay “1” to
1(closed) and all other to 0 (open).
Set X8 outputs, NNN is the
decimal value (0 to 255),
#3*NNN* See command “1”.
representing an 8 bit bit-
mask, to be applied.
Configure X8 contacts, NNN
is the decimal value (0 to #4*3*
255), representing an 8 bit 3 mean “00000011”, so X8 IO0 and IO1
#4*NNN*
bit-mask to set the behaviour are set as outputs, all the other contacts
of every X8 contact are set as inputs.
(1=output, 0=input).
Enable/disable the audio #5*0* disable audio rebroadcasting,
#5*N*
rebroadcasting feature. #5*1* enable audio rebroadcasting,
Remarks:
1. If relay 1 is configured as the one to be switched on at call answer, and at the same
time there is a door open code set, and the door code is typed in during the call, the
relay will be switched off after the expire of the door lock timer. To prevent that, avoid
using “Door Open” and “Enable relay on at call answer” at the same time. Another
possibility is to configure the “Enable relay on at call answer” feature to use relay 2-8
when using Annuncicom 1000;
2. When DTMF command is used to switch on any relay(s), only relay 1 is switched off
automatically when the call is terminated. To close relays 2-8 a separate DTMF
command needs to be sent.
3. When a X8 contact that is configured as input is tried to be set using DTMF
command 3, the active call will be closed as it will be detected as a button press.
4. In order the status of X8 contacts to be correctly displayed after using DTMF
command 4, the SIP client needs to be rebooted in order the X8 device to be
properly reinitialised with the new settings
A special control interface allow the remoter control of the device from the network, or from a
serial cable connection.
A set of commands is supplied for this purpose. Command can be sent using one of the
following method:
R2
2 mean binary
“00000010”
so the command set
relay “2” to 1(closed) and
This feature allows the audio redirection after a call has been established. When this feature is
enabled, the same RTP received audio stream (uLaw or aLaw) will be forwarded to the remote
target destination.
This feature allows to receive a UDP-RTP audio stream, as MPEG1 Layer 3 (MP3) or MPEG2
Layer 3, on a preconfigured port (see chapter Advanced WEB UI Configuration).
The SIP client can be configured to listen for RTP notification audio messages to a specific port.
The notification audio can be sent via unicast, broadcast, or multicast. The following RTP
payload types are supported and automatically detected from the RTP stream:
• PCM: 8,12,24,32,44.1 kHz MSB mono
• PCM: 8,12,24,32,44.1 kHz LSB mono
• PCM: 44.1, 48 kHz MSB/LSB stereo
• aLaw: 8,12,24,32 kHz mono
• uLaw: 8,12,24,32 kHz mono
• MP3: The same types as for BGM
• High priority – In this case the notification message interrupts any pending or
established SIP call. While the notification message is active, the SIP client
will reject all incoming calls. After the end of the notification message the
BGM playback is restored, and the SIP client can accept incoming calls.
• Low priority – In this case the SIP communication has a higher priority. The
notification message will be received only in idle mode, or when playing
BGM. While the notification message is active, any incoming SIP call will
cancel it, and the SIP client will start ringing. After the end of the SIP call the
device will switch back to the notification message if it is still active.
NOTE: The SIP client has a protection mechanism for ignoring notification audio streams
with unsupported RTP packets. If such a stream is received, then the SIP client ignores
the stream for the next 2 seconds to avoid performance issues and drops of the
established SIP communication.
Configuring PS16
• Install the SIP ABCL FW using the HTTP update as described in chapter WEB UI
ABCL SIP Firmware update. After rebooting the PS16, open the SIP client web page,
and apply the factory defaults.
• On the first boot, you will see the following message in the display:
Please configure
The SIP Client!
• Open the configuration page, and put the required SIP server, SIP ID (user name),
and password from the Basic Settings page. The SIP profile should be already preset
to “SIP Phone”.
• Reboot the device. If the SIP client is successfully registered, you should see the idle
message:
SIP Client
V1.12 (22 Jun 2011)
• Next you need to assign a call destination for all keys. Open the web interface, and
go to Configuration-->Advanced Settings-->Outbound Calls configuration page.
Configure all 8 call IDs from the “Call on Device Inputs” section to be used from
PS16 buttons from 1 to 8 (the bottom row of keys). For the second row of keys
please use the call IDs from the “Call on X8 Inputs” section.
When an incoming call is received, the PS16 will start ringing, and the LED on button 1 will start
blinking. The Call ID of the calling party (if available) is also shown on the display. Press any key
to answer the call, and any key to close the call.
Press the corresponding target button to initiate the call. The PS16 shall start ringing, and the
LEDs of this button will start blinking. A message will be shown on the display as well:
Outgoing call:
[email protected]
In order to be able to use the serial interface, it has to be enabled by choosing one of the
following options:
If needed, the Serial Port 1 settings as could be modified for the purpose of your application.
Click “Apply” and reboot the device in order the new setting to take effect.
Command Mode
To enable it, select “Serial Control Interface”. In command mode the serial interface can be
used to send commands as you can do via the UDP, TCP, or CGI interfaces as described at the
beginning of this section. The following rules imply:
When the X command is used from the TCP/UDP port, or from the CGI interface, the serial port
enters in a data transmission mode. In this case, the serial port starts receiving the data, sent by
the initiating interface, and sends data back to it. The following rules imply in this case:
• The reverse channel (sending data from the serial interface back to the
interface that has issued the X command) works only with TCP and UDP
interfaces. There is no stream back (reverse channel) when the X command
is sent via the CGI interface;
• The data being sent from the UDP/TCP/CGI interface must be preceded by
X, like:
X12345678
• The serial interface adds the “X” to the data that are being sent back to the
X68656C6C6F
Let's illustrate this with a specific example. For this purpose we will use a SIP client with Control
Interfaces settings as shown above, and a Serial Terminal Emulator. You can use any terminal
out of the following non-exhaustive list:
In our example we will use the CoolTERM terminal emulator application for MacOS
First, configure your SIP client as requested, and reboot the device.
Second, run the CoolTERM and click on Connection→Options menu item. The configuration
panel will appear:
Check your serial port options, and make sure you select <CR> for the Enter key emulation.
Click OK, then click the “Connect” button to connect the terminal to the configured COM port.
Type the first two commands (X12345678 and X99998888). The data should be displayed on
the CoolTERM window:
Next, click on Connection→Send String from the menu bar, and type “hello” in the window. Click
“Send”:
The data should be displayed in the telnet window as X68656C6C6F. Mind the starting “X”
added by the serial interface at the beginning. Now, do the same, but adding a <CR> at the end
by pressing “Enter”:
Last, press Ctrl-] and type quit to close the telnet session.
This feature allows to transparently transfer data in full-duplex mode between the Serial COM
port of the SIP client, and a TCP connected remote host without the need to use the X
command.
To enable it, select “Serial GW, TCP, passive” from the “Use Serial Port For” drop-down menu.
The remote host must open a TCP connection to the SIP client in order the gateway to be
functional. The TCP port to which the SIP client will listen for incoming TCP connections is
configured via the webUI as shown on 12.
Setting up the tunnel is quite similar to the case when sending date using the X command:
First, open the serial terminal emulator, and configure it as specified above. Make sure you
select the correct serial port device, and configure the same COM port settings as configured in
the SIP client COM port settings, and click Connect to open the COM port device.
Type the “test” - it should appear in the CoolTerm terminal window. Next, click on Connection--
>Send Text File, and select an plain ASCII file to send. The data should start appearing in the
telnet window.
When finished, press Ctrl+] and type “quit” to close the telnet session. With this, the
established Serial-to-TCP tunnel is destroyed.
If triggering of calls to more than 2 targets is desired, then BARIX X8 device must be correctly
configured and connected to COM port of the device.
X8 pinout
2 I/O 7 2 RS-485A
3 I/O 6 3 RS-485B
6 I/O 3
J5
7 I/O 2
8 I/O 1 1 Shield
9 I/O 0 2 Shield
Programming X8
The X8 device provided by Barix must be configured for a special mode in order to be used for
the needs of SIP application. In general, this is the default mode of X8, but if you have changed
it for some reason, or if not sure in what mode the X8 is programmed, then follow the procedure
below to reset to the default parameters:
• Power up X8. The device will reset to factory defaults. All LEDs will be
illuminated, LED 3 will blink showing that the default parameters have been
stored in the non volatile memory.
• Remove the power, then remove the bridge between pins 8 and 9. The X8 is
After connecting the X8 to the device the left LED1 will blink every second, while LED2 and
LED3 will randomly blink showing the exchange of Modbus data and commands between X8
and the SIP client. The X8 can be accessed on Modbus address 255 using the following serial
settings: 19200,8 bits, No parity, No handshake.
In order the X8 to function properly, open the application Advanced Settings –> Control interfaces
page, and set “Use Serial Port for” to “X8 extension”. In this application is automatically
reconfigured to to use the correct COM port settings depending on the used device
(Annuncicom 100/200 or Annuncicom 155). In this case the Serial 1 COM port settings are
ignored, even if it is possible tо change them from the configuration page.
Next, you need to connect the X8 to the device. To connect it to COM1 PORT of Annuncicom
100/200, you need to prepare an adapter cable using the connection diagram below.
Connecting the X8 to Annuncicom 155 is easier, because in this case the RS232 to RS485
adapter cable is not needed. Connect the X8 directly to the COM2 port of Annuncicom 155 using
the following connection diagram:
For more Information about the pinout of the M12 connector on the Annuncicom 155 front panel,
please refer to the supplied documentation, or download the Annuncicom 155 Product Manual
For the purpose of this application, the most simple configuration is used. Connect your buttons
or contact closures between each input and signal ground as shown in the picture below.
However, up to 70 buttons and a volume control may be connected if desired. The application
also needs to be modified to support more buttons. For more information please refer to BARIX
customer support.
Barix SIP client implementation is using "Early SDP offer" (i.e. SDP in the INVITE SIP
message) which is the culprit when used with PBX server which is configured to use
"Late SDP offer" (i.e. SDP in the ACK SIP message) as default (e.g. Mitel, Cisco
CUCM), which results in missing audio when the call is established. In this case the
PBX must be configured to use "Early SDP offer" (e.g called “Early Media” in Cisco
CUCM).
Authentication ID
Some SIP PBX require Authentication ID (sometimes also called Authorisation user
name) which is different than the SIP ID/Username (which is usually the SIP extension
number). For SIP client prior to v2.14 it was necessary to configure the same ID as
Authentication ID and SIP ID(Username). Starting from SIP v2.14 you can configure
Authentication ID separately.
SIP proxies and Virtual IP configuration (e.x. used by Shoretel) are not supported.
• Check that the server is reachable, for example using the “ping” command from the
command prompt. A reply, as shown below, must be received.
If no reply is received, check the network connections and the server configuration.
• Check device WEB UI “SIP Id” and “SIP Password” fields to be correct.
• Check the Syslog messages sent from the device. An error message 401
(Unauthorised) means a bad “SIP Id” or “SIP Password”.
7.3 Remote peer don't receive any audio after call established
52 Common issues
7.5 Internet dialog, audio missing after call established
When a call is established with a peer located outside of the local network, through a
router, add a redirection rule on your local LAN gateway setup. For example, if the Barix
device RTP audio port is 5004 (default) and the device LAN IP is 192.168.0.2, a rule must
added as described below.
Please see the specific router/gateway manual, looking for a “Port Redirection” or “Port
Forwarding” section.
If these values are not set the application will exit after boot, and not do anything.
7.8 DTMF command not executed, or the door relay is not opened
Check if the remote SIP telephone has both SIP INFO and DTMF enabled at the same time. If
yes-configure it to use only one of these methods. Here is an example how to do it on SNOM
360:
Open the web configuration page, and go to your Identity-->SIP page. Find the option „DTMF via
SIP info“, and set it to „Off“:
53 Common issues
8 Additional Information
8.1 WEB UI “ABCL SIP” firmware update
From the main WEB menu, click on the “Update” button. You will see the update page. Click on
“Browse”, then navigate to the update_rescue/compound.bin in the directory where you have
unzipped the abcl_sip_vXX.XX_DATE.zip file. Select it, then click on the “Upload” button to
continue.
Reboot the device when the update is finished, and open the web UI at the announced IP
address. Navigate to the reboot page by clicking on the “Reboot” tab, then select “SIP Client
(sip)” from the Application drop-down menu, and click the “Apply” button. The device will reboot
again.
Sometimes when the device is not accessible via the LAN, or the image in the flash memory is
corrupted for some reason, then a serial rescue may be needed to reset the device to the factory
defaults2.
So, here are the steps that need to be executed to do the serial rescue:
▪ Connect the COM port of the device to the COM port of your computer via a null
modem serial cable;
▪ Start the rescue process by executing ipamresX, where X is the number (1-4) of
2 Rescuing the SIP Client using the serial port is more complex, and requires some engineering work.
Please contact BARIX Support to get more information.
54 Additional Information
the serial port on the computer;
▪ If running on Linux /Mac execute the ipamresd.sh script, giving the device name
of your COM port as a parameter. For ex.:
./seriald.sh /dev/tty.UC-232AC
▪ Power on the device, and wait for the update to finish. The device will reboot
automatically.
NOTE: All other settings except the network settings will be lost !
Hexadecimal digits have values from 0..15, represented as 0..9 and as A (for 10) to F (for 15).
To convert a binary value in a hexadecimal representation, the upper and lower four bits are
treated separately, resulting in a two-digit hexadecimal number.
55 Additional Information
9 Dictionary
Class A network
Class B network
Class C network
• IP address 192.0.0.x to 223.255.255.x
Class C networks are most common and for smaller companies. These networks can consist of
a maximum number of 254hosts.
• Example: 192.7.1.9 (network 192.7.1, host 9)
Class D network
The remaining addresses 224.x.x.x - 239.x.x.x are defined as ”Class D” and are used as
multicast addresses.
Class E network
No addresses are allowed with the four highest order bits set to “1” (240.x.x.x – 254.x.x.x).
These addresses, called "class E", are reserved.
DHCP
Short for Dynamic Host Configuration Protocol, a protocol used to assign an IP address to a
device connected to a Network.
FDX
Short for Full Duplex. A full-duplex system allows communication between two parties to be
done in both directions simultaneously. See this Wikipedia article for more information.
HDX
Short for Half Duplex. In a half-duplex system simultaneous communication in both directions is
not possible, i.e. if one of the parties is sending, the other have to wait it to finish before replying.
See this Wikipedia article for more information.
56 Dictionary
IP
Short for Internet Protocol, the IP is an address of a computer or other network device on a
network using IP or TCP/IP. Every device on an IP-based network requires an IP address to
identify its location or address on the network. Example: 192.168.2.10
Ipzator
Barix IPzator™ technology is designed for the purpose that the Barix device can create its own
IP address according to the network structure in case it can’t receive one from your network. If
DHCP, AUTOIP or BOOTP fail, IPzator will create an IP address within the subnet and test it
(starting with x.x.x.168 and if occupied incrementing by one). If the address works and is not
being used by another device on the network, it will give the address to the Barix device.
IP Addressing
An IP address is a 32 bit value, divided into four octets of eight bits each. The standard
representation is four decimal numbers (in the range of 0..255), divided by dots.
• Example: 192.2.1.123
This is called decimal-dot notation. The IP address is divided in two parts: a network and a host
part. To support different needs, five ”network classes” have been defined. Depending on the
network class, the last one, two or last three bytes define the host, while the remaining part
defines the network. In the following text, ‘x’ stands for the host part of the IP address.
• Example: 192.168.0.x
IP Netmask
The Netmask is used to divide the IP address differently from the standard defined by the
classes A,B and C.
Entering a Netmask, it is possible to define how many bits from the IP address are to be taken
as the network part and how many bits are to be taken as the host part.
Netmask examples:
57 Dictionary
255.255.255.192 6
255.255.255.128 7
255.255.255.0 8
255.255.254.0 9
255.255.252.0 10
255.255.248.0 11
. .
. .
255.128.0.0 23
255.0.0.0 24
MAC address
Abbreviation for Medium Access Control, a MAC is a unique address number formatted in
hexadecimal format and given to each computer and/or network device on a computer network.
Because a MAC address is a unique address a computer network will not have the same MAC
address assigned to more than one computer or network device. Example:A1:B2:C3:D4:E5:F6
Netmask
A number used to identify a sub network so that an IP address can be shared on a LAN (Local
Area Network).
A mask is used to determine what subnet an IP address belongs to. An IP address has two
components, the network address and the host address. For example, consider the IP address
150.215.017.009. Assuming this is part of a Class B network, the first two numbers (150.2.)
represent the Class B network address, and the second two numbers (.017.009) identify a
particular host on this network.
The Netmask would then be 255.255.0.0 .
Network Address
The host address with all host bits set to "0" is used to address the network as a whole (for
example in routing entries).
• Example: 192.168.0.0
Network addresses can not be used as a host address!
If your network is not connected to the Internet and there are no plans to make such a
connection you may use any IP address you wish.
However if you are not connected to the Internet and have plans to connect to the Internet or you
are connected to the Internet and want to operate your Barix device on an intranet you should
use one of the sub-networks below for your network. These network numbers have been
reserved for such networks. If you have any questions about IP assignment ask your Network
Administrator.
58 Dictionary
Private IP networks by class:
Class Network
A 10.x.x.x
B 172.16.x.x
C 192.168.0.x
Network RFC’s
For more information regarding IP addressing see the following documents. They can be found
on the Internet:
RFC Description
950 Internet Standard Subnetting Procedure
1700 Assigned Numbers
1117 Internet Numbers
1597 Address Allocation for Private Internets
SIP
The Session Initiation Protocol (SIP) is a signalling protocol, widely used for controlling
multimedia communication sessions such as voice and video calls over Internet Protocol (IP).
The protocol can be used for creating, modifying and terminating two-party (unicast) or
multiparty (multicast) sessions consisting of one or several media streams. The modification can
involve changing addresses or ports, inviting more participants, adding or deleting media
streams, etc. Other feasible application examples include video conferencing, streaming
multimedia distribution, instant messaging, presence information and online games.
SIP Dialog
A dialog is a peer-to-peer SIP relationship between two user agents that persists for some time.
SIP Message
SIP Registrar
A registrar is a server that accepts REGISTER requests and places the information it receives in
those requests into the location service for the domain it handles.
Static IP
UAC
SIP terminology, means “user agent client”, to indicate generally the device that start a
transaction, sending a request to a server (UAS).
59 Dictionary
UAS
SIP terminology, means “user agent server”, to indicate generally the device that start a
transaction, receiving a request from a client (UAC).
Illustration Index
Illustration 1: SIP Client use cases.................................................................................................................... 9
Illustration 2: Connecting Annuncicom 100..................................................................................................... 12
Illustration 3: Home page of unconfigured SIP client.......................................................................................13
Illustration 4: SIP client Basic Settings menu page......................................................................................... 14
Illustration 5: Home page of a configured and registered SIP client................................................................15
Illustration 6: SIP Client Profiles page............................................................................................................. 19
Illustration 7: SIP Client Configuration page.................................................................................................... 21
Illustration 8: Device status page.................................................................................................................... 31
Illustration 9: SIP application status page........................................................................................................ 32
Illustration 10: SIP Client EEPROM settings status page................................................................................32
Illustration 11: Factory Defaults page.............................................................................................................. 33
Illustration 12: Serial Port Settings page......................................................................................................... 42
Illustration 13: Serial Terminal CoolTerm settings............................................................................................ 44
Illustration 14: Device upload web page.......................................................................................................... 51
60 Dictionary
10 Legal Information
Barix AG
Ringstraße 15a
8600 Dübendorf
SWITZERLAND
T +41 43 433 22 11
F +41 44 274 28 49
www.barix.com
[email protected]
[email protected]
61 Legal Information