From ca6d2340d569134682aa9555633089061ec40120 Mon Sep 17 00:00:00 2001
From: Neil Dorin <ndorin@pepperdash.com>
Date: Wed, 22 Jan 2020 10:42:23 -0700
Subject: [PATCH] Updates to schemas

---
 .../Schema/ControlPropertiesConfigSchema.json | 108 +++++++++++++++++-
 .../Schema/TcpSshPropertiesConfigSchema.json  |  15 ++-
 2 files changed, 111 insertions(+), 12 deletions(-)

diff --git a/Pepperdash Core/Pepperdash Core/Comm/Schema/ControlPropertiesConfigSchema.json b/Pepperdash Core/Pepperdash Core/Comm/Schema/ControlPropertiesConfigSchema.json
index ec74fc9..b2cc61a 100644
--- a/Pepperdash Core/Pepperdash Core/Comm/Schema/ControlPropertiesConfigSchema.json	
+++ b/Pepperdash Core/Pepperdash Core/Comm/Schema/ControlPropertiesConfigSchema.json	
@@ -5,6 +5,7 @@
   "$ref": "#/definitions/ControlPropertiesConfig",
   "definitions": {
     "ControlPropertiesConfig": {
+      "description": "The method of communicating with the device",
       "properties": {
         "method": {
           "type": "string",
@@ -28,33 +29,128 @@
           "title": "Properties for IP based communication",
           "default": null
         },
-        "comm": {
-
+        "comParams": {
+          "title":"Com Port parameters",
+          "description": "The parameters to configure the COM port",
+          "protocol":{
+            "title":"Protocol",
+            "type":"string",
+            "enum":[
+              "RS232",
+              "RS422",
+              "RS485"
+            ]
+          },
+          "baudRate":{
+            "title":"Baud Rate",
+            "type":"integer",
+            "enum":[
+              300,
+              600,
+              1200,
+              1800,
+              2400,
+              3600,
+              4800,
+              7200,
+              9600,
+              14400,
+              19200,
+              28800,
+              38400,
+              57600,
+              115200
+            ]
+          },
+          "dataBits":{
+            "title":"Data Bits",
+            "type":"integer",
+            "enum":[
+              7,
+              8
+            ]
+          },
+          "stopBits":{
+            "title":"Stop Bits",
+            "type":"integer",
+            "enum":[
+              1,
+              2
+            ]
+          },
+          "parity":{
+            "title":"Parity",
+            "type":"string",
+            "enum":[
+              "None",
+              "Even",
+              "One"
+            ]
+          },
+          "softwareHandshake":{
+            "title":"Software Handshake",
+            "type":"string",
+            "enum":[
+              "None",
+              "RTS",
+              "CTS",
+              "RTSCTS"
+            ]
+          },
+          "hardwareHandshake":{
+            "title":"Hardware Handshake",
+            "type":"string",
+            "enum":[
+              "None",
+              "XON",
+              "XONT",
+              "XONR"
+            ]
+          },
+          "pacing":{
+            "title":"Pacing",
+            "type":"integer"
+          }
+        },
+        "cresnetId":{
+          "type": "string",
+          "title":"Cresnet ID",
+          "description": "Cresnet ID of the device",
+          "default": "",
+          "examples": [
+            "13",
+            "03",
+            "0A",
+            "F1"
+          ],
+          "pattern": "^(?!00|01|02|FF)[0-9,A-F,a-f][0-9,A-F,a-f]$"
         },
         "controlPortDevKey": {
           "type": "string",
-          "title": "Key of the device where the control port is found",
+          "title":"Port Device",
+          "description": "Key of the device where the control port is found",
           "examples": [
             "processor"
           ]
         },
         "controlPortNumber": {
           "type": "integer",
-          "title": "Control Port Number on the device referenced by controlPortDevKey",
+          "description": "Control Port Number on the device referenced by controlPortDevKey",
           "examples": [
             1
           ]
         },
         "controlPortName": {
           "type": "string",
-          "title": "Control Port Name on the device referenced by controlPortDevKey",
+          "description": "Control Port Name on the device referenced by controlPortDevKey",
           "examples": [
             "hdmi1"
           ]
         },
         "irFile": {
           "type": "string",
-          "title": "IR Filename",
+          "title": "IR File",
+          "description": "IR Filename",
           "default": "",
           "examples": [
             "Comcast Motorola DVR.ir"
diff --git a/Pepperdash Core/Pepperdash Core/Comm/Schema/TcpSshPropertiesConfigSchema.json b/Pepperdash Core/Pepperdash Core/Comm/Schema/TcpSshPropertiesConfigSchema.json
index 60d278f..118e4ba 100644
--- a/Pepperdash Core/Pepperdash Core/Comm/Schema/TcpSshPropertiesConfigSchema.json	
+++ b/Pepperdash Core/Pepperdash Core/Comm/Schema/TcpSshPropertiesConfigSchema.json	
@@ -1,14 +1,14 @@
 {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "type": "object",
-    "title": "ControlPropertiesConfig",
+    "title": "TcpSshPropertiesConfig",
     "$ref": "#/definitions/TcpSshPropertiesConfig",
     "definitions": {
         "TcpSshPropertiesConfig": {
             "properties": {
                 "username": {
                     "type": "string",
-                    "title": "Username Credential",
+                    "title": "Username",
                     "default":"",
                     "examples": [
                         "admin"
@@ -28,7 +28,7 @@
                 },
                 "address": {
                     "type": "string",
-                    "title": "IP address or hostname",
+                    "title": "IP Address or Hostname",
                     "examples": [
                         "192.168.99.100",
                         "myDeviceHostname"
@@ -37,7 +37,7 @@
                 },
                 "password": {
                     "type": "string",
-                    "title": "Password Credential",
+                    "title": "Password",
                     "default":"",
                     "examples": [
                         "password"
@@ -47,6 +47,7 @@
                 "autoReconnect": {
                     "type": "boolean",
                     "title": "Auto Reconnect",
+                    "description": "Indicates if automatic attemtps to reconnect should be made if communication is lost with the device",
                     "default": true,
                     "examples": [
                         true
@@ -54,7 +55,8 @@
                 },
                 "autoReconnectIntervalMs": {
                     "type": "integer",
-                    "title": "Auto Reconnect Interval in Ms",
+                    "title": "Auto Reconnect Interval (Milliseconds)",
+                    "description": "If Auto Reconnect is enabled, how often should reconnect attempts be made",
                     "default": 5000,
                     "examples": [
                         2000
@@ -62,7 +64,8 @@
                 },
                 "bufferSize": {
                     "type": "integer",
-                    "title": "Receive Buffer Size",
+                    "title": "Buffer Size",
+                    "description": "The size of the receive buffer to use",
                     "default": 32768,
                     "examples": [
                         32768