J_CaddxNX584SerialConnection.js

/*
 * Generic serial-port setup tab
 * for devices which talk to a serial port directly attached to Vera
 * or which can open a TCP socket to an IPv4 host.
 *
 * How to use this tab in your plugin:
 *
 * 1. In your static JSON file, define a tab like this:
 * {
 *   "Label": { 
 *     "lang_tag": "connection", 
 *     "text": "Connection" 
 *   }, 
 *   "Position": "1", 
 *   "TabType": "javascript",
 *   "ScriptName": "J_SerialConnection.js",
 *   "Function": "serialConnection"
 * },
 *
 * 2. In your Lua code startup function:
 *    - Check for the "urn:micasaverde-com:serviceId:HaDevice1"/"IODevice" variable.
 *      If set and not empty, this means a "local" serial port has been assigned by
 *      the user (it may be IPSerial or a physical serial port).  Do nothing more.
 *    - Check for the "ip" special variable.
 *      If set and of the form "1.1.1.1:123", this means a TCP socket to an IPv4 host
 *      on the specified port should be opened using luup.io.open().
 *      If set and of the form "1.1.1.1", this means that the TCP port is a "default"
 *      value, which may mean something useful or not, depending on the plugin.
 *      If your plugin's implementation uses <ioPort> then Luup may open a
 *      connection for you anyway.  Use luup.io.open(), do nothing, or signal an error.
 *      Other forms are reserved (for IPv6 or named hosts).
 *    - If neither is set, return false from the startup to signal an error.
 *
 * Copyright 2012 Deborah Pickett (futzle)
 * This is free software and may be used under GPLv2 or BSD licences.
 */

var numberPattern255 = "(\\d|[1-9]\\d|1\\d\\d|2[0-4]\\d|25[0-5])";
var numberPattern65535 = "(\\d|[1-9]\\d|[1-9]\\d\\d|[1-9]\\d\\d\\d|[1-5]\\d\\d\\\d\\d|6[0-4]\\d\\d\\d|65[0-4]\\d\\d|655[0-2]\\d|6553[0-5])";
var ipv4Pattern = new RegExp("^" + numberPattern255 + "\\." 
  + numberPattern255 + "\\." + numberPattern255 + "\\." + numberPattern255 + "$");
var ipv4PortPattern = new RegExp("^(" + numberPattern255 + "\\." 
  + numberPattern255 + "\\." + numberPattern255 + "\\." + numberPattern255 + "):("
  + numberPattern65535 + ")$");

var entityMap = {
  "&": "&amp;",
  "<": "&lt;",
  ">": "&gt;",
  '"': '&quot;',
  "'": '&#39;',
  "/": '&#x2F;'
};

function escapeHtml(string) {
  return String(string).replace(/[&<>"'\/]/g, function (s) {
    return entityMap[s];
  });
}

function getConnectionType(deviceId)
{
  var ioDevice = get_device_state(deviceId, "urn:micasaverde-com:serviceId:HaDevice1", "IODevice", 0);
  var ipDevice = jQuery.grep(jsonp.ud.devices, function(o, i) { return o.id == deviceId; })[0];
  if (ioDevice != undefined && ioDevice != "") { return "ioDevice"; }
  if (ipDevice != undefined)
  {
    if (ipDevice.ip != "")
    {
      return "ip";
    }
  }
  return "none";
}

/* Get a list of all serial devices. */
function getSerialDevices(deviceId)
{
  return jQuery.grep(jsonp.ud.devices, function(d) {
    return d.device_type == "urn:micasaverde-org:device:SerialPort:1";
  } );
}

/* Find the device which has the given device ID
   as its "IODevice" variable.  This is the device
   that "owns" the given serial device. */
function getDeviceOfSerialDevice(serialDeviceId)
{
  var matches = jQuery.grep(jsonp.ud.devices, function(d) {
    return jQuery.grep(d.states, function(state) {
      return state.service == "urn:micasaverde-com:serviceId:HaDevice1" &&
        state.variable == "IODevice" &&
        state.value == serialDeviceId;
    } ).length > 0;
  } );
  if (matches.length > 0) { return matches[0]; }
  return undefined;
}

/* Get the IP address, coded in the ip special variable. */
function getIpAddress(deviceId)
{
  var ipDevice = jQuery.grep(jsonp.ud.devices, function(o, i) { return o.id == deviceId; })[0];
  var ip = ipDevice.ip;
  if (ip == undefined) { return undefined; }
  if (ip == "") { return undefined; }
  if (ipv4Pattern.test(ip)) { return ip; }
  var ipv4Match = ipv4PortPattern.exec(ip);
  if (ipv4Match != undefined) { return ipv4Match[1]; }
  return undefined;
}

/* Get the TCP port, coded in the ip special variable. */
function getTcpPort(deviceId)
{
  var ipDevice = jQuery.grep(jsonp.ud.devices, function(o, i) { return o.id == deviceId; })[0];
  var ip = ipDevice.ip;
  if (ip == undefined) { return undefined; }
  if (ip == "") { return undefined; }
  if (ipv4Pattern.test(ip)) { return undefined; }
  var ipv4Match = ipv4PortPattern.exec(ip);
  if (ipv4Match != undefined) { return ipv4Match[6]; }
  return undefined;
}

/* Mess with the DOM to disable parts of the UI. */
function enableSelectedOption(deviceId, currentConnectionType, ownedSerialDeviceId)
{
  jQuery('#serialDevice').get(0).disabled = true;
  jQuery('#serialSpeed').get(0).disabled = true;
  jQuery('#serialData').get(0).disabled = true;
  jQuery('#serialParity').get(0).disabled = true;
  jQuery('#serialStop').get(0).disabled = true;
  jQuery('#ipaddress').get(0).disabled = true;
  jQuery('#tcpport').get(0).disabled = true;

  if (currentConnectionType == "ioDevice")
  {
    jQuery('#serialDevice').get(0).disabled = false;
    if (ownedSerialDeviceId != undefined && ownedSerialDeviceId != "")
    {
      var serialSpeed = get_device_state(ownedSerialDeviceId, "urn:micasaverde-org:serviceId:SerialPort1", "baud", 0);
      if (serialSpeed == undefined || serialSpeed == "") serialSpeed = "9600";  // Default
      jQuery('#serialSpeed').val(serialSpeed).get(0).disabled = false;
      var serialData = get_device_state(ownedSerialDeviceId, "urn:micasaverde-org:serviceId:SerialPort1", "databits", 0);
      if (serialData == undefined || serialData == "") serialData = "8";  // Default
      jQuery('#serialData').val(serialData).get(0).disabled = false;
      var serialParity = get_device_state(ownedSerialDeviceId, "urn:micasaverde-org:serviceId:SerialPort1", "parity", 0);
      if (serialParity == undefined || serialParity == "") serialParity = "none";  // Default
      jQuery('#serialParity').val(serialParity).get(0).disabled = false;
      var serialStop = get_device_state(ownedSerialDeviceId, "urn:micasaverde-org:serviceId:SerialPort1", "stopbits", 0);
      if (serialStop == undefined || serialStop == "") serialStop = "1";  // Default
      jQuery('#serialStop').val(serialStop).get(0).disabled = false;
    }
  }
  if (currentConnectionType == "ip")
  {
    jQuery('#ipaddress').get(0).disabled = false;
    jQuery('#tcpport').get(0).disabled = false;
  }
}

/* Set the IODevice variable, when
   the radio button for "serial port" is selected,
   or when the dropdown changes. */
function setSerialDevice(deviceId, serialDeviceId)
{
  set_device_state(deviceId, "urn:micasaverde-com:serviceId:HaDevice1", "IODevice", serialDeviceId, 0);
  var ipDevice = jQuery.grep(jsonp.ud.devices, function(o, i) { return o.id == deviceId; })[0];
  ipDevice.ip = "";
  enableSelectedOption(deviceId, "ioDevice", serialDeviceId);
}

/* Set the IODevice serial properties (speed, parity, etc.). */
function setSerialProperties(deviceId, serialDeviceId)
{
  set_device_state(serialDeviceId, "urn:micasaverde-org:serviceId:SerialPort1", "baud", jQuery('#serialSpeed').val(), 0);
  set_device_state(serialDeviceId, "urn:micasaverde-org:serviceId:SerialPort1", "databits", jQuery('#serialData').val(), 0);
  set_device_state(serialDeviceId, "urn:micasaverde-org:serviceId:SerialPort1", "parity", jQuery('#serialParity').val(), 0);
  set_device_state(serialDeviceId, "urn:micasaverde-org:serviceId:SerialPort1", "stopbits", jQuery('#serialStop').val(), 0);
}

/* Set the ip special variable, when
   the radio button for "serial proxy" is selected,
   or when the two text fields change. */
function setIPDevice(deviceId, ipAddress, tcpPort)
{
  if (jQuery('#tcpport').get(0).disabled || tcpPort == undefined || tcpPort == "")
  {
    var ipDevice = jQuery.grep(jsonp.ud.devices, function(o, i) { return o.id == deviceId; })[0];
    ipDevice.ip = "";
  }
  else
  {
    var ipDevice = jQuery.grep(jsonp.ud.devices, function(o, i) { return o.id == deviceId; })[0];
    ipDevice.ip = ipAddress + ":" + tcpPort;
  }
  set_device_state(deviceId, "urn:micasaverde-com:serviceId:HaDevice1", "IODevice", "", 0);
  enableSelectedOption(deviceId, "ip", undefined);
}

/* Fetch the named file over Ajax and execute function
   f() on the resulting XML. */
function withUpnpFileName(deviceId, filename, f)
{
  new Ajax.Request("../port_3480/" + filename, {
    onSuccess : function(response) {
        return f(response.responseXML);
      }
    }
  );
}

/* Fetch the Implementation file (I_*.xml) and
   execute the function f() on the resulting XML. */
function withImplementationFile(deviceId, f)
{
  var device = jQuery.grep(jsonp.ud.devices, function(o, i) { return o.id == deviceId; })[0];
  if (device.impl_file != "")
  {
    return withUpnpFileName(deviceId, device.impl_file, f);
  }
  else
  {
    return withUpnpFileName(deviceId, device.device_file, function(doc) {
      var implementationElement = doc.querySelector("root > device > implementationList > implementationFile");
      if (implementationElement != undefined)
      {
        var implementationFile = implementationElement.textContent.trim();
        return withUpnpFileName(deviceId, implementationFile, f);
      }
    });
  }
}

/* Entry point.  This function sets the HTML for the tab. */
function serialConnection(deviceId)
{
  var currentConnectionType = getConnectionType(deviceId);
  
  var htmlResult = "<div>";
  htmlResult += "<form>";
  htmlResult += "<p>Select how the serial device is connected.</p>";

  /* Serial port (including IPSerial) */
  htmlResult += "<p><input type='radio' name='connectionType' value='serial' ";
  if (currentConnectionType == "ioDevice") htmlResult += "checked='checked' ";
  htmlResult += "onclick='setSerialDevice(" + deviceId + ",jQuery(\"#serialDevice\").val())'/>Serial port or IPSerial device ";
  htmlResult += "<select id='serialDevice' onchange='setSerialDevice(" + deviceId + ",jQuery(\"#serialDevice\").val())'>";
  htmlResult += "<option value=''>None</option>";
  var serialDevices = getSerialDevices(deviceId);
  var ownedSerialDeviceId;
  jQuery.each(serialDevices, function(i, d) {
    htmlResult += "<option value='" + d.id + "'";
    var deviceOwner = getDeviceOfSerialDevice(d.id);
    if (deviceOwner != undefined)
    {
      if (deviceId == deviceOwner.id)
      {
        // This is my serial device.
        htmlResult += " selected='selected'";
        ownedSerialDeviceId = d.id;
      }
      else
      {
        // Devices already owned by other plugins.
        htmlResult += " disabled='disabled'";
      }
    }
    htmlResult += ">" + escapeHtml(d.name);
    // Tell user who owns this device (if it's not us).
    if (deviceOwner != undefined && deviceOwner.id != deviceId)
    {
      htmlResult += " [" + escapeHtml(deviceOwner.name) + "]";
    }
    htmlResult += "</option>";
  });
  htmlResult += "</select>";
  htmlResult += "</p>";
  htmlResult += "<p style='margin-left: 4em;'>";
  htmlResult += "Speed <select id='serialSpeed' onchange='setSerialProperties(" + deviceId + ",jQuery(\"#serialDevice\").val())'><option value='300'>300</option><option value='1200'>1200</option><option value='2400'>2400</option><option value='4800'>4800</option><option value='9600'>9600</option><option value='19200'>19200</option><option value='38400'>38400</option><option value='57600'>57600</option><option value='115200'>115200</option><option value='230400'>230400</option></select>";
  htmlResult += " Data bits <select id='serialData' onchange='setSerialProperties(" + deviceId + ",jQuery(\"#serialDevice\").val())'><option value='7'>7</option><option value='8'>8</option></select>";
  htmlResult += " Parity <select id='serialParity' onchange='setSerialProperties(" + deviceId + ",jQuery(\"#serialDevice\").val())'><option value='none'>None</option><option value='even'>Even</option><option value='odd'>Odd</option></select>";
  htmlResult += " Stop bits <select id='serialStop' onchange='setSerialProperties(" + deviceId + ",jQuery(\"#serialDevice\").val())'><option value='0'>0</option><option value='1'>1</option><option value='2'>2</option></select>";
  htmlResult += "</p>";

  /* Serial proxy over Ethernet. */
  htmlResult += "<p><input type='radio' name='connectionType' value='ip' ";
  if (currentConnectionType == "ip") htmlResult += "checked='checked' ";
  htmlResult += "onclick='setIPDevice(" + deviceId + ",jQuery(\"#ipaddress\").val(),jQuery(\"#tcpport\").val())'/>Serial proxy on another machine ";
  var ipAddress = getIpAddress(deviceId);
  if (ipAddress == undefined) { ipAddress = ""; }
  htmlResult += "<p style='margin-left: 4em;'>IP address <input id='ipaddress' type='text' size='16' value='" + escapeHtml(ipAddress) + "' onchange='setIPDevice(" + deviceId + ",jQuery(\"#ipaddress\").val(),jQuery(\"#tcpport\").val())' />";
  var tcpPort = getTcpPort(deviceId);
  if (tcpPort == undefined) { tcpPort = ""; }
  htmlResult += " TCP port <input id='tcpport' type='text' size='6' value='" + escapeHtml(tcpPort) + "' onchange='setIPDevice(" + deviceId + ",jQuery(\"#ipaddress\").val(),jQuery(\"#tcpport\").val())' /></p> ";
  htmlResult += "</p>";

  htmlResult += "</form>";
  htmlResult += "</div>";
  set_panel_html(htmlResult);

  enableSelectedOption(deviceId, currentConnectionType, ownedSerialDeviceId);

  /* See if this device has an <ioPort> element.
     If so, don't let user edit the TCP port. */
  withImplementationFile(deviceId, function(doc) {
    var ioPortElement = doc.querySelector("implementation > settings > ioPort");
    if (ioPortElement != undefined)
    {
      var ioPortHardcoded = ioPortElement.textContent.trim();
      jQuery('#tcpport').val(ioPortHardcoded).get(0).disabled = true;
    }
  });
}