all files / lib/lifx/ utils.js

99.14% Statements 115/116
95.45% Branches 42/44
100% Functions 17/17
100% Lines 111/111
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287    122×                   12×                               46× 46×   46×     46× 376× 376×     46×                                                         40× 40×                 28× 15× 13×       28×   28×                                                                               17×   16× 16×   15× 15×     13× 13× 13×   13×     13×                       18×               18×                 16× 16× 16× 16× 16×   16× 16× 16×     16× 16× 11×         16×     16× 16×     16× 16×   11×   16×   16×                   33×                    
'use strict';
 
function _toConsumableArray(arr) { Eif (Array.isArray(arr)) { for (var i = 0, arr2 = Array(arr.length); i < arr.length; i++) { arr2[i] = arr[i]; } return arr2; } else { return Array.from(arr); } }
 
var os = require('os');
 
var _require = require('../lifx'),
    constants = _require.constants;
 
var productDetailList = require('./products.json');
var utils = exports;
 
/**
 * Return all ip addresses of the machine
 * @return {Array} list containing ip address info
 */
utils.getHostIPs = function () {
  var ips = [];
  var ifaces = os.networkInterfaces();
  Object.keys(ifaces).forEach(function (ifname) {
    ifaces[ifname].forEach(function (iface) {
      ips.push(iface.address);
    });
  });
  return ips;
};
 
/**
 * Generates a random hex string of the given length
 * @example
 * // returns something like 8AF1
 * utils.getRandomHexString(4)
 * @example
 * // returns something like 0D41C8AF
 * utils.getRandomHexString()
 * @param  {Number} [length=8] string length to generate
 * @return {String}            random hex string
 */
utils.getRandomHexString = function (length) {
  var string = '';
  var chars = '0123456789ABCDEF';
 
  if (!length) {
    length = 8;
  }
 
  for (var i = 0; i < length; i++) {
    var randomNumber = Math.floor(Math.random() * chars.length);
    string += chars.substring(randomNumber, randomNumber + 1);
  }
 
  return string;
};
 
/**
 * Reads a little-endian unsigned 64-bit value and returns it as buffer
 * This function exists for easy replacing if a native method will be provided
 * by node.js and does not make sense like is
 * @param  {Buffer} buffer buffer to read from
 * @param  {Number} offset offset to begin reading from
 * @return {Buffer}        resulting 64-bit buffer
 */
utils.readUInt64LE = function (buffer, offset) {
  return buffer.slice(offset, offset + 8);
};
 
/**
 * Writes a 64-bit value provided as buffer and returns the result
 * This function exists for easy replacing if a native method will be provided
 * by node.js and does not make sense like is
 * @param  {Buffer} buffer buffer to write from
 * @param  {Number} offset offset to begin reading from
 * @param  {Buffer} input  the buffer to write
 * @return {Buffer}        resulting 64-bit buffer
 */
utils.writeUInt64LE = function (buffer, offset, input) {
  return input.copy(buffer, offset, 0, 8);
};
 
/**
 * Validates a given ip address is IPv4 format
 * @param  {String} ip IP address to validate
 * @return {Boolean}   is IPv4 format?
 */
utils.isIpv4Format = function (ip) {
  var ipv4Regex = /^(\d{1,3}\.){3}\d{1,3}$/;
  return ipv4Regex.test(ip);
};
 
/**
 * set any val to a number by the given default
 * @param {any} val given value
 * @param {Number} def given default
 * @return {Number} the 16bit number
 */
utils.to16Bitnumber = function (val, def) {
  if (typeof val !== 'number') {
    if (typeof def === 'number') {
      val = def;
    } else {
      val = 0;
    }
  }
  if (val < 0) {
    val = -1 * val + 0x10000;
  }
  return val & 0xffff;
};
 
/**
 * Checks validity of color to be an HSBK Value
 * This updates HSBK to defaults
 * @param {Object} color value
 * @param {Number} color.hue value
 * @param {Number} color.saturation value
 * @param {Number} color.brightness value
 * @param {Number} color.kelvin value
 * @return {Object} HSBK value
 */
utils.toColorHsbk = function (color) {
  if (typeof color !== 'object') {
    throw new TypeError('LIFX util toColorHsbk expects colors to be an object');
  }
  return {
    hue: utils.to16Bitnumber(color.hue, 0x8000),
    saturation: utils.to16Bitnumber(color.saturation, 0x8000),
    brightness: utils.to16Bitnumber(color.brightness, 0x8000),
    kelvin: utils.to16Bitnumber(color.kelvin, constants.HSBK_DEFAULT_KELVIN)
  };
};
 
/**
 * Checks validity of colors array containing HSBK
 * This updates HSBK values to defaults
 * @param {array} colors of HSBK values
 * @param {Number} size if set array has to have size
 * @return {array} colors array by the given size
 */
utils.buildColorsHsbk = function (colors, size) {
  var _this = this;
 
  if (!Array.isArray(colors)) {
    throw new TypeError('LIFX util buildColorsHsbk expects colors to be an array');
  }
  if (typeof size !== 'number') {
    size = 0;
  }
  return new Array(size).fill(undefined).map(function (_, idx) {
    return _this.toColorHsbk(colors[idx] || {});
  });
};
 
/**
 * Converts an RGB Hex string to an object with decimal representations
 * @example rgbHexStringToObject('#FF00FF')
 * @param {String} rgbHexString hex value to parse, with leading #
 * @return {Object}             object with decimal values for r, g, b
 */
utils.rgbHexStringToObject = function (rgbHexString) {
  if (typeof rgbHexString !== 'string') {
    throw new TypeError('LIFX util rgbHexStringToObject expects first parameter to be a string');
  }
  var hashChar = rgbHexString.substr(0, 1);
  if (hashChar !== '#') {
    throw new RangeError('LIFX util rgbHexStringToObject expects hex parameter with leading \'#\' sign');
  }
  var pureHex = rgbHexString.substr(1);
  if (pureHex.length !== 6 && pureHex.length !== 3) {
    throw new RangeError('LIFX util rgbHexStringToObject expects hex value parameter to be 3 or 6 chars long');
  }
 
  var r = void 0;
  var g = void 0;
  var b = void 0;
 
  if (pureHex.length === 6) {
    r = pureHex.substring(0, 2);
    g = pureHex.substring(2, 4);
    b = pureHex.substring(4, 6);
  } else Eif (pureHex.length === 3) {
    r = pureHex.substring(0, 1);
    r += r;
    g = pureHex.substring(1, 2);
    g += g;
    b = pureHex.substring(2, 3);
    b += b;
  }
 
  return {
    r: parseInt(r, 16),
    g: parseInt(g, 16),
    b: parseInt(b, 16)
  };
};
 
/**
 * find mininum number in an array
 * @param {Array} array of numbers
 * @return {Number} minium of the given array
 */
utils.minNumberInArray = function (array) {
  return Math.min.apply(Math, _toConsumableArray(array));
};
 
/**
 * find maxinum number in an array
 * @param {Array} array of numbers
 * @return {Number} maxinum of the given array
 */
utils.maxNumberInArray = function (array) {
  return Math.max.apply(Math, _toConsumableArray(array));
};
 
/**
 * Converts an object with r,g,b integer values to an
 * hsb integer object
 * @param {Object} rgbObj object with r,g,b keys and values
 * @return {Object} hsbObj object with h,s,b keys and converted values
 */
utils.rgbToHsb = function (rgbObj) {
  var red = rgbObj.r / constants.RGB_MAXIMUM_VALUE;
  var green = rgbObj.g / constants.RGB_MAXIMUM_VALUE;
  var blue = rgbObj.b / constants.RGB_MAXIMUM_VALUE;
  var rgb = [red, green, blue];
  var hsb = {};
 
  var max = utils.maxNumberInArray(rgb);
  var min = utils.minNumberInArray(rgb);
  var c = max - min;
 
  // https://en.wikipedia.org/wiki/HSL_and_HSV#Hue_and_chroma
  var hue = void 0;
  if (c === 0) {
    hue = 0;
  } else if (max === red) {
    hue = (green - blue) / c;
    if (hue < 0) {
      hue += 6;
    }
  } else if (max === green) {
    hue = 2 + (blue - red) / c;
  } else {
    // max === blue
    hue = 4 + (red - green) / c;
  }
  hsb.h = Math.round(60 * hue);
 
  // https://en.wikipedia.org/wiki/HSL_and_HSV#Lightness
  var lightness = max;
  hsb.b = Math.round(lightness * 100);
 
  // https://en.wikipedia.org/wiki/HSL_and_HSV#Saturation
  var saturation = void 0;
  if (c === 0) {
    saturation = 0;
  } else {
    saturation = c / lightness;
  }
  hsb.s = Math.round(saturation * 100);
 
  return hsb;
};
 
/**
 * Get's product and vendor details for the given id's
 * hsb integer object
 * @param {Number} vendorId id of the vendor
 * @param {Number} productId id of the product
 * @return {Object|Boolean} product and details vendor details or false if not found
 */
utils.getHardwareDetails = function (vendorId, productId) {
  for (var i = 0; i < productDetailList.length; i += 1) {
    if (productDetailList[i].vid === vendorId) {
      for (var j = 0; j < productDetailList[i].products.length; j += 1) {
        if (productDetailList[i].products[j].pid === productId) {
          return {
            vendorName: productDetailList[i].name,
            productName: productDetailList[i].products[j].name,
            productFeatures: productDetailList[i].products[j].features
          };
        }
      }
    }
  }
 
  return false;
};