diff options
Diffstat (limited to 'docs/_book/Scripting/SupportLib/index.html')
| -rw-r--r-- | docs/_book/Scripting/SupportLib/index.html | 458 |
1 files changed, 458 insertions, 0 deletions
diff --git a/docs/_book/Scripting/SupportLib/index.html b/docs/_book/Scripting/SupportLib/index.html new file mode 100644 index 0000000..a94c1da --- /dev/null +++ b/docs/_book/Scripting/SupportLib/index.html @@ -0,0 +1,458 @@ + +<!DOCTYPE HTML> +<html lang="" > + <head> + <meta charset="UTF-8"> + <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + <title>Support Library ยท Luxcena-Neo wiki</title> + <meta http-equiv="X-UA-Compatible" content="IE=edge" /> + <meta name="description" content=""> + <meta name="generator" content="GitBook 3.2.3"> + <meta name="author" content="JakobST1n"> + + + + <link rel="stylesheet" href="../../gitbook/style.css"> + + + + + <link rel="stylesheet" href="../../gitbook/gitbook-plugin-code/plugin.css"> + + + + <link rel="stylesheet" href="../../gitbook/gitbook-plugin-pretty-term/terminal.css"> + + + + <link rel="stylesheet" href="../../gitbook/gitbook-plugin-hints/plugin-hints.css"> + + + + <link rel="stylesheet" href="../../gitbook/gitbook-plugin-comment/plugin.css"> + + + + <link rel="stylesheet" href="../../gitbook/gitbook-plugin-emphasize/plugin.css"> + + + + <link rel="stylesheet" href="../../gitbook/gitbook-plugin-api/api.css"> + + + + <link rel="stylesheet" href="../../gitbook/gitbook-plugin-highlight/website.css"> + + + + <link rel="stylesheet" href="../../gitbook/gitbook-plugin-search/search.css"> + + + + <link rel="stylesheet" href="../../gitbook/gitbook-plugin-fontsettings/website.css"> + + + + + + + + + + + + + + + + + + + + + + + + <meta name="HandheldFriendly" content="true"/> + <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> + <meta name="apple-mobile-web-app-capable" content="yes"> + <meta name="apple-mobile-web-app-status-bar-style" content="black"> + <link rel="apple-touch-icon-precomposed" sizes="152x152" href="../../gitbook/images/apple-touch-icon-precomposed-152.png"> + <link rel="shortcut icon" href="../../gitbook/images/favicon.ico" type="image/x-icon"> + + + + + </head> + <body> + +<div class="book"> + <div class="book-summary"> + + +<div id="book-search-input" role="search"> + <input type="text" placeholder="Type to search" /> +</div> + + + <nav role="navigation"> + + + +<ul class="summary"> + + + + + + + + + + <li class="chapter " data-level="1.1" data-path="../../"> + + <a href="../../"> + + + Introduction + + </a> + + + + </li> + + <li class="chapter " data-level="1.2" data-path="../../Usage/"> + + <a href="../../Usage/"> + + + Usage + + </a> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.2.1" data-path="../../Usage/Install.html"> + + <a href="../../Usage/Install.html"> + + + Install + + </a> + + + + </li> + + <li class="chapter " data-level="1.2.2" data-path="../../Usage/Configuration.html"> + + <a href="../../Usage/Configuration.html"> + + + Configuration + + </a> + + + + </li> + + <li class="chapter " data-level="1.2.3" data-path="../../Usage/CLI.html"> + + <a href="../../Usage/CLI.html"> + + + CLI + + </a> + + + + </li> + + + </ul> + + </li> + + <li class="chapter " data-level="1.3" > + + <span> + + + Scripting + + </span> + + + + <ul class="articles"> + + + <li class="chapter active" data-level="1.3.1" data-path="./"> + + <a href="./"> + + + Support Library + + </a> + + + + </li> + + + </ul> + + </li> + + <li class="chapter " data-level="1.4" > + + <span> + + + Contributing + + </span> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.4.1" > + + <span> + + + Modules + + </span> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.4.1.1" data-path="../../Contributing/Modules/CompileAndRun.html"> + + <a href="../../Contributing/Modules/CompileAndRun.html"> + + + CompileAndRun + + </a> + + + + </li> + + + </ul> + + </li> + + + </ul> + + </li> + + + + + <li class="divider"></li> + + <li> + <a href="https://www.gitbook.com" target="blank" class="gitbook-link"> + Published with GitBook + </a> + </li> +</ul> + + + </nav> + + + </div> + + <div class="book-body"> + + <div class="body-inner"> + + + +<div class="book-header" role="navigation"> + + + <!-- Title --> + <h1> + <i class="fa fa-circle-o-notch fa-spin"></i> + <a href="../.." >Support Library</a> + </h1> +</div> + + + + + <div class="page-wrapper" tabindex="-1" role="main"> + <div class="page-inner"> + +<div id="book-search-results"> + <div class="search-noresults"> + + <section class="normal markdown-section"> + + <h1 id="support-library">Support Library</h1> +<hr> +<h2 id="class-strip"><code>class</code> Strip</h2> +<p>This is the object you are refeering to when you want to do things with LED's. +You shouldn't have to do instantiate your own new strip-object as you can use the one +set up by the software itself.</p> +<pre><code class="lang-python">LuxcenaNeo.strip +<span class="hljs-keyword">or</span> +neo.strip +</code></pre> +<h3 id="stripshow">Strip.show()</h3> +<p>Display all the changes made to the LEDs, on the actual LEDs.</p> +<h3 id="stripsetpixelcolorn-color">Strip.setPixelColor(<code>n</code>, <code>color</code>)</h3> +<p>Set LED at position n to the provided 24-bit color value (in RGB order).</p> +<h3 id="stripsetpixelcolorxyx-y-color">Strip.setPixelColorXY(<code>x</code>, <code>y</code>, <code>color</code>)</h3> +<p>Set LED at position (x, y) in the defined matrix to the provided 24-bit color value (in RGB order).</p> +<h3 id="stripsetpixelcolorrgbn-red-green-blue-white--0">Strip.setPixelColorRGB(<code>n</code>, <code>red</code>, <code>green</code>, <code>blue</code>, <code>white = 0</code>)</h3> +<p>Set LED at position n to the provided red, green, and blue color. +Each color component should be a value from 0 to 255 (where 0 is the +lowest intensity and 255 is the highest intensity).</p> +<h3 id="stripsetpixelcolorxyrgbx-y-red-green-blue-white--0">Strip.setPixelColorXYRGB(<code>x</code>, <code>y</code>, <code>red</code>, <code>green</code>, <code>blue</code>, <code>white = 0</code>)</h3> +<p>Set LED at position (x, y) in the defined matrix to the provided red, green, and blue color. +Each color component should be a value from 0 to 255 (where 0 is the +lowest intensity and 255 is the highest intensity).</p> +<h3 id="stripsetsegmentcolorrgbsegment-red-green-blue-white--0">Strip.setSegmentColorRGB(<code>segment</code>, <code>red</code>, <code>green</code>, <code>blue</code>, <code>white = 0</code>)</h3> +<p>Set a whole segment to the provided red, green and blue color. +Each color component should be a value from 0 to 255 (where 0 is the +lowest intensity and 255 is the highest intensity).</p> +<h3 id="stripsetbrightnessbrightness">Strip.setBrightness(<code>brightness</code>)</h3> +<p>Scale each LED in the buffer by the provided brightness. A brightness +of 0 is the darkest and 255 is the brightest.</p> +<h3 id="stripgetbrightness">Strip.getBrightness():</h3> +<p>Get the brightness value for each LED in the buffer. A brightness +of 0 is the darkest and 255 is the brightest.</p> +<h3 id="stripgetpixels">Strip.getPixels():</h3> +<p>Return an object which allows access to the LED display data as if +it were a sequence of 24-bit RGB values.</p> +<h3 id="stripnumpixels">Strip.numPixels():</h3> +<p>Return the number of pixels in the display.</p> +<h3 id="stripgetpixelcolorn">Strip.getPixelColor(<code>n</code>)</h3> +<p>Get the 24-bit RGB color value for the LED at position n.</p> +<hr> +<h2 id="colorred-green-blue-white--0">Color(<code>red</code>, <code>green</code>, <code>blue</code>, <code>white = 0</code>)</h2> +<p>Convert the provided red, green, blue color to a 24-bit color value. +Each color component should be a value 0-255 where 0 is the lowest intensity +and 255 is the highest intensity.</p> +<h2 id="hexcolorvalue">hexColor(<code>value</code>)</h2> +<p>Convert the provided hexadecimal color to a 24-bit color value.</p> + + + </section> + + </div> + <div class="search-results"> + <div class="has-results"> + + <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> + <ul class="search-results-list"></ul> + + </div> + <div class="no-results"> + + <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> + + </div> + </div> +</div> + + </div> + </div> + + </div> + + + + + + + </div> + + <script> + var gitbook = gitbook || []; + gitbook.push(function() { + gitbook.page.hasChanged({"page":{"title":"Support Library","level":"1.3.1","depth":2,"next":{"title":"Contributing","level":"1.4","depth":1,"ref":"","articles":[{"title":"Modules","level":"1.4.1","depth":2,"ref":"","articles":[{"title":"CompileAndRun","level":"1.4.1.1","depth":3,"path":"Contributing/Modules/CompileAndRun.md","ref":"Contributing/Modules/CompileAndRun.md","articles":[]}]}]},"previous":{"title":"Scripting","level":"1.3","depth":1,"ref":"","articles":[{"title":"Support Library","level":"1.3.1","depth":2,"path":"Scripting/SupportLib/README.md","ref":"Scripting/SupportLib/README.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["code","pretty-term","hints","comment","github","emphasize","api","offline","livereload"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"emphasize":{},"offline":{},"pretty-term":{},"github":{"url":"https://github.com/jakobst1n/luxcena-neo"},"livereload":{},"search":{},"hints":{"danger":"fa fa-exclamation-circle","info":"fa fa-info-circle","tip":"fa fa-mortar-board","working":"fa fa-wrench"},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"code":{"copyButtons":true},"fontsettings":{"theme":"white","family":"sans","size":2},"highlight":{},"api":{},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"comment":{"highlightCommented":true}},"theme":"default","author":"JakobST1n","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Luxcena-Neo wiki","gitbook":"*"},"file":{"path":"Scripting/SupportLib/README.md","mtime":"2018-11-30T23:20:59.931Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-30T22:53:52.196Z"},"basePath":"../..","book":{"language":""}}); + }); + </script> +</div> + + + <script src="../../gitbook/gitbook.js"></script> + <script src="../../gitbook/theme.js"></script> + + + <script src="../../gitbook/gitbook-plugin-code/plugin.js"></script> + + + + <script src="../../gitbook/gitbook-plugin-pretty-term/terminal.js"></script> + + + + <script src="../../gitbook/gitbook-plugin-comment/plugin.js"></script> + + + + <script src="../../gitbook/gitbook-plugin-github/plugin.js"></script> + + + + <script src="../../gitbook/gitbook-plugin-api/api.js"></script> + + + + <script src="../../gitbook/gitbook-plugin-offline/service-worker-registration.js"></script> + + + + <script src="../../gitbook/gitbook-plugin-livereload/plugin.js"></script> + + + + <script src="../../gitbook/gitbook-plugin-search/search-engine.js"></script> + + + + <script src="../../gitbook/gitbook-plugin-search/search.js"></script> + + + + <script src="../../gitbook/gitbook-plugin-lunr/lunr.min.js"></script> + + + + <script src="../../gitbook/gitbook-plugin-lunr/search-lunr.js"></script> + + + + <script src="../../gitbook/gitbook-plugin-sharing/buttons.js"></script> + + + + <script src="../../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script> + + + + </body> +</html> + |