GVE_DevNet_RoomOS_Bookings_OBTP

Note:

Parts of this code were driven by the emulator already-developed here: OBTP-Emulator, with major enhancements on:

• Adding the ability to check what existing bookings are available on the Cisco TelePresence endpoints
• Adding the ability to send multiple bookings and not just one replacing any existing bookings.
• Dynamically reading existing bookings' data (using xCommand Bookings List) to a local XML file, adding the newly inserted booking to it, and then sent to the device using a POST call to: 'http://(ip_address)/bookingsputxml'

Contacts

• Rami Alfadel (ralfadel@cisco.com)

Solution Components

• Cisco TelePresence endpoints
• Cisco TelePresence end-point xAPIs
• Python
  • Python Module:
    • Flask

Solution Overview

This prototype is showing a method to send OBTP bookings to Cisco Collaboration Endpoints from a web dashboard, without the need to connect to calendar-services.

Installation/Configuration

Getting Started

1. Choose a folder, then create a virtual environment:
   python3 -m venv <name of environment>

2. Activate the created virtual environment:
   source <name of environment>/Scripts/activate

3. Access the created virtual environment:
   cd <name of environment>

4. Clone this Github repository into the virtual environment folder:
   git clone [add github link here]

• For Github link: In Github, click on the Clone or download button in the upper part of the page > click the copy icon
  

5. Access the folder GVE_DevNet_RoomOS_Bookings_OBTP:
   cd GVE_DevNet_RoomOS_Bookings_OBTP

6. Install the solution requirements:
   pip3 install -r requirements.txt

7. Initiate the Flask application settings:
   export FLASK_APP=app.py
export FLASK_ENV=development

8. Start the Flask application:
   flask run

9. Open the hosted web page in your browser:
   (Default: localhost:5000)

Usage

• As you open the main page, you will be asked to login with a Meraki API Key:

• If the login is successful, the context page will show up:

  • Displaying the following buttons/options:

    • Get Current Bookings:
      Which will invoke the xAPI call: (Bookings List) and display if any bookings existing in the device, in a JSON format in the bookings area below:

    • Insert a new booking:
      Which will open a new tab for the user to be able to add a new booking:

      • Note: When a new booking is inserted, a local XML file will be generated/updated. First checking any existing bookings and adding them to the XML file, then add the details of the new booking and then send the whole XML file to the device, using the API call:
        'http://(ip_address)/bookingsputxml'

    • Clear All Bookings: Which will clear all the bookings in the device, and check with the user if to delete the generated XML file or keep it.

Notes

• The xAPI calls genereated from the python flask application are following the websocket methodolegy explained here: xAPI over WebSocket
• Currently, new bookings will be sent using the API call:
  'http://(ip_address)/bookingsputxml'
  • For future enhancment, the method can be upgraded to use: (Bookings Book). However when we tested this call on devices that are register on-prem, the API wasn't able send bookings, responding with the error: ""Device not entitled" matching what's discussed here: Cisco Community

LICENSE

Provided under Cisco Sample Code License, for details see LICENSE

CODE_OF_CONDUCT

Our code of conduct is available here

CONTRIBUTING

See our contributing guidelines here

DISCLAIMER:

Please note: This script is meant for demo purposes only. All tools/ scripts in this repo are released for use "AS IS" without any warranties of any kind, including, but not limited to their installation, use, or performance. Any use of these scripts and tools is at your own risk. There is no guarantee that they have been through thorough testing in a comparable environment and we are not responsible for any damage or data loss incurred with their use. You are responsible for reviewing and testing any scripts you run thoroughly before use in any non-testing environment.