Repository navigation
Expand file tree
/
Copy pathwebinterface.html
More file actions
33 lines (32 loc) · 17.6 KB
/
Copy pathwebinterface.html
File metadata and controls
33 lines (32 loc) · 17.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Webinterface | PixelIt Documentation</title>
<meta name="generator" content="VuePress 1.9.10">
<link rel="icon" href="/logo.png">
<meta name="description" content="PixelIt Documentation">
<meta name="theme-color" content="#3eaf7c">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="preload" href="/assets/css/0.styles.979457c6.css" as="style"><link rel="preload" href="/assets/js/app.ca5d93ae.js" as="script"><link rel="preload" href="/assets/js/2.91244bc8.js" as="script"><link rel="preload" href="/assets/js/1.05285c6d.js" as="script"><link rel="preload" href="/assets/js/31.cc0d9785.js" as="script"><link rel="prefetch" href="/assets/js/10.27500631.js"><link rel="prefetch" href="/assets/js/11.dcc4f3d2.js"><link rel="prefetch" href="/assets/js/12.04809d88.js"><link rel="prefetch" href="/assets/js/13.f2b0cfdf.js"><link rel="prefetch" href="/assets/js/14.7fd2fb5d.js"><link rel="prefetch" href="/assets/js/15.60f55f36.js"><link rel="prefetch" href="/assets/js/16.608157bf.js"><link rel="prefetch" href="/assets/js/17.e4c0f8ba.js"><link rel="prefetch" href="/assets/js/18.66f3f452.js"><link rel="prefetch" href="/assets/js/19.646861bf.js"><link rel="prefetch" href="/assets/js/20.26d4bf0e.js"><link rel="prefetch" href="/assets/js/21.6812bf4d.js"><link rel="prefetch" href="/assets/js/22.37f964c9.js"><link rel="prefetch" href="/assets/js/23.e244064d.js"><link rel="prefetch" href="/assets/js/24.afae4f3b.js"><link rel="prefetch" href="/assets/js/25.cd5f49a9.js"><link rel="prefetch" href="/assets/js/26.ef6c9d54.js"><link rel="prefetch" href="/assets/js/27.40af10d3.js"><link rel="prefetch" href="/assets/js/28.ad5db2ed.js"><link rel="prefetch" href="/assets/js/29.9b5d4d2f.js"><link rel="prefetch" href="/assets/js/3.c710d3fb.js"><link rel="prefetch" href="/assets/js/30.c275e3f8.js"><link rel="prefetch" href="/assets/js/4.8eb55a11.js"><link rel="prefetch" href="/assets/js/5.5369e4a2.js"><link rel="prefetch" href="/assets/js/6.787aa3b3.js"><link rel="prefetch" href="/assets/js/7.c097858b.js"><link rel="prefetch" href="/assets/js/vendors~docsearch.aae61d50.js">
<link rel="stylesheet" href="/assets/css/0.styles.979457c6.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/" class="home-link router-link-active"><img src="/logo.png" alt="PixelIt Documentation" class="logo"> <span class="site-name can-hide">PixelIt Documentation</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"> <a href="https://github.com/pixelit-project/Docs" target="_blank" rel="noopener noreferrer" class="repo-link">
GitHub
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"> <a href="https://github.com/pixelit-project/Docs" target="_blank" rel="noopener noreferrer" class="repo-link">
GitHub
<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a></nav> <ul class="sidebar-links"><li><a href="/" aria-current="page" class="sidebar-link">Introduction</a></li><li><a href="/hardware.html" class="sidebar-link">Hardware</a></li><li><a href="/firmware.html" class="sidebar-link">Firmware</a></li><li><a href="/webinterface.html" aria-current="page" class="active sidebar-link">Webinterface</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/webinterface.html#demo" class="sidebar-link">Demo</a></li><li class="sidebar-sub-header"><a href="/webinterface.html#dashboard" class="sidebar-link">Dashboard</a></li><li class="sidebar-sub-header"><a href="/webinterface.html#options" class="sidebar-link">Options</a></li><li class="sidebar-sub-header"><a href="/webinterface.html#sensor-buttons" class="sidebar-link">Sensor & Buttons</a></li><li class="sidebar-sub-header"><a href="/webinterface.html#test-area" class="sidebar-link">Test Area</a></li><li class="sidebar-sub-header"><a href="/webinterface.html#statistics" class="sidebar-link">Statistics</a></li><li class="sidebar-sub-header"><a href="/webinterface.html#pixel-gallery" class="sidebar-link">Pixel Gallery</a></li><li class="sidebar-sub-header"><a href="/webinterface.html#update" class="sidebar-link">Update</a></li></ul></li><li><a href="/api.html" class="sidebar-link">API</a></li><li><a href="/tools.html" class="sidebar-link">Tools</a></li><li><a href="/nodered.html" class="sidebar-link">Node-RED</a></li><li><a href="/homeassistant.html" class="sidebar-link">Home Assistant</a></li><li><a href="/iobroker.html" class="sidebar-link">ioBroker</a></li><li><a href="/troubleshooting.html" class="sidebar-link">Troubleshooting</a></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="webinterface"><a href="#webinterface" class="header-anchor">#</a> Webinterface</h1> <p>Open the device IP address in your browser to access <a href="#dashboard">Dashboard</a>, <a href="#options">Options</a>, <a href="#sensor-buttons">Sensors & Buttons</a>, <a href="#test-area">Test Area</a>, <a href="#statistics">Statistics</a>, <a href="#pixel-gallery">Pixel Gallery</a>, Pixel Creator and <a href="#update">Update & Backup</a>. The WebUI communicates with the device over WebSocket port 81; both HTTP port 80 and WebSocket port 81 must be reachable.</p> <h2 id="demo"><a href="#demo" class="header-anchor">#</a> Demo</h2> <p>Try the <a href="https://pixelit-project.github.io/PixelIt/webui/" target="_blank" rel="noopener noreferrer">hosted demo<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a>. Device-changing actions are disabled in demo mode. Local editing tools can still be explored.</p> <p>Screenshots below show the earlier 2.6.0 layout and do not include every 3.0.0 control. They were captured from the <a href="https://github.com/pixelit-project/PixelIt.WebUI/tree/e7140761cf5fabd45677aec7f7b1967f1c672520" target="_blank" rel="noopener noreferrer">WebUI source available at the 2.6.0 release date<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a>, using its built-in demo data. Displayed versions, pins and sensor values are sample data, not recommended settings or firmware defaults. The hosted demo can change independently of the stable firmware.</p> <h2 id="dashboard"><a href="#dashboard" class="header-anchor">#</a> Dashboard</h2> <p>System details can be collapsed. Dashboard logs can be filtered and paused; see <a href="/troubleshooting.html#logs-and-diagnostics">logs and diagnostics</a>. Hidden WebUI tabs pause their Liveview preview; reopening the page resumes with the latest image. Slow previews can skip frames without implying that the physical LEDs skipped them.</p> <p><img src="/webinterface_2_6_dashboard.jpg" alt="Dashboard showing sample system and sensor data"></p> <h2 id="options"><a href="#options" class="header-anchor">#</a> Options</h2> <p>Options and Sensors & Buttons keep separate configuration drafts. Save your edits using the sticky save toolbar, or discard them to return to the saved configuration. The WebUI warns you about unsaved changes.</p> <p><img src="/webinterface_2_6_options.jpg" alt="Options with the save toolbar and configuration cards"></p> <h3 id="matrix-and-clock-settings"><a href="#matrix-and-clock-settings" class="header-anchor">#</a> Matrix and clock settings</h3> <p>Choose the layout matching your matrix wiring and configure LED color correction, automatic brightness reference points, NTP time and clock fallback. See the <a href="/api.html#matrix-layout">configuration reference</a> for layout values, correction profiles and calibration, and <a href="/api.html#time-and-clock-fallback">time and clock fallback</a> for UTC offsets and the supported daylight-saving rule.</p> <h3 id="startup-and-transitions"><a href="#startup-and-transitions" class="header-anchor">#</a> Startup and transitions</h3> <p>Under <strong>Options → Defaults</strong>, choose <strong>Boot animation</strong>: <strong>Gradient letters</strong> (default) or <strong>Multicolor letters</strong> (classic). Enable <strong>Boot-Screen active</strong> to play it. <strong>Show WiFi screen during startup</strong> independently controls the complete connection screen and hotspot notice; it defaults to enabled. Save changes and restart to apply them.</p> <p>Choose <strong>Clock/date transition</strong> separately from <strong>Fallback Animation</strong>. Auto uses Vertical Slide with small clock fonts and a slower Fade with the large font. Clock Auto Fallback offers all ten standalone effects and Random Wipe. See <a href="/api.html#time-and-clock-fallback">time and clock fallback</a> for stored numeric values.</p> <h3 id="telemetry-and-update-notifications"><a href="#telemetry-and-update-notifications" class="header-anchor">#</a> Telemetry and update notifications</h3> <p>Telemetry uploads and matrix update notifications are independent options. See <a href="/api.html#telemetry-and-update-notifications">Telemetry and update notifications</a> for the transmitted data, service addresses, timing and how to disable each option. Matrix update notifications do not install firmware automatically.</p> <h3 id="play-sound-on-boot"><a href="#play-sound-on-boot" class="header-anchor">#</a> Play sound on boot</h3> <p>With a configured DFPlayer Mini, this option plays track index <code>1</code> at startup using the initial volume setting. File-copy order can affect that index; see <a href="/api.html#option-2">Sound Option 2</a>.</p> <p>Enable <strong>Include beta releases in update searches</strong> only if you want published prereleases offered in addition to stable firmware. It defaults to off; save to apply it. Update notifications announce releases but never install them automatically. During a manual firmware upload, the matrix shows animated progress and a reboot screen.</p> <h3 id="mqtt"><a href="#mqtt" class="header-anchor">#</a> MQTT</h3> <p>If you have a working MQTT server, you can enable this option to receive messages through a MQTT broker. The REST API remains available at the same time.</p> <p>Enable Home Assistant discovery in the MQTT options to control display power and brightness and receive status information. See <a href="/homeassistant.html">Home Assistant</a> for setup, available entities and automation examples for sending screens. The <a href="/homeassistant.html#pixelit-custom-integration">PixelIt custom integration</a> provides direct Home Assistant control and liveview without MQTT. <a href="/nodered.html">Node-RED</a> can also control PixelIt through MQTT.</p> <p>Matrix-info MQTT updates default to every 15 seconds. Choose sensor updates <strong>when readings change</strong> or <strong>periodically</strong>, with separate thresholds and intervals. <strong>Use default thresholds</strong> fills the draft; save it to apply. See <a href="/api.html#mqtt-publishing-intervals">MQTT publishing intervals</a>.</p> <h2 id="sensor-buttons"><a href="#sensor-buttons" class="header-anchor">#</a> Sensor & Buttons</h2> <p>Configure sensor units and offsets, peripheral pins, button pressed levels and actions. Save changes to apply them and restart the device. Pin assignments must match your <a href="/hardware.html#wiring-guide">wiring</a>. In particular, do not copy the demo's button levels onto ESP8266 boot pins.</p> <p><img src="/webinterface_2_6_sensors.jpg" alt="Sensor and button configuration"></p> <h2 id="test-area"><a href="#test-area" class="header-anchor">#</a> Test Area</h2> <p>Send test text, adjust brightness or submit a JSON screen payload. Use the <a href="/api.html#screen">API examples</a> for valid payloads. Test actions require a live device and are disabled in the demo.</p> <p><img src="/webinterface_2_6_test.jpg" alt="Test Area with JSON and text controls"></p> <h2 id="statistics"><a href="#statistics" class="header-anchor">#</a> Statistics</h2> <p>View device statistics collected by the WebUI. These views depend on an active device connection and are separate from firmware configuration.</p> <h2 id="pixel-gallery"><a href="#pixel-gallery" class="header-anchor">#</a> Pixel Gallery</h2> <p>Browse shared artwork or open Pixel Creator from the navigation. See <a href="/tools.html">Tools</a> for gallery IDs, drawing and animation workflows. The external gallery service is required for browsing artwork. Dimension/animation filters, compatibility labels, RGB565 copying and moderated reports are described in <a href="/tools.html#pixel-gallery">Tools</a>.</p> <h2 id="update"><a href="#update" class="header-anchor">#</a> Update</h2> <p>For a manual update, download the firmware for your hardware. The WebUI provides hardware-specific release downloads, image compatibility warnings and a prompt to back up your configuration before uploading. Check these warnings before continuing. The update view shows upload progress and reports reconnect or error status.</p> <p>For the latest stable firmware, use <a href="https://github.com/pixelit-project/PixelIt/releases/latest" target="_blank" rel="noopener noreferrer">GitHub Releases / latest<span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></a>. An ESP32 first-install image is for a full installation over USB; use the matching OTA image for updates through the WebUI. See <a href="/firmware.html#flashing-web">Firmware</a> for USB installation.</p> <p><img src="/webinterface_2_6_update.jpg" alt="Update and configuration backup controls"></p></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/pixelit-project/Docs/edit/master/src/webinterface.md" target="_blank" rel="noopener noreferrer">Edit this page</a> <span><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg> <span class="sr-only">(opens new window)</span></span></div> <div class="last-updated"><span class="prefix">Last Updated:</span> <span class="time">11/20/2026, 11:38:13 PM</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/firmware.html" class="prev">
Firmware
</a></span> <span class="next"><a href="/api.html">
API
</a>
→
</span></p></div> </main></div><div class="global-ui"><!----></div></div>
<script src="/assets/js/app.ca5d93ae.js" defer></script><script src="/assets/js/2.91244bc8.js" defer></script><script src="/assets/js/1.05285c6d.js" defer></script><script src="/assets/js/31.cc0d9785.js" defer></script>
</body>
</html>