Skip to content

Latest commit

 

History

History
105 lines (59 loc) · 4.12 KB

README.md

File metadata and controls

105 lines (59 loc) · 4.12 KB
Raw

Webex xAPI POST example

Example of a Macro running on a Cisco video endpoint that performs a POST action. In this case the macro calls my home automation system to switch ON/OFF/DIMM/COLOR a lamp.

Equipment: Cisco Webex DX80

Firmware: RoomOS 2019-02-22. The minimum CE firmware version is 9.6.1 (when HTTP POSTs were introduced).

Connected: The Cisco Webex video unit is registered to the Cisco Webex Teams cloud, but this should also work if it's registered on-premise.

Setup: This DX80 is connected to my home network. Firewall rules give it just enough access to make lamp on/off/dim/color API calls. Check out how the software was setup in the feature introduction.

NOTE: you can do the same on other Cisco video units with Touch 10 panels.



Flow

  1. Press button on DX80 (to switch on a lamp)
  2. Macro code (JS) detects button press and executes related code
  3. This code does an API call (HTTP POST) to my home automation system
  4. Home automation system executes requested action: lamp is ON!


Steps

  1. Browse to DX80 admin interface

  2. Login with admin rights. This is needed for access to Macros the integrator role gives you access to the in-room control panel editor

  3. Launch the “In-Room Control” editor (Integration menu) save-layout

  4. Click “Launch Editor” and build your screen(s)

  5. Save your screen and see them in real live: press the save-layout button (top-right)

NOTE: don’t forget to export your configuration! Expand the top right menu: export-layout

  1. Open the Macro editor

  2. Click “Create a new Macro”

  3. Paste the code from the .js file in the editor and modify as needed

  4. Apply your code changes by saving them NOTE: below the code editor you find the console. When you use “console.log(‘abc’);” entries in your code the values will appear in the console. Great for troubleshooting.

  5. Save code changes and Editor changes and test your code.




Resources

Developere Portal

Command Reference xAPI

Learning lab: Introduction to xAPI for Cisco Collaboration Devices learning lab

Learning lab: Creating custom In-Room Controls and Macros

Learning lab: Customizing Collaboration Devices from Code



Result

"Office" Tab

office-tab

"Office" Tab in Designer

office-tab-designer

"Home" Tab

This is the home tab, shared to give you an idea of what you could technically do.

office-tab



Disclaimer

This example is only a sample and is NOT guaranteed to be bug free and production quality. The sample macros are meant to:

  • Show how to use CE Macros.
  • Serve as a step by step example of building a macro using JavaScript and integration with the Codec XAPI
  • Provided as a guide for a developer to see how to initialize a macro and set up handlers for user and dialog updates.

Support Notice

Support for the macros is provided on a "best effort" basis via Github. Like any custom deployment, it is the responsibility of the partner and/or customer to ensure that the customization works correctly and this includes ensuring that the macro is properly integrated into 3rd party applications.