UNPKG

lifx-lan-client

Version:

Node.js implementation of the LIFX LAN protocol

531 lines (530 loc) 21.2 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/lifx/packets/setWaveform.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> setWaveform.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">5.81% </span> <span class="quiet">Statements</span> <span class='fraction'>5/86</span> </div> <div class='fl pad1y space-right2'> <span class="strong">0% </span> <span class="quiet">Branches</span> <span class='fraction'>0/49</span> </div> <div class='fl pad1y space-right2'> <span class="strong">0% </span> <span class="quiet">Functions</span> <span class='fraction'>0/2</span> </div> <div class='fl pad1y space-right2'> <span class="strong">5.81% </span> <span class="quiet">Lines</span> <span class='fraction'>5/86</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</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-no">&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-no">&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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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-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: 21 }; &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 setWaveform LIFX packet');</span> } &nbsp; <span class="cstat-no" title="statement not covered" > obj.stream = buf.readUInt8(offset);</span> <span class="cstat-no" title="statement not covered" > offset += 1;</span> &nbsp; <span class="cstat-no" title="statement not covered" > obj.isTransient = buf.readUInt8(offset);</span> <span class="cstat-no" title="statement not covered" > offset += 1;</span> &nbsp; <span class="cstat-no" title="statement not covered" > obj.color = {};</span> <span class="cstat-no" title="statement not covered" > obj.color.hue = buf.readUInt16LE(offset);</span> <span class="cstat-no" title="statement not covered" > offset += 2;</span> <span class="cstat-no" title="statement not covered" > obj.color.saturation = buf.readUInt16LE(offset);</span> <span class="cstat-no" title="statement not covered" > offset += 2;</span> <span class="cstat-no" title="statement not covered" > obj.color.brightness = buf.readUInt16LE(offset);</span> <span class="cstat-no" title="statement not covered" > offset += 2;</span> <span class="cstat-no" title="statement not covered" > obj.color.kelvin = buf.readUInt16LE(offset);</span> <span class="cstat-no" title="statement not covered" > offset += 2;</span> &nbsp; <span class="cstat-no" title="statement not covered" > obj.period = 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.cycles = buf.readFloatLE(offset);</span> <span class="cstat-no" title="statement not covered" > offset += 4;</span> &nbsp; <span class="cstat-no" title="statement not covered" > obj.skewRatio = buf.readUInt16LE(offset);</span> <span class="cstat-no" title="statement not covered" > offset += 2;</span> &nbsp; <span class="cstat-no" title="statement not covered" > obj.waveform = buf.readUInt8(offset);</span> <span class="cstat-no" title="statement not covered" > offset += 1;</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 {Boolean} obj.isTransient restore color used before effect * @param {Object} obj.color an objects with colors to set * @param {Number} obj.color.hue between 0 and 65535 * @param {Number} obj.color.saturation between 0 and 65535 * @param {Number} obj.color.brightness between 0 and 65535 * @param {Number} [obj.color.kelvin=3500] between 2500 and 9000 * @param {Number} obj.period length of one cycle in milliseconds * @param {Number} obj.cycles how often to repeat through effect * @param {Number} obj.skewRatio distribution between time on original and new color , positive is for more new color, negative for original color * @param {Number} obj.waveform between 0 and 4 for form of effect * @return {Buffer} packet */ Packet.toBuffer = <span class="fstat-no" title="function not covered" >function (obj) {</span> <span class="cstat-no" title="statement not covered" > var buf = Buffer.alloc(this.size);</span> <span class="cstat-no" title="statement not covered" > buf.fill(0);</span> <span class="cstat-no" title="statement not covered" > var offset = 0;</span> &nbsp; // obj.stream field has unknown function so leave it as 0 <span class="cstat-no" title="statement not covered" > offset += 1;</span> &nbsp; <span class="cstat-no" title="statement not covered" > if (obj.isTransient === undefined) {</span> <span class="cstat-no" title="statement not covered" > throw new TypeError('obj.isTransient value must be given for setWaveform LIFX packet');</span> } <span class="cstat-no" title="statement not covered" > if (typeof obj.isTransient !== 'boolean') {</span> <span class="cstat-no" title="statement not covered" > throw new TypeError('Invalid isTransient value given for setWaveform LIFX packet, must be boolean');</span> } <span class="cstat-no" title="statement not covered" > buf.writeUInt8(obj.isTransient, offset);</span> <span class="cstat-no" title="statement not covered" > offset += 1;</span> &nbsp; <span class="cstat-no" title="statement not covered" > if (typeof obj.color !== 'object') {</span> <span class="cstat-no" title="statement not covered" > throw new TypeError('Invalid object for color given for setWaveform LIFX packet');</span> } &nbsp; <span class="cstat-no" title="statement not covered" > if (typeof obj.color.hue !== 'number' &amp;&amp; obj.color.hue &lt; 0 || obj.color.hue &gt; 65535) {</span> <span class="cstat-no" title="statement not covered" > throw new RangeError('Invalid color hue given for setWaveform LIFX packet, must be a number between 0 and 65535');</span> } <span class="cstat-no" title="statement not covered" > buf.writeUInt16LE(obj.color.hue, offset);</span> <span class="cstat-no" title="statement not covered" > offset += 2;</span> &nbsp; <span class="cstat-no" title="statement not covered" > if (typeof obj.color.saturation !== 'number' &amp;&amp; obj.color.saturation &lt; 0 || obj.color.saturation &gt; 65535) {</span> <span class="cstat-no" title="statement not covered" > throw new RangeError('Invalid color saturation given for setWaveform LIFX packet, must be a number between 0 and 65535');</span> } <span class="cstat-no" title="statement not covered" > buf.writeUInt16LE(obj.color.saturation, offset);</span> <span class="cstat-no" title="statement not covered" > offset += 2;</span> &nbsp; <span class="cstat-no" title="statement not covered" > if (typeof obj.color.brightness !== 'number' &amp;&amp; obj.color.brightness &lt; 0 || obj.color.brightness &gt; 65535) {</span> <span class="cstat-no" title="statement not covered" > throw new RangeError('Invalid color brightness given for setWaveform LIFX packet, must be a number between 0 and 65535');</span> } <span class="cstat-no" title="statement not covered" > buf.writeUInt16LE(obj.color.brightness, offset);</span> <span class="cstat-no" title="statement not covered" > offset += 2;</span> &nbsp; <span class="cstat-no" title="statement not covered" > if (obj.color.kelvin === undefined) {</span> <span class="cstat-no" title="statement not covered" > obj.color.kelvin = constants.HSBK_DEFAULT_KELVIN;</span> } <span class="cstat-no" title="statement not covered" > if (typeof obj.color.kelvin !== 'number' &amp;&amp; obj.color.kelvin &lt; 2500 || obj.color.kelvin &gt; 9000) {</span> <span class="cstat-no" title="statement not covered" > throw new RangeError('Invalid color kelvin given for setWaveform LIFX packet, must be a number between 2500 and 9000');</span> } <span class="cstat-no" title="statement not covered" > buf.writeUInt16LE(obj.color.kelvin, offset);</span> <span class="cstat-no" title="statement not covered" > offset += 2;</span> &nbsp; <span class="cstat-no" title="statement not covered" > if (obj.period === undefined) {</span> <span class="cstat-no" title="statement not covered" > throw new TypeError('obj.period value must be given for setWaveform LIFX packet');</span> } <span class="cstat-no" title="statement not covered" > if (typeof obj.period !== 'number') {</span> <span class="cstat-no" title="statement not covered" > throw new TypeError('Invalid period type given for setWaveform LIFX packet, must be a number');</span> } <span class="cstat-no" title="statement not covered" > buf.writeUInt32LE(obj.period, offset);</span> <span class="cstat-no" title="statement not covered" > offset += 4;</span> &nbsp; <span class="cstat-no" title="statement not covered" > if (obj.cycles === undefined) {</span> <span class="cstat-no" title="statement not covered" > throw new TypeError('obj.cycles value must be given for setWaveform LIFX packet');</span> } <span class="cstat-no" title="statement not covered" > if (typeof obj.cycles !== 'number') {</span> <span class="cstat-no" title="statement not covered" > throw new TypeError('Invalid cycles type given for setWaveform LIFX packet, must be a number');</span> } <span class="cstat-no" title="statement not covered" > buf.writeFloatLE(obj.cycles, offset);</span> <span class="cstat-no" title="statement not covered" > offset += 4;</span> &nbsp; <span class="cstat-no" title="statement not covered" > if (obj.skewRatio === undefined) {</span> <span class="cstat-no" title="statement not covered" > throw new TypeError('obj.skewRatio value must be given for setWaveform LIFX packet');</span> } <span class="cstat-no" title="statement not covered" > if (typeof obj.skewRatio !== 'number') {</span> <span class="cstat-no" title="statement not covered" > throw new TypeError('Invalid skewRatio type given for setWaveform LIFX packet, must be a number');</span> } <span class="cstat-no" title="statement not covered" > buf.writeInt16LE(obj.skewRatio, offset);</span> <span class="cstat-no" title="statement not covered" > offset += 2;</span> &nbsp; <span class="cstat-no" title="statement not covered" > if (obj.waveform === undefined) {</span> <span class="cstat-no" title="statement not covered" > throw new TypeError('obj.waveform value must be given for setWaveform LIFX packet');</span> } <span class="cstat-no" title="statement not covered" > if (typeof obj.waveform !== 'number' &amp;&amp; obj.waveform &lt; 0 || obj.waveform &gt; constants.LIGHT_WAVEFORMS.length - 1) {</span> <span class="cstat-no" title="statement not covered" > throw new RangeError('Invalid waveform value given for setWaveform LIFX packet, must be a number between 0 and ' + (constants.LIGHT_WAVEFORMS.length - 1));</span> } <span class="cstat-no" title="statement not covered" > buf.writeUInt8(obj.waveform, offset);</span> <span class="cstat-no" title="statement not covered" > offset += 1;</span> &nbsp; <span class="cstat-no" title="statement not covered" > return buf;</span> }; &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>