ciscodevnet / awesome-xapi

A curated list of developer resources to integrate with Webex Devices

Awesome xAPI

A curated list of developer resources for Webex Devices API inspired by awesome-go and awesome-python.

Looking for developer resources for Webex Messaging and Meetings? check awesome-webex.

Contributing

Please take a quick gander at the Contribution guidelines first. Thanks to all contributors; you rock!

If you see a package or project here that is no longer maintained or is not a good fit, please submit a pull request to improve this file. Thank you!

Contents

DISCLAIMER: Cisco does not make any commitments about the resources listed in this document, nor the accuracy of the third party resources and any content accessible via the links below.

• !Get Started!
• Articles and Blogs
• Building Blocks
• Code Samples
• Developer Tools
  • DevNet Sandbox
• Reference
  • PDF Guides
• 3rd Party Hardware

!Get Started!

Tour the xAPI via step-by-step tutorials.

• Introduction to xAPI - Learn to invoke your device's API via SSH, HTTP and Node.js (by Cisco DevNet).
• In-Room Controls - Create an "Ultrasound Panel" animated via Node.js or a Macro (by Cisco DevNet).
• Macro Scripting - Write your first Macro scripts (by Cisco CE).
• Personalizing your device - Add your own logo and custom messages from code (by Cisco DevNet).

Articles

Blogs and community articles that document features, cover use cases or propose code samples.

• Blogs introducting new Features
  • Introducing HTTPClient - HTTP POST/PUT/GET/DELETE/PATCH with return
  • Introducing Kiosk Mode - Hide default Call, Share and Meetings buttons
  • Introducing USB input - Support for 3rd party USB input devices (keyboards)
  • Introducing WebSockets - xAPI over WebSockets: XoWS (pronounced cows).
  • Introducing WebEngine - A dive into Web Engine, Digital Signage & Web Apps.
• Community Articles
  • CE Programmability - Learn How To Build Applications for Webex Devices.
  • Holy cows! - Delivering the art of possible with video devices.
  • SIP messaging channel - SIP Messaging Channel for Remote Endpoint Control.
  • CE9-projects - Adam Schaeffer sharing projects and ideas.
  • WebSocket vs SSH vs HttpFeedback - Which is Best?.
• Help Articles
  • Advanced Settings - Advanced Settings for Room and Desk Devices
  • Integrating - In-Room Controls and Use of an External Video Switch with Room Devices
  • Local user - Local User Administration on Room and Desk Devices
  • Screens setup tips - Recommended external screen settings for Room Devices.
  • USB input-device - Use of a 3rd party USB input device.

Building Blocks

Helper libraries to interact with codecs

• Command Line Interface
  • xows CLI - Command-line utility built on top of pyxows (by Cisco CE).
• JavaScript
  • jsxapi - JavaScript bindings for Cisco Collaboration Endpoint XAPI (by Cisco CE).
  • sugar - Syntactic "$ugar" for handling user input (by valgaze).
• Postman
  • ce-xapi-as-admin - Collection for CE xAPI as Administrator (by ObjectIsAdvantag).
  • ce-xapi-as-integrator - Collection for CE xAPI as Integrator (by ObjectIsAdvantag).
  • webex-admin-api - Collection for Webex Administrators (by ObjectIsAdvantag).
  • webex-devices-xapi - Collection for cloud /xAPI (by ObjectIsAdvantag).
• PowerShell
  • Send-XCommand - Cmdlets for sending xConfiguration & xCommand requests (by stephenwelsh).
• Python
  • pyxows - Python bindings for Cisco Collaboration Endpoint xAPI over WebSockets (by Cisco CE).

Code Samples

From basic examples to finalized solutions illustrating the xAPI capabilities.

• Repositories of examples
  • CE9-projects - Projects for Cisco DX, MX, SX and Room Systems (by technologyordie).
  • macro-projects-Examples - Cisco Video Endpoint Macro Repository (by Bobby-McGonigle).
  • roomdevices-macros-samples - Selection of macros proposed by the xAPI dev team (by Cisco CE).
  • xapi-samples - UI extensions, macros and scripts to quickly learn xAPI (by ObjectIsAdvantag).
  • yolo-oslo - Repository of in-room controls and macro samples (by acaeti).
• Solutions
  • cisco-tp-snapshots - Take snapshots with your Cisco Room Device, aka Telepresence Endpoint (by drkchiloll).
  • codec-dashboard - Web dashboard to display/alert on codec information (by gsheppar).
  • feedback-meeting - Dashboard built from feedback collected via a custom "Call Survey" control (by tloyau).
  • maze game - Navigate blind in a maze, look for the treasure (by ObjectIsAdvantag).
  • MyRoomKit - Botkit chatbot as an extension of a RoomKit device (by ObjectIsAdvantag).
  • roomie - App reporting whether there are people in the meeting rooms (by bjolseth).
  • roomkit-collector - Collect PeopleCount events and compute weighted averages (by ObjectIsAdvantag).
  • roomkit-react-map - React map showing PeopleCount analytics fired by a set of RoomKits (by ObjectIsAdvantag).
  • telehealthPresence - Add additional presence states for video endpoints in Jabber (by voipnorm).
  • video status monitor - Web page displaying call status and people count/presence (by DJF3).

Developer Tools

Handy tools and building-blocks to create, test and deploy applications.

• Sandbox - Reserve a CE device and code for up to a week (by DevNet).
  • RoomOS 10.3 Sandbox - RoomKit pro equiped with CE 10.3 (work in progress, stay tuned).
  • CE9.15 Sandbox - RoomKit pro equiped with CE 9.15.
• Test
  • Playground - Launch the UI Extensions Editor straight from Chrome, no codec (by ObjectIsAdvantag).
  • SIP test addresses - [email protected], [email protected], [email protected], [email protected], [email protected].
• Deploy
  • CE-Deploy - Desktop application for deploying features (by voipnorm).
  • CiscoTPCustomXML - Deploy packages to Cisco Telepresence apps (by vipnorm).
  • macros-env - Enhance your macro runtime with environment variables (by ObjectIsAdvantag).

Reference

Documentation, product resources and technical support.

• Portals and Dev Centers
  • Adoption Toolkits - Video value statements, quick-start guides, use cases and promotional posters.
  • Configuration guides - Configure your Touch10 interface or 3rd party Video Switchers
  • Developer Portal - Technical resources for developers and integrators.
  • Product resources - Resources for all Supported Collaboration Endpoints.
  • Project Workplace - Discover Cisco's devices portfolio, product features and recommandations.
• Release notes
  • CE 9.x Release notes - New features and functionality in CE9.
  • RoomOS What's new - New features and capabilities for RoomOS.
• Technical Support
  • 'xAPI devs' space - Chat live with other developers in Webex Teams.
  • Forums - Telepresence forum by Cisco Support Community.
  • Known issues - Known and Resolved issues for RoomOS.
• Videos
  • Customizing Devices - Introduction to Video Series.
  • Kiosk - Removing default buttons.
  • Presenter Track - How PresenterTrack behaves in a few common scenarios.
  • Timer - Timer creation for Webex devices.
  • UI Extensions - Creating a speed dial.
  • Web Apps - Creating Web Applications on a Webex Board.

Reference Guides

API Reference, Configuration and Administration guide for specific versions of CE and RoomOS.

• Product Documentation
  • Cisco TelePresence systems
  • Cisco Webex registered devices
  • Board Devices, DX, MX, Room Devices, SX
• RoomOS 10.3
  • API Reference Guide
• CE 9.15
  • API Reference Guide, Administrator Guide (CodecPro), Customization Guide, Getting Started Guide (not available)
• CE 9.14
  • API Reference Guide, Administrator Guide (CodecPro), Customization Guide, Getting Started Guide
• CE 9.13
  • API Reference Guide, Administrator Guide (CodecPro), Customization Guide, Getting Started Guide
• CE 9.12
  • API Reference Guide, Administrator Guide (CodecPro), Customization Guide, Getting Started Guide
• CE 9.10
  • API Reference Guide, Administrator Guide (CodecPro), and (RoomKit), Customization Guide (not available)
• CE 9.9
  • Blog: WebEngine and new UI Extensions Editor
  • API Reference Guide, Administrator Guide (CodecPro), and (RoomKit), Customization Guide
• CE 9.8
  • Blog: New features,
  • API Reference Guide, Administrator Guide (CodecPro), and (RoomKit), Customization Guide
• CE 9.7
  • Blog: xAPI over WebSocket
  • API Reference Guide, Administrator Guide (CodecPro), and (RoomKit), Customization Guide
• CE 9.6
  • Blog: New features
  • API Reference Guide, Administrator Guide (CodecPro), and (RoomKit), Customization Guide
• CE 9.5
  • API Reference Guide, Administrator Guide (CodecPro), and (RoomKit), Customization Guide
• CE 9.4
  • API Reference Guide, Administrator Guide (CodecPro), and (RoomKit), Customization Guide
• CE 9.3
  • API Reference Guide, Administration Guide (RoomKit), Customization Guide
• CE 9.2
  • API Reference Guide (DX70/DX80) and (RoomKit), Administration Guide (RoomKit), Customization Guide

Third-Party

Hardware, integrations and control systems

• Control Systems
  • AMX/Harman
  • Creston
  • Extron
  • Lightware
• Other Hardware
  • Audio Plug Terminal Block
  • USB to Serial Adapter
• USB HID Compliant devices
  • Dynamag - Card Reader
  • Logitech R400 - Wireless Presenter
• Video Integrations
  • Kaptivo

awesome-xapi's Issues

add SIP testing addresses

[email protected]
[email protected]
[email protected]
[email protected]
[email protected]

add technologyordie samples

I did add these samples, then realized the project has no license, which does not let the dev community to safely reuse this samples:

• CE9-projects - Projects for Cisco DX, MX, SX and Room Systems (by technologyordie).

add blog

https://blog.webex.com/collaboration-devices/holy-cows-xows-delivering-the-art-of-possible-with-video-devices/

add section for USB HID compliant devices (advertised as keyboards)

add yolo-oslo samples

https://github.com/acaeti/yolo-oslo

ADD xcommand over SIP article

https://voipnorm.blogspot.com/2019/07/ce-sip-messaging-channel-for-remote.html

add feedback-meeting

https://github.com/tloyau/feedback-meeting

add a demos section

Cyprien :

1. no local storage
2. Prefer to monitor RoomAnalitycs change and on each change send the data to your collector to graph/agregate it the way they decide
3. no impact. Activate it out of call

If you want to go you can re-use : http://websrv.ciscofrance.com:15131/map
GitHUb (no map) here : https://github.com/tloyau/cisco-people-presence

add section for videos

https://www.youtube.com/watch?v=qKqlIReRJog&t=6s

add CE9.8 documentation

reflect Sandbox update from CE 9.6 to 9.7.1

add macros-env

https://github.com/ObjectIsAdvantag/macros-env

add a Cisco live Video & Decks section

to help on-boarding new developers

add section for Connectivity

I really like this plug:
https://www.adafruit.com/product/2914

let's consider it to be added to a new section (IoT, Audio...)

add CE9.6 documentation

https://www.cisco.com/c/dam/en/us/td/docs/telepresence/endpoint/ce96/collaboration-endpoint-software-api-reference-guide-ce96.pdf

add examples in PowerShell

see post in xAPI devs space

I'm running into a bit of a roadblock deploying Macros to the endpoints via the putxml API. I'm using PowerShell to read in the contents of a txt file that contains the JS code using Get-Content. When I insert this into the XML body <Command><Macros><Macro><Save><Name>Testing</Name><Overwrite>True</Overwrite><body>$macroBody</body></Save></Macro></Macros></Command> the result is a giant blob of text. When I POST this it ends up as a single line of text on the endpoint... Which is a problem when you have comments in your JavaScript. Anybody know how I can maintain my line breaks in the import file? Probably a PowerShell thing I need to figure out...

Blah... Yeah, it's a PowerShell thing. Instead of deleting my above post, I will include the solution in case it helps anyone else... When you use Get-Content it will strip carriage returns. Instead, use Get-Content -Raw and the carriage returns will be preserved.
$response | ConvertTo-Json

remove bluejeans article

link is broken

add What's new for RoomOS

https://help.webex.com/en-us/6ger7db/What-s-New-in-RoomOS

add section for HDMI switches

compatible with CE
https://www.extron.com/article/ciscotouch

add Administrator Guides

https://www.cisco.com/c/en/us/support/collaboration-endpoints/spark-room-kit-series/products-maintenance-guides-list.html

add Webex Devices APIs example scripts

https://github.com/CiscoDevNet/webex-device-api-examples

add whitepaper on Security for RoomOS devices

https://www.cisco.com/c/dam/en/us/td/docs/telepresence/endpoint/webex/webex-rooms-security-white-paper.pdf

add "Join Webex" button

Zoom or BlueJeans button just like the "Join Webex" button?
Look at https://github.com/nosaturn/CiscoTelePresenceEndpoints

add USB input device tuto

https://collaborationhelp.cisco.com/article/en-us/nhqh1mf

add XML escape when posting to /putxml

https://www.freeformatter.com/xml-escape.html

add Creston buttons

http://applicationmarket.crestron.com/cisco-touch-10-room-control-v1-0/

add CE bot

[email protected]

add administrator guides

ex: https://www.cisco.com/c/dam/en/us/td/docs/telepresence/endpoint/ce98/codec-pro-administrator-guide-ce98.pdf

Consider 'platinum onboarding' sample

Interesting sample here: https://github.com/CiscoSE/platinum-onboard/tree/master/ceapi

However uses undocumented device API (/web/api) to get proximity user details - may need to wait until that capability is exposed in supported APIs (or just pass for now)

Investigate a WebEngine section

Starting with Digital Signage
https://help.webex.com/en-us/nmd8log/Enable-Digital-Signage-on-Cisco-Webex-Boards-and-Room-Devices

add CLI clixows

add Lightware integration

Video: https://lightware.com/cisco-integration-lightware

add cisco-tp-snapshots

from: https://github.com/drkchiloll/cisco-tp-snapshots

Add Webex Edge security guide

https://www.cisco.com/c/dam/en/us/td/docs/voice_ip_comm/cloudCollaboration/wbxt/whitepapers/webex-edge-devices-white-paper.pdf

and also consider adding to awesome-webex

add Customization Guides

https://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/products-installation-and-configuration-guides-list.html

add xows article

https://community.cisco.com/t5/collaboration-voice-and-video/xapi-over-websocket-xows-ce9-7-x/ba-p/3831553

add USB to Serial adapter

https://www.tripplite.com/support/USA19HS

enhance the Getting Started instructions

for now, we are only listing tutorials

we could enhance with a journey, such as:

1. Discover the possibilities (videos, decks, blogs)
2. Take your first steps by installing some examples (macros, extensions)
3. Start to learn coding (take the labs)
4. Explore resources and join the xAPI devs community
5. Validate your skills with the DevNet certifications (DEVWBX and CLAUTO)

add Bobby examples

https://github.com/Bobby-McGonigle/Cisco-RoomDevice-Macro-Projects-Examples

add blog

https://community.cisco.com/t5/collaboration-voice-and-video/a-dive-into-web-engine-and-the-new-ui-extensions-editor-digital/ba-p/3947191

add Adoption Toolkits

https://community.cisco.com/t5/collaboration-voice-and-video/cisco-webex-devices-adoption-toolkits/ta-p/3832348

add OSMC Remote Control

https://www.maplin.co.uk/osmc-remote-control-0616909468072

add to Community Articles

http://voipnorm.blogspot.com/2019/07/ce-websocket-v-ssh-v-httpfeedback-which.html

add InRoom-Macro-Deployer

https://github.com/voipnorm/InRoom-Macro-Deployer

Evaluate a Webex Share section

Share is not running CE,
so goal would be to point to the API:

• https://help.webex.com/en-us/94331fb/Cisco-Webex-Share-REST-APIs

add CE9.6.1 blog

• HTTP PUT/POST
• USB input
• Hiding Buttons

https://community.cisco.com/t5/collaboration-voice-and-video/ce9-6-x-in-room-control-and-macros-usb-input-devices-http-post/ba-p/3765081

add Sugar

https://github.com/valgaze/sugar

add pyxows

https://github.com/cisco-ce/pyxows

add webex-ep-websocket-monitor

https://github.com/nsthompson/webex-ep-websocket-monitor

add USB HID codes

https://www.freebsddiary.org/APC/usb_hid_usages.php