diff options
Diffstat (limited to 'docs/_book/Usage')
| -rw-r--r-- | docs/_book/Usage/CLI.html | 405 | ||||
| -rw-r--r-- | docs/_book/Usage/Configuration.html | 441 | ||||
| -rw-r--r-- | docs/_book/Usage/Install.html | 417 | ||||
| -rw-r--r-- | docs/_book/Usage/index.html | 397 |
4 files changed, 1660 insertions, 0 deletions
diff --git a/docs/_book/Usage/CLI.html b/docs/_book/Usage/CLI.html new file mode 100644 index 0000000..d56a2f6 --- /dev/null +++ b/docs/_book/Usage/CLI.html @@ -0,0 +1,405 @@ + +<!DOCTYPE HTML> +<html lang="" > + <head> + <meta charset="UTF-8"> + <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + <title>CLI · 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"> + + + + <link rel="prev" href="Configuration.html" /> + + + </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="./"> + + <a href="./"> + + + Usage + + </a> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.2.1" data-path="Install.html"> + + <a href="Install.html"> + + + Install + + </a> + + + + </li> + + <li class="chapter " data-level="1.2.2" data-path="Configuration.html"> + + <a href="Configuration.html"> + + + Configuration + + </a> + + + + </li> + + <li class="chapter active" data-level="1.2.3" data-path="CLI.html"> + + <a href="CLI.html"> + + + CLI + + </a> + + + + </li> + + + </ul> + + </li> + + <li class="chapter " data-level="1.3" > + + <span> + + + Contributing + + </span> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.3.1" > + + <span> + + + Modules + + </span> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.3.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=".." >CLI</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="command-line-interface">Command line interface</h1> +<hr> +<p>This gets installed in the <code>/usr/bin</code> directory, and can be called by:</p> +<pre><code class="lang-bash">$ luxcena-neo.sh +</code></pre> +<p>or is alias</p> +<pre><code class="lang-bash">$ lux-neo +</code></pre> +<p><div class="alert alert-danger hints-alert"><div class="hints-icon"><i class="fa fa-exclamation-circle"></i></div><div class="hints-container"><p>This CLI assumes root access, so please run it with <code>sudo</code></p> +</div></div></p> +<h2 id="options">Options</h2> +<h4 id="sudo-lux-neo-uninstall"><code>sudo lux-neo uninstall</code></h4> +<p>Uninstall the whole thing. You will have to remove this script yourself.</p> +<h4 id="sudo-lux-neo-update"><code>sudo lux-neo update</code></h4> +<p>Update to the newest version on the current branch.</p> +<h4 id="sudo-lux-neo-conf"><code>sudo lux-neo conf</code></h4> +<p>Open the strip-config in <code>nano</code>.</p> +<h4 id="sudo-lux-neo-start"><code>sudo lux-neo start</code></h4> +<p>Start the server.</p> +<h4 id="sudo-lux-neo-stop"><code>sudo lux-neo stop</code></h4> +<p>Stop the server.</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> + + + + <a href="Configuration.html" class="navigation navigation-prev navigation-unique" aria-label="Previous page: Configuration"> + <i class="fa fa-angle-left"></i> + </a> + + + + + </div> + + <script> + var gitbook = gitbook || []; + gitbook.push(function() { + gitbook.page.hasChanged({"page":{"title":"CLI","level":"1.2.3","depth":2,"next":{"title":"Contributing","level":"1.3","depth":1,"ref":"","articles":[{"title":"Modules","level":"1.3.1","depth":2,"ref":"","articles":[{"title":"CompileAndRun","level":"1.3.1.1","depth":3,"path":"Contributing/Modules/CompileAndRun.md","ref":"Contributing/Modules/CompileAndRun.md","articles":[]}]}]},"previous":{"title":"Configuration","level":"1.2.2","depth":2,"path":"Usage/Configuration.md","ref":"Usage/Configuration.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/lucena-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":"Usage/CLI.md","mtime":"2018-11-29T21:47:23.305Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T21:47:00.710Z"},"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> + diff --git a/docs/_book/Usage/Configuration.html b/docs/_book/Usage/Configuration.html new file mode 100644 index 0000000..ec2a8cc --- /dev/null +++ b/docs/_book/Usage/Configuration.html @@ -0,0 +1,441 @@ + +<!DOCTYPE HTML> +<html lang="" > + <head> + <meta charset="UTF-8"> + <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + <title>Configuration · 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"> + + + <link rel="next" href="CLI.html" /> + + + <link rel="prev" href="Install.html" /> + + + </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="./"> + + <a href="./"> + + + Usage + + </a> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.2.1" data-path="Install.html"> + + <a href="Install.html"> + + + Install + + </a> + + + + </li> + + <li class="chapter active" data-level="1.2.2" data-path="Configuration.html"> + + <a href="Configuration.html"> + + + Configuration + + </a> + + + + </li> + + <li class="chapter " data-level="1.2.3" data-path="CLI.html"> + + <a href="CLI.html"> + + + CLI + + </a> + + + + </li> + + + </ul> + + </li> + + <li class="chapter " data-level="1.3" > + + <span> + + + Contributing + + </span> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.3.1" > + + <span> + + + Modules + + </span> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.3.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=".." >Configuration</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="configuration">Configuration</h1> +<p>How to setup luxcena-neo to work with your setup</p> +<hr> +<pre><code class="lang-bash">$ sudo lux-neo conf +</code></pre> +<p>When running the command above, a config file should appear in the editor 'nano'.</p> +<pre><code class="lang-json">{ + <span class="hljs-string">"led_count"</span>: <span class="hljs-number">53</span>, + <span class="hljs-string">"segments"</span>: [], + <span class="hljs-string">"matrix"</span>: [], + <span class="hljs-string">"segmentConfiguration"</span>: <span class="hljs-string">"snake"</span>, + <span class="hljs-string">"led_pin"</span>: <span class="hljs-number">18</span>, + <span class="hljs-string">"led_freq_hz"</span>: <span class="hljs-number">800000</span>, + <span class="hljs-string">"led_dma"</span>: <span class="hljs-number">10</span>, + <span class="hljs-string">"led_invert"</span>: <span class="hljs-literal">false</span>, + <span class="hljs-string">"led_channel"</span>: <span class="hljs-number">0</span> +} +</code></pre> +<p><div class="alert alert-success hints-alert"><div class="hints-icon"><i class="fa fa-mortar-board"></i></div><div class="hints-container"><p>If you rather want to use vim or another editor, the file is at <code>/home/lux-neo/userdata/config/strip.json</code></p> +</div></div></p> +<h2 id="ledcount">led_count</h2> +<p>This is the number of LED's you want to control.</p> +<h2 id="segments">segments</h2> +<p>This is a simple list, here you should add the lenghts of all your segments. Please enter the "real" length, and don't start counting from 0. If you just want one segment, you should just have one element in the list, which is the number of led's you are controlling.</p> +<p>When summing this list, it should check out with the "led-count"-option.</p> +<h2 id="matrix">matrix</h2> +<p>This is a two dimensonal array, used to arrange the segments in a matrix of your likings. Here you enter the segment-number to represent them. In the example above, all the segments are in one line. If you want to have them in a square, it could look like this:</p> +<pre><code class="lang-json"><span class="hljs-string">"segments"</span>: [<span class="hljs-number">10</span>, <span class="hljs-number">10</span>, <span class="hljs-number">10</span>, <span class="hljs-number">10</span>, <span class="hljs-number">10</span>, <span class="hljs-number">10</span>, <span class="hljs-number">10</span>, <span class="hljs-number">10</span>, <span class="hljs-number">10</span>], +<span class="hljs-string">"matrix"</span>: [ + [<span class="hljs-number">0</span>, <span class="hljs-number">1</span>, <span class="hljs-number">2</span>], + [<span class="hljs-number">3</span>, <span class="hljs-number">4</span>, <span class="hljs-number">5</span>], + [<span class="hljs-number">6</span>, <span class="hljs-number">7</span>, <span class="hljs-number">8</span>] +] +</code></pre> +<p><div class="alert alert-danger hints-alert"><div class="hints-icon"><i class="fa fa-exclamation-circle"></i></div><div class="hints-container"><p>If you don't have a reference to all the segments or something, the matrix setup will fail. And fall back to 'segmentsconfiguration'</p> +</div></div></p> +<h2 id="segmentconfiguration">segmentconfiguration</h2> +<p>If the matrix-option is empty or badly setup. The matrix will be set up using one of these defaults:</p> +<pre><code>"snake": +"line": +"random": +</code></pre><h2 id="ledpin">led_pin</h2> +<p>If using the luxcena-shield, you shouldn't have to worry about this option. But set it to the GPIO-port connected to your pixel's din-port.</p> +<h2 id="leddma">led_dma</h2> +<p><div class="alert alert-danger hints-alert"><div class="hints-icon"><i class="fa fa-exclamation-circle"></i></div><div class="hints-container"><p>If using a newer RPi (3 or newer), leave this as 10! Or your file-system might crash.</p> +</div></div> +This is the dma-channel used to generate the data-stream. If you for some reason need channel 10 for something else, you can change it. But i strongly recommend leaving it to 10!</p> +<h2 id="ledinvert">led_invert</h2> +<p>This should not be touched, unless you are using a inverting level converter.</p> +<h2 id="ledchannel">led_channel</h2> +<p>Leave this as default unless you know what you are doing.</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> + + + + <a href="Install.html" class="navigation navigation-prev " aria-label="Previous page: Install"> + <i class="fa fa-angle-left"></i> + </a> + + + <a href="CLI.html" class="navigation navigation-next " aria-label="Next page: CLI"> + <i class="fa fa-angle-right"></i> + </a> + + + + </div> + + <script> + var gitbook = gitbook || []; + gitbook.push(function() { + gitbook.page.hasChanged({"page":{"title":"Configuration","level":"1.2.2","depth":2,"next":{"title":"CLI","level":"1.2.3","depth":2,"path":"Usage/CLI.md","ref":"Usage/CLI.md","articles":[]},"previous":{"title":"Install","level":"1.2.1","depth":2,"path":"Usage/Install.md","ref":"Usage/Install.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/lucena-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":"Usage/Configuration.md","mtime":"2018-11-29T21:31:10.857Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T21:47:00.710Z"},"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> + diff --git a/docs/_book/Usage/Install.html b/docs/_book/Usage/Install.html new file mode 100644 index 0000000..a3af5e1 --- /dev/null +++ b/docs/_book/Usage/Install.html @@ -0,0 +1,417 @@ + +<!DOCTYPE HTML> +<html lang="" > + <head> + <meta charset="UTF-8"> + <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + <title>Install · 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"> + + + <link rel="next" href="Configuration.html" /> + + + <link rel="prev" href="./" /> + + + </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="./"> + + <a href="./"> + + + Usage + + </a> + + + + <ul class="articles"> + + + <li class="chapter active" data-level="1.2.1" data-path="Install.html"> + + <a href="Install.html"> + + + Install + + </a> + + + + </li> + + <li class="chapter " data-level="1.2.2" data-path="Configuration.html"> + + <a href="Configuration.html"> + + + Configuration + + </a> + + + + </li> + + <li class="chapter " data-level="1.2.3" data-path="CLI.html"> + + <a href="CLI.html"> + + + CLI + + </a> + + + + </li> + + + </ul> + + </li> + + <li class="chapter " data-level="1.3" > + + <span> + + + Contributing + + </span> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.3.1" > + + <span> + + + Modules + + </span> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.3.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=".." >Install</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="installation">Installation</h1> +<p>If you want to install luxcena-neo to use it, these are the instructions:</p> +<hr> +<h2 id="requirements">Requirements</h2> +<ul> +<li>The luxcena-shield</li> +<li>Access to the raspberry pi (SSH or direct)</li> +<li>Root access (preferably through the <code>sudo</code> command)</li> +</ul> +<h2 id="install">Install</h2> +<ol> +<li>Start with logging into your Raspberry Pi</li> +<li>Run these commands<pre><code class="lang-bash">$ git <span class="hljs-built_in">clone</span> https://github.com/JakobST1n/Luxcena-Neo +$ <span class="hljs-built_in">cd</span> Luxcena-Neo +$ sudo ./bin/install.sh +</code></pre> +</li> +<li>Follow the instructions on screen. You should answer yes to most of the questions.</li> +<li>The install-process might seem to hang, but there is just no output being sent to the console. If you want to see a bit more verbose output. Open another terminal session, and run this command:<pre><code class="lang-bash">$ tail -n 10 <span class="hljs-_">-f</span> /tmp/luxcena-neo.install.log +</code></pre> +This is also where you will find possible reasons for a failed install.</li> +<li>Luxcena-Neo should now be installed. Start it with this command<pre><code class="lang-bash">$ luxcena-neo start +</code></pre> +</li> +</ol> +<h2 id="troubleshooting">Troubleshooting</h2> +<p>We haven't encountered any troubles yet, but once we do, we will post fix'es here.</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> + + + + <a href="./" class="navigation navigation-prev " aria-label="Previous page: Usage"> + <i class="fa fa-angle-left"></i> + </a> + + + <a href="Configuration.html" class="navigation navigation-next " aria-label="Next page: Configuration"> + <i class="fa fa-angle-right"></i> + </a> + + + + </div> + + <script> + var gitbook = gitbook || []; + gitbook.push(function() { + gitbook.page.hasChanged({"page":{"title":"Install","level":"1.2.1","depth":2,"next":{"title":"Configuration","level":"1.2.2","depth":2,"path":"Usage/Configuration.md","ref":"Usage/Configuration.md","articles":[]},"previous":{"title":"Usage","level":"1.2","depth":1,"path":"Usage/README.md","ref":"Usage/README.md","articles":[{"title":"Install","level":"1.2.1","depth":2,"path":"Usage/Install.md","ref":"Usage/Install.md","articles":[]},{"title":"Configuration","level":"1.2.2","depth":2,"path":"Usage/Configuration.md","ref":"Usage/Configuration.md","articles":[]},{"title":"CLI","level":"1.2.3","depth":2,"path":"Usage/CLI.md","ref":"Usage/CLI.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/lucena-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":"Usage/Install.md","mtime":"2018-11-29T19:23:03.655Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T21:47:00.710Z"},"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> + diff --git a/docs/_book/Usage/index.html b/docs/_book/Usage/index.html new file mode 100644 index 0000000..a461209 --- /dev/null +++ b/docs/_book/Usage/index.html @@ -0,0 +1,397 @@ + +<!DOCTYPE HTML> +<html lang="" > + <head> + <meta charset="UTF-8"> + <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + <title>Usage · 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"> + + + <link rel="next" href="Install.html" /> + + + <link rel="prev" href="../" /> + + + </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 active" data-level="1.2" data-path="./"> + + <a href="./"> + + + Usage + + </a> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.2.1" data-path="Install.html"> + + <a href="Install.html"> + + + Install + + </a> + + + + </li> + + <li class="chapter " data-level="1.2.2" data-path="Configuration.html"> + + <a href="Configuration.html"> + + + Configuration + + </a> + + + + </li> + + <li class="chapter " data-level="1.2.3" data-path="CLI.html"> + + <a href="CLI.html"> + + + CLI + + </a> + + + + </li> + + + </ul> + + </li> + + <li class="chapter " data-level="1.3" > + + <span> + + + Contributing + + </span> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.3.1" > + + <span> + + + Modules + + </span> + + + + <ul class="articles"> + + + <li class="chapter " data-level="1.3.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=".." >Usage</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="usage">Usage</h1> +<h2 id="install"><a href="Install.html">Install</a></h2> +<p>Want to install luxcena-neo? This is the guide!</p> +<h2 id="configuration"><a href="Configuration.html">Configuration</a></h2> +<p>Just installed luxcena-neo, or you have changed your setup? This is the guide!</p> +<h2 id="cli"><a href="CLI.html">CLI</a></h2> +<p>Ready to start the thing? Or change something?</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> + + + + <a href="../" class="navigation navigation-prev " aria-label="Previous page: Introduction"> + <i class="fa fa-angle-left"></i> + </a> + + + <a href="Install.html" class="navigation navigation-next " aria-label="Next page: Install"> + <i class="fa fa-angle-right"></i> + </a> + + + + </div> + + <script> + var gitbook = gitbook || []; + gitbook.push(function() { + gitbook.page.hasChanged({"page":{"title":"Usage","level":"1.2","depth":1,"next":{"title":"Install","level":"1.2.1","depth":2,"path":"Usage/Install.md","ref":"Usage/Install.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"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/lucena-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":"Usage/README.md","mtime":"2018-11-29T21:34:57.947Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-11-29T21:47:00.710Z"},"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> + |