Commit f1b8be50 authored by Jean-Yves LEBLEU's avatar Jean-Yves LEBLEU

Update link for devices to device documenation

Small fix on release notes index
parent 666870e1
......@@ -171,8 +171,7 @@ In section **pool**, modify the options::
range 172.30.8.10 172.30.8.200;
.. warning:: XiVO only answers to DHCP requests from :ref:`supported devices <devices>`. In case of
.. warning:: XiVO only answers to DHCP requests from `supported devices <https://documentation.xivo.solutions/projects/devices/en/latest/>`_. In case of
you need to address other equipment, use the option *allow unknown-clients;* in the
:file:`/etc/dhcp/dhcpd_sites/` files
......
......@@ -32,8 +32,7 @@ the notion of a primary and backup telephony server.
* Trunk registration timeout (``expiry``) should be less than 300 seconds (5 minutes)
* The slave must have **no** provisioning plugins installed.
The HA solution is guaranteed to work correctly with :ref:`the following devices <devices>`.
The HA solution is guaranteed to work correctly with `the following devices <https://documentation.xivo.solutions/projects/devices/en/latest/>`_.
Quick Summary
=============
......
......@@ -148,7 +148,7 @@ Behavior
* The key blinks on Snom and Yealink phone sets. It doesn't blink on Polycom phone sets.
* To be able to terminate Wrapup via the key on Snom phones you must use correct version of plugin (see
:ref:`devices_releasenotes`).
`devices releasenotes <https://documentation.xivo.solutions/projects/devices/en/latest/devices/devices.html#plugins-release-notes>`_).
Configuration
......
.. _compatible-devices:
Community Supported Devices
===========================
The community supported devices are only supported by the community. In other words, maintenance,
bug, corrections and features are developed by members of the XiVO community. XiVO does not
officially endorse support for these devices.
``xivo-provd`` plugins for these devices can be installed from the
:ref:`"community supported devices" repository <alternative-plugins-repo>`.
Aastra
------
6700i and 9000i series:
======== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
======== =========== ========== ============
6730i |n| 8 |y|
6753i |y| 6 |y|
6757i |y| 30 |y|
9143i |y| 7 |y|
9480i |n| 6 |y|
9480CT |n| 6 |y|
======== =========== ========== ============
Alcatel-Lucent
--------------
IP Touch series:
====================== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
====================== =========== ========== ============
4008 Extended Edition |y| 4 |n|
4018 Extended Edition |y| 4 |n|
====================== =========== ========== ============
Note that you *must not* download the firmware for these phones unless you
agree to the fact it comes from a non-official source.
For the plugin to work fully, you need these additional packages::
apt-get install p7zip python-pexpect telnet
Avaya
-----
1200 series IP Deskphones (previously known as Nortel IP Phones):
======== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
======== =========== ========== ============
1220 IP |y| 0 |n|
1230 IP |n| 0 |n|
======== =========== ========== ============
Cisco
-----
Cisco Small Business SPA300 series:
=========== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
=========== =========== ========== ============
SPA301 |n| 1 |n|
SPA303 |n| 3 |n|
=========== =========== ========== ============
.. note:: Function keys are shared with line keys for all SPA phones
Cisco Small Business SPA500 series:
=========== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
=========== =========== ========== ============
SPA501G |y| 8 |n|
SPA502G |n| 1 |n|
SPA504G |y| 4 |n|
SPA508G |y| 8 |n|
SPA509G |n| 12 |n|
SPA512G |n| 1 |n|
SPA514G |n| 4 |n|
SPA525G |y| 5 |n|
SPA525G2 |n| 5 |n|
=========== =========== ========== ============
The SPA500 expansion module is supported.
Cisco Small Business IP Phones (previously known as Linksys IP Phones)
=========== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
=========== =========== ========== ============
SPA901 |n| 1 |n|
SPA921 |n| 1 |n|
SPA922 |n| 1 |n|
SPA941 |n| 4 |n|
SPA942 |y| 4 |n|
SPA962 |y| 6 |n|
=========== =========== ========== ============
.. note:: You must install the firmware of each SPA9xx phones you are using since they reboot in
loop when they can’t find their firmware.
The SPA932 expansion module is supported.
ATAs:
=========== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
=========== =========== ========== ============
PAP2 |n| 0 |n|
SPA2102 |n| 0 |n|
SPA8800 |n| 0 |n|
SPA112 |n| 0 |n|
=========== =========== ========== ============
For best results, activate :ref:`dhcp-integration` on your XiVO.
.. note::
These devices can be used to connect Faxes. For better success with faxes some parameters
must be changed. You can read the :ref:`fax-analog-gateway` section.
.. note::
If you want to manually resynchronize the configuration from the ATA device
you should use the following url::
http://ATA_IP/admin/resync?http://XIVO_IP:8667/CONF_FILE
where :
* *ATA_IP* is the IP address of the ATA,
* *XIVO_IP* is the IP address of your XiVO,
* *CONF_FILE* is one of ``spa2102.cfg``, ``spa8000.cfg``
Digium
------
+--------------------------------------------+-------+-------+-------+
| | D40 | D50 | D70 |
+============================================+=======+=======+=======+
| Provisioning | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| H-A | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Directory XIVO | N | NYT | N |
+--------------------------------------------+-------+-------+-------+
| Funckeys | 2 | 14 | 106 |
+--------------------------------------------+-------+-------+-------+
| **Supported programmable keys** |
+--------------------------------------------+-------+-------+-------+
| User with supervision function | N | NYT | N |
+--------------------------------------------+-------+-------+-------+
| Group | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Queue | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Conference Room with supervision function | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| **General Functions** |
+--------------------------------------------+-------+-------+-------+
| Online call recording | N | NYT | N |
+--------------------------------------------+-------+-------+-------+
| Phone status | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Sound recording | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Call recording | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Incoming call filtering | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Do not disturb | HK | NYT | HK |
+--------------------------------------------+-------+-------+-------+
| Group interception | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Listen to online calls | N | NYT | N |
+--------------------------------------------+-------+-------+-------+
| Directory access | N | NYT | N |
+--------------------------------------------+-------+-------+-------+
| Filtering Boss - Secretary | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| **Transfers Functions** |
+--------------------------------------------+-------+-------+-------+
| Blind transfer | HK | NYT | HK |
+--------------------------------------------+-------+-------+-------+
| Indirect transfer | HK | NYT | HK |
+--------------------------------------------+-------+-------+-------+
| **Forwards Functions** |
+--------------------------------------------+-------+-------+-------+
| Disable all forwarding | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Enable/Disable forwarding on no answer | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Enable/Disable forwarding on busy | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Enable/Disable forwarding unconditional | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| **Voicemail Functions** |
+--------------------------------------------+-------+-------+-------+
| Enable voicemail with supervision function | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Reach the voicemail | HK | NYT | HK |
+--------------------------------------------+-------+-------+-------+
| Delete messages from voicemail | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| **Agent Functions** |
+--------------------------------------------+-------+-------+-------+
| Connect/Disconnect a static agent | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Connect a static agent | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| Disconnect a static agent | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
| **Parking Functions** |
+--------------------------------------------+-------+-------+-------+
| Parking | N | NYT | N |
+--------------------------------------------+-------+-------+-------+
| Parking position | N | NYT | N |
+--------------------------------------------+-------+-------+-------+
| **Paging Functions** |
+--------------------------------------------+-------+-------+-------+
| Paging | Y | NYT | Y |
+--------------------------------------------+-------+-------+-------+
.. note:: Some function keys are shared with line keys
Particularities:
* For best results, activate :ref:`dhcp-integration` on your XiVO.
* Impossible to do directed pickup using a BLF function key.
* Only supports DTMF in RFC2833 mode.
* Does not work reliably with Cisco ESW520 PoE switch. When connected to such a switch, the D40 tends to reboot randomly, and the D70 does not boot at all.
* It's important to not edit the phone configuration via the phones' web interface when using these phones with XiVO.
* Paging doesn't work.
Fanvil
------
=========== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
=========== =========== ========== ============
C62P |y| 5 |y|
=========== =========== ========== ============
Gigaset
-------
Also known as Siemens.
=========== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
=========== =========== ========== ============
C470 IP |n| 0 |n|
C475 IP |n| 0 |n|
C590 IP |n| 0 |n|
C595 IP |n| 0 |n|
C610 IP |n| 0 |n|
C610A IP |n| 0 |n|
S675 IP |n| 0 |n|
S685 IP |n| 0 |n|
N300 IP |n| 0 |n|
N300A IP |n| 0 |n|
N510 IP PRO |n| 0 |n|
=========== =========== ========== ============
Jitsi
-----
======== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
======== =========== ========== ============
Jitsi |y| |u| |n|
======== =========== ========== ============
Panasonic
---------
Panasonic KX-HTXXX series:
======== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
======== =========== ========== ============
KX-HT113 |n| |u| |n|
KX-HT123 |n| |u| |n|
KX-HT133 |n| |u| |n|
KX-HT136 |n| |u| |n|
======== =========== ========== ============
.. note:: This phone is for testing for the moment
Polycom
-------
======== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
======== =========== ========== ============
SPIP320 |n| 0 |n|
SPIP321 |n| 0 |n|
SPIP330 |n| 0 |n|
SPIP430 |n| 0 |n|
SPIP501 |y| 0 |n|
SPIP600 |n| 0 |n|
SPIP601 |n| 0 |n|
SPIP670 |n| 47 |n|
======== =========== ========== ============
SoundStation IP:
======== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
======== =========== ========== ============
SPIP4000 |n| 0 |n|
======== =========== ========== ============
Others:
======== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
======== =========== ========== ============
VVX1500 |n| 0 |n|
======== =========== ========== ============
Snom
----
======== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
======== =========== ========== ============
300 |n| 6 |y|
320 |y| 12 |y|
360 |n| |u| |y|
820 |y| 4 |y|
MP |n| |u| |y|
PA1 |n| 0 |y|
======== =========== ========== ============
.. note:: For some models, function keys are shared with line keys
.. warning:: If you are using Snom phones with HA, you should not assign multiple lines to the same device.
There's a known issue with the provisioning of Snom phones in XiVO:
* After a factory reset of a phone, if no language and timezone are set for the "default config device" in :menuselection:`XiVO --> Configuration --> Provisioning --> Template device`, you will be forced to select a default language and timezone on the phone UI.
Technicolor
-----------
Previously known as Thomson:
======== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
======== =========== ========== ============
ST2022 |n| |u| |u|
ST2030 |y| 10 |y|
======== =========== ========== ============
.. note:: Function keys are shared with line keys
.. _yealink-community-devices:
Yealink
-------
======== =========== ========== ============ ================
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_ Plugin
======== =========== ========== ============ ================
CP860 |n| 0 |u| xivo-yealink-v72
T23P |n| 3 |u| xivo-yealink-v80
T27P |y| 21 |y| xivo-yealink-v80
T29G |n| 27 |u| xivo-yealink-v80
T49G |y| 29 |y| xivo-yealink-v80
======== =========== ========== ============ ================
.. note:: Some function keys are shared with line keys
Zenitel
-------
========== =========== ========== ============
Model Tested [1]_ Fkeys [2]_ XiVO HA [3]_
========== =========== ========== ============
IP station |y| 1 |n|
========== =========== ========== ============
.. [1] ``Tested`` means the device has been tested by the XiVO development team and that
the developers have access to this device.
.. [2] ``Fkeys`` is the number of programmable function keys that you can configure from the
XiVO web interface. It is not necessarily the same as the number of physical function
keys the device has (for example, a 6757i has 12 physical keys but you can configure 30
function keys because of the page system).
.. [3] ``XiVO HA`` means the device is confirmed to work with :ref:`XiVO HA <high-availability>`.
.. |y| replace:: Yes
.. |n| replace:: No
.. |ny| replace:: Not Yet
.. |u| replace:: ---
.. _devices:
*******
Devices
*******
In XiVO, there are two kind of devices:
.. toctree::
:maxdepth: 1
official_devices
community_devices
The officially supported devices will be supported across upgrades and phone features are guaranteed
to be supported on the latest version.
The community supported devices are only supported by the community. In other words, maintenance,
bug, corrections and features are developed by members of the XiVO community. XiVO does not
officially endorse support for these devices.
The next topics lists the officially and community supported devices. For each vendor, a table shows
the various features supported by XiVO. Here's an example:
+--------------------------------------------+---------+---------+--------------+
| | Model X | Model Y | Model Z |
+============================================+=========+=========+==============+
| Provisioning | Y | Y | Y |
+--------------------------------------------+---------+---------+--------------+
| H-A | Y | Y | Y |
+--------------------------------------------+---------+---------+--------------+
| Directory XIVO | N | Y | Y |
+--------------------------------------------+---------+---------+--------------+
| Funckeys | 0 | 2 | 8 |
+--------------------------------------------+---------+---------+--------------+
| | **Supported programmable keys** |
+--------------------------------------------+---------+---------+--------------+
| User with supervision function | Y | Y | Y |
+--------------------------------------------+---------+---------+--------------+
The rows have the following meaning:
Provisioning
Is the device supported by the :ref:`auto-provisioning <provisioning>` system ?
H-A
Is the device supported by the :ref:`high availability <high-availability>` system ?
Directory XiVO
Is the device supported by the :ref:`remote directory <remote-directory>` ? In other word, is it
possible to consult the XiVO's remote directory from the device ?
Funckeys
How many function keys can be configured on the device from the XiVO web interface ?
The number of function keys that can be configured on a device is not necessarily the same as
the number of physical function keys the device has. For example, an Aastra 6757i has 12 physical
keys but you can configure 30 function keys because of the page system.
Inside a table, the following legend is used:
* Y = Yes / Supported
* N = No / Not supported
* NT = Not tested
* NYT = Not yet tested
Each table also contains a section about the supported function keys. In that section, the following
legend can also be used:
* FK = Funckey
* SK = SoftKey
* HK = HardKey
* MN = Menu
Function keys work using the extensions in :menuselection:`Services --> Extensions`. It is important
to enable the function keys you want to use. Also, the enable transfer option in the user
configuration services tab must be enabled to use transfer function keys.
.. _devices_releasenotes:
Plugins release notes
=====================
xivo-aastra-3.3.1-SP4-HF9
-------------------------
.. note:: Replaces xivo-aastra-3.3.1-SP4 plugin
:v1.8: Download links for firmwares update for Aastra/Mitel phones.
:v1.7: Firmware update for Aastra/Mitel phones.
Particularly these new firmwares support forwarding of Multiple Spanning Tree Protocol (MSTP) messages from the LAN port to the PC port.
This ensures issues regarding network loops are not created.
xivo-aastra-4.3.0
-----------------
.. note:: Replaces xivo-aastra-4.1.0 plugin
:v1.8: Download links for firmwares update for Aastra/Mitel phones.
:v1.7: Firmware update for Aastra/Mitel phones.
Particularly these new firmwares support forwarding of Multiple Spanning Tree Protocol (MSTP) messages from the LAN port to the PC port.
This ensures issues regarding network loops are not created.
xivo-cisco-spa8000-6.1.11
-------------------------
:v1.1: Fix download of firmware with procedure :ref:`Cisco SPA8000 download firmware <cisco-spa8000-fw-download>`.
xivo-patton-6.10
----------------
:v1.1: Plugin added which provision FXS patton gateways (SN411X and SN43XX)
xivo-patton-SN4120-6.10
-----------------------
:v1.2: Fix plugin installation (install rule for SN4120 firmware was wrong)
:v1.1: Plugin added which provision BRI patton gateway (SN4120)
xivo-polycom-4.0.11
-------------------
.. note:: Replaces xivo-polycom-4.0.9 plugin: *this plugin is required* for Polycom devices with MAC address in the range 64167F (instead of 0004F2)
:v2.2: fix URL for Updater file download
:v2.1: DND feature disabled
:v1.9: integrate XiVOCC required template configuration
xivo-polycom-5.4.3
------------------
:v2.1: DND feature disabled
:v1.8: integrate XiVOCC required template configuration
xivo-snom-8.7.5.35
------------------
:v2.4: Internal changes.
:v2.3: Change provisioning of :ref:`login_pause_funckeys` keys to support Wrapup indication.
:v2.2: Add support to SIP Auto-Answer Header (needed for CTI Transfer in Polaris)
:v2.1: DND feature disabled
:v1.9: update to use the new language pack
:v1.8: correction for provisioning if there is no DST
xivo-snom-8.9.3.80
------------------
.. note:: Replaces xivo-snom-8.9.3.60 plugin
:v2.6: Support for fw 8.9.3.80 and use check-sync NOTIFY event with reboot=false.
:v2.5: Change parameter to fix Switchboard answer
:v2.4: Change provisioning of :ref:`login_pause_funckeys` keys to support Wrapup indication.
:v2.3: Add support for D712 and upgrade firmware for 7XX serie.
:v2.2: Add support to SIP Auto-Answer Header (needed for CTI Transfer in Polaris)
:v2.1: DND feature disabled
:v1.8: correction for provisioning if there is no DST
xivo-yealink-v70
----------------
:v2.1.2: Replace broken firmware link
:v2.1: DND feature disabled
xivo-yealink-v72
----------------
:v2.1: DND feature disabled
xivo-yealink-v73
----------------
:v2.1: DND feature disabled
xivo-yealink-v81
----------------
.. note:: Replaces xivo-yealink-v80 plugin