Cisco Touch-10 Macro for Kaptivo

It has long been requested by Cisco collaboration endpoint users to have a button on the Touch-10 that will activate a Kaptivo sharing session.

For this, we have built the attached Cisco macro for Touch-10.
Once installed you will see a new button on the Touch10 home screen labeled Share Whiteboard.

When first clicked you will need to pair with the Kaptivo in the room via IP address (not kaptivo-id).
This step requires that you are physically present at pairing time to press the Kaptivo control pad button for authentication.

Remember, this API is *only* replacing the physical button press, it doesn’t provide any more interaction or information other than “is blue button flashing”, and “press button”.

With the script installed and active, you can press the Touch-10 button, or press the Kaptvo Control Pad button to start a session.
The button's state will stay synchronized. You can also end the session by pressing either.

Also, while sharing, if someone tries to connect to the Kaptivo’s web-app, it will pop-up an approval request on the Touch-10. This is because users tend to overlook the flashing CP button when Kaptivo is already sharing via Kaptivocast.

Be aware that the macro uses Cisco FacilityService #5 to store kaptivo pairing info.

          For each FacilityService you can associate a phone number or a URL.
          So we add a URL which looks like kaptivo:ip-addr:access_token:friendly_name 
          stored it in the URL field of the facility with no name to keep it from appearing in a call menu.

Requirements

1. Cisco video room device with xAPI macro engine (SX20, DX, MX or Room series)
2. Kaptivocast connected to one of the HDMI inputs
3. Firmware CE9.8 or newer
4. Admin/Integrator user access to endpoint

Background Documentation

1. Read the document Working with Macros and In-room Controls for a comprehensive introduction of In-Room Controls, Macros as well as step-by-step instructions on how to build and upload your code.
2. Watch this video for a quick introduction of what In-Room Controls are: https://www.youtube.com/watch?v=7dw9zvvitp8
3. Documentation for the xAPI can be found in the Command References overview.
4. A list of resources including Tutorials for learning to write xAPI macros is here

Setup

1. Connect to the Web interface of your Cisco Endpoint as administrator or integrator.
   
   
2. In the Integration Menu, choose In-Room Control, and Select Launch Editor. 
   Then add a new panel and Import/merge from file - found under the menu on the top-right - (use 'merge' if you have existing room control panels).
   Upload the kaptivo_roomcontrolconfig.xml layout attached to this article
   
   
3. Select "Export to Video System" from the menu at the top-right. (if you experience an error here, check your user permissions have 'integrator' access)
   
   
4. In the Integration Menu, Select Macro Editor, and Import from File the Kaptivo Room Controller.js javascript file attached to this article. 
   Note, simply copy/pasting the macro-text has caused problems in some cases.
   
   
5. In the Macros editor, update script around line 8 changing adding the IP address of the Camera and changing the codec's Connector ID (where you've plugged the Kaptivocast).
   If you do not know the Connector ID, you can look at the codecs web interface, Setup menu > Configuration option > Video tab.
   
   
6. Finally, you may need to turn on the HttpClient in the codec's web interface. Look at the Setup menu, Configuration option, HttpClient tab, and set "Mode On"

Macro Usage

Once loaded you will notice a new button on the Touch-10 Home screen.

When you first click the Share Whiteboard button you will need to pair a Kaptivo.

Click the Configuration tab, click "Pair/Unpair" and add your Kaptivo by its IP Address

You'll be asked to press the Kaptivo Control Pad button to complete the pairing process.
You have 30 seconds to press the button.

Now that you've completed the Pairing process you can use the slider to start or stop sharing your whiteboard.  You can still use the Kaptivo control pad button, the two devices will stay in sync.

While sharing is in progress, when someone tries to connect to your Kaptivo, either by going to https://kaptivo.live - if cloud connected - or going to the IP Address of a self-hosted unit, the macro will pop-up an approval request on the touch-10.