{"id":20588642,"url":"https://github.com/ciscodevnet/xapi-samples","last_synced_at":"2025-03-06T13:23:27.850Z","repository":{"id":65632186,"uuid":"115175969","full_name":"CiscoDevNet/xapi-samples","owner":"CiscoDevNet","description":"Examples of UI Extensions, Macros and Node.js scripts for Webex devices and Cisco Collaboration Endpoints","archived":false,"fork":false,"pushed_at":"2020-08-31T06:13:08.000Z","size":5279,"stargazers_count":48,"open_issues_count":8,"forks_count":30,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-01-16T23:33:05.275Z","etag":null,"topics":["cisco-ce","dx80","jsxapi","roomkit","webex","xapi"],"latest_commit_sha":null,"homepage":"http://cs.co/roomdevices","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CiscoDevNet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-12-23T06:32:21.000Z","updated_at":"2024-05-28T14:53:45.000Z","dependencies_parsed_at":"2023-02-01T17:31:53.220Z","dependency_job_id":null,"html_url":"https://github.com/CiscoDevNet/xapi-samples","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fxapi-samples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fxapi-samples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fxapi-samples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fxapi-samples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CiscoDevNet","download_url":"https://codeload.github.com/CiscoDevNet/xapi-samples/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242215365,"owners_count":20090819,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cisco-ce","dx80","jsxapi","roomkit","webex","xapi"],"created_at":"2024-11-16T07:25:42.014Z","updated_at":"2025-03-06T13:23:27.833Z","avatar_url":"https://github.com/CiscoDevNet.png","language":"HTML","readme":"# Handy samples for xAPI UI Extensions and Macros [![published](https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg)](https://developer.cisco.com/codeexchange/github/repo/CiscoDevNet/xapi-samples)\n\nThis repo can get you quickly ramp up with CE programmability and xAPI, with examples for:\n- [UI Extensions](./controls), \n- [JavaScript Macros](./macros), \n- [Node.js applications](./jsxapi), \n- [Python applications](./pyxows) \n\n**New to xAPI UI Extensions and Macros?**\n- check the [QuickStart Guide](./docs/QuickStart.md) to learn to load Controls and Macros to your device, \n- take a DevNet Tutorial from the xAPI track (intro to xAPI and creating custom UI Extensions)\n\n**Don't have a CE device at hand to mess up with?**\n- reserve a [DevNet sandbox](https://github.com/CiscoDevNet/awesome-xapi/#sandboxes) equiped with CE latest\n\n**Going Futher**\nOnce you're done browsing the examples in this repo, here are a few suggestions\n- check the [official Macro Samples repository](https://github.com/CiscoDevNet/roomdevices-macros-samples)\n- load the [Postman collection for xAPI](https://github.com/CiscoDevNet/postman-xapi) to invoke the xAPI from code external to the Room Device\n- read through the full [CE Customization PDF Guide](https://www.cisco.com/c/dam/en/us/td/docs/telepresence/endpoint/ce99/collaboration-endpoint-software-api-reference-guide-ce99.pdf)\n- check for the curated list of resources at [awesome-xapi](https://github.com/CiscoDevNet/awesome-xapi)\n\n\n## T-Shell Tips for developers\n\nSimply SSH to your Collaboration Device and run the commands below:\n\n### Listen to events\n\nThe 'xfeedback' commands let you see all events fired on your device.\nThis is very useful to investigate possibilities, and take shortcut without going through the whole documentation at times.\n\n```shell\n# Listen to all notifications (events, status, commands)\nxfeedback register /\n```\n\n```shell\n# Listen to UI Extensions events\nxfeedback register /Event/UserInterface/Extensions\n```\n\n```shell\n# Stop listening\nxfeedback deregisterall\n```\n\n### Send messages\n\nSending messages lets you craft custom APIs, by coming up with your own protocols, aka, Event Driven Architectures.\nOne code will send a serialized message, the other code will capture the message and decode it.\n\n```shell\n# Listen to messages\nxfeedback register /Event/Message/Send\n```\n\n```shell\n# Send message\nxCommand Message Send Text: \"This is random text\"\n```\n\nCheck the [message Macro](macros/8-message.js) for an example in JavaScript.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fciscodevnet%2Fxapi-samples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fciscodevnet%2Fxapi-samples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fciscodevnet%2Fxapi-samples/lists"}