diff options
Diffstat (limited to 'public/docs/Usage')
| -rw-r--r-- | public/docs/Usage/CLI/index.html | 890 | ||||
| -rw-r--r-- | public/docs/Usage/Configuration/index.html | 880 | ||||
| -rw-r--r-- | public/docs/Usage/Install/index.html | 819 |
3 files changed, 1250 insertions, 1339 deletions
diff --git a/public/docs/Usage/CLI/index.html b/public/docs/Usage/CLI/index.html index b89e230..bffd34d 100644 --- a/public/docs/Usage/CLI/index.html +++ b/public/docs/Usage/CLI/index.html @@ -1,38 +1,15 @@ - - - <!doctype html> <html lang="en" class="no-js"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> - <meta http-equiv="x-ua-compatible" content="ie=edge"> - - - - - <meta name="lang:clipboard.copy" content="Copy to clipboard"> - - <meta name="lang:clipboard.copied" content="Copied to clipboard"> - - <meta name="lang:search.language" content="en"> - - <meta name="lang:search.pipeline.stopwords" content="True"> - - <meta name="lang:search.pipeline.trimmer" content="True"> - - <meta name="lang:search.result.none" content="No matching documents"> - - <meta name="lang:search.result.one" content="1 matching document"> - <meta name="lang:search.result.other" content="# matching documents"> - <meta name="lang:search.tokenizer" content="[\s\-]+"> - <link rel="shortcut icon" href="../../assets/images/favicon.png"> - <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2"> + <link rel="icon" href="../../assets/images/favicon.png"> + <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-8.5.10"> @@ -40,126 +17,127 @@ - <link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css"> + <link rel="stylesheet" href="../../assets/stylesheets/main.975780f9.min.css"> + + <link rel="stylesheet" href="../../assets/stylesheets/palette.2505c338.min.css"> + + + - <script src="../../assets/javascripts/modernizr.74668098.js"></script> - - <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> - <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback"> - <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style> + + + <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"> + <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style> - <link rel="stylesheet" href="../../assets/fonts/material-icons.css"> + <link rel="stylesheet" href="../../assets/_mkdocstrings.css"> <link rel="stylesheet" href="../../assets/luxcena-colors.css"> + <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> + + </head> - <body dir="ltr"> - <svg class="md-svg"> - <defs> - - - </defs> - </svg> - <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> - <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> - <label class="md-overlay" data-md-component="overlay" for="__drawer"></label> - <a href="#command-line-interface" tabindex="1" class="md-skip"> - Skip to content - </a> - <header class="md-header" data-md-component="header"> - <nav class="md-header-nav md-grid"> - <div class="md-flex"> - <div class="md-flex__cell md-flex__cell--shrink"> - <a href="../.." title="Luxcena Neo Documentation" class="md-header-nav__button md-logo"> - - <i class="md-icon"></i> - + + + <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="None" data-md-color-accent="None"> + + + + <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> + <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> + <label class="md-overlay" for="__drawer"></label> + <div data-md-component="skip"> + + + <a href="#command-line-interface" class="md-skip"> + Skip to content </a> - </div> - <div class="md-flex__cell md-flex__cell--shrink"> - <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> - </div> - <div class="md-flex__cell md-flex__cell--stretch"> - <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> - - <span class="md-header-nav__topic"> - Luxcena Neo Documentation - </span> - <span class="md-header-nav__topic"> - - CLI - - </span> - + + </div> + <div data-md-component="announce"> + + </div> + + + + +<header class="md-header" data-md-component="header"> + <nav class="md-header__inner md-grid" aria-label="Header"> + <a href="../.." title="Luxcena Neo Documentation" class="md-header__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo"> + + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg> + + </a> + <label class="md-header__button md-icon" for="__drawer"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> + </label> + <div class="md-header__title" data-md-component="header-title"> + <div class="md-header__ellipsis"> + <div class="md-header__topic"> + <span class="md-ellipsis"> + Luxcena Neo Documentation + </span> </div> - </div> - <div class="md-flex__cell md-flex__cell--shrink"> - - <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> - -<div class="md-search" data-md-component="search" role="dialog"> - <label class="md-search__overlay" for="__search"></label> - <div class="md-search__inner" role="search"> - <form class="md-search__form" name="search"> - <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> - <label class="md-icon md-search__icon" for="__search"></label> - <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> -  - </button> - </form> - <div class="md-search__output"> - <div class="md-search__scrollwrap" data-md-scrollfix> - <div class="md-search-result" data-md-component="result"> - <div class="md-search-result__meta"> - Type to start searching - </div> - <ol class="md-search-result__list"></ol> + <div class="md-header__topic" data-md-component="header-topic"> + <span class="md-ellipsis"> + + CLI + + </span> </div> </div> </div> - </div> -</div> - - </div> - - </div> + + + + </nav> + </header> - <div class="md-container"> + <div class="md-container" data-md-component="container"> - + + + - <main class="md-main" role="main"> - <div class="md-main__inner md-grid" data-md-component="container"> + <main class="md-main" data-md-component="main"> + <div class="md-main__inner md-grid"> - <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> + + <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> - <nav class="md-nav md-nav--primary" data-md-level="0"> - <label class="md-nav__title md-nav__title--site" for="__drawer"> - <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo"> - - <i class="md-icon"></i> + + + +<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> + <label class="md-nav__title" for="__drawer"> + <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo"> + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg> + </a> Luxcena Neo Documentation </label> @@ -170,24 +148,30 @@ - - <li class="md-nav__item"> - <a href="../.." title="Introduction" class="md-nav__link"> - Introduction - </a> - </li> + + + + <li class="md-nav__item"> + <a href="../.." class="md-nav__link"> + Introduction + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../FuturePlan/" title="Plan for the future" class="md-nav__link"> - Plan for the future - </a> - </li> + + + + <li class="md-nav__item"> + <a href="../../FuturePlan/" class="md-nav__link"> + Plan for the future + </a> + </li> + @@ -195,84 +179,104 @@ - - - <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked> + + - <label class="md-nav__link" for="nav-3"> - Usage - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> - <label class="md-nav__title" for="nav-3"> - Usage - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - + <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked> + + + + + <label class="md-nav__link" for="__nav_3"> + Usage + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Usage" data-md-level="1"> + <label class="md-nav__title" for="__nav_3"> + <span class="md-nav__icon md-icon"></span> + Usage + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> + <a href="../Install/" class="md-nav__link"> + Install + </a> + </li> + - - <li class="md-nav__item"> - <a href="../Install/" title="Install" class="md-nav__link"> - Install - </a> - </li> - - - - + + + + + + + <li class="md-nav__item"> + <a href="../Configuration/" class="md-nav__link"> + Configuration + </a> + </li> + - - <li class="md-nav__item"> - <a href="../Configuration/" title="Configuration" class="md-nav__link"> - Configuration - </a> - </li> - - - - + - + + + - - - <li class="md-nav__item md-nav__item--active"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> + + + <li class="md-nav__item md-nav__item--active"> - - - <label class="md-nav__link md-nav__link--active" for="__toc"> + <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> + + + + + + <label class="md-nav__link md-nav__link--active" for="__toc"> + CLI + <span class="md-nav__icon md-icon"></span> + </label> + + <a href="./" class="md-nav__link md-nav__link--active"> CLI - </label> - - <a href="./" title="CLI" class="md-nav__link md-nav__link--active"> - CLI - </a> - + </a> -<nav class="md-nav md-nav--secondary"> + + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + - <label class="md-nav__title" for="__toc">Table of contents</label> - <ul class="md-nav__list" data-md-scrollfix> + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#options" class="md-nav__link"> Options </a> - <nav class="md-nav"> + <nav class="md-nav" aria-label="Options"> <ul class="md-nav__list"> <li class="md-nav__item"> @@ -343,212 +347,176 @@ </li> - - - - </ul> </nav> - - </li> + + </li> + - - </ul> - </nav> - </li> + + + </ul> + </nav> + </li> + - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4"> + + + - <label class="md-nav__link" for="nav-4"> - Scripting - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> - <label class="md-nav__title" for="nav-4"> - Scripting - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - + <li class="md-nav__item md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > + + + + + <label class="md-nav__link" for="__nav_4"> + Scripting + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Scripting" data-md-level="1"> + <label class="md-nav__title" for="__nav_4"> + <span class="md-nav__icon md-icon"></span> + Scripting + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> + <a href="../../Scripting/Strip/" class="md-nav__link"> + Strip + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../Scripting/SupportLib/" title="Support Library" class="md-nav__link"> - Support Library - </a> - </li> - - - - + + + + + + + <li class="md-nav__item"> + <a href="../../Scripting/NeoBehaviour/" class="md-nav__link"> + Main interface + </a> + </li> + - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4-2" type="checkbox" id="nav-4-2"> - - <label class="md-nav__link" for="nav-4-2"> - Examples - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> - <label class="md-nav__title" for="nav-4-2"> - Examples - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - + - - - <li class="md-nav__item"> - <a href="../../Scripting/Examples/strandtest/" title="Strandtest" class="md-nav__link"> - Strandtest - </a> - </li> - - - </ul> - </nav> - </li> - - - </ul> - </nav> - </li> + </ul> + </nav> + </li> + - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5"> - - <label class="md-nav__link" for="nav-5"> - Code Documentation - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> - <label class="md-nav__title" for="nav-5"> - Code Documentation - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1"> + + + - <label class="md-nav__link" for="nav-5-1"> - Modules - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> - <label class="md-nav__title" for="nav-5-1"> - Modules - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - - <li class="md-nav__item"> - <a href="../../Code Documentation/Modules/CompileAndRun/" title="CompileAndRun" class="md-nav__link"> - CompileAndRun - </a> - </li> - - - </ul> - </nav> - </li> - - - - + <li class="md-nav__item md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > + + + + + <label class="md-nav__link" for="__nav_5"> + Code Documentation + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Code Documentation" data-md-level="1"> + <label class="md-nav__title" for="__nav_5"> + <span class="md-nav__icon md-icon"></span> + Code Documentation + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> + <a href="../../Code%20Documentation/Run/" class="md-nav__link"> + Run + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../Code Documentation/Run/" title="Run" class="md-nav__link"> - Run - </a> - </li> - - - + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" > + + + + + <label class="md-nav__link" for="__nav_5_2"> + API + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="API" data-md-level="2"> + <label class="md-nav__title" for="__nav_5_2"> + <span class="md-nav__icon md-icon"></span> + API + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> + <a href="../../Code%20Documentation/SocketIO/" class="md-nav__link"> + Socket-IO + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../Code Documentation/Design/" title="Design" class="md-nav__link"> - Design - </a> - </li> - - - - + + </ul> + </nav> + </li> + - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-4" type="checkbox" id="nav-5-4"> - - <label class="md-nav__link" for="nav-5-4"> - API - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> - <label class="md-nav__title" for="nav-5-4"> - API - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - + - - - <li class="md-nav__item"> - <a href="../../Code Documentation/SocketIO/" title="Socket-IO" class="md-nav__link"> - Socket-IO - </a> - </li> - - - </ul> - </nav> - </li> - - - </ul> - </nav> - </li> + </ul> + </nav> + </li> + </ul> @@ -558,25 +526,31 @@ </div> - <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> + + <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> -<nav class="md-nav md-nav--secondary"> + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + - <label class="md-nav__title" for="__toc">Table of contents</label> - <ul class="md-nav__list" data-md-scrollfix> + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#options" class="md-nav__link"> Options </a> - <nav class="md-nav"> + <nav class="md-nav" aria-label="Options"> <ul class="md-nav__list"> <li class="md-nav__item"> @@ -647,10 +621,6 @@ </li> - - - - </ul> </nav> @@ -659,60 +629,48 @@ </div> - <div class="md-content"> - <article class="md-content__inner md-typeset"> - - + + <div class="md-content" data-md-component="content"> + <article class="md-content__inner md-typeset"> - <h1 id="command-line-interface">Command line interface</h1> + + + +<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: +<div class="highlight"><pre><span></span><code>$ luxcena-neo.sh +</code></pre></div> +or is alias +<div class="highlight"><pre><span></span><code>$ lux-neo +</code></pre></div></p> <div class="admonition danger"> <p class="admonition-title">Important!</p> -<p>This CLI assumes root access, so please run it with <code class="codehilite"><span class="n">sudo</span></code></p> +<p>This CLI assumes root access, so please run it with <code>sudo</code></p> </div> <h2 id="options">Options</h2> -<h3 id="sudo-lux-neo-uninstall"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="n">uninstall</span></code></h3> +<h3 id="sudo-lux-neo-uninstall"><code>sudo lux-neo uninstall</code></h3> <p>Uninstall the whole thing. You will have to remove this script yourself.</p> -<h3 id="sudo-lux-neo-update-skipnode"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="k">update</span> <span class="p">(</span><span class="n">skipNode</span><span class="p">)</span></code></h3> +<h3 id="sudo-lux-neo-update-skipnode"><code>sudo lux-neo update (skipNode)</code></h3> <p>Update to the newest version on the current branch. -If <code class="codehilite"><span class="n">skipNode</span></code> is the second argument, <code class="codehilite"><span class="n">npm</span></code> won't be run.</p> -<h3 id="sudo-lux-neo-conf"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="n">conf</span></code></h3> -<p>Open the strip-config in <code class="codehilite"><span class="n">nano</span></code>.</p> -<h3 id="sudo-lux-neo-start-boot"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="k">start</span> <span class="p">(</span><span class="n">boot</span><span class="p">)</span></code></h3> +If <code>skipNode</code> is the second argument, <code>npm</code> won't be run.</p> +<h3 id="sudo-lux-neo-conf"><code>sudo lux-neo conf</code></h3> +<p>Open the strip-config in <code>nano</code>.</p> +<h3 id="sudo-lux-neo-start-boot"><code>sudo lux-neo start (boot)</code></h3> <p>Start the server. -If you add <code class="codehilite"><span class="n">boot</span></code>, it will start when the system boots: -<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>sudo lux-neo start boot -</pre></div> -</td></tr></table></p> -<h3 id="sudo-lux-neo-stop-boot"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="n">stop</span> <span class="p">(</span><span class="n">boot</span><span class="p">)</span></code></h3> +If you add <code>boot</code>, it will start when the system boots: +<div class="highlight"><pre><span></span><code>sudo lux-neo start boot +</code></pre></div></p> +<h3 id="sudo-lux-neo-stop-boot"><code>sudo lux-neo stop (boot)</code></h3> <p>Stop the server. -If you add <code class="codehilite"><span class="n">boot</span></code>, it will <em>NOT</em> start when the system boots: -<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>sudo lux-neo start boot -</pre></div> -</td></tr></table></p> -<h3 id="sudo-lux-neo-status"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="n">status</span></code></h3> +If you add <code>boot</code>, it will <em>NOT</em> start when the system boots: +<div class="highlight"><pre><span></span><code>sudo lux-neo start boot +</code></pre></div></p> +<h3 id="sudo-lux-neo-status"><code>sudo lux-neo status</code></h3> <p>This will output the status of the app. First it reports if the service is running, and some general info. Then it prints the systemd-status report.</p> <p>Example output: -<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span> 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>Luxcena-neo-cli [args: 'status'] +<div class="highlight"><pre><span></span><code>Luxcena-neo-cli [args: 'status'] ╭─────────────────────╮ │ Service active: yes │ @@ -731,117 +689,110 @@ and some general info. Then it prints the systemd-status report.</p> Dec 05 22:55:28 LUXCENA-STUE-SKAP systemd[1]: Started Luxcena Neo. ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ -</pre></div> -</td></tr></table></p> -<h3 id="sudo-lux-neo-log-serviceapp"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="n">log</span> <span class="n">service</span><span class="o">/</span><span class="n">app</span></code></h3> +</code></pre></div></p> +<h3 id="sudo-lux-neo-log-serviceapp"><code>sudo lux-neo log service/app</code></h3> <p>This shows the last 20 lines of the chosen log-file. And stays open to show all new entries.</p> <p>Example output: -<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1 -2 -3 -4 -5</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>Luxcena-neo-cli [args: 'log app'] +<div class="highlight"><pre><span></span><code>Luxcena-neo-cli [args: 'log app'] ━━━App log (press ctrl+c to exit)━━━━━━━━━━━━━━━━━━ [3.11.2018 23:5:21:401] EVENT Starting Luxcena-Neo... [3.11.2018 23:5:22:462] SUCCESS Webserver now listening at *:8080 -</pre></div> -</td></tr></table></p> -<h3 id="sudo-lux-neo-version"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="k">version</span></code></h3> +</code></pre></div></p> +<h3 id="sudo-lux-neo-version"><code>sudo lux-neo version</code></h3> <p>Currently not really doing anything usefull apart from showing which branch you are on.</p> <p>Example output: -<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1 -2 -3 -4 -5 -6</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>Luxcena-neo-cli [args: 'version'] +<div class="highlight"><pre><span></span><code>Luxcena-neo-cli [args: 'version'] ╭─────────────────────╮ │ Version: Unknown │ │ branch : dev │ ╰─────────────────────╯ -</pre></div> -</td></tr></table></p> -<h3 id="sudo-lux-neo-selectbranch-branch"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="n">selectBranch</span> <span class="o"><</span><span class="n">branch</span><span class="o">></span></code></h3> +</code></pre></div></p> +<h3 id="sudo-lux-neo-selectbranch-branch"><code>sudo lux-neo selectBranch <branch></code></h3> <p>This will change what branch you are on to <branch>. Stashing changes (shouldn't be a concern, but just saying it anyways).</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Please note that the version-checker now will just be useless, as it does not now what branch we really are on.</p> </div> - - - - - - - - </article> - </div> + + + + + </article> + </div> + + </div> + </main> - -<footer class="md-footer"> + <footer class="md-footer"> - <div class="md-footer-nav"> - <nav class="md-footer-nav__inner md-grid"> + + <nav class="md-footer__inner md-grid" aria-label="Footer" > + - <a href="../Configuration/" title="Configuration" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> - <div class="md-flex__cell md-flex__cell--shrink"> - <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> - </div> - <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> - <span class="md-flex__ellipsis"> - <span class="md-footer-nav__direction"> - Previous - </span> - Configuration + <a href="../Configuration/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Configuration" rel="prev"> + <div class="md-footer__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> + </div> + <div class="md-footer__title"> + <div class="md-ellipsis"> + <span class="md-footer__direction"> + Previous </span> + Configuration </div> - </a> - + </div> + </a> + + - <a href="../../Scripting/SupportLib/" title="Support Library" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> - <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> - <span class="md-flex__ellipsis"> - <span class="md-footer-nav__direction"> - Next - </span> - Support Library + <a href="../../Scripting/Strip/" class="md-footer__link md-footer__link--next" aria-label="Next: Strip" rel="next"> + <div class="md-footer__title"> + <div class="md-ellipsis"> + <span class="md-footer__direction"> + Next </span> + Strip </div> - <div class="md-flex__cell md-flex__cell--shrink"> - <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> - </div> - </a> - - </nav> - </div> + </div> + <div class="md-footer__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> + </div> + </a> + + </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> - <div class="md-footer-copyright"> - - powered by - <a href="https://www.mkdocs.org">MkDocs</a> - and - <a href="https://squidfunk.github.io/mkdocs-material/"> - Material for MkDocs</a> - </div> + <div class="md-copyright"> + + + Made with + <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> + Material for MkDocs + </a> + +</div> </div> </div> </footer> </div> + <div class="md-dialog" data-md-component="dialog"> + <div class="md-dialog__inner md-typeset"></div> + </div> - <script src="../../assets/javascripts/application.c648116f.js"></script> - - <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script> + <script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.16e2a7d4.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script> + + + <script src="../../assets/javascripts/bundle.5a2dcb6a.min.js"></script> <script src="../../assets/luxcena-colors.js"></script> @@ -856,5 +807,6 @@ all new entries.</p> <script src="../../assets/js-sequence.js"></script> + </body> </html>
\ No newline at end of file diff --git a/public/docs/Usage/Configuration/index.html b/public/docs/Usage/Configuration/index.html index f1216e4..02a3297 100644 --- a/public/docs/Usage/Configuration/index.html +++ b/public/docs/Usage/Configuration/index.html @@ -1,38 +1,15 @@ - - - <!doctype html> <html lang="en" class="no-js"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> - <meta http-equiv="x-ua-compatible" content="ie=edge"> - - - - - <meta name="lang:clipboard.copy" content="Copy to clipboard"> - - <meta name="lang:clipboard.copied" content="Copied to clipboard"> - - <meta name="lang:search.language" content="en"> - - <meta name="lang:search.pipeline.stopwords" content="True"> - - <meta name="lang:search.pipeline.trimmer" content="True"> - - <meta name="lang:search.result.none" content="No matching documents"> - - <meta name="lang:search.result.one" content="1 matching document"> - <meta name="lang:search.result.other" content="# matching documents"> - <meta name="lang:search.tokenizer" content="[\s\-]+"> - <link rel="shortcut icon" href="../../assets/images/favicon.png"> - <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2"> + <link rel="icon" href="../../assets/images/favicon.png"> + <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-8.5.10"> @@ -40,126 +17,127 @@ - <link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css"> + <link rel="stylesheet" href="../../assets/stylesheets/main.975780f9.min.css"> + + <link rel="stylesheet" href="../../assets/stylesheets/palette.2505c338.min.css"> + + + - <script src="../../assets/javascripts/modernizr.74668098.js"></script> - - <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> - <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback"> - <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style> + + + <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"> + <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style> - <link rel="stylesheet" href="../../assets/fonts/material-icons.css"> + <link rel="stylesheet" href="../../assets/_mkdocstrings.css"> <link rel="stylesheet" href="../../assets/luxcena-colors.css"> + <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> + + </head> - <body dir="ltr"> - <svg class="md-svg"> - <defs> - - - </defs> - </svg> - <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> - <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> - <label class="md-overlay" data-md-component="overlay" for="__drawer"></label> - <a href="#configuration" tabindex="1" class="md-skip"> - Skip to content - </a> - <header class="md-header" data-md-component="header"> - <nav class="md-header-nav md-grid"> - <div class="md-flex"> - <div class="md-flex__cell md-flex__cell--shrink"> - <a href="../.." title="Luxcena Neo Documentation" class="md-header-nav__button md-logo"> - - <i class="md-icon"></i> - + + + <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="None" data-md-color-accent="None"> + + + + <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> + <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> + <label class="md-overlay" for="__drawer"></label> + <div data-md-component="skip"> + + + <a href="#configuration" class="md-skip"> + Skip to content </a> - </div> - <div class="md-flex__cell md-flex__cell--shrink"> - <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> - </div> - <div class="md-flex__cell md-flex__cell--stretch"> - <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> - - <span class="md-header-nav__topic"> - Luxcena Neo Documentation - </span> - <span class="md-header-nav__topic"> - - Configuration - - </span> - + + </div> + <div data-md-component="announce"> + + </div> + + + + +<header class="md-header" data-md-component="header"> + <nav class="md-header__inner md-grid" aria-label="Header"> + <a href="../.." title="Luxcena Neo Documentation" class="md-header__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo"> + + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg> + + </a> + <label class="md-header__button md-icon" for="__drawer"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> + </label> + <div class="md-header__title" data-md-component="header-title"> + <div class="md-header__ellipsis"> + <div class="md-header__topic"> + <span class="md-ellipsis"> + Luxcena Neo Documentation + </span> </div> - </div> - <div class="md-flex__cell md-flex__cell--shrink"> - - <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> - -<div class="md-search" data-md-component="search" role="dialog"> - <label class="md-search__overlay" for="__search"></label> - <div class="md-search__inner" role="search"> - <form class="md-search__form" name="search"> - <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> - <label class="md-icon md-search__icon" for="__search"></label> - <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> -  - </button> - </form> - <div class="md-search__output"> - <div class="md-search__scrollwrap" data-md-scrollfix> - <div class="md-search-result" data-md-component="result"> - <div class="md-search-result__meta"> - Type to start searching - </div> - <ol class="md-search-result__list"></ol> + <div class="md-header__topic" data-md-component="header-topic"> + <span class="md-ellipsis"> + + Configuration + + </span> </div> </div> </div> - </div> -</div> - - </div> - - </div> + + + + </nav> + </header> - <div class="md-container"> + <div class="md-container" data-md-component="container"> - + + + - <main class="md-main" role="main"> - <div class="md-main__inner md-grid" data-md-component="container"> + <main class="md-main" data-md-component="main"> + <div class="md-main__inner md-grid"> - <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> + + <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> - <nav class="md-nav md-nav--primary" data-md-level="0"> - <label class="md-nav__title md-nav__title--site" for="__drawer"> - <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo"> - - <i class="md-icon"></i> + + + +<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> + <label class="md-nav__title" for="__drawer"> + <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo"> + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg> + </a> Luxcena Neo Documentation </label> @@ -170,24 +148,30 @@ - - <li class="md-nav__item"> - <a href="../.." title="Introduction" class="md-nav__link"> - Introduction - </a> - </li> + + + + <li class="md-nav__item"> + <a href="../.." class="md-nav__link"> + Introduction + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../FuturePlan/" title="Plan for the future" class="md-nav__link"> - Plan for the future - </a> - </li> + + + + <li class="md-nav__item"> + <a href="../../FuturePlan/" class="md-nav__link"> + Plan for the future + </a> + </li> + @@ -195,65 +179,83 @@ - - - <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked> + + - <label class="md-nav__link" for="nav-3"> - Usage - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> - <label class="md-nav__title" for="nav-3"> - Usage - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - + <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked> + + + + + <label class="md-nav__link" for="__nav_3"> + Usage + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Usage" data-md-level="1"> + <label class="md-nav__title" for="__nav_3"> + <span class="md-nav__icon md-icon"></span> + Usage + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> + <a href="../Install/" class="md-nav__link"> + Install + </a> + </li> + - - <li class="md-nav__item"> - <a href="../Install/" title="Install" class="md-nav__link"> - Install - </a> - </li> - - - - + - + + + - - - <li class="md-nav__item md-nav__item--active"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> + + + <li class="md-nav__item md-nav__item--active"> - - - <label class="md-nav__link md-nav__link--active" for="__toc"> + <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> + + + + + + <label class="md-nav__link md-nav__link--active" for="__toc"> + Configuration + <span class="md-nav__icon md-icon"></span> + </label> + + <a href="./" class="md-nav__link md-nav__link--active"> Configuration - </label> - - <a href="./" title="Configuration" class="md-nav__link md-nav__link--active"> - Configuration - </a> - + </a> -<nav class="md-nav md-nav--secondary"> + + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + - <label class="md-nav__title" for="__toc">Table of contents</label> - <ul class="md-nav__list" data-md-scrollfix> + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#led_count" class="md-nav__link"> @@ -291,6 +293,13 @@ </li> <li class="md-nav__item"> + <a href="#led_dma" class="md-nav__link"> + led_dma + </a> + +</li> + + <li class="md-nav__item"> <a href="#led_invert" class="md-nav__link"> led_invert </a> @@ -304,224 +313,190 @@ </li> - - - - </ul> </nav> - - </li> + + </li> + - - - + + + + + + + <li class="md-nav__item"> + <a href="../CLI/" class="md-nav__link"> + CLI + </a> + </li> + - - <li class="md-nav__item"> - <a href="../CLI/" title="CLI" class="md-nav__link"> - CLI - </a> - </li> - - - </ul> - </nav> - </li> + + + </ul> + </nav> + </li> + - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4"> + + + - <label class="md-nav__link" for="nav-4"> - Scripting - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> - <label class="md-nav__title" for="nav-4"> - Scripting - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - + <li class="md-nav__item md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > + + + + + <label class="md-nav__link" for="__nav_4"> + Scripting + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Scripting" data-md-level="1"> + <label class="md-nav__title" for="__nav_4"> + <span class="md-nav__icon md-icon"></span> + Scripting + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> + <a href="../../Scripting/Strip/" class="md-nav__link"> + Strip + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../Scripting/SupportLib/" title="Support Library" class="md-nav__link"> - Support Library - </a> - </li> - - - - + + + + + + + <li class="md-nav__item"> + <a href="../../Scripting/NeoBehaviour/" class="md-nav__link"> + Main interface + </a> + </li> + - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4-2" type="checkbox" id="nav-4-2"> - - <label class="md-nav__link" for="nav-4-2"> - Examples - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> - <label class="md-nav__title" for="nav-4-2"> - Examples - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - + - - - <li class="md-nav__item"> - <a href="../../Scripting/Examples/strandtest/" title="Strandtest" class="md-nav__link"> - Strandtest - </a> - </li> - - - </ul> - </nav> - </li> - - - </ul> - </nav> - </li> + </ul> + </nav> + </li> + - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5"> - - <label class="md-nav__link" for="nav-5"> - Code Documentation - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> - <label class="md-nav__title" for="nav-5"> - Code Documentation - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1"> + + + - <label class="md-nav__link" for="nav-5-1"> - Modules - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> - <label class="md-nav__title" for="nav-5-1"> - Modules - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - - <li class="md-nav__item"> - <a href="../../Code Documentation/Modules/CompileAndRun/" title="CompileAndRun" class="md-nav__link"> - CompileAndRun - </a> - </li> - - - </ul> - </nav> - </li> - - - - + <li class="md-nav__item md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > + + + + + <label class="md-nav__link" for="__nav_5"> + Code Documentation + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Code Documentation" data-md-level="1"> + <label class="md-nav__title" for="__nav_5"> + <span class="md-nav__icon md-icon"></span> + Code Documentation + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> + <a href="../../Code%20Documentation/Run/" class="md-nav__link"> + Run + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../Code Documentation/Run/" title="Run" class="md-nav__link"> - Run - </a> - </li> - - - + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" > + + + + + <label class="md-nav__link" for="__nav_5_2"> + API + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="API" data-md-level="2"> + <label class="md-nav__title" for="__nav_5_2"> + <span class="md-nav__icon md-icon"></span> + API + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> + <a href="../../Code%20Documentation/SocketIO/" class="md-nav__link"> + Socket-IO + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../Code Documentation/Design/" title="Design" class="md-nav__link"> - Design - </a> - </li> - - - - + + </ul> + </nav> + </li> + - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-4" type="checkbox" id="nav-5-4"> - - <label class="md-nav__link" for="nav-5-4"> - API - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> - <label class="md-nav__title" for="nav-5-4"> - API - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - + - - - <li class="md-nav__item"> - <a href="../../Code Documentation/SocketIO/" title="Socket-IO" class="md-nav__link"> - Socket-IO - </a> - </li> - - - </ul> - </nav> - </li> - - - </ul> - </nav> - </li> + </ul> + </nav> + </li> + </ul> @@ -531,18 +506,24 @@ </div> - <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> + + <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> -<nav class="md-nav md-nav--secondary"> + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + - <label class="md-nav__title" for="__toc">Table of contents</label> - <ul class="md-nav__list" data-md-scrollfix> + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#led_count" class="md-nav__link"> @@ -580,6 +561,13 @@ </li> <li class="md-nav__item"> + <a href="#led_dma" class="md-nav__link"> + led_dma + </a> + +</li> + + <li class="md-nav__item"> <a href="#led_invert" class="md-nav__link"> led_invert </a> @@ -593,10 +581,6 @@ </li> - - - - </ul> </nav> @@ -605,43 +589,34 @@ </div> - <div class="md-content"> - <article class="md-content__inner md-typeset"> - - + + <div class="md-content" data-md-component="content"> + <article class="md-content__inner md-typeset"> - <h1 id="configuration">Configuration</h1> + + + +<h1 id="configuration">Configuration</h1> <p>How to setup luxcena-neo to work with your setup</p> <hr /> -<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>$ sudo lux-neo conf -</pre></div> -</td></tr></table> - +<div class="highlight"><pre><span></span><code>$ sudo lux-neo conf +</code></pre></div> <p>When running the command above, a config file should appear in the editor 'nano'. -<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span> 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 -10 -11</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="p">{</span> - <span class="nt">"led_count"</span><span class="p">:</span> <span class="mi">53</span><span class="p">,</span> - <span class="nt">"segments"</span><span class="p">:</span> <span class="p">[],</span> - <span class="nt">"matrix"</span><span class="p">:</span> <span class="p">[],</span> - <span class="nt">"segmentConfiguration"</span><span class="p">:</span> <span class="s2">"snake"</span><span class="p">,</span> - <span class="nt">"led_pin"</span><span class="p">:</span> <span class="mi">18</span><span class="p">,</span> - <span class="nt">"led_freq_hz"</span><span class="p">:</span> <span class="mi">800000</span><span class="p">,</span> - <span class="nt">"led_dma"</span><span class="p">:</span> <span class="mi">10</span><span class="p">,</span> - <span class="nt">"led_invert"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span> - <span class="nt">"led_channel"</span><span class="p">:</span> <span class="mi">0</span> -<span class="p">}</span> -</pre></div> -</td></tr></table></p> -<details class="tip"><summary>Tip - Change editor</summary><p>If you rather want to use vim or another editor, the file is at <code class="codehilite"><span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">lux</span><span class="o">-</span><span class="n">neo</span><span class="o">/</span><span class="n">userdata</span><span class="o">/</span><span class="n">config</span><span class="o">/</span><span class="n">strip</span><span class="p">.</span><span class="n">json</span></code></p> +<div class="highlight"><pre><span></span><code><span class="p">{</span><span class="w"></span> +<span class="w"> </span><span class="nt">"led_count"</span><span class="p">:</span><span class="w"> </span><span class="mi">53</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"segments"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w"></span> +<span class="w"> </span><span class="nt">"matrix"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w"></span> +<span class="w"> </span><span class="nt">"segmentConfiguration"</span><span class="p">:</span><span class="w"> </span><span class="s2">"snake"</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"led_pin"</span><span class="p">:</span><span class="w"> </span><span class="mi">18</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"led_freq_hz"</span><span class="p">:</span><span class="w"> </span><span class="mi">800000</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"led_dma"</span><span class="p">:</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"led_invert"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w"></span> +<span class="w"> </span><span class="nt">"led_channel"</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="w"></span> +<span class="p">}</span><span class="w"></span> +</code></pre></div></p> +<details class="tip"> +<summary>Tip - Change editor</summary> +<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> </details> <h2 id="led_count">led_count</h2> <p>This is the number of LED's you want to control.</p> @@ -650,22 +625,27 @@ <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> +<p><div class="highlight"><pre><span></span><code><span class="nt">"segments"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="mi">10</span><span class="p">,</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> </span><span class="mi">10</span><span class="p">,</span><span class="w"> </span><span class="mi">10</span><span class="p">],</span><span class="w"></span> +<span class="nt">"matrix"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span> +<span class="w"> </span><span class="p">[[</span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="kc">false</span><span class="p">],</span><span class="w"> </span><span class="p">[</span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="kc">true</span><span class="p">],</span><span class="w"> </span><span class="p">[</span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="kc">false</span><span class="p">]],</span><span class="w"></span> +<span class="w"> </span><span class="p">[[</span><span class="mi">3</span><span class="p">,</span><span class="w"> </span><span class="kc">true</span><span class="p">],</span><span class="w"> </span><span class="p">[</span><span class="mi">4</span><span class="p">,</span><span class="w"> </span><span class="kc">false</span><span class="p">],</span><span class="w"> </span><span class="p">[</span><span class="mi">5</span><span class="p">,</span><span class="w"> </span><span class="kc">true</span><span class="p">]],</span><span class="w"></span> +<span class="w"> </span><span class="p">[[</span><span class="mi">6</span><span class="p">,</span><span class="w"> </span><span class="kc">false</span><span class="p">],</span><span class="w"> </span><span class="p">[</span><span class="mi">7</span><span class="p">,</span><span class="w"> </span><span class="kc">true</span><span class="p">],</span><span class="w"> </span><span class="p">[</span><span class="mi">8</span><span class="p">,</span><span class="w"> </span><span class="kc">false</span><span class="p">]]</span><span class="w"></span> +<span class="p">]</span><span class="w"></span> +</code></pre></div> +Each entry looks is a list, with two parameters, <code>[<segment_number>, <invert>]</code></p> <div class="admonition danger"> <p class="admonition-title">Warning</p> <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> <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> -<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1 -2 -3</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="s2">"snake"</span><span class="err">:</span> -<span class="s2">"line"</span><span class="err">:</span> -<span class="s2">"random"</span><span class="err">:</span> -</pre></div> -</td></tr></table> - +<div class="highlight"><pre><span></span><code><span class="nt">"snake"</span><span class="p">:</span><span class="w"></span> +<span class="nt">"line"</span><span class="p">:</span><span class="w"></span> +<span class="nt">"random"</span><span class="p">:</span><span class="w"></span> +</code></pre></div> <h2 id="led_pin">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="led_dma">led_dma</h2> <div class="admonition danger"> <p class="admonition-title">Warning</p> <p>If using a newer RPi (3 or newer), leave this as 10! Or your file-system might crash.</p> @@ -677,78 +657,83 @@ <p>Leave this as default unless you know what you are doing.</p> <hr /> <p>Now you might want to take a look at the <a href="/Usage/CLI.md">command line interface</a>.</p> - - - - - - - - </article> - </div> + + + + + </article> + </div> + + </div> + </main> - -<footer class="md-footer"> + <footer class="md-footer"> - <div class="md-footer-nav"> - <nav class="md-footer-nav__inner md-grid"> + + <nav class="md-footer__inner md-grid" aria-label="Footer" > + - <a href="../Install/" title="Install" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> - <div class="md-flex__cell md-flex__cell--shrink"> - <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> - </div> - <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> - <span class="md-flex__ellipsis"> - <span class="md-footer-nav__direction"> - Previous - </span> - Install + <a href="../Install/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Install" rel="prev"> + <div class="md-footer__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> + </div> + <div class="md-footer__title"> + <div class="md-ellipsis"> + <span class="md-footer__direction"> + Previous </span> + Install </div> - </a> - + </div> + </a> + + - <a href="../CLI/" title="CLI" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> - <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> - <span class="md-flex__ellipsis"> - <span class="md-footer-nav__direction"> - Next - </span> - CLI + <a href="../CLI/" class="md-footer__link md-footer__link--next" aria-label="Next: CLI" rel="next"> + <div class="md-footer__title"> + <div class="md-ellipsis"> + <span class="md-footer__direction"> + Next </span> + CLI </div> - <div class="md-flex__cell md-flex__cell--shrink"> - <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> - </div> - </a> - - </nav> - </div> + </div> + <div class="md-footer__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> + </div> + </a> + + </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> - <div class="md-footer-copyright"> - - powered by - <a href="https://www.mkdocs.org">MkDocs</a> - and - <a href="https://squidfunk.github.io/mkdocs-material/"> - Material for MkDocs</a> - </div> + <div class="md-copyright"> + + + Made with + <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> + Material for MkDocs + </a> + +</div> </div> </div> </footer> </div> + <div class="md-dialog" data-md-component="dialog"> + <div class="md-dialog__inner md-typeset"></div> + </div> - <script src="../../assets/javascripts/application.c648116f.js"></script> - - <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script> + <script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.16e2a7d4.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script> + + + <script src="../../assets/javascripts/bundle.5a2dcb6a.min.js"></script> <script src="../../assets/luxcena-colors.js"></script> @@ -763,5 +748,6 @@ <script src="../../assets/js-sequence.js"></script> + </body> </html>
\ No newline at end of file diff --git a/public/docs/Usage/Install/index.html b/public/docs/Usage/Install/index.html index 9da9810..6f10b75 100644 --- a/public/docs/Usage/Install/index.html +++ b/public/docs/Usage/Install/index.html @@ -1,38 +1,15 @@ - - - <!doctype html> <html lang="en" class="no-js"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> - <meta http-equiv="x-ua-compatible" content="ie=edge"> - - - - - <meta name="lang:clipboard.copy" content="Copy to clipboard"> - - <meta name="lang:clipboard.copied" content="Copied to clipboard"> - - <meta name="lang:search.language" content="en"> - - <meta name="lang:search.pipeline.stopwords" content="True"> - - <meta name="lang:search.pipeline.trimmer" content="True"> - - <meta name="lang:search.result.none" content="No matching documents"> - - <meta name="lang:search.result.one" content="1 matching document"> - <meta name="lang:search.result.other" content="# matching documents"> - <meta name="lang:search.tokenizer" content="[\s\-]+"> - <link rel="shortcut icon" href="../../assets/images/favicon.png"> - <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2"> + <link rel="icon" href="../../assets/images/favicon.png"> + <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-8.5.10"> @@ -40,126 +17,127 @@ - <link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css"> + <link rel="stylesheet" href="../../assets/stylesheets/main.975780f9.min.css"> + + <link rel="stylesheet" href="../../assets/stylesheets/palette.2505c338.min.css"> + + + - <script src="../../assets/javascripts/modernizr.74668098.js"></script> - - <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> - <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback"> - <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style> + + + <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"> + <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style> - <link rel="stylesheet" href="../../assets/fonts/material-icons.css"> + <link rel="stylesheet" href="../../assets/_mkdocstrings.css"> <link rel="stylesheet" href="../../assets/luxcena-colors.css"> + <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> + + </head> - <body dir="ltr"> - <svg class="md-svg"> - <defs> - - - </defs> - </svg> - <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> - <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> - <label class="md-overlay" data-md-component="overlay" for="__drawer"></label> - <a href="#installation" tabindex="1" class="md-skip"> - Skip to content - </a> - <header class="md-header" data-md-component="header"> - <nav class="md-header-nav md-grid"> - <div class="md-flex"> - <div class="md-flex__cell md-flex__cell--shrink"> - <a href="../.." title="Luxcena Neo Documentation" class="md-header-nav__button md-logo"> - - <i class="md-icon"></i> - + + + <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="None" data-md-color-accent="None"> + + + + <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> + <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> + <label class="md-overlay" for="__drawer"></label> + <div data-md-component="skip"> + + + <a href="#installation" class="md-skip"> + Skip to content </a> - </div> - <div class="md-flex__cell md-flex__cell--shrink"> - <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> - </div> - <div class="md-flex__cell md-flex__cell--stretch"> - <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> - - <span class="md-header-nav__topic"> - Luxcena Neo Documentation - </span> - <span class="md-header-nav__topic"> - - Install - - </span> - + + </div> + <div data-md-component="announce"> + + </div> + + + + +<header class="md-header" data-md-component="header"> + <nav class="md-header__inner md-grid" aria-label="Header"> + <a href="../.." title="Luxcena Neo Documentation" class="md-header__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo"> + + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg> + + </a> + <label class="md-header__button md-icon" for="__drawer"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> + </label> + <div class="md-header__title" data-md-component="header-title"> + <div class="md-header__ellipsis"> + <div class="md-header__topic"> + <span class="md-ellipsis"> + Luxcena Neo Documentation + </span> </div> - </div> - <div class="md-flex__cell md-flex__cell--shrink"> - - <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> - -<div class="md-search" data-md-component="search" role="dialog"> - <label class="md-search__overlay" for="__search"></label> - <div class="md-search__inner" role="search"> - <form class="md-search__form" name="search"> - <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> - <label class="md-icon md-search__icon" for="__search"></label> - <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> -  - </button> - </form> - <div class="md-search__output"> - <div class="md-search__scrollwrap" data-md-scrollfix> - <div class="md-search-result" data-md-component="result"> - <div class="md-search-result__meta"> - Type to start searching - </div> - <ol class="md-search-result__list"></ol> + <div class="md-header__topic" data-md-component="header-topic"> + <span class="md-ellipsis"> + + Install + + </span> </div> </div> </div> - </div> -</div> - - </div> - - </div> + + + + </nav> + </header> - <div class="md-container"> + <div class="md-container" data-md-component="container"> - + + + - <main class="md-main" role="main"> - <div class="md-main__inner md-grid" data-md-component="container"> + <main class="md-main" data-md-component="main"> + <div class="md-main__inner md-grid"> - <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> + + <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> - <nav class="md-nav md-nav--primary" data-md-level="0"> - <label class="md-nav__title md-nav__title--site" for="__drawer"> - <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo"> - - <i class="md-icon"></i> + + + +<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> + <label class="md-nav__title" for="__drawer"> + <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo" aria-label="Luxcena Neo Documentation" data-md-component="logo"> + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg> + </a> Luxcena Neo Documentation </label> @@ -170,24 +148,30 @@ - - <li class="md-nav__item"> - <a href="../.." title="Introduction" class="md-nav__link"> - Introduction - </a> - </li> + + + + <li class="md-nav__item"> + <a href="../.." class="md-nav__link"> + Introduction + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../FuturePlan/" title="Plan for the future" class="md-nav__link"> - Plan for the future - </a> - </li> + + + + <li class="md-nav__item"> + <a href="../../FuturePlan/" class="md-nav__link"> + Plan for the future + </a> + </li> + @@ -195,53 +179,69 @@ - - - <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked> + + - <label class="md-nav__link" for="nav-3"> - Usage - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> - <label class="md-nav__title" for="nav-3"> - Usage - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - + <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" checked> + + + + + <label class="md-nav__link" for="__nav_3"> + Usage + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Usage" data-md-level="1"> + <label class="md-nav__title" for="__nav_3"> + <span class="md-nav__icon md-icon"></span> + Usage + </label> + <ul class="md-nav__list" data-md-scrollfix> - + + + - - - <li class="md-nav__item md-nav__item--active"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> + + + <li class="md-nav__item md-nav__item--active"> - - - <label class="md-nav__link md-nav__link--active" for="__toc"> + <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> + + + + + + <label class="md-nav__link md-nav__link--active" for="__toc"> + Install + <span class="md-nav__icon md-icon"></span> + </label> + + <a href="./" class="md-nav__link md-nav__link--active"> Install - </label> - - <a href="./" title="Install" class="md-nav__link md-nav__link--active"> - Install - </a> - + </a> -<nav class="md-nav md-nav--secondary"> + + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + - <label class="md-nav__title" for="__toc">Table of contents</label> - <ul class="md-nav__list" data-md-scrollfix> + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#requirements" class="md-nav__link"> @@ -264,236 +264,204 @@ </li> - - - - </ul> </nav> - - </li> + + </li> + - - - + + + + + + + <li class="md-nav__item"> + <a href="../Configuration/" class="md-nav__link"> + Configuration + </a> + </li> + - - <li class="md-nav__item"> - <a href="../Configuration/" title="Configuration" class="md-nav__link"> - Configuration - </a> - </li> - - - - + + + + + + + <li class="md-nav__item"> + <a href="../CLI/" class="md-nav__link"> + CLI + </a> + </li> + - - <li class="md-nav__item"> - <a href="../CLI/" title="CLI" class="md-nav__link"> - CLI - </a> - </li> - - - </ul> - </nav> - </li> + + + </ul> + </nav> + </li> + - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4"> + + + - <label class="md-nav__link" for="nav-4"> - Scripting - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> - <label class="md-nav__title" for="nav-4"> - Scripting - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - + <li class="md-nav__item md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > + + + + + <label class="md-nav__link" for="__nav_4"> + Scripting + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Scripting" data-md-level="1"> + <label class="md-nav__title" for="__nav_4"> + <span class="md-nav__icon md-icon"></span> + Scripting + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> + <a href="../../Scripting/Strip/" class="md-nav__link"> + Strip + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../Scripting/SupportLib/" title="Support Library" class="md-nav__link"> - Support Library - </a> - </li> - - - - + + + + + + + <li class="md-nav__item"> + <a href="../../Scripting/NeoBehaviour/" class="md-nav__link"> + Main interface + </a> + </li> + - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4-2" type="checkbox" id="nav-4-2"> - - <label class="md-nav__link" for="nav-4-2"> - Examples - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> - <label class="md-nav__title" for="nav-4-2"> - Examples - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - + - - - <li class="md-nav__item"> - <a href="../../Scripting/Examples/strandtest/" title="Strandtest" class="md-nav__link"> - Strandtest - </a> - </li> - - - </ul> - </nav> - </li> - - - </ul> - </nav> - </li> + </ul> + </nav> + </li> + - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5"> - - <label class="md-nav__link" for="nav-5"> - Code Documentation - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> - <label class="md-nav__title" for="nav-5"> - Code Documentation - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1"> + + + - <label class="md-nav__link" for="nav-5-1"> - Modules - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> - <label class="md-nav__title" for="nav-5-1"> - Modules - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - - <li class="md-nav__item"> - <a href="../../Code Documentation/Modules/CompileAndRun/" title="CompileAndRun" class="md-nav__link"> - CompileAndRun - </a> - </li> - - - </ul> - </nav> - </li> - - - - + <li class="md-nav__item md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > + + + + + <label class="md-nav__link" for="__nav_5"> + Code Documentation + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="Code Documentation" data-md-level="1"> + <label class="md-nav__title" for="__nav_5"> + <span class="md-nav__icon md-icon"></span> + Code Documentation + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> + <a href="../../Code%20Documentation/Run/" class="md-nav__link"> + Run + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../Code Documentation/Run/" title="Run" class="md-nav__link"> - Run - </a> - </li> - - - + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_2" type="checkbox" id="__nav_5_2" > + + + + + <label class="md-nav__link" for="__nav_5_2"> + API + <span class="md-nav__icon md-icon"></span> + </label> + + <nav class="md-nav" aria-label="API" data-md-level="2"> + <label class="md-nav__title" for="__nav_5_2"> + <span class="md-nav__icon md-icon"></span> + API + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> + <a href="../../Code%20Documentation/SocketIO/" class="md-nav__link"> + Socket-IO + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../Code Documentation/Design/" title="Design" class="md-nav__link"> - Design - </a> - </li> - - - - + + </ul> + </nav> + </li> + - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-4" type="checkbox" id="nav-5-4"> - - <label class="md-nav__link" for="nav-5-4"> - API - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> - <label class="md-nav__title" for="nav-5-4"> - API - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - + - - - <li class="md-nav__item"> - <a href="../../Code Documentation/SocketIO/" title="Socket-IO" class="md-nav__link"> - Socket-IO - </a> - </li> - - - </ul> - </nav> - </li> - - - </ul> - </nav> - </li> + </ul> + </nav> + </li> + </ul> @@ -503,18 +471,24 @@ </div> - <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> + + <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> -<nav class="md-nav md-nav--secondary"> + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + - <label class="md-nav__title" for="__toc">Table of contents</label> - <ul class="md-nav__list" data-md-scrollfix> + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#requirements" class="md-nav__link"> @@ -537,10 +511,6 @@ </li> - - - - </ul> </nav> @@ -549,41 +519,38 @@ </div> - <div class="md-content"> - <article class="md-content__inner md-typeset"> - - + + <div class="md-content" data-md-component="content"> + <article class="md-content__inner md-typeset"> - <h1 id="installation">Installation</h1> + + + +<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 class="codehilite"><span class="n">sudo</span></code> command)</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 -<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1 -2 -3</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>git clone https://github.com/JakobST1n/Luxcena-Neo +<div class="highlight"><pre><span></span><code>git clone https://github.com/JakobST1n/Luxcena-Neo <span class="nb">cd</span> Luxcena-Neo sudo ./bin/install.sh -</pre></div> -</td></tr></table></li> +</code></pre></div></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: -<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>tail -n <span class="m">10</span> -f /tmp/luxcena-neo.install.log -</pre></div> -</td></tr></table> +<div class="highlight"><pre><span></span><code>tail -n <span class="m">10</span> -f /tmp/luxcena-neo.install.log +</code></pre></div> 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 -<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>luxcena-neo start -</pre></div> -</td></tr></table></li> +<div class="highlight"><pre><span></span><code>luxcena-neo start +</code></pre></div></li> </ol> <div class="admonition default user"> <p class="admonition-title">neo":"luxcena-neo</p> @@ -592,78 +559,83 @@ This is also where you will find possible reasons for a failed install.</li> <p>We haven't encountered any troubles yet, but once we do, we will post fix'es here.</p> <hr /> <p>You should now be all set to <a href="/Usage/Configuration.md">configuring luxcena-neo</a>.</p> - - - - - - - - </article> - </div> + + + + + </article> + </div> + + </div> + </main> - -<footer class="md-footer"> + <footer class="md-footer"> - <div class="md-footer-nav"> - <nav class="md-footer-nav__inner md-grid"> + + <nav class="md-footer__inner md-grid" aria-label="Footer" > + - <a href="../../FuturePlan/" title="Plan for the future" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> - <div class="md-flex__cell md-flex__cell--shrink"> - <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> - </div> - <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> - <span class="md-flex__ellipsis"> - <span class="md-footer-nav__direction"> - Previous - </span> - Plan for the future + <a href="../../FuturePlan/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Plan for the future" rel="prev"> + <div class="md-footer__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> + </div> + <div class="md-footer__title"> + <div class="md-ellipsis"> + <span class="md-footer__direction"> + Previous </span> + Plan for the future </div> - </a> - + </div> + </a> + + - <a href="../Configuration/" title="Configuration" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> - <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> - <span class="md-flex__ellipsis"> - <span class="md-footer-nav__direction"> - Next - </span> - Configuration + <a href="../Configuration/" class="md-footer__link md-footer__link--next" aria-label="Next: Configuration" rel="next"> + <div class="md-footer__title"> + <div class="md-ellipsis"> + <span class="md-footer__direction"> + Next </span> + Configuration </div> - <div class="md-flex__cell md-flex__cell--shrink"> - <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> - </div> - </a> - - </nav> - </div> + </div> + <div class="md-footer__button md-icon"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> + </div> + </a> + + </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> - <div class="md-footer-copyright"> - - powered by - <a href="https://www.mkdocs.org">MkDocs</a> - and - <a href="https://squidfunk.github.io/mkdocs-material/"> - Material for MkDocs</a> - </div> + <div class="md-copyright"> + + + Made with + <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> + Material for MkDocs + </a> + +</div> </div> </div> </footer> </div> + <div class="md-dialog" data-md-component="dialog"> + <div class="md-dialog__inner md-typeset"></div> + </div> - <script src="../../assets/javascripts/application.c648116f.js"></script> - - <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script> + <script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.16e2a7d4.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script> + + + <script src="../../assets/javascripts/bundle.5a2dcb6a.min.js"></script> <script src="../../assets/luxcena-colors.js"></script> @@ -678,5 +650,6 @@ This is also where you will find possible reasons for a failed install.</li> <script src="../../assets/js-sequence.js"></script> + </body> </html>
\ No newline at end of file |