For the impatient, just go here: quickstart.md
8 8
ad88888ba 88 88 ,ad8888ba, db 88888888ba
d8" 8 8 "8b 88 88 d8"' `"8b d88b 88 "8b
Y8, 8 8 88 88 d8' d8'`8b 88 ,8P
`Y8a8a8a, 88 88 88 d8' `8b 88aaaaaa8P'
`"8"8"8b, 88 88 88 88888 d8YaaaaY8b 88""""88'
8 8 `8b 88 88 Y8, 88 d8""""""""8b 88 `8b
Y8a 8 8 a8P Y8a. .a8P Y8a. .a88 d8' `8b 88 `8b
"Y88888P" `"Y8888Y"' `"Y88888P" d8' `8b 88 `8b
8 8 Syntactic "$ugar" for handling user input & other tasks on collaboration hardware
$ugar makes it simple to write code that handles user input:
$ugar isn't a library, it's a bit of so-called syntactic "$ugar" for the incredible JSXAPI library
It fills a very specific niche to make user interactivty a bit simpler (ie input box, prompts, widgets, etc)
There are no build/setup steps or dependencies for $ugar-- just copy the library.js (or library_min.js) file and paste it in the bottom of your macro
Just make sure your macro imports XAPI: const xapi = require('xapi');
See the examples directory for some sample user-interfaces and associated macro code to handle interactivity
See the docs directory for a listing of helpers and other functions
$('button1').on('click', (event) => {
// In here you can invoke other methods, post to a web service, etc
$().call('[email protected]'); // initiate webex call
});$('button2').on('input', (event) => {
console.log(event); // event: { id: '1', FeedbackId: '__button2', Text: 'bongo' }
const userData = `You entered ${event.Text}!`;
$().alert(userData);
});$('widget_id').on('widget_action', (event) => {
console.log("#", event);
// { id: '1', WidgetId: 'widget_id', Value: '2', Type: 'pressed' }
// { id: '1', WidgetId: 'widget_id', Value: '2', Type: 'released' }
});Note: for "utility functions" like prompt no parameter required for the $ugar function
$().prompt(['choice a','choice b','choice c','choice d', 'choice e'], 'How was it?', 'Pick one below', (event) => {
console.log("## Prompt payload!", event);
});$('widget_id').on('widget_action', (event) => {
console.log("#", event);
// { id: '1', WidgetId: 'widget_id', Value: '2', Type: 'pressed' }
// { id: '1', WidgetId: 'widget_id', Value: '2', Type: 'released' }
});Also lots of various utility helpers that alias common tasks: (ex $().alert, $().prompt), see more in the API Reference
-
Macros 101: https://help.webex.com/en-us/np8b6m6/Use-of-Macros-with-Room-and-Desk-Devices-and-Webex-Boards
-
https://www.cisco.com/c/dam/en/us/td/docs/telepresence/endpoint/ce95/macro-scripting-tutorial.pdf
-
Lots of configuration guides: https://www.cisco.com/c/en/us/support/collaboration-endpoints/spark-room-kit-series/products-installation-and-configuration-guides-list.html
Given environment restrictions $ugar is not a commonjs/AMD/RequireJS exported library, see below to run basic tests
npm i # install testing dependencies
npm test # run tests