diff options
Diffstat (limited to 'public/docs/Scripting/SupportLib/index.html')
| -rw-r--r-- | public/docs/Scripting/SupportLib/index.html | 1067 |
1 files changed, 485 insertions, 582 deletions
diff --git a/public/docs/Scripting/SupportLib/index.html b/public/docs/Scripting/SupportLib/index.html index 870452f..fc81557 100644 --- a/public/docs/Scripting/SupportLib/index.html +++ b/public/docs/Scripting/SupportLib/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="#support-library" 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="#support-library" 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"> - - Support Library - - </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"> + + Support Library + + </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,220 +148,351 @@ - - <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> + - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3"> + + + - <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--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" > + + + + + <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="../../Usage/Install/" class="md-nav__link"> + Install + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../Usage/Install/" title="Install" class="md-nav__link"> - Install - </a> - </li> - - - - + + + + + + + <li class="md-nav__item"> + <a href="../../Usage/Configuration/" class="md-nav__link"> + Configuration + </a> + </li> + - - <li class="md-nav__item"> - <a href="../../Usage/Configuration/" title="Configuration" class="md-nav__link"> - Configuration - </a> - </li> - - - - + + + + + + + <li class="md-nav__item"> + <a href="../../Usage/CLI/" class="md-nav__link"> + CLI + </a> + </li> + + + + </ul> + </nav> + </li> + - <li class="md-nav__item"> - <a href="../../Usage/CLI/" title="CLI" class="md-nav__link"> - CLI - </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_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="../Strip/" class="md-nav__link"> + Strip + </a> + </li> + + + + + + + + + <li class="md-nav__item"> + <a href="../NeoBehaviour/" class="md-nav__link"> + Main interface + </a> + </li> + + + </ul> + </nav> + </li> + - <li class="md-nav__item md-nav__item--active md-nav__item--nested"> - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked> + + + + + + + - <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_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 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> + + + + </ul> + </nav> + </li> + + + </ul> + </nav> + </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"> - - - - - <label class="md-nav__link md-nav__link--active" for="__toc"> - Support Library - </label> - <a href="./" title="Support Library" class="md-nav__link md-nav__link--active"> - Support Library - </a> - - -<nav class="md-nav md-nav--secondary"> + </ul> +</nav> + </div> + </div> + </div> + + + + <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" 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="#class-strip" class="md-nav__link"> - class Strip + <a href="#class-neobehaviour" class="md-nav__link"> + class NeoBehaviour </a> - <nav class="md-nav"> + <nav class="md-nav" aria-label="class NeoBehaviour"> <ul class="md-nav__list"> <li class="md-nav__item"> - <a href="#stripshow" class="md-nav__link"> - Strip.show() - </a> - -</li> - - <li class="md-nav__item"> - <a href="#stripsetpixelcolorn-color" class="md-nav__link"> - Strip.setPixelColor(n, color) - </a> - -</li> - - <li class="md-nav__item"> - <a href="#stripsetpixelcolorxyx-y-color" class="md-nav__link"> - Strip.setPixelColorXY(x, y, color) - </a> - -</li> - - <li class="md-nav__item"> - <a href="#stripsetpixelcolorrgbn-red-green-blue-white-0" class="md-nav__link"> - Strip.setPixelColorRGB(n, red, green, blue, white = 0) + <a href="#def-declare_variablesself" class="md-nav__link"> + def declare_variables(self) </a> </li> <li class="md-nav__item"> - <a href="#stripsetpixelcolorxyrgbx-y-red-green-blue-white-0" class="md-nav__link"> - Strip.setPixelColorXYRGB(x, y, red, green, blue, white = 0) + <a href="#def-on_startself" class="md-nav__link"> + def on_start(self) </a> </li> <li class="md-nav__item"> - <a href="#stripsetsegmentcolorrgbsegment-red-green-blue-white-0" class="md-nav__link"> - Strip.setSegmentColorRGB(segment, red, green, blue, white = 0) + <a href="#def-each_tickself" class="md-nav__link"> + def each_tick(self): </a> </li> <li class="md-nav__item"> - <a href="#stripsetbrightnessbrightness" class="md-nav__link"> - Strip.setBrightness(brightness) + <a href="#def-each_secondself" class="md-nav__link"> + def each_second(self): </a> </li> <li class="md-nav__item"> - <a href="#stripgetbrightness" class="md-nav__link"> - Strip.getBrightness(): + <a href="#def-each_minuteself" class="md-nav__link"> + def each_minute(self): </a> </li> <li class="md-nav__item"> - <a href="#stripgetpixels" class="md-nav__link"> - Strip.getPixels(): + <a href="#def-each_hourself" class="md-nav__link"> + def each_hour(self): </a> </li> <li class="md-nav__item"> - <a href="#stripnumpixels" class="md-nav__link"> - Strip.numPixels(): + <a href="#def-each_dayself" class="md-nav__link"> + def each_day(self): </a> </li> <li class="md-nav__item"> - <a href="#stripgetpixelcolorn" class="md-nav__link"> - Strip.getPixelColor(n) + <a href="#deltatime" class="md-nav__link"> + deltatime </a> </li> @@ -394,319 +503,102 @@ </li> <li class="md-nav__item"> - <a href="#colorred-green-blue-white-0" class="md-nav__link"> - Color(red, green, blue, white = 0) - </a> - -</li> - - <li class="md-nav__item"> - <a href="#hexcolorvalue" class="md-nav__link"> - hexColor(value) - </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-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="../Examples/strandtest/" title="Strandtest" class="md-nav__link"> - Strandtest - </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-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"> - <a href="../../Code Documentation/Run/" title="Run" class="md-nav__link"> - Run - </a> - </li> - - - - - - - - <li class="md-nav__item"> - <a href="../../Code Documentation/Design/" title="Design" class="md-nav__link"> - Design - </a> - </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> - </div> - </div> - </div> - - - <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> - <div class="md-sidebar__scrollwrap"> - <div class="md-sidebar__inner"> - -<nav class="md-nav md-nav--secondary"> - - - - - - <label class="md-nav__title" for="__toc">Table of contents</label> - <ul class="md-nav__list" data-md-scrollfix> - - <li class="md-nav__item"> <a href="#class-strip" class="md-nav__link"> class Strip </a> - <nav class="md-nav"> + <nav class="md-nav" aria-label="class Strip"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#stripshow" class="md-nav__link"> - Strip.show() + strip.show() </a> </li> <li class="md-nav__item"> - <a href="#stripsetpixelcolorn-color" class="md-nav__link"> - Strip.setPixelColor(n, color) + <a href="#stripset_pixel_colorn-color" class="md-nav__link"> + strip.set_pixel_color(n, *color) </a> </li> <li class="md-nav__item"> - <a href="#stripsetpixelcolorxyx-y-color" class="md-nav__link"> - Strip.setPixelColorXY(x, y, color) + <a href="#stripset_pixel_color_xyx-y-color" class="md-nav__link"> + strip.set_pixel_color_XY(x, y, *color) </a> </li> <li class="md-nav__item"> - <a href="#stripsetpixelcolorrgbn-red-green-blue-white-0" class="md-nav__link"> - Strip.setPixelColorRGB(n, red, green, blue, white = 0) + <a href="#stripset_segment_colorsegment-color" class="md-nav__link"> + strip.set_segment_color(segment, *color) </a> </li> <li class="md-nav__item"> - <a href="#stripsetpixelcolorxyrgbx-y-red-green-blue-white-0" class="md-nav__link"> - Strip.setPixelColorXYRGB(x, y, red, green, blue, white = 0) + <a href="#stripget_pixels" class="md-nav__link"> + strip.get_pixels(): </a> </li> <li class="md-nav__item"> - <a href="#stripsetsegmentcolorrgbsegment-red-green-blue-white-0" class="md-nav__link"> - Strip.setSegmentColorRGB(segment, red, green, blue, white = 0) + <a href="#stripnum_pixels" class="md-nav__link"> + strip.num_pixels(): </a> </li> <li class="md-nav__item"> - <a href="#stripsetbrightnessbrightness" class="md-nav__link"> - Strip.setBrightness(brightness) + <a href="#stripget_pixel_colorn" class="md-nav__link"> + strip.get_pixel_color(n) </a> </li> - <li class="md-nav__item"> - <a href="#stripgetbrightness" class="md-nav__link"> - Strip.getBrightness(): - </a> + </ul> + </nav> </li> - - <li class="md-nav__item"> - <a href="#stripgetpixels" class="md-nav__link"> - Strip.getPixels(): + + <li class="md-nav__item"> + <a href="#color" class="md-nav__link"> + `*color`` </a> </li> - - <li class="md-nav__item"> - <a href="#stripnumpixels" class="md-nav__link"> - Strip.numPixels(): + + <li class="md-nav__item"> + <a href="#utilshex_to_rgbvalue" class="md-nav__link"> + utils.hex_to_rgb(value) </a> </li> - - <li class="md-nav__item"> - <a href="#stripgetpixelcolorn" class="md-nav__link"> - Strip.getPixelColor(n) + + <li class="md-nav__item"> + <a href="#utilsrgb_to_hexrgb" class="md-nav__link"> + utils.rgb_to_hex(rgb) </a> </li> - - </ul> - </nav> - -</li> <li class="md-nav__item"> - <a href="#colorred-green-blue-white-0" class="md-nav__link"> - Color(red, green, blue, white = 0) + <a href="#utilsrgb_from_twentyfour_bitcolor" class="md-nav__link"> + utils.rgb_from_twentyfour_bit(color) </a> </li> <li class="md-nav__item"> - <a href="#hexcolorvalue" class="md-nav__link"> - hexColor(value) + <a href="#utilsrgb_from_twentyfour_bitcolor_1" class="md-nav__link"> + utils.rgb_from_twentyfour_bit(color) </a> </li> - - - - </ul> </nav> @@ -715,134 +607,144 @@ </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="support-library">Support Library</h1> + + + +<h1 id="support-library">Support Library</h1> +<p>The script/mode file has to contain a <code>Main</code> class, which is inherited from <code>NeoBehaviour</code> like this: +<div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">luxcena_neo</span> <span class="kn">import</span> <span class="n">NeoBehaviour</span> + +<span class="k">class</span> <span class="nc">Main</span><span class="p">(</span><span class="n">NeoBehaviour</span><span class="p">):</span> + <span class="k">def</span> <span class="nf">on_start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> + <span class="n">strip</span><span class="o">.</span><span class="n">setPixelColor</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"#fafafa"</span><span class="p">)</span> +</code></pre></div> +The <code>strip</code> will be available anywhere in your script whe it is started using <code>neo_runtime</code>.</p> +<hr /> +<h2 id="class-neobehaviour"><code>class</code> NeoBehaviour</h2> +<p>This is the class your <code>Main</code> should inherit from. +This has some special methods that you can override.</p> +<p><em>NOTE:</em> Do not override <code>__init__</code> unless you know +what you are doing! This contains code that +is crucial for <code>neo_runtime</code>.</p> +<h3 id="def-declare_variablesself">def declare_variables(<code>self</code>)</h3> +<p>When the runtime executes this, the method <code>self.declare(Variable)</code> is available. This is where +you can add variables that show up in the UI. +Take a look at the <code>Variable</code> class further down on this site.</p> +<h3 id="def-on_startself">def on_start(<code>self</code>)</h3> +<p>This is run once at the start of the program. This is a logical place +to initialize variables where you need to remember state, but you +don't want to put the variable in the UI.</p> +<h3 id="def-each_tickself">def each_tick(self):</h3> +<p>This will run as often as possible. If nothing else happens, it will run every one millisecond.</p> +<h3 id="def-each_secondself">def each_second(self):</h3> +<p>This will run at most once a second, it might be longer if some other function is doing some work that takes a long time (more that a second).</p> +<h3 id="def-each_minuteself">def each_minute(self):</h3> +<p>This will run at most once a minute, it might be longer if some other function is doing some work that takes a long time (more that a minute).</p> +<h3 id="def-each_hourself">def each_hour(self):</h3> +<p>This will run at most once a hour, it might be longer if some other function is doing some work that takes a long time (more that a hour).</p> +<h3 id="def-each_dayself">def each_day(self):</h3> +<p>This will run at most once a day, it might be longer if some other function is doing some work that takes a long time (more that a day).</p> +<h3 id="deltatime">deltatime</h3> +<p>For each of the <code>each_</code> methods, you can add a second argument to the +definition. If you do, that will be the time in seconds since last time +the function ran. +<div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">each_tick</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dt</span><span class="p">):</span> + <span class="nb">print</span><span class="p">(</span><span class="n">dt</span><span class="p">)</span> +<span class="k">def</span> <span class="nf">each_minute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">deltatime</span><span class="p">):</span> + <span class="nb">print</span><span class="p">(</span><span class="n">dt</span><span class="p">)</span> +</code></pre></div> +The name of the parameter doesn't matter. For the example above, +in an ideal world, this would print <code>0.1</code> every millisecond, and <code>60</code> every minute. Because the world isnt ideal, the deltatime is likely +going to be slightly longer than the ideal.</p> <hr /> -<h2 id="class-strip"><code class="codehilite"><span class="k">class</span></code> Strip</h2> +<h2 id="class-strip"><code>class</code> Strip</h2> <p>This is the object you are refeering to when you want to do things with LED's. You shouldn't have to do instantiate your own new strip-object as you can use the one -set up by the software itself. -<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="n">LuxcenaNeo</span><span class="o">.</span><span class="n">strip</span> -<span class="ow">or</span> -<span class="n">neo</span><span class="o">.</span><span class="n">strip</span> -</pre></div> -</td></tr></table></p> -<h3 id="stripshow">Strip.show()</h3> +set up by the software itself.</p> +<h3 id="stripshow">strip.show()</h3> <p>Display all the changes made to the LEDs, on the actual LEDs.</p> -<h3 id="stripsetpixelcolorn-color">Strip.setPixelColor(<code class="codehilite"><span class="n">n</span></code>, <code class="codehilite"><span class="n">color</span></code>)</h3> +<h3 id="stripset_pixel_colorn-color">strip.set_pixel_color(<code>n</code>, <code>*color</code>)</h3> <p>Set LED at position n to the provided 24-bit color value (in RGB order).</p> -<h3 id="stripsetpixelcolorxyx-y-color">Strip.setPixelColorXY(<code class="codehilite"><span class="n">x</span></code>, <code class="codehilite"><span class="n">y</span></code>, <code class="codehilite"><span class="n">color</span></code>)</h3> +<h3 id="stripset_pixel_color_xyx-y-color">strip.set_pixel_color_XY(<code>x</code>, <code>y</code>, <code>*color</code>)</h3> <p>Set LED at position (x, y) in the defined matrix to the provided 24-bit color value (in RGB order).</p> -<h3 id="stripsetpixelcolorrgbn-red-green-blue-white-0">Strip.setPixelColorRGB(<code class="codehilite"><span class="n">n</span></code>, <code class="codehilite"><span class="n">red</span></code>, <code class="codehilite"><span class="n">green</span></code>, <code class="codehilite"><span class="n">blue</span></code>, <code class="codehilite"><span class="n">white</span> <span class="o">=</span> <span class="mi">0</span></code>)</h3> -<p>Set LED at position n to the provided red, green, and blue color. -Each color component should be a value from 0 to 255 (where 0 is the -lowest intensity and 255 is the highest intensity).</p> -<h3 id="stripsetpixelcolorxyrgbx-y-red-green-blue-white-0">Strip.setPixelColorXYRGB(<code class="codehilite"><span class="n">x</span></code>, <code class="codehilite"><span class="n">y</span></code>, <code class="codehilite"><span class="n">red</span></code>, <code class="codehilite"><span class="n">green</span></code>, <code class="codehilite"><span class="n">blue</span></code>, <code class="codehilite"><span class="n">white</span> <span class="o">=</span> <span class="mi">0</span></code>)</h3> -<p>Set LED at position (x, y) in the defined matrix to the provided red, green, and blue color. -Each color component should be a value from 0 to 255 (where 0 is the -lowest intensity and 255 is the highest intensity).</p> -<h3 id="stripsetsegmentcolorrgbsegment-red-green-blue-white-0">Strip.setSegmentColorRGB(<code class="codehilite"><span class="n">segment</span></code>, <code class="codehilite"><span class="n">red</span></code>, <code class="codehilite"><span class="n">green</span></code>, <code class="codehilite"><span class="n">blue</span></code>, <code class="codehilite"><span class="n">white</span> <span class="o">=</span> <span class="mi">0</span></code>)</h3> +<h3 id="stripset_segment_colorsegment-color">strip.set_segment_color(<code>segment</code>, <code>*color</code>)</h3> <p>Set a whole segment to the provided red, green and blue color. Each color component should be a value from 0 to 255 (where 0 is the lowest intensity and 255 is the highest intensity).</p> -<h3 id="stripsetbrightnessbrightness">Strip.setBrightness(<code class="codehilite"><span class="n">brightness</span></code>)</h3> -<p>Scale each LED in the buffer by the provided brightness. A brightness -of 0 is the darkest and 255 is the brightest.</p> -<h3 id="stripgetbrightness">Strip.getBrightness():</h3> -<p>Get the brightness value for each LED in the buffer. A brightness -of 0 is the darkest and 255 is the brightest.</p> -<h3 id="stripgetpixels">Strip.getPixels():</h3> +<h3 id="stripget_pixels">strip.get_pixels():</h3> <p>Return an object which allows access to the LED display data as if it were a sequence of 24-bit RGB values.</p> -<h3 id="stripnumpixels">Strip.numPixels():</h3> +<h3 id="stripnum_pixels">strip.num_pixels():</h3> <p>Return the number of pixels in the display.</p> -<h3 id="stripgetpixelcolorn">Strip.getPixelColor(<code class="codehilite"><span class="n">n</span></code>)</h3> +<h3 id="stripget_pixel_colorn">strip.get_pixel_color(<code>n</code>)</h3> <p>Get the 24-bit RGB color value for the LED at position n.</p> +<h2 id="color">`*color``</h2> +<p>All functions that take in this, will automatically parse the value provided.</p> +<p>If parameter is only a str, it will be treated as a hex value. e.g. <code>set_pixel_color(0, "#fafafa")</code> +If parameter is a tuple, the first three items in that tuple will be treated as a rgb value. e.g. <code>set_pixel_color(0, (255, 238, 10))</code> +If parameter is a int, it will be treated as a 24-bit color value. e.g. <code>set_pixel_color(0, 2812873)</code> +If there are 3 parameters, these will be treated as a rgb value. e.g. <code>set_pixel_color(0, 255, 238, 10)</code> +This means that all of these have the same effect: +<div class="highlight"><pre><span></span><code><span class="n">set_pixel_color</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="s2">"#fafafa"</span><span class="p">)</span> +<span class="n">set_pixel_color</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">16448250</span><span class="p">)</span> +<span class="n">set_pixel_color</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">250</span><span class="p">,</span> <span class="mi">250</span><span class="p">,</span> <span class="mi">250</span><span class="p">)</span> +<span class="n">set_pixel_color</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="p">(</span><span class="mi">250</span><span class="p">,</span> <span class="mi">250</span><span class="p">,</span> <span class="mi">250</span><span class="p">))</span> +</code></pre></div></p> <hr /> -<h2 id="colorred-green-blue-white-0">Color(<code class="codehilite"><span class="n">red</span></code>, <code class="codehilite"><span class="n">green</span></code>, <code class="codehilite"><span class="n">blue</span></code>, <code class="codehilite"><span class="n">white</span> <span class="o">=</span> <span class="mi">0</span></code>)</h2> -<p>Convert the provided red, green, blue color to a 24-bit color value. -Each color component should be a value 0-255 where 0 is the lowest intensity -and 255 is the highest intensity.</p> -<h2 id="hexcolorvalue">hexColor(<code class="codehilite"><span class="n">value</span></code>)</h2> -<p>Convert the provided hexadecimal color to a 24-bit color value.</p> - - - - - - +<p>These are in <code>utils</code>, can be imported with <code>from luxcena_neo import utils</code>.</p> +<h2 id="utilshex_to_rgbvalue">utils.hex_to_rgb(<code>value</code>)</h2> +<p>Convert provided hex color to a tuple with rgb colors. (r, g, b).</p> +<h2 id="utilsrgb_to_hexrgb">utils.rgb_to_hex(<code>rgb</code>)</h2> +<p>Converts rgb colors in tuple to hex string.</p> +<h2 id="utilsrgb_from_twentyfour_bitcolor">utils.rgb_from_twentyfour_bit(<code>color</code>)</h2> +<p>Takes a 24bit color value and returns a rgb tuple.</p> +<h2 id="utilsrgb_from_twentyfour_bitcolor_1">utils.rgb_from_twentyfour_bit(<code>color</code>)</h2> +<p>Takes a 24bit color value and returns a hex string.</p> - - </article> - </div> + + + + + </article> + </div> + + </div> + </main> - -<footer class="md-footer"> - - <div class="md-footer-nav"> - <nav class="md-footer-nav__inner md-grid"> - - <a href="../../Usage/CLI/" title="CLI" 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> - CLI - </span> - </div> - </a> - - - <a href="../Examples/strandtest/" title="Strandtest" 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> - Strandtest - </span> - </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> + <footer class="md-footer"> <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> @@ -857,5 +759,6 @@ and 255 is the highest intensity.</p> <script src="../../assets/js-sequence.js"></script> + </body> </html>
\ No newline at end of file |