aboutsummaryrefslogtreecommitdiff
path: root/public/docs/Scripting/Strip/index.html
diff options
context:
space:
mode:
authorjakob.stendahl <jakob.stendahl@infomedia.dk>2022-12-12 14:13:40 +0100
committerJakob Stendahl <jakob.stendahl@outlook.com>2022-12-12 14:13:40 +0100
commit4189c0c988daa939be0e8ec979ce0ae0563c4b7d (patch)
treef07143ac71bd80457f681ec64bde1bbcbefa7a08 /public/docs/Scripting/Strip/index.html
parentf1664d7c0dda8b4e557a02cd6fbfe56308daa4e4 (diff)
downloadLuxcena-Neo-4189c0c988daa939be0e8ec979ce0ae0563c4b7d.tar.gz
Luxcena-Neo-4189c0c988daa939be0e8ec979ce0ae0563c4b7d.zip
Create docs from python code
Diffstat (limited to 'public/docs/Scripting/Strip/index.html')
-rw-r--r--public/docs/Scripting/Strip/index.html1207
1 files changed, 1207 insertions, 0 deletions
diff --git a/public/docs/Scripting/Strip/index.html b/public/docs/Scripting/Strip/index.html
new file mode 100644
index 0000000..d17627c
--- /dev/null
+++ b/public/docs/Scripting/Strip/index.html
@@ -0,0 +1,1207 @@
+
+<!doctype html>
+<html lang="en" class="no-js">
+ <head>
+
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+
+
+
+ <link rel="icon" href="../../assets/images/favicon.png">
+ <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-8.5.10">
+
+
+
+ <title>Strip - Luxcena Neo Documentation</title>
+
+
+
+ <link rel="stylesheet" href="../../assets/stylesheets/main.975780f9.min.css">
+
+
+ <link rel="stylesheet" href="../../assets/stylesheets/palette.2505c338.min.css">
+
+
+
+
+
+
+
+
+
+
+ <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/_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" 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="#documentation-for-strip" class="md-skip">
+ Skip to content
+ </a>
+
+ </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 class="md-header__topic" data-md-component="header-topic">
+ <span class="md-ellipsis">
+
+ Strip
+
+ </span>
+ </div>
+ </div>
+ </div>
+
+
+
+
+ </nav>
+
+</header>
+
+ <div class="md-container" 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="sidebar" data-md-type="navigation" >
+ <div class="md-sidebar__scrollwrap">
+ <div class="md-sidebar__inner">
+
+
+
+<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>
+
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../.." class="md-nav__link">
+ Introduction
+ </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-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/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 md-nav__item--active md-nav__item--nested">
+
+
+ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
+
+
+
+
+ <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 md-nav__item--active">
+
+ <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">
+ Strip
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <a href="./" class="md-nav__link md-nav__link--active">
+ Strip
+ </a>
+
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+
+ <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="#luxcena_neo.strip.Strip" class="md-nav__link">
+ Strip
+ </a>
+
+ <nav class="md-nav" aria-label="Strip">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.brightness" class="md-nav__link">
+ brightness
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.power_on" class="md-nav__link">
+ power_on
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.blank" class="md-nav__link">
+ blank()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.get_pixel_color" class="md-nav__link">
+ get_pixel_color()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.get_pixels" class="md-nav__link">
+ get_pixels()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.num_pixels" class="md-nav__link">
+ num_pixels()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.set_pixel_color" class="md-nav__link">
+ set_pixel_color()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.set_pixel_color_XY" class="md-nav__link">
+ set_pixel_color_XY()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.set_segment_color" class="md-nav__link">
+ set_segment_color()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.set_strip_color" class="md-nav__link">
+ set_strip_color()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.show" class="md-nav__link">
+ show()
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#a-note-on-colors" class="md-nav__link">
+ A note on colors
+ </a>
+
+</li>
+
+ </ul>
+
+</nav>
+
+ </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--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>
+
+
+
+ </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">
+ <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="#luxcena_neo.strip.Strip" class="md-nav__link">
+ Strip
+ </a>
+
+ <nav class="md-nav" aria-label="Strip">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.brightness" class="md-nav__link">
+ brightness
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.power_on" class="md-nav__link">
+ power_on
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.blank" class="md-nav__link">
+ blank()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.get_pixel_color" class="md-nav__link">
+ get_pixel_color()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.get_pixels" class="md-nav__link">
+ get_pixels()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.num_pixels" class="md-nav__link">
+ num_pixels()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.set_pixel_color" class="md-nav__link">
+ set_pixel_color()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.set_pixel_color_XY" class="md-nav__link">
+ set_pixel_color_XY()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.set_segment_color" class="md-nav__link">
+ set_segment_color()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.set_strip_color" class="md-nav__link">
+ set_strip_color()
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#luxcena_neo.strip.Strip.show" class="md-nav__link">
+ show()
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#a-note-on-colors" class="md-nav__link">
+ A note on colors
+ </a>
+
+</li>
+
+ </ul>
+
+</nav>
+ </div>
+ </div>
+ </div>
+
+
+
+ <div class="md-content" data-md-component="content">
+ <article class="md-content__inner md-typeset">
+
+
+
+
+<h1 id="documentation-for-strip">Documentation for <code>strip</code></h1>
+
+
+<div class="doc doc-object doc-class">
+
+
+
+<h2 id="luxcena_neo.strip.Strip" class="doc doc-heading">
+ <code>luxcena_neo.strip.Strip</code>
+
+
+</h2>
+
+
+ <div class="doc doc-contents first">
+
+
+ <p>Class representing a led-strip,</p>
+<p>If you are using the NeoBehaviour runtime, an pre-configured instance of this will
+be setup in your module with the name <code>strip</code>.</p>
+
+ <p><strong>Attributes:</strong></p>
+ <table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>SEGMENTS</code></td>
+ <td>
+ <code>list[int]</code>
+ </td>
+ <td><p>A list of the configured segments.</p></td>
+ </tr>
+ </tbody>
+ </table>
+
+
+
+
+
+ <div class="doc doc-children">
+
+
+
+
+
+
+
+<div class="doc doc-object doc-attribute">
+
+
+
+<h3 id="luxcena_neo.strip.Strip.brightness" class="doc doc-heading">
+<code class="codehilite language-python"><span class="n">brightness</span></code>
+
+ <span class="doc doc-labels">
+ <small class="doc doc-label doc-label-writable"><code>writable</code></small>
+ <small class="doc doc-label doc-label-property"><code>property</code></small>
+ </span>
+
+</h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>The current brightness.</p>
+ </div>
+
+</div>
+
+<div class="doc doc-object doc-attribute">
+
+
+
+<h3 id="luxcena_neo.strip.Strip.power_on" class="doc doc-heading">
+<code class="codehilite language-python"><span class="n">power_on</span></code>
+
+ <span class="doc doc-labels">
+ <small class="doc doc-label doc-label-writable"><code>writable</code></small>
+ <small class="doc doc-label doc-label-property"><code>property</code></small>
+ </span>
+
+</h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Wether the power action is on or not.</p>
+ </div>
+
+</div>
+
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="luxcena_neo.strip.Strip.blank" class="doc doc-heading">
+<code class="codehilite language-python"><span class="n">blank</span><span class="p">(</span><span class="n">auto_show</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></code>
+
+</h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Will turn off all pixels.</p>
+
+ <p><strong>Parameters:</strong></p>
+ <table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Default</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>auto_show</code></td>
+ <td>
+ <code>bool</code>
+ </td>
+ <td><p>If set to true, strip.show() is called. Disable this if needed for some quicker animations.</p></td>
+ <td>
+ <code>True</code>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="luxcena_neo.strip.Strip.get_pixel_color" class="doc doc-heading">
+<code class="codehilite language-python"><span class="n">get_pixel_color</span><span class="p">(</span><span class="n">n</span><span class="p">)</span></code>
+
+</h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Get the 24-bit RGB color value for the LED at position n.</p>
+
+ </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="luxcena_neo.strip.Strip.get_pixels" class="doc doc-heading">
+<code class="codehilite language-python"><span class="n">get_pixels</span><span class="p">()</span></code>
+
+</h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Return an object which allows access to the LED display data as if
+it were a sequence of 24-bit RGB values.</p>
+
+ </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="luxcena_neo.strip.Strip.num_pixels" class="doc doc-heading">
+<code class="codehilite language-python"><span class="n">num_pixels</span><span class="p">()</span></code>
+
+</h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Return the number of pixels in the display.</p>
+
+ </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="luxcena_neo.strip.Strip.set_pixel_color" class="doc doc-heading">
+<code class="codehilite language-python"><span class="n">set_pixel_color</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="o">*</span><span class="n">color</span><span class="p">)</span></code>
+
+</h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Set the color of the LED at position N.</p>
+
+ <p><strong>Parameters:</strong></p>
+ <table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Default</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>n</code></td>
+ <td>
+ <code>int</code>
+ </td>
+ <td><p>The pixel to set.</p></td>
+ <td>
+ <em>required</em>
+ </td>
+ </tr>
+ <tr>
+ <td><code>*color</code></td>
+ <td>
+ </td>
+ <td><p>This will be interpreted as a color.</p></td>
+ <td>
+ <code>()</code>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="luxcena_neo.strip.Strip.set_pixel_color_XY" class="doc doc-heading">
+<code class="codehilite language-python"><span class="n">set_pixel_color_XY</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="o">*</span><span class="n">color</span><span class="p">)</span></code>
+
+</h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Set the color of a LED at position (x, y) in the matrix you have configured to a color.</p>
+<p>Note: This will only print a warning message if you try to set pixels outside the matrix.</p>
+
+ <p><strong>Parameters:</strong></p>
+ <table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Default</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>x</code></td>
+ <td>
+ <code>int</code>
+ </td>
+ <td><p>The x position.</p></td>
+ <td>
+ <em>required</em>
+ </td>
+ </tr>
+ <tr>
+ <td><code>y</code></td>
+ <td>
+ <code>int</code>
+ </td>
+ <td><p>The y position.</p></td>
+ <td>
+ <em>required</em>
+ </td>
+ </tr>
+ <tr>
+ <td><code>*color</code></td>
+ <td>
+ </td>
+ <td><p>This will be interpreted as a color.</p></td>
+ <td>
+ <code>()</code>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="luxcena_neo.strip.Strip.set_segment_color" class="doc doc-heading">
+<code class="codehilite language-python"><span class="n">set_segment_color</span><span class="p">(</span><span class="n">segment</span><span class="p">,</span> <span class="o">*</span><span class="n">color</span><span class="p">)</span></code>
+
+</h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Set a whole segment to the provided color.</p>
+
+ <p><strong>Parameters:</strong></p>
+ <table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Default</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>segment</code></td>
+ <td>
+ <code>int</code>
+ </td>
+ <td><p>The segment to set.</p></td>
+ <td>
+ <em>required</em>
+ </td>
+ </tr>
+ <tr>
+ <td><code>*color</code></td>
+ <td>
+ </td>
+ <td><p>This will be interpreted as a color.</p></td>
+ <td>
+ <code>()</code>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="luxcena_neo.strip.Strip.set_strip_color" class="doc doc-heading">
+<code class="codehilite language-python"><span class="n">set_strip_color</span><span class="p">(</span><span class="o">*</span><span class="n">color</span><span class="p">)</span></code>
+
+</h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Set all pixels in the strip to a color</p>
+
+ <p><strong>Parameters:</strong></p>
+ <table>
+ <thead>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Default</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>*color</code></td>
+ <td>
+ </td>
+ <td><p>This will be interpreted as a color.</p></td>
+ <td>
+ <code>()</code>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
+
+<h3 id="luxcena_neo.strip.Strip.show" class="doc doc-heading">
+<code class="codehilite language-python"><span class="n">show</span><span class="p">()</span></code>
+
+</h3>
+
+
+ <div class="doc doc-contents ">
+
+ <p>Update the display with the data from the LED buffer, you can think of it as a flush method.</p>
+
+ </div>
+
+</div>
+
+
+
+ </div>
+
+ </div>
+
+</div><hr />
+<h2 id="a-note-on-colors">A note on colors</h2>
+<p>Most methods which need colors takes a <code>*color</code> parameter. This is because it interprets multiple types of colors. The example below illustrates this, each of the lines has the exact same effect on the led strip.
+<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">&quot;#fafafa&quot;</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>
+
+
+
+
+
+
+ </article>
+ </div>
+
+
+ </div>
+
+ </main>
+
+ <footer class="md-footer">
+
+
+ <nav class="md-footer__inner md-grid" aria-label="Footer" >
+
+
+ <a href="../../Usage/CLI/" class="md-footer__link md-footer__link--prev" aria-label="Previous: CLI" 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>
+ CLI
+ </div>
+ </div>
+ </a>
+
+
+
+ <a href="../NeoBehaviour/" class="md-footer__link md-footer__link--next" aria-label="Next: Main interface" rel="next">
+ <div class="md-footer__title">
+ <div class="md-ellipsis">
+ <span class="md-footer__direction">
+ Next
+ </span>
+ Main interface
+ </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-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 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>
+
+ <script src="../../assets/webfont.js"></script>
+
+ <script src="../../assets/snap.svg-min.js"></script>
+
+ <script src="../../assets/underscore-min.js"></script>
+
+ <script src="../../assets/sequence-diagram.min.js"></script>
+
+ <script src="../../assets/js-sequence.js"></script>
+
+
+
+ </body>
+</html> \ No newline at end of file