Snom Service Hub

Content

Page tree


Check your firmware version

This feature is available starting from firmware release 10.1.207.0

Introduction

This article describes a way to stream images coming from your intercom / webcam devices on a D86x or D89x desk phone.

In order to achieve this, please follow the following steps.

Step 1

Get the following information from your intercom / webcam:

Image URL: an URL from your intercom that shows a continuous stream of images (that is external to any Snom device, so please check the documentation for your intercom to understand if it's available, and how to enable and configure this feature)

Access credentials: if your device requires authentication to access that URL, please verify the correct username/password that allow you to access to the image URL from any external device (as the Snom phone will be)

Tip

Once you have the Image URL and the credentials, you can try the URL on an internet browser to make sure you can access the images stream on the intercom


Step 2

You need to create an URL that can be used on the Snom phone to access the stream of images correctly

To do this, you need to fill in some variables (as below) and put them all together in a single URL

VariablesDescriptionExample
intercom_titleUsed to show the device name in the image screenintercom_title=Front Door
refresh_delayThis tells the phone how fast the refresh of the image must be (in ms)refresh_delay=500
img_urlThe URL that points to intercom's image stream (as in Step 1)img_url=http://admin:password@Intercom_IP/bha-api/image.cgi
dtmf_key[index]

The number of the context key you want to configure as a DTMF key on the phone

Valid values: F1 F2 F3 F4

dtmf_key1=F1
dtmf_keys[index]The DTMF key tones needed to open the gate/door dtmf_keys1=21#
dtmf_label[index]The label you want to show on the DTMF context keydtmf_label1=Open Door
action_url_key[index]

The number of the context key you want to configure as the Action URL

Valid values: F1 F2 F3 F4

action_url_key1=F2
action_url[index]The Action URL that needs to be used to open a gateway or other IoT devicesaction_url1=http://admin:password@Intercom_IP/bha-api/open-door.cgi
action_url_label[index]The label you want to show on the Action URL context keyaction_url_label1=Open Gate

more buttons

If you want to configure more then one button (as DTMF and ActionURL) you need to increase the index at the end of the variable. Eg dtmf_key2,dtmf_keys2,dtmf_label2


Use refresh_delay with caution
If the delay is too small, that can overload intercom's web server and slow down the phone
Please check the intercom manual to see if there are accepted or suggested values


DTMF Tones

DTMF tones are only sent if there is an active call between the telephone and the intercom device.
If you wish to open the door without answering, use Action_URL instead



In order to geneate the URL you need to use the following syntax

Syntax
file://xml/gui/intercom.xml#  followed by the above variables using
var: for declaration
& to concatenate all of them
Generated URL to be used
file://xml/gui/intercom.xml#var:intercom_title=Front Door&var:refresh_delay=500&var:img_url=http://admin:password@Intercom_IP/bha-api/image.cgi&var:dtmf_key1=F1&var:dtmf_keys1=21#&var:dtmf_label1=Open Door&var:action_url_key1=F2&var:http://admin:password@Intercom_IP/bha-api/open-door.cgi&var:action_url_label1=Open Gate


special chars - 2N

In case your img_url contains the special char &, you need to encode it.
For example, with 2N  that uses & inside the url to get the correct image's size, (e.g. http://IP_Camera/api/camera/snapshot?width=640&height=480&tok=) it must be changed in http://IP_Camera/api/camera/snapshot?width=640%25252526height=480%25252526tok= 


Step 3

  1. Connect to the phone web user interface (WUI), and go to Directory → Local Directory


  2.  Click on ADD, and fill the Name and Phone number of your intercom device


  3. Fill the Action URL field with the Generated URL and create the contact


  4. Check that the contact is now present in the Local Directory page


Step 4

Push the intercom call button

The phone will start ringing and it will show the intercom's camera image stream

Now you can answer, open gate with DTMF code or Action URL


Tip

If you just want to see the image stream (e.g. from a web camera), you can simply configure a function key on the phone (as Action URL) that recall the Generated URL link once pressed


Image resolution

Please verify that the image resolution generated by your intercom device/camera, doesn't exceed phone's display capabilities

If that happens, phone cannot show the image correctly or at all

If that is the case, please check with your intercom manufacturer how to change the image resolution


Further Information


Related articles