RoomOS Introduction

Welcome

This section of the lab consists 3 main sections.

RoomOS xAPI will teach you to interact with the RoomOS xAPI stack from several different integration points, such as SSH, HTTP and Macros. The xAPI are the building blocks to help you bring your solution to life.

RoomOS UserInterfaces will guide you through the customizable interfaces of the device. These pieces help you communicate with your users and build new experiences.

Solution Exercises discusses best practices for developing any customization with the RoomOS xAPI and contains walkthroughs of real solutions for you to build leveraging what you learned from the RoomOS xAPI and UserInterfaces sections

Important

Before you start, if you're running through this lab at Webex One, please ensure the Subscription Assistant UI is available on your RoomOS Device.

If it's not, follow the instructions below to download and install the Subscription Assistant Macro.

Subscription Assistant Icon
Subscription Assistant Icon

This macro was built to assist you for lessons where you'll Subscribe/Register Feedback to various xAPI Paths. Do not modify this macro, but feel free to learn from this macro and how it operates.

We won't be reviewing this macro in this lab, so if we'd encourage you take a copy home with you and review outside this course

SubAssist Macro
Lab-1451_Subscription-Assistant Macro

Gif

  • Locate the Lab-1451_Subscription-Assistant_Part-2.zip file you downloaded
  • Unzip it's Contents
  • Login into the WebUI of your RoomOS Device 
    https://[ROOMOS_IP_ADDRESS]
  • Navigate to Macro Editor
  • Drag and Drop the Subscription Assistant Macro into the Macro Editor
  • Save the Macro and Activate the Macro

SubAssist Operation

SubAssist Home

After installing and enabling the Subscription Assistant Macro, the macro will generate a UI extension on your Codec's Touch Control Surface

Clicking on this button, will open various tools for you to use when running through Part 2

View UI Operation

SubAssist Operation

SubAssist xConfig

In the xConfigurations Page, you'll have tools for modifying xConfigurations on your device.

Use these tools when Subscribing/Registering feedback to xConfigurations throughout the various lessons in Part 2

SubAssist xStatus

In the xStatuses Page, you'll have tools that will issue certain xCommands that will cause certain xStatus events to fire on your device.

Use these tools when Subscribing/Registering feedback to xStatus throughout the various lessons in Part 2

SubAssist xEvent

In the xEvents Page, you'll have tools that will cause certain xEvent events to fire on your device.

Use these tools when Subscribing/Registering feedback to xEvents throughout the various lessons in Part 2

SubAssist Home

Throughout Part 2, we will Subscribe to the same xAPI paths from each Integration Method. This is to familiarize you more with the Syntax of each integration method and how to structure that xApi Path.

That Said, we need to clean up the Codec at the end of each Section. When prompted to by the Lab Guide, run the Section Cleanup button. This will prepare the device for the next set of lessons in Part 2