awesome-xapi
awesome-xapi copied to clipboard
Published
20 hours ago •
CiscoDevNet
CiscoDevNet
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.
- technology() or die; - 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
- 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
- RoomOS 10.3
- CE 9.15
- API Reference Guide, Administrator Guide (CodecPro), Customization Guide, Getting Started Guide (not available)
- CE 9.14
- CE 9.13
- CE 9.12
- CE 9.10
- API Reference Guide, Administrator Guide (CodecPro), and (RoomKit), Customization Guide (not available)
- CE 9.9
- CE 9.8
- CE 9.7
- CE 9.6
- CE 9.5
- CE 9.4
- CE 9.3
- CE 9.2
Third-Party
Hardware, integrations and control systems
- Control Systems
- Other Hardware
- USB HID Compliant devices
- Dynamag - Card Reader
- Logitech R400 - Wireless Presenter
- Video Integrations
Metadata
61
Stars
19
Forks
Watchers
Owner
CiscoDevNet
Metadata
A curated list of developer resources to integrate with Webex Devices