UNPKG

lifx-lan-client

Version:

Node.js implementation of the LIFX LAN protocol

582 lines (581 loc) 19.9 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/lifx/packets/setMultiZoneEffect.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/packets/</a> setMultiZoneEffect.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">47.3% </span> <span class="quiet">Statements</span> <span class='fraction'>35/74</span> </div> <div class='fl pad1y space-right2'> <span class="strong">42.31% </span> <span class="quiet">Branches</span> <span class='fraction'>11/26</span> </div> <div class='fl pad1y space-right2'> <span class="strong">50% </span> <span class="quiet">Functions</span> <span class='fraction'>1/2</span> </div> <div class='fl pad1y space-right2'> <span class="strong">47.3% </span> <span class="quiet">Lines</span> <span class='fraction'>35/74</span> </div> </div> </div> <div class='status-line low'></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</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-no">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes"></span></td><td class="text"><pre class="prettyprint lang-js">'use strict'; &nbsp; var _require = require('../../lifx'), constants = _require.constants; &nbsp; var Packet = { size: 59 }; &nbsp; /** * Converts packet specific data from a buffer to an object * @param {Buffer} buf Buffer containing only packet specific data no header * @return {Object} Information contained in packet */ Packet.toObject = <span class="fstat-no" title="function not covered" >function (buf) {</span> <span class="cstat-no" title="statement not covered" > var obj = {};</span> <span class="cstat-no" title="statement not covered" > var offset = 0;</span> &nbsp; <span class="cstat-no" title="statement not covered" > if (buf.length !== this.size) {</span> <span class="cstat-no" title="statement not covered" > throw new Error('Invalid length given for setMultiZoneEffect LIFX packet');</span> } &nbsp; <span class="cstat-no" title="statement not covered" > obj.instanceId = buf.readUInt32LE(offset);</span> <span class="cstat-no" title="statement not covered" > offset += 4;</span> &nbsp; <span class="cstat-no" title="statement not covered" > obj.effectType = buf.readUInt8(offset);</span> <span class="cstat-no" title="statement not covered" > offset += 1;</span> &nbsp; // skip reserved field UInt16LE <span class="cstat-no" title="statement not covered" > offset += 2;</span> &nbsp; <span class="cstat-no" title="statement not covered" > obj.speed = buf.readUInt32LE(offset);</span> <span class="cstat-no" title="statement not covered" > offset += 4;</span> &nbsp; // FIXME: Int64 is not supported. Not giving the value makes the effect infinite // obj.duration = utils.readUInt64LE(buf, offset); // obj.duration = new Int64(buf.readUInt32LE(offset), buf.readUInt32LE(offset + 4)); <span class="cstat-no" title="statement not covered" > offset += 8;</span> &nbsp; // skip reserved field UInt32LE <span class="cstat-no" title="statement not covered" > offset += 4;</span> &nbsp; // skip reserved field UInt32LE <span class="cstat-no" title="statement not covered" > offset += 4;</span> &nbsp; // Parameters Block 8*32Bit // reserved for internal use <span class="cstat-no" title="statement not covered" > offset += 4;</span> &nbsp; <span class="cstat-no" title="statement not covered" > if (obj.type === constants.MULTIZONE_EFFECTS.indexOf('MOVE')) {</span> <span class="cstat-no" title="statement not covered" > obj.parameter2 = buf.readUInt32LE(offset);</span> <span class="cstat-no" title="statement not covered" > offset += 4;</span> // skip parameter3 <span class="cstat-no" title="statement not covered" > offset += 4;</span> // skip parameter4 <span class="cstat-no" title="statement not covered" > offset += 4;</span> // skip parameter5 <span class="cstat-no" title="statement not covered" > offset += 4;</span> // skip parameter6 <span class="cstat-no" title="statement not covered" > offset += 4;</span> // skip parameter7 <span class="cstat-no" title="statement not covered" > offset += 4;</span> // skip parameter8 <span class="cstat-no" title="statement not covered" > offset += 4;</span> } else <span class="cstat-no" title="statement not covered" >if (obj.type === constants.MULTIZONE_EFFECTS.indexOf('OFF')) {</span> // skip parameter2 <span class="cstat-no" title="statement not covered" > offset += 4;</span> // skip parameter3 <span class="cstat-no" title="statement not covered" > offset += 4;</span> // skip parameter4 <span class="cstat-no" title="statement not covered" > offset += 4;</span> // skip parameter5 <span class="cstat-no" title="statement not covered" > offset += 4;</span> // skip parameter6 <span class="cstat-no" title="statement not covered" > offset += 4;</span> // skip parameter7 <span class="cstat-no" title="statement not covered" > offset += 4;</span> // skip parameter8 <span class="cstat-no" title="statement not covered" > offset += 4;</span> } &nbsp; <span class="cstat-no" title="statement not covered" > return obj;</span> }; &nbsp; /** * Converts the given packet specific object into a packet * @param {Object} obj object with configuration data * @param {Number} obj.instanceId client identifier (set randomly) * @param {Number} obj.effectType a constants.MULTIZONE_EFFECTS * @param {Number} obj.speed speed in milliseconds for completing one animation if cyclic or for one animation frame if acyclic * @param {Number} obj.duration duration in nanosecond for how long the effect should last * @param {Number} obj.parameter2 a constants.MULTIZONE_EFFECTS_MOVE_DIRECTION if effect 'MOVE' is set * @return {Buffer} packet */ Packet.toBuffer = function (obj) { var buf = Buffer.alloc(this.size); buf.fill(0); var offset = 0; &nbsp; // instanceId is random. Could be used to identify the event later on buf.writeUInt32LE(Math.floor(Math.random() * 1000), offset); offset += 4; &nbsp; <span class="missing-if-branch" title="if path not taken" >I</span>if (obj.effectType === undefined) { <span class="cstat-no" title="statement not covered" > throw new TypeError('obj.effectType value must be given for setMultiZoneEffect LIFX packet');</span> } <span class="missing-if-branch" title="if path not taken" >I</span>if (typeof obj.effectType !== 'number' &amp;&amp; <span class="branch-1 cbranch-no" title="branch not covered" >obj.effectType &lt; 0 </span>|| obj.effectType &gt; constants.MULTIZONE_EFFECTS.length - 1) { <span class="cstat-no" title="statement not covered" > throw new RangeError('Invalid type value given for setMultiZoneEffect LIFX packet, must be a number between 0 and ' + (constants.MULTIZONE_EFFECTS.length - 1));</span> } buf.writeUInt8(obj.effectType, offset); offset += 1; &nbsp; // skip reserved field UInt16LE offset += 2; &nbsp; <span class="missing-if-branch" title="if path not taken" >I</span>if (obj.speed === undefined) { <span class="cstat-no" title="statement not covered" > throw new TypeError('obj.speed value must be given for setMultiZoneEffect LIFX packet');</span> } <span class="missing-if-branch" title="if path not taken" >I</span>if (typeof obj.speed !== 'number') { <span class="cstat-no" title="statement not covered" > throw new TypeError('Invalid speed type given for setMultiZoneEffect LIFX packet, must be a number');</span> } buf.writeUInt32LE(obj.speed, offset); offset += 4; &nbsp; // FIXME: Disabled due to missing Int64 support in node // if (obj.duration === undefined) { // throw new TypeError('obj.duration value must be given for setMultiZoneEffect LIFX packet'); // } // if (typeof obj.duration !== 'number') { // throw new TypeError('Invalid duration type given for setMultiZoneEffect LIFX packet, must be a number'); // } // utils.writeUInt64LE(buf, offset, obj.duration); // obj.duration.toBuffer().copy(buf, offset); offset += 8; &nbsp; // skip reserved field UInt32LE offset += 4; &nbsp; // skip reserved field UInt32LE offset += 4; &nbsp; // Parameters Block 8*32Bit // reserved for internal use offset += 4; &nbsp; // The following parameters vary depending on the effect <span class="missing-if-branch" title="else path not taken" >E</span>if (obj.effectType === constants.MULTIZONE_EFFECTS.indexOf('MOVE')) { <span class="missing-if-branch" title="if path not taken" >I</span>if (obj.parameter2 === undefined) { <span class="cstat-no" title="statement not covered" > throw new TypeError('obj.parameter2 value must be given for setMultiZoneEffect (effect MOVE) LIFX packet');</span> } <span class="missing-if-branch" title="if path not taken" >I</span>if (typeof obj.parameter2 !== 'number' &amp;&amp; <span class="branch-1 cbranch-no" title="branch not covered" >obj.parameter2 &lt; 0 </span>|| obj.parameter2 &gt; constants.MULTIZONE_EFFECTS_MOVE_DIRECTION.length - 1) { <span class="cstat-no" title="statement not covered" > throw new RangeError('Invalid parameter2 value given for setMultiZoneEffect (effect MOVE) LIFX packet, must be a number between 0 and ' + (constants.MULTIZONE_EFFECTS_MOVE_DIRECTION.length - 1));</span> } buf.writeUInt32LE(obj.parameter2, offset); offset += 4; // skip parameter3 offset += 4; // skip parameter4 offset += 4; // skip parameter5 offset += 4; // skip parameter6 offset += 4; // skip parameter7 offset += 4; // skip parameter8 offset += 4; } &nbsp; return buf; }; &nbsp; module.exports = Packet;</pre></td></tr> </table></pre> <div class='push'></div><!-- for sticky footer --> </div><!-- /wrapper --> <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>