lifx-lan-client

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/lifx/packet.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="../../prettify.css" /> <link rel="stylesheet" href="../../base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(../../sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="../../index.html">all files</a> / <a href="index.html">lib/lifx/</a> packet.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 93.43% Statements 128/137 </div> <div class='fl pad1y space-right2'> 74.71% Branches 65/87 </div> <div class='fl pad1y space-right2'> 100% Functions 5/5 </div> <div class='fl pad1y space-right2'> 93.43% Lines 128/137 </div> </div> </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">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 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311</td><td class="line-coverage quiet">    1×       1×   1×                                               1×           1×                                                     1× 6× 6×     6× 6×   6× 6× 6× 6× 6× 6×   6× 6×     6× 6×   6× 6×   6× 6× 6×   6× 5× 5× 5×   5× 5×     5× 5×   5× 5×   5× 5×   5×               1× 2×     2× 2×     1×     1× 1× 1× 1×             1×               1× 53× 53× 53×     53× 53×   53× 50×   53×   53×   53× 53×     53× 8×     53×   1×     53× 53×   53× 53× 52×   1×     52×     52× 42×   52×     52×   52× 1×   52×   52× 52× 11×     52×     52× 52×   52× 51×   52×     52× 1×   52×   52× 1× 51× 51×   52× 1×   51× 51×     51×   51×               1× 53×   53× 53×         53× 53× 35× 31×   18×                               1× 60× 60×   60× 59× 1× 1× 1× 1×   60×           60×   60× 60×   60× 10×   60× 8×     60×     1×</td><td class="text"><pre class="prettyprint lang-js">'use strict';   var _require = require('../lifx'), constants = _require.constants, utils = _require.utils;   var packets = require('./packets');   var _require2 = require('lodash'), result = _require2.result, find = _require2.find, extend = _require2.extend, assign = _require2.assign;   /* Package headers 36 bit in total consisting of size - 2 bit frameDescription - 2 bit   source - 4 bit target - 6 bit 00 00 - site - 6 bit   frameAddressDescription - 1 bit sequence - 1 bit time - 8 bit type - 2 bit 00 00 */     var Packet = {};   /** * Mapping for types * @type {Array} */ Packet.typeList = [{ id: 2, name: 'getService' }, { id: 3, name: 'stateService' }, { id: 12, name: 'getHostInfo' }, { id: 13, name: 'stateHostInfo' }, { id: 14, name: 'getHostFirmware' }, { id: 15, name: 'stateHostFirmware' }, { id: 16, name: 'getWifiInfo' }, { id: 17, name: 'stateWifiInfo' }, { id: 18, name: 'getWifiFirmware' }, { id: 19, name: 'stateWifiFirmware' }, // {id: 20, name: 'getPower'}, // These are for device level // {id: 21, name: 'setPower'}, // and do not support duration value // {id: 22, name: 'statePower'}, // since that we don't use them { id: 23, name: 'getLabel' }, { id: 24, name: 'setLabel' }, { id: 25, name: 'stateLabel' }, { id: 32, name: 'getVersion' }, { id: 33, name: 'stateVersion' }, { id: 34, name: 'getInfo' }, { id: 35, name: 'stateInfo' }, { id: 38, name: 'rebootRequest' }, { id: 43, name: 'rebootResponse' }, { id: 45, name: 'acknowledgement' }, { id: 48, name: 'getLocation' }, { id: 50, name: 'stateLocation' }, { id: 51, name: 'getGroup' }, { id: 53, name: 'stateGroup' }, { id: 54, name: 'getOwner' }, { id: 56, name: 'stateOwner' }, { id: 58, name: 'echoRequest' }, { id: 59, name: 'echoResponse' }, // {id: 60, name: 'getStatistic'}, // {id: 61, name: 'stateStatistic'}, { id: 101, name: 'getLight' }, { id: 102, name: 'setColor' }, { id: 103, name: 'setWaveform' }, { id: 107, name: 'stateLight' }, { id: 110, name: 'getTemperature' }, { id: 111, name: 'stateTemperature' }, // {id: 113, name: 'setSimpleEvent'}, // {id: 114, name: 'getSimpleEvent'}, // {id: 115, name: 'stateSimpleEvent'}, { id: 116, name: 'getPower' }, { id: 117, name: 'setPower' }, { id: 118, name: 'statePower' }, // {id: 119, name: 'setWaveformOptional'}, { id: 120, name: 'getInfrared' }, { id: 121, name: 'stateInfrared' }, { id: 122, name: 'setInfrared' }, { id: 401, name: 'getAmbientLight' }, { id: 402, name: 'stateAmbientLight' }, // {id: 403, name: 'getDimmerVoltage'}, // {id: 404, name: 'stateDimmerVoltage'}, { id: 501, name: 'setColorZones' }, { id: 502, name: 'getColorZones' }, { id: 503, name: 'stateZone' }, { id: 504, name: 'getCountZone' }, { id: 505, name: 'stateCountZone' }, { id: 506, name: 'stateMultiZone' }, // {id: 507, name: 'getEffectZone'}, { id: 508, name: 'setMultiZoneEffect' // {id: 509, name: 'stateEffectZone'} }];   /** * Parses a lifx packet header * @param {Buffer} buf Buffer containg lifx packet including header * @return {Object} parsed packet header */ Packet.headerToObject = function (buf) { var obj = {}; var offset = 0;   // Frame obj.size = buf.readUInt16LE(offset); offset += 2;   var frameDescription = buf.readUInt16LE(offset); obj.addressable = (frameDescription & constants.ADDRESSABLE_BIT) !== 0; obj.tagged = (frameDescription & constants.TAGGED_BIT) !== 0; obj.origin = (frameDescription & constants.ORIGIN_BITS) >> 14 !== 0; obj.protocolVersion = frameDescription & constants.PROTOCOL_VERSION_BITS; offset += 2;   obj.source = buf.toString('hex', offset, offset + 4); offset += 4;   // Frame address obj.target = buf.toString('hex', offset, offset + 6); offset += 6;   obj.reserved1 = buf.slice(offset, offset + 2); offset += 2;   obj.site = buf.toString('utf8', offset, offset + 6); obj.site = obj.site.replace(/\0/g, ''); offset += 6;   var frameAddressDescription = buf.readUInt8(offset); obj.ackRequired = (frameAddressDescription & constants.ACK_REQUIRED_BIT) !== 0; obj.resRequired = (frameAddressDescription & constants.RESPONSE_REQUIRED_BIT) !== 0; offset += 1;   obj.sequence = buf.readUInt8(offset); offset += 1;   // Protocol header obj.time = utils.readUInt64LE(buf, offset); offset += 8;   obj.type = buf.readUInt16LE(offset); offset += 2;   obj.reserved2 = buf.slice(offset, offset + 2); offset += 2;   return obj; };   /** * Parses a lifx packet * @param {Buffer} buf Buffer with lifx packet * @return {Object} parsed packet */ Packet.toObject = function (buf) { var obj = {};   // Try to read header of packet try { obj = this.headerToObject(buf); } catch (err) { // If this fails return with error return err; }   Eif (obj.type !== undefined) { var typeName = result(find(this.typeList, { id: obj.type }), 'name'); Eif (packets[typeName] !== undefined) { Iif (typeof packets[typeName].toObject === 'function') { var specificObj = packets[typeName].toObject(buf.slice(constants.PACKET_HEADER_SIZE)); obj = extend(obj, specificObj); } } }   return obj; };   /** * Creates a lifx packet header from a given object * @param {Object} obj Object containg header configuration for packet * @return {Buffer} packet header buffer */ Packet.headerToBuffer = function (obj) { var buf = Buffer.alloc(36); buf.fill(0); var offset = 0;   // Frame buf.writeUInt16LE(obj.size, offset); offset += 2;   if (obj.protocolVersion === undefined) { obj.protocolVersion = constants.PROTOCOL_VERSION_CURRENT; } var frameDescription = obj.protocolVersion;   Iif (obj.addressable !== undefined && obj.addressable === true) { frameDescription |= constants.ADDRESSABLE_BIT; } else Eif (obj.source !== undefined && obj.source.length > 0 && obj.source !== '00000000') { frameDescription |= constants.ADDRESSABLE_BIT; }   if (obj.tagged !== undefined && obj.tagged === true) { frameDescription |= constants.TAGGED_BIT; }   if (obj.origin !== undefined && obj.origin === true) { // 0 or 1 to the 14 bit frameDescription |= 1 << 14; }   buf.writeUInt16LE(frameDescription, offset); offset += 2;   Eif (obj.source !== undefined && obj.source.length > 0) { if (obj.source.length === 8) { buf.write(obj.source, offset, 4, 'hex'); } else { throw new RangeError('LIFX source must be given in 8 characters'); } } offset += 4;   // Frame address if (obj.target !== undefined && obj.target !== null) { buf.write(obj.target, offset, 6, 'hex'); } offset += 6;   // reserved1 offset += 2;   if (obj.site !== undefined && obj.site !== null) { buf.write(obj.site, offset, 6, 'utf8'); } offset += 6;   var frameAddressDescription = 0; if (obj.ackRequired !== undefined && obj.ackRequired === true) { frameAddressDescription |= constants.ACK_REQUIRED_BIT; }   Iif (obj.resRequired !== undefined && obj.resRequired === true) { frameAddressDescription |= constants.RESPONSE_REQUIRED_BIT; } buf.writeUInt8(frameAddressDescription, offset); offset += 1;   if (typeof obj.sequence === 'number') { buf.writeUInt8(obj.sequence, offset); } offset += 1;   // Protocol header if (obj.time !== undefined) { utils.writeUInt64LE(buf, offset, obj.time); } offset += 8;   if (typeof obj.type === 'number') { obj.type = result(find(this.typeList, { id: obj.type }), 'id'); } else Eif (typeof obj.type === 'string' || obj.type instanceof String) { obj.type = result(find(this.typeList, { name: obj.type }), 'id'); } if (obj.type === undefined) { throw new Error('Unknown lifx packet of type: ' + obj.type); } buf.writeUInt16LE(obj.type, offset); offset += 2;   // reserved2 offset += 2;   return buf; };   /** * Creates a packet from a configuration object * @param {Object} obj Object with configuration for packet * @return {Buffer|Boolean} the packet or false in case of error */ Packet.toBuffer = function (obj) { Eif (obj.type !== undefined) { // Map id to string if needed Eif (typeof obj.type === 'number') { obj.type = result(find(this.typeList, { id: obj.type }), 'name'); } else if (typeof obj.type === 'string' || obj.type instanceof String) { obj.type = result(find(this.typeList, { name: obj.type }), 'name'); }   Eif (obj.type !== undefined) { if (typeof packets[obj.type].toBuffer === 'function') { var packetTypeData = packets[obj.type].toBuffer(obj); return Buffer.concat([this.headerToBuffer(obj), packetTypeData]); } return this.headerToBuffer(obj); } }   return false; };   /** * Creates a new packet by the given type * Note: This does not validate the given params * @param {String|Number} type the type of packet to create as number or string * @param {Object} params further settings to pass * @param {String} [source] the source of the packet, length 8 * @param {String} [target] the target of the packet, length 12 * @return {Object} The prepared packet object including header */ Packet.create = function (type, params, source, target) { var obj = {}; Eif (type !== undefined) { // Check if type is valid if (typeof type === 'string' || type instanceof String) { obj.type = result(find(this.typeList, { name: type }), 'id'); } else Eif (typeof type === 'number') { var typeMatch = find(this.typeList, { id: type }); obj.type = result(typeMatch, 'id'); type = result(typeMatch, 'name'); } Iif (obj.type === undefined) { return false; } } else { return false; } obj.size = constants.PACKET_HEADER_SIZE + packets[type].size;   Eif (source !== undefined) { obj.source = source; } if (target !== undefined) { obj.target = target; } if (packets[type].tagged !== undefined) { obj.tagged = packets[type].tagged; }   return assign(obj, params); };   module.exports = Packet;</pre></td></tr> </table></pre> <div class='push'></div> </div> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Wed Apr 15 2020 17:31:34 GMT+0300 (Eastern European Summer Time) </div> </div> <script src="../../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../../sorter.js"></script> </body> </html>