PepperDash.Essentials.Plugin.CiscoRoomOsCodec 1.6.0-feature-camera-updates.5

Cisco RoomOS Video Codec Plugin

Overview

The Cisco RoomOS plugin provides device control over the Cisco Webex family of video conference codecs with regards to the most commonly used and requested attriute and control types.

It implements all available Essentials interfaces relevant to a device of this type, including but not limited to VideoCodecBase. Interfaces supported can be found by viewing the declaration of the CiscoCodec class in CiscoRoomOsCodec.cs.

Additionally, every component implements IKeyed and all devices are added to the DeviceManager unpon instantiation.

Cloning Instructions

After forking this repository into your own GitHub space, you can create a new repository using this one as the template. Then you must install the necessary dependencies as indicated below.

Dependencies

The Essentials libraries are required. They referenced via nuget. You must have nuget.exe installed and in the PATH environment variable to use the following command. Nuget.exe is available at nuget.org.

Installing Dependencies

To install dependencies once nuget.exe is installed, run the following command from the root directory of your repository: nuget install .\packages.config -OutputDirectory .\packages -excludeVersion. To verify that the packages installed correctly, open the plugin solution in your repo and make sure that all references are found, then try and build it.

Installing Different versions of PepperDash Core

If you need a different version of PepperDash Core, use the command nuget install .\packages.config -OutputDirectory .\packages -excludeVersion -Version {versionToGet}. Omitting the -Version option will pull the version indicated in the packages.config file.

Instructions for Renaming Solution and Files

See the Task List in Visual Studio for a guide on how to start using the templage. There is extensive inline documentation and examples as well.

For renaming instructions in particular, see the XML remarks tags on class definitions

License

Provided under MIT license

Join Map

Digitals

Note: Using the Camera Mode Auto/Manual/Off joins (131-133) to control the tracking mode relies on the tracking capabilities reported from the codec.<br> If only SpeakerTrack is available, setting the camera mode to auto will turn on SpeakerTrack.<br> If only PresenterTrack is available, setting the camera mode to auto will turn on PresenterTrack.<br> If both are available, setting the camera mode to auto will turn on the preferred mode set using the defaultTrackingMode configuration value<br>

Analogs

Serials

Configuration

Device

{
  "key": "Codec-1",
  "name": "Video Codec 1",
  "type": "ciscoRoomOS",
  "group": "videoCodec",
  "properties": {
    "control": {
      "endOfLineString": "\n",
      "deviceReadyResponsePattern": "",
      "method": "Ssh",
      "tcpSshProperties": {
        "address": "10.0.0.1",
        "port": 22,
        "autoReconnect": true,
        "AutoReconnectIntervalMs": 10000,
        "username": "admin",
        "password": "tandberg"
      }
    },
    "phonebookDisableAutoPopulate": true,
    "phonebookMode": "Corporate",
    "showSelfViewByDefault": true,
    "sharing": {
      "autoShareContentWhileInCall": false,
      "defaultShareLocalOnly": true
    },
    "joinableCooldownSeconds": 0,
    "phonebookResultsLimit": 50,
    "defaultTrackingMode": "SpeakerTrack",
    "overrideMeetingsLimit": true,
    "cameraInfo": [
      {
        "CameraNumber": 1,
        "Name": "Audience"
      },
      {
        "CameraNumber": 2,
        "Name": "Presenter"
      }
    ]
  }
}

Note: Not all configuration properties are currently shown

Bridge

{
  "uid": 20,
  "key": "eisc-vc",
  "type": "eiscApiAdvanced",
  "group": "api",
  "name": "EISC VC Bridge",
  "properties": {
    "control": {
      "tcpSshProperties": {
        "address": "127.0.0.2",
        "port": 0
      },
      "ipId": "4F"
    },
    "devices": [
      {
        "deviceKey": "Codec-1",
        "joinStart": 1
      }
    ]
  }
}

Console commands

• devjson {"deviceKey":"Codec-1-ssh","methodName":"SendText", "params": ["xStatus SystemUnit\n"]}
  • Invoke a method on the device. The example here can be used to send the xStatus SystemUnit command directly to the device
• devmethods {deviceKey}
  • Get a list of methods to use with the devjson command
  • {deviceKey} - device key to get the methods for
• setdevicestreamdebug {deviceKey} {Off|Both|Tx|Rx}
  • Turn on comm-level (ssh, tcp, serial) debugging messages
  • {deviceKey} - Device key to turn on comm debugging for. Should be the actual connection device, usually the standard key name with -ssh appended
  • {Off|Both|Tx|Rx} - Direction to turn on debugging for
    • Off - Logging will be turned off
    • Tx - Commands sent to the device will be logged
    • Rx - Reponsees from the device will be logged
    • Both - Commands and responses will be logged
• setcodeccommdebug {1 | 0}
  • Turn on device-level communications debugging. In order to see thes messages, the appdebug 1 command must be sent
  • {1 | 0} - 1 turns debuggging on, 0 turns it off