Project

General

Profile

Help » History » Version 15

Tijmen de Mes, 12/24/2012 09:55 AM

1 1 Tijmen de Mes
h1. Help
2
3
Blink allows you to communicate in real time over the Internet. To use Blink you need a SIP account from a SIP service provider. Same like using an email program, you must configure Blink with the account you have obtained from your service provider. If things do not work they way you expect, the reasons can be caused mainly by two things, one is Blink software itself and the another one is the communication with the SIP Service Provider. While Blink may not be bug free, most of the problems you encounter when using Blink are related to the network communication with the SIP Service Provider. It is not the end-user who should understand the mechanics about how things work, so the main responsibility of making sure that things work correct falls into the hands of the SIP service provider who must properly setup its SIP infrastructure and support its user base.
4
5
h2. Service Provider Problems
6
7
If you encounter connectivity problems like inability to receive incoming calls or failure to make outbound calls, you should obtain the SIP trace logs and contact your SIP Service Provider and ask for the reason.
8
9
h3. SIP Trace Logs
10
11 2 Tijmen de Mes
SIP Protocol trace can be enabled in menu _Blink -> Preferences -> Logging -> SIP trace_. The location of the trace file is:
12 1 Tijmen de Mes
13
* Linux: ~/.blink/logs/sip_trace.txt
14
* Windows XP: C:\Documents and Settings\Username\Application Data\Blink\logs\sip_trace.txt
15
* Windows Vista and 7: C:\Users\Username\AppData\Roaming\Blink\logs\sip_trace.txt
16
17
h2. Software Problems
18
19
To report a problem, send an email to support@ag-projects.com. Please paste the relevant logs as explained below.
20
21 2 Tijmen de Mes
Please report your OS name and version and Blink version. You can find Blink version in menu _Blink -> About_.
22 1 Tijmen de Mes
23
h3. Program Exceptions
24
25
On Linux, Blink program exceptions are logged to _/var/log/syslog_.
26
27
On Windows, Blink exceptions are logged to _C:\Program Files\Blink\blink.exe-stderr_ and _C:\Program Files\Blink\blink.exe-stdout_
28
29
h3. Crash Reports
30
31
On Linux, in case of a crash, a core file is generated in the user home directory. If no dump is generated, add to the user profile _ulimit -c unlimited_
32
33 2 Tijmen de Mes
On Windows XP, crash dump files can be found in the folowing folder: _C:\Documents and Settings\All Users\Application Data\Microsoft\Dr Watson,_ the filenames are called _drwtsn32.log_ and _user.dmp_. The dump file _user.dmp_ can be analyzed with the Windows Debugger. Load the file _user.dmp_ in "Windows Debugger":http://www.microsoft.com/whdc/devtools/debugging/default.mspx and type _!analyze -v_ to obtain a backtrace. Click "here":http://support.microsoft.com/kb/315263 for instructions on how to use the debugger.
34 1 Tijmen de Mes
35
h3. Configuration File
36
37
Blink accounts and settings are stored in a flat-text configuration file.
38
39
It is critical that you do not edit this file manually. If you did and Blink does not start you must delete the file and start all over again. The location of the configuration file is:
40
41 4 Tijmen de Mes
* Linux: _~/.blink/logs/config_
42
* Windows XP: _C:\Documents and Settings\Username\Application Data\Blink\config_
43
* Windows Vista and 7: _C:\Users\Username\AppData\Roaming\Blink\config_
44 5 Tijmen de Mes
45 1 Tijmen de Mes
If you send the configuration file to us for debugging, use a text editor to strip the passwords and Google token.
46
47
h2. SIP Accounts
48
49
!>BlinkQTScreenshot-Enrollment.jpg!
50 14 Tijmen de Mes
51 9 Tijmen de Mes
To use Blink you need a SIP Account. At first start, Blink shows the _Add Account_ wizard that helps you configure the initial SIP Account. 
52 7 Tijmen de Mes
53 1 Tijmen de Mes
If you do not have a SIP Account, Blink can create one for you using the free service provided by SIP2SIP. For more information about this service visit http://sip2sip.info
54
55 6 Tijmen de Mes
If you already have a SIP Account, select this option then enter the SIP address in the form of _user@domain_ and _password_. The SIP registrar of the domain is then automatically located in the DNS.
56 1 Tijmen de Mes
57 6 Tijmen de Mes
You may configure Blink to use multiple SIP Accounts. To configure a new SIP Account, go to menu _Blink->Accounts->Add Account_.... The Add Account window shows up and you can repeat the steps described above.
58 1 Tijmen de Mes
59
After you have configured an account, you can see the status of the registration in the account list of Main Window window. Solid color means that the account has successfully registered, gray color means that the registration has failed or is in progress.
60
61 6 Tijmen de Mes
To edit the properties of existing accounts go to menu _Blink -> Accounts -> Manage accounts_.
62 1 Tijmen de Mes
63
h2. Main Interface
64
65
 
66 15 Tijmen de Mes
Blink presents a _Contacts driven_ interface as the main window. The design allows to locate a Contact then to start an action for it, for example to start an audio call.
67 1 Tijmen de Mes
68
Hover the mouse over the GUI elements to see a short description of their function.
69
70
h3. SIP Account
71
72
You can select the SIP Account used as identity for outbound sessions in the Accounts drop down box presented on the top of the main interface.
73
74
h4. Bonjour Account
75
76
Bonjour Account is a special type of account that is designed to announce itself and discover other neighbours on the local area network. This account does not require a server or SIP service in order to operate.
77
78
Bounjour account can be enabled or disabled in menu Blink -> Accounts
79
80
h3. Search Bar
81
82
The Search bar is used for finding an existing contact or for entering a SIP address or telephone number.
83
84
To search for a local contact in Blink's Contacts List or the syncronized Google Contacts, type text in the Search Bar. You may select a Contact that matched the typed text or use the typed text as the Contact for the next action.
85
86
Use the buttons presented at the bottom of the main window to start a session to the current selected Contact or press on Add Contact to add the typed address to the Contacts List.
87
88
Pressing enter after antering text in the search bar will start an audio call to that address.
89
90
If you have registered a SIP Account with Blink, you can search for SIP addresses of other Blink users in menu Tools -> Search for people....
91
92
h3. Presence Bar
93
94
You can use the elements in this section of the interface to change your presence state.
95
96
h3. Panel Switcher
97
98
This button can be used to switch between the Contacts and Calls panel.
99
100
h3. Contacts List
101
102
Contacts are organized into Groups. Groups can be collapsed or expanded by clicking on their left-side triangle.
103
104
Right click on a Group or Contact to see all possible actions for each of them.
105
106
Clicking on Return key or double-clicking a Contact will start the default session type depending on the preferred media configured for each Contact. The default action is to start an audio call.
107
108
h4. Google Contacts
109
110
The group named Google Contacts displays addresses synced with the Google gmail service. To enable Google Contacts syncronization, go to menu Tools->Enable Google Contacts. When prompted type in your Google account credentials. You can disable the Google Contacts from the same menu.
111
112
h4. Bonjour Neighbours
113
114
Bonjour Neighbours appear in the Contacts List as a separate Group. When selecting Bonjour as the default account, Bonjour Neighbours group is expanded and moved on top of the Contacts list. When changing back to a regular SIP Account, the groups in the Contacts list reshuffle to their previous positions.
115
116
h3. Action Buttons
117
118
Use the buttons presented at the bottom of the main window to start a session to the current selected Contact.
119
120
h4. Add Contact
121
122
123
You can add a Contact to the Contacts List by clicking on the + button presented on the bottom left of the main interface. Add Contact window appears. The contacts can be stored either locally on the computer that runs Blink or the storage server for the SIP accounts that have XCAP storage feature enabled.
124
125
h4. Edit Contact
126
127
You can edit a Contact by right clicking on it and select Edit menu option. Edit Contact window appears. To set the Icon for the Contact, click on the Icon area, a file selection dialog appears. If Subscribe to Presence is enabled and the contact publishes its own icon, the icon is automatically retrieved from the network. If a local icon is selected, it will overwrite the network provided icon.
128
129
h4. Silent Button
130
131
Use this button to disable the audible ringtones caused by incoming session request.
132
133
h2. Alert Panel
134
135
 
136
Incoming session requests bring up the Alert Panel. Click on the Accept Button to accept a session request. There are two options for rejecting an incoming session request:
137
138
Click on the Reject button. The session is rejected with SIP response code 603 and all other SIP devices registered for the same account stop ringing. Forwarding to voicemail or other destinations, when available in the SIP server is also cancelled. You must use this option to terminate all call processing associated with the request.
139
Click on the Busy button. Blink sends a 486 code back to the caller and stops ringing, other SIP devices keep ringing and forwarding to other destinations remains active as set in the SIP server. You must use this option when you want to pick up the call at a different location or allow the Server to perform other pre-configured routing decisions.
140
Click on the Escape key. Blink stops ringing and does nothing else with regards to SIP signaling. Use this option when you do not want to take any decission about the call but you do not want to be disturbed by the ring tone either.
141
The currently selected input and output audio devices are showed for incoming audio session requests.
142
143
h2. Audio Calls
144
145
146
Blink has no traditional telephone dialpad, nor you will need one to interact with it. As computers have physical keyboards displaying a classic 12 key dial-pad is a poor design choice for a modern graphical user interface of a rich communications SIP client.
147
148
To start an Audio Call, select an existing contact or enter a SIP address or telephone number in the search bar.
149
150
Once text is entered in the search bar just press enter to start and audio call to that address.
151
152
Once a Contact is selected, click on the Green Handset located at the bottom of the main interface or right click and select Start Audio call from the contextual menu. For each new call an entry is added to the Calls panel.
153
154
When starting and audio call, the main interface switches from the Contacts list to the Calls panel. You can toggle between the two panels by using the button presented on the top of the main interface. The number of active calls sessions is presented at the bottom of the Contacts list.
155
156
To switch between multiple calls just click on another call in the Calls panel. When switching to a particular call, the audio stream is connected to the input and output device and all other audio calls are put on hold.
157
158
To mute your microphone click on the bottom right microphone icon. To un-mute click it again.
159
160
The shortcut key for hold is Control+Space.
161
162
The shortcut key for hangup is Control+ESC (Linux only).
163
164
The shortcut key for redial is Control+R.
165
166
h3. DTMF
167
168
Dial tones are used to interact with PBX and IVR systems or legacy PSTN gateways. To send DTMF tones, focus the Audio Call by clicking on it. The current call is already focused if you just started it. What you then type on the keyboard is automatically translated into DTMF tones. Alpha-numeric keys are translated into numeric DTMF keys as they are on a numeric telephone keypad.
169
170
h3. Hangup
171
172
To hangup, click on the Red handset displayed for each audio call in the right hand side of the Calls panel.
173
174
h3. Call Recording
175
176
To record an audio call click on the Black circle. While recording, the circle will toggle between red and black. Recordings are stored as .wav files in the following locations:
177
178
Linux: ~/.blink/recordings/
179
Windows XP: C:\Documents and Settings\Username\Application Data\Blink\recordings\
180
Windows Vista and 7: C:\Users\Username\AppData\Roaming\Blink\recordings\
181
182
h3. Calling to PSTN
183
184
To dial a telephone number, just enter a number in the Search Bar followed by Return key.
185
186
When dialing numbers by selecting entries from the Google Contacts it is recommended that you store your numbers in international E.164 format (that is + followed by the number).
187
188
If you have created a SIP Account with Blink, you can call to PSTN numbers if you have a positive credit. You can use a Credit Card to add Credit to your account in menu Tools -> Buy prepaid credit.... You may request the assignment of a PSTN Caller Id by sending an request to the support email address. Recognized number formats are + or 00 followed by the Country Code and then Subscriber Number.
189
190
If you use another SIP Account than the one provided by Blink, access to the PSTN is subject to the support provided by your SIP service provider. The number format depends as well on the conventions imposed by the SIP service provider in question.
191
192
When dialing telephone numbers, you can replace the + prefix or add an optional prefix with your own values by editing the section Blink -> Accounts -> Manage accounts -> Advanced.
193
194
h3. Audio Conference
195
196
Drag and drop audio calls on top of each other to create a Conference or use the button presented at the botton at the Calls panel to start a Conference with all active audio calls.
197
198
Add new participants to a Conference by dragging Contacts from the Contacts list onto add the green area highlighed on top of the Contacts list.
199
200
Each participant can be muted individually by pressing on the microphone symbol that appears on each conferenced session.
201
202
To end an Audio Conference drag the calls out of the conference area or press the Conference button again.
203
204
There can be multiple active Audio Conferences at any given time, you can use drag and drop to group calls together in different conferences.
205
206
h2. Preferences
207
208
209
To edit Blink general preferences and manage the SIP accounts, open menu Blink -> Preferences.
210
211
The Preferences are split in Accounts, Audio, Chat, File Transfer, Alerts, Logging and Advanced. Each SIP account has its own set of properties.