Cisco Phone Services Interface

(c) 2011 My Device.

www.mydevice.com.au

This driver provides a Cisco phone interface from your favourite XP processor. Use it to trigger events and provide simple feedback right on your phone!

It requires Cisco CallManager or CallManager Express and will be visible when the user hits the services button on a compatible Cisco IP phone.

This driver has been tested against CallManager Express and the 7940/7960 series of IP phones.

Note:

Please report any bugs found to bugs@mydevice.com.au. Include driver version number and steps to reproduce the issue where possible.

Driver Configuration Settings:

Service:

Filename - The name of the xml file the Cisco phone will look for. You can set this to anything you like, but I recommend leaving it as cisco.xml.

Port - The port the phone will connect on to get the menu information. You can change this if you wish to run multiple copies of the driver, otherwise leave it on it's default value of 8000.

Title - This string is displayed across the top of the menu on the phone.

Prompt - This string is displayed below the menu. Use it to describe to the user how they should interact with the system. Standard text is "Select using the keypad".

Password - Set a password. This stops the casual user from pointing a browser at the URL below and triggering events/macros in your RTI system. Please refrain from using anything other than alphanumeric chars and space.

The above settings determine the URL you should enter in CallManager/Express. The URL is determined as follows:

http://<xp.ip.address>:<Port>/<Filename>

Using the default values above, and assuming your XP has an IP of 192.168.0.200 would result in the following URL:

http://192.168.0.200:8000/cisco.xml

You should paste this into the 'Services URL' in Cisco CallManager Express. You find this by browsing to Configure -> System Parameters -> IP Phone URLs.

Next, we set the menu items to be displayed.

Menu Item [1-10]:

Type - The type of menu entry. Choose from the following: static/boolean (internal)/boolean (external) or Remote URL.

Static: The menu item is static text that does not change. The Alternate String field is ignored.

Boolean (internal): Each time this menu is selected an internal flag will toggle and track the state. If the flag is true, the Alternate String field is displayed.

Boolean (external): This indicates an external Boolean (flag or 3rd party driver) will determine if the String or Alternate String field is displayed. Requires that the Boolean (external) field be set.

Remote URL: Each time this menu is selected the phone will redirect the the URL provided in the URL field below. Please note that the rendering capabilities of the phone are rather restricted!

String - The default menu string to display.

Alternate string - Menu string to display as dictated by the Boolean (internal or external) menu type above.

Boolean (external) - Point this to the XP flag or 3rd party driver Boolean that you wish to monitor.

URL - URL you wish to browse to when the menu item is selected. Should be in the format http://www.website.com

Licensing:

Unlock Code - Once you have purchased a license for this driver, enter the unlock code here. Without an unlock code the driver will for for 60 minutes at a time. After 60 minutes the driver will cease to function until the XP is reset/power cycled.

Events:

There are 2 events available per menu item. One for when the standard item is selected, one for when the alternate menu item is selected.

Menu Item [1-10] Selected

This event triggers when the standard (ie. 'String' value) is selected from the phone.

Menu Item [1-10] Alternate Selected

This event triggers when the alternate (ie. 'Alternate string' value) is selected from the phone.

Examples:

Lets add a typical setup where the XP6 has a static IP address of 192.168.0.200 and we wish to add 3 menu items.

1) A static entry that says 'Welcome Home' and will trigger a welcome home macro.

2) A static entry that says 'Goodnight' and will trigger a goodnight macro.

3) A Boolean (internal) entry that alternates between 'Open Gate' and 'Close Gate' each time it is selected.

4) A Boolean (external) entry that alternates between 'Arm Alarm' and 'Panic!' based on the armed status of a 3rd party alarm driver.

5) An entry that will display "RSS Feed" and browse to a text based website when selected.

In the driver config we set the following:

Service

Filename: cisco.xml

Port: 8000

Title: My Device Services

Prompt: Select using the keypad

Password: passphrase

Menu Item 1

Type: Static

String: Welcome Home

Alternate String:

Boolean (external): Not Set

URL:

Menu Item 2

Type: Static

String: Goodnight

Alternate String:

Boolean (external): Not Set

URL:

Menu Item 3

Type: Boolean (internal)

String: Open Gate

Alternate String: Close Gate

Boolean (external): Not Set

URL:

Menu Item 4

Type: Boolean (external)

String: Arm Alarm

Alternate String: Panic!

Boolean (external): <browse to the 3rd party boolean from the alarm driver>

URL:

Menu Item 5

Type: Remote URL

String: RSS Feed

Alternate String:

Boolean (external): Not Set

URL: http://www.simplerssfeed.com/rss.html

Our menu is now configured, but we need to act upon the events when an item is selected. Go to the Events tab of your XP processor and add a driver event.

1) For the first static entry, select Cisco Phone Services Interface -> Menu Item 1 Selected.

Then set the macro that runs the Welcome home scene.

Note: we don't need to worry about the Menu Item 1 Alternate Selected event here as it is never displayed.

2) For the second static entry, select Cisco Phone Services Interface -> Menu Item 2 Selected.

Then set the macro that runs the Goodnight scene.

Note: we don't need to worry about the Menu Item 2 Alternate Selected event here as it is never displayed.

3) For the Boolean (internal) entry, select Cisco Phone Services Interface -> Menu Item 3 Selected.

Then set the macro that Opens the gate.

Now, select Cisco Phone Services Interface -> Menu Item 3 Alternate Selected and set the macro that closes the gate.

4) For the Boolean (external) entry, select Cisco Phone Services Interface -> Menu Item 4 Selected.

Then set the macro that arms the alarm.

Now, select Cisco Phone Services Interface -> Menu Item 4 Alternate Selected and set the macro that triggers a panic.

5) For the Remote URL entry, we don't need to do anything as the phone won't contact us. Rather it will browse to the website directly on the phone.