Git Product home page Git Product logo

labs-xapi's Introduction

Cisco DevNet Learning Labs: Labs XAPI

These self-paced interactive tutorials provide instructions for developers to learn how to use XAPIs.

We write these labs for display within the Cisco DevNet Learning Labs system.

Contributions are welcome, and we are glad to review changes through pull requests. See contributing.md for details.

Once approved, Cisco DevNet reviewers then create a release to publish through our Learning Labs system.

The goal of these Learning Labs is to ensure a 'hands-on' learning approach rather than theory or instructions.

About these Learning Labs

These labs teach how to:

  • Use XAPI controls.
  • Use XAPI branding.

If you need more help, you can reach out to DevNet through one of our support options.

Preview Learning Lab Markdown locally

Refer to the instruction for your text editor for Markdown previewing. For example, Markdown and Visual Studio Code describes how to configure Markdown extensions.

Contributor guidelines

These learning modules are for public consumption, so you must ensure that you have the rights to any content that you contribute.

Write your content in Markdown. DevNet staff reviews content according to the Cisco Style Guide. (Link available on Cisco VPN only.)

Publishing requirements

To create and publish a new lab, take the following steps:

  • Add a new folder under labs.
  • Create a JSON file with the same name as the labs/folder name.
  • Create markdown files named 1.md, 2.md, and so on; refer to those files in the labs/folder JSON file.
  • Ensure that the JSON file contains appropriate page titles and file references.
  • Send a pull request to get the files committed and merged to the default branch by a DevNet reviewer.

A DevNet reviewer then creates a release on the repository with the latest changes and publishes through the admin interface.

Editors

You can write Markdown in a plain text editor, and desktop and Web-based options allow you to simultaneously write and preview your work. We recommend Visual Studio Code Download for these reasons:

  • Lightweight environment for coding (or writing Markdown).
  • Available on macOS, Linux, or Windows.
  • Github Client integration.
  • Great Markdown preview features native in the editor.
  • Intuitive operation and structure.

You can validate a JSON file by using the online formatter and validator.

Getting involved

  • If you'd like to contribute to an existing lab, refer to contributing.md.
  • If you're interested in creating a new Cisco DevNet Learning Lab, please contact a DevNet administrator for guidance.

labs-xapi's People

Contributors

agentlecisco avatar annegentle avatar dstaudt avatar eckelcu avatar henrikba avatar lawrencepersoncisco avatar objectisadvantag avatar reneebornstein avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

bjornars henrikba

labs-xapi's Issues

Resetting Endpoints

I just noticed that when I went through the lab a 2nd time, that some of the messages I sent to screen were still there. I think we need a reset statement at the beginning (or end for the previous user).

Though I admit, if the student has enough time, I will have them re-register the device, which I assume would clear it out. But I still think adding a reset statement would be worth it.

Reference the RoomKit Sandbox

Added to the In-Room Controls lab.

TODO: add to the Intro lab mainly as it does not make a lot of sense for branding

collab-xapi-intro modifications

Step 3: Add a note "Access to Advanced Settings requires that you are connected to the same network as the room device."

Step 4: "and sign out if you're already signed in...." by clicking on the username in the top right.

Step 7: Standby status from standby.js returned [object Object] instead of correct status.

Step 8: CURL command assumes OSX/Linux as \ does not let you continue on next line in Windows.

collab-xapi-controls\step3

Again, note that the IP address needs to be changed.

Also worth noting where the "untlrasoundvalue" can be found in the admin page: Setup -> Configuration -> Audio (bottom of page)

Images that match in case you need them
image

image

collab-xapi-controls\step4

seetings -> settings

Note on IP change (or maybe just put it into the step1 that in each time they'll adjust or maybe make another file that contains that info that all of these reference).

Image in case its needed:
image

collab-xapi-controls\step5

intiailize -> initialize

initialiazed - >initialized

Remind the user that the file (and instructions) for uploading the xml file are in Step2

Image in case its needed for documentation
image

collab-xapi-controls\step2

"To start with, load and deploy the control.xml panel on your device."
No indication of how you want them to do this. Assume you want them to go the web interface then Integration -> In-Room Controls -> Launch Editor -> Editor Menu (top right) -Import from file -> Find the control.xml in the step2 dir -> Open. Then "Export configuration to video system"

They before they run the control.js in this directory, they will need to again adjust the IP (and username and password if they did not use integrator).

I received an error (and unlike the previous step, the application remains running)
image

Here's the image on my touch 10.
image

Feedback from Steve Hill

Mostly note the same issues I raised about cut and paste on 3rd lab (which probably needs an enhancement) as well as time adjustment.

image

collab-xapi-controls\step5

Suggest that the user adjust the level below 5 to see the change from "disabled" to the "tip"

Images in case its needed
image
image

collab-xapi-branding

Step 4: see error "invalid type" when running branding upload from postman.
image

Step 5: See error when attempting to run customMessage.js
image

Feedback from Craig Tait

image
Hey Steve Greenberg - results of my run-through:
Intro to xapi Lab - 60 minutes (included installing node and Postman)
Some minor documentation changes…
Page 2, Step 6:
“…new window will appear on the left” (should be “right”)
Step 5:
On a DX, there is no ‘xcommand Standby Deactivate’
xconfiguration Standby
*c xConfiguration Standby Control: On
*c xConfiguration Standby Delay: 10
*c xConfiguration Standby WakeupOnMotionDetection: Off
** end
Step 6:
“For this lab, we have pre-generated… based on the ‘integration:integrator’ username and password” (should read “integrator:integrator”)
Because in Step 2:, we said,
“Enter ‘integrator’ as Username”
Step 8:
cURL is missing the —insecure option, because we’re going against a self-signed cert.
curl -X POST https://192.168.1.34/putxml
-H 'Authorization: Basic aW50ZWdyYXRvcjppbnRlZ3JhdG9y'
-H 'Content-Type: text/xml'
-d '[email protected]'
curl: (60) SSL certificate problem: self signed certificate
add —insecure to the cURL command and it works
Branding Lab - 30 minutes
In-Room Controls - 40 minutes

Webex branding alignment

as of the new branding, Webex designates the global brand and also the cloud platform (for meetings, teams and devices)

to reflect this, and aligning with Fabian's communication, I propose we go with:

  • Cloud-registered devices
  • Room Devices and Desk Devices fall into the larger Webex Devices brand
  • a device can be on-prem or cloud-registered. In the latter case, it is registered to the Webex cloud platform (and NOT to Webex teams)
  • as Webex teams designates the mobile, desktop, web apps (the clients), a device will pair with a Webex Team app. we can also say a device pairs with Webex Teams.

Fabian extract: Ever wish you had a big green Join button on your device to get into your meeting? 🔮 It's here! 🙌
Just as you have a green Join button appear in the Cisco Spark ( 🔜Webex Teams) app… the same Join button will appear on the device! 😍
How you ask? Simply deploy Hybrid Calendar Service, register the room or desk device to a place, schedule a meeting, and add the cloud-registered device to book the device and meeting. The awake screen will then also show a list of upcoming meetings. ✅
All the information you need is right here. 👊

collab-xapi-controls suggested revisions.

Step 2:
Though I get the controls to go to the touch 10 on my room kit. I never see the control in the simulated touch 10. I tried load simulator config and clean up.
image

Step 3:
Because of all my messing with the simulator, once I am in the editor, I had climate and & lights and blinds as two created pannels. I assume you want to have them remove all pannels first?
image

image

Note: has both a quote and the beginning of a markdown underscore: _Note that choosing a color is proposed for CE9.3+" Also don't think proposed is the right word you want here, maybe added is what you want?

"Awesome! but now vey interactive isn'it... No worries: in" -> "Awesome. However its not interactive yet.. No worries. In"

Step 4:
Assume "const MAX = 90 // for a DX80" is also true for a DX70 (which SEVT users will be using)? If so remove 80.

Maybe write out the "on(‘ready’)" with "xapi.on('ready'" and maybe a statement that indicates that you are replacing everything from that statement till the end of the code.

I don't think you should reference line numbers as in "On line 12" & "On line 19" because the screen in learning labs doesn't have a number. So they may see numbers in their editor, which would be different, and depending on how they pasted the new code in could be different.

The last note of the page has a beginning underscore for markdown, but is missing the trailing.

"Launch the script.." -> "Launch the script (from the command line again)"

At the end of step for do we need to tell the user to ctrl-c to kill the app or should we have that before the next?

Step 5

I screwed up the placement of the new lines of code the first time I tried, so I suspect that others might do the same. Might just need an extra image or note about placement, or just have them paste the whole ending, i.e. everything after the const line, but note that only XX lines were added.

Step 7
Maybe I screwed up placement again, but I am not seeing the note when the volume gets too low (attached and renamed to txt so that github would take it). Though I did when I originally tried from the github version.

control.txt

I feel like at the end of step 7 we should have a if your device is cloud registered then "congratulations, you are done (macros will be coming to cloud devices at a later time)" statement.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.