Deployed 3b25d47b to stable with MkDocs 1.6.1 and mike 2.1.3

This commit is contained in:
Docs
2025-11-29 14:56:13 +00:00
parent a9d998a33c
commit 2ccadc6387
40 changed files with 4155 additions and 412 deletions

View File

@@ -21,8 +21,11 @@
<link rel="next" href="../prepare_ha/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.22">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.0">
@@ -30,10 +33,10 @@
<link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.618322db.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
@@ -79,7 +82,6 @@
</head>
@@ -269,10 +271,15 @@
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
@@ -315,10 +322,15 @@
<span class="md-ellipsis">
Getting started (Home Assistant)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
@@ -326,7 +338,11 @@
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting started (Home Assistant)
Getting started (Home Assistant)
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -365,10 +381,15 @@
<span class="md-ellipsis">
First steps
</span>
<span class="md-nav__icon md-icon"></span>
</label>
@@ -376,7 +397,11 @@
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_1_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2_1">
<span class="md-nav__icon md-icon"></span>
First steps
First steps
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -401,10 +426,15 @@
<span class="md-ellipsis">
Prepare NsPanel
</span>
<span class="md-nav__icon md-icon"></span>
</label>
@@ -414,10 +444,15 @@
<span class="md-ellipsis">
Prepare NsPanel
</span>
</a>
@@ -439,7 +474,9 @@
<li class="md-nav__item">
<a href="#downgrade-tasmota" class="md-nav__link">
<span class="md-ellipsis">
Downgrade Tasmota
Downgrade Tasmota
</span>
</a>
@@ -448,7 +485,9 @@
<li class="md-nav__item">
<a href="#configure-tasmota-template-for-nspanel" class="md-nav__link">
<span class="md-ellipsis">
Configure Tasmota Template for NSPanel
Configure Tasmota Template for NSPanel
</span>
</a>
@@ -457,7 +496,9 @@
<li class="md-nav__item">
<a href="#upload-berry-driver-to-tasmota" class="md-nav__link">
<span class="md-ellipsis">
Upload Berry Driver to Tasmota
Upload Berry Driver to Tasmota
</span>
</a>
@@ -466,7 +507,9 @@
<li class="md-nav__item">
<a href="#flash-firmware-to-nextion-screen" class="md-nav__link">
<span class="md-ellipsis">
Flash Firmware to Nextion Screen
Flash Firmware to Nextion Screen
</span>
</a>
@@ -493,10 +536,15 @@
<span class="md-ellipsis">
Prepare Home Assistant
</span>
</a>
</li>
@@ -516,10 +564,15 @@
<span class="md-ellipsis">
Configure MQTT
</span>
</a>
</li>
@@ -547,10 +600,15 @@
<span class="md-ellipsis">
FAQ
</span>
</a>
</li>
@@ -611,10 +669,15 @@
<span class="md-ellipsis">
Configuration - apps.yaml (Home Assistant)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
@@ -622,7 +685,11 @@
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Configuration - apps.yaml (Home Assistant)
Configuration - apps.yaml (Home Assistant)
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -638,10 +705,15 @@
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
@@ -661,10 +733,15 @@
<span class="md-ellipsis">
Screensaver
</span>
</a>
</li>
@@ -717,10 +794,15 @@
<span class="md-ellipsis">
Cards
</span>
<span class="md-nav__icon md-icon"></span>
</label>
@@ -728,7 +810,11 @@
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3">
<span class="md-nav__icon md-icon"></span>
Cards
Cards
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -744,10 +830,15 @@
<span class="md-ellipsis">
Entities Card
</span>
</a>
</li>
@@ -767,10 +858,15 @@
<span class="md-ellipsis">
Grid Card
</span>
</a>
</li>
@@ -790,10 +886,15 @@
<span class="md-ellipsis">
Climate/Thermo Card
</span>
</a>
</li>
@@ -813,10 +914,15 @@
<span class="md-ellipsis">
Media Card
</span>
</a>
</li>
@@ -836,10 +942,15 @@
<span class="md-ellipsis">
Alarm Card
</span>
</a>
</li>
@@ -859,10 +970,15 @@
<span class="md-ellipsis">
Wifi/QR Card
</span>
</a>
</li>
@@ -882,10 +998,15 @@
<span class="md-ellipsis">
Power Card
</span>
</a>
</li>
@@ -905,10 +1026,15 @@
<span class="md-ellipsis">
Unlock Card
</span>
</a>
</li>
@@ -936,10 +1062,15 @@
<span class="md-ellipsis">
Special Settings for Entities
</span>
</a>
</li>
@@ -959,10 +1090,15 @@
<span class="md-ellipsis">
Subpages
</span>
</a>
</li>
@@ -982,10 +1118,15 @@
<span class="md-ellipsis">
Notifications
</span>
</a>
</li>
@@ -1005,10 +1146,15 @@
<span class="md-ellipsis">
Physical Buttons
</span>
</a>
</li>
@@ -1059,10 +1205,15 @@
<span class="md-ellipsis">
Getting started (ioBroker)
</span>
<span class="md-nav__icon md-icon"></span>
</label>
@@ -1070,7 +1221,11 @@
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Getting started (ioBroker)
Getting started (ioBroker)
</label>
<ul class="md-nav__list" data-md-scrollfix>
@@ -1086,10 +1241,15 @@
<span class="md-ellipsis">
Prepare NsPanel
</span>
</a>
</li>
@@ -1109,10 +1269,15 @@
<span class="md-ellipsis">
Prepare ioBroker
</span>
</a>
</li>
@@ -1156,7 +1321,9 @@
<li class="md-nav__item">
<a href="#downgrade-tasmota" class="md-nav__link">
<span class="md-ellipsis">
Downgrade Tasmota
Downgrade Tasmota
</span>
</a>
@@ -1165,7 +1332,9 @@
<li class="md-nav__item">
<a href="#configure-tasmota-template-for-nspanel" class="md-nav__link">
<span class="md-ellipsis">
Configure Tasmota Template for NSPanel
Configure Tasmota Template for NSPanel
</span>
</a>
@@ -1174,7 +1343,9 @@
<li class="md-nav__item">
<a href="#upload-berry-driver-to-tasmota" class="md-nav__link">
<span class="md-ellipsis">
Upload Berry Driver to Tasmota
Upload Berry Driver to Tasmota
</span>
</a>
@@ -1183,7 +1354,9 @@
<li class="md-nav__item">
<a href="#flash-firmware-to-nextion-screen" class="md-nav__link">
<span class="md-ellipsis">
Flash Firmware to Nextion Screen
Flash Firmware to Nextion Screen
</span>
</a>
@@ -1199,51 +1372,59 @@
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<div><h1 id="flash-tasmota-to-your-nspanel">Flash Tasmota to your NSPanel<a class="headerlink" href="#flash-tasmota-to-your-nspanel" title="Permanent link"></a></h1>
<p>You need to connect to your nspanel via serial and flash tasmota <a href="http://ota.tasmota.com/tasmota32/release/tasmota32-nspanel.bin">tasmota32-nspanel.bin</a> to your NSPanel.
You can use the Tasmota Web Installer to do so. <a href="https://tasmota.github.io/install/">Tasmota Web Installer</a></p>
<p>Checkout Blakadders Template Repo for more information on flashing, do not use the autoexec.be from this page.
<div><h1 id="flash-tasmota-to-your-nspanel">Flash Tasmota to Your NSPanel<a class="headerlink" href="#flash-tasmota-to-your-nspanel" title="Permanent link"></a></h1>
<p>You need to connect to your NSPanel via serial and flash Tasmota using <a href="http://ota.tasmota.com/tasmota32/release/tasmota32-nspanel.bin">tasmota32-nspanel.bin</a>.<br>
You can use the <a href="https://tasmota.github.io/install/">Tasmota Web Installer</a> to do so.</p>
<p>Check out Blakadder's Template Repo for more information on flashing. <strong>Do not</strong> use the autoexec.be from that page.<br>
<a href="https://templates.blakadder.com/sonoff_NSPanel.html">NSPanel Page of the Tasmota Template Repository</a></p>
<p>If you prefer EspHome over Tasmota, you can use this thrid party esphome component, which is replacing tasmota and the berry driver of this project.
<a href="https://github.com/sairon/esphome-nspanel-lovelace-ui">ESPHome component</a></p>
<p>If you prefer ESPHome over Tasmota, you can use this third-party ESPHome component, which replaces Tasmota and the Berry driver used in this project.<br>
<a href="https://github.com/sairon/esphome-nspanel-lovelace-ui">ESPHome Component</a></p>
<hr>
<h2 id="downgrade-tasmota">Downgrade Tasmota<a class="headerlink" href="#downgrade-tasmota" title="Permanent link"></a></h2>
<p>Downgrade your tasmoto to the 15.0.1 - in newer versions flashing the display is currently not working.</p>
<p><code>https://ota.tasmota.com/tasmota32/release-15.0.1/tasmota32-nspanel.bin</code></p>
<p>Downgrade your Tasmota to version <strong>15.0.1</strong> - in newer versions, flashing the display currently does not work.</p>
<p><a href="https://ota.tasmota.com/tasmota32/release-15.0.1/tasmota32-nspanel.bin">https://ota.tasmota.com/tasmota32/release-15.0.1/tasmota32-nspanel.bin</a></p>
<hr>
<h2 id="configure-tasmota-template-for-nspanel">Configure Tasmota Template for NSPanel<a class="headerlink" href="#configure-tasmota-template-for-nspanel" title="Permanent link"></a></h2>
<p>Configure the NSPanel template for Tasmota. (Go to Configuration and Configure Other and paste the template there, make sure to tick the activate checkbox)</p>
<p>Configure the NSPanel template for Tasmota. (Go to Configuration &gt; Configure Other, paste the template there, and make sure to tick the Activate checkbox.)</p>
<p><img alt="tasmota-template-config" src="../img/tasmota-template-config.png"></p>
<p>You can use the following template or copy the one on the <a href="https://templates.blakadder.com/sonoff_NSPanel.html">Tasmota Template Repo Site</a>.</p>
<p><code>{"NAME":"NSPanel","GPIO":[0,0,0,0,3872,0,0,0,0,0,32,0,0,0,0,225,0,480,224,1,0,0,0,33,0,0,0,0,0,0,0,0,0,0,4736,0],"FLAG":0,"BASE":1,"CMND":"ADCParam 2,11200,10000,3950 | Sleep 0 | BuzzerPWM 1"}</code></p>
<p>After a reboot of tasmota your screen will light up with the stock display firmware.</p>
<p>You can use the following template or copy the one from the <a href="https://templates.blakadder.com/sonoff_NSPanel.html">Tasmota Template Repo Site</a>:</p>
<p>{"NAME":"NSPanel","GPIO":[0,0,0,0,3872,0,0,0,0,0,32,0,0,0,0,225,0,480,224,1,0,0,0,33,0,0,0,0,0,0,0,0,0,0,4736,0],"FLAG":0,"BASE":1,"CMND":"ADCParam 2,11200,10000,3950 | Sleep 0 | BuzzerPWM 1"}</p>
<p>After a reboot of Tasmota, your screen will light up with the stock display firmware.</p>
<hr>
<h2 id="upload-berry-driver-to-tasmota">Upload Berry Driver to Tasmota<a class="headerlink" href="#upload-berry-driver-to-tasmota" title="Permanent link"></a></h2>
<p>Go to <code>Consoles</code> &gt; <code>Console</code> in Tasmota and execute the following command:</p>
<div class="highlight"><pre><span></span><code>Backlog UrlFetch https://raw.githubusercontent.com/joBr99/nspanel-lovelace-ui/main/tasmota/autoexec.be; SetOption151 0;Restart 1
</code></pre></div>
<p>This will download the autoexec.be file from the repository and restart tasmota.</p>
<p>Note: The command is also disabling matter to free up memory, as it's most likely not used by any homeassistant users anyway.
(Matter could cause memory issues during flashing of the Nextion Screen, but you can still enable it if you need to.)</p>
<p>Go to Consoles &gt; Console in Tasmota and execute the following command:</p>
<p>Backlog UrlFetch <a href="https://raw.githubusercontent.com/joBr99/nspanel-lovelace-ui/main/tasmota/autoexec.be">https://raw.githubusercontent.com/joBr99/nspanel-lovelace-ui/main/tasmota/autoexec.be</a>; SetOption151 0; Restart 1</p>
<p>This downloads the autoexec.be file from the repository and restarts Tasmota.</p>
<p>Note: This command also disables Matter to free up memory, as it's unlikely to be used by most Home Assistant users. (Matter can cause memory issues during flashing of the Nextion screen, but you can re-enable it later if needed.)</p>
<hr>
<h2 id="flash-firmware-to-nextion-screen">Flash Firmware to Nextion Screen<a class="headerlink" href="#flash-firmware-to-nextion-screen" title="Permanent link"></a></h2>
<p>Due the limitations of Berry, it's not possible to download the tft file directly from github, so I'm also renting a small server where you can download the file via HTTP.</p>
<p>Use the one following commands in the tasmota console (not berry console) to flash the latest release from this repository:</p>
<p>EU Version: <code>FlashNextion http://nspanel.pky.eu/lui-release.tft</code></p>
<p>US Version Portrait: <code>FlashNextion http://nspanel.pky.eu/lui-us-p-release.tft</code></p>
<p>US Version Landscape: <code>FlashNextion http://nspanel.pky.eu/lui-us-l-release.tft</code></p>
<p>After sending the command, the screen should show a progress bar. The flashing progress takes around 5 minutes.</p>
<p>Note: For the US Version Users - keep in mind that you need to add the model config option to your apps.yaml later, more details on config overview page</p>
<p>Due to the limitations of Berry, it's not possible to download the TFT file directly from GitHub. A small server is available to download the file via HTTP.</p>
<p>Use one of the following commands in the Tasmota console (not the Berry console) to flash the latest release from this repository:</p>
<p>EU Version:<br>
FlashNextion <a href="http://nspanel.pky.eu/lui-release.tft">http://nspanel.pky.eu/lui-release.tft</a></p>
<p>US Version Portrait:<br>
FlashNextion <a href="http://nspanel.pky.eu/lui-us-p-release.tft">http://nspanel.pky.eu/lui-us-p-release.tft</a></p>
<p>US Version Landscape:<br>
FlashNextion <a href="http://nspanel.pky.eu/lui-us-l-release.tft">http://nspanel.pky.eu/lui-us-l-release.tft</a></p>
<p>After sending the command, the screen should show a progress bar. The flashing process takes around 5 minutes.</p>
<p>Note for US users: You'll need to add the model config option to your apps.yaml later. More details can be found on the config overview page.</p>
<hr>
<details>
<summary>Alternatively you can use your own webserver or the one build into HomeAssistant:</summary>
<summary>Alternatively, you can use your own web server or the one built into Home Assistant:</summary>
<br>
Upload the nspanel.tft from the lastest release to a Webserver (for example www folder of Home Assistant) and execute the following command in Tasmota Console. (Development Version: [tft file from HMI folder](HMI/nspanel.tft))
Upload the nspanel.tft from the latest release to a web server (for example, the www folder of Home Assistant) and execute the following command in the Tasmota Console.
(Development version: [TFT file from HMI folder](HMI/nspanel.tft))
**Webserver must be HTTP, HTTPS is not supported, due to limitations of berry lang on tasmota**
**The web server must be HTTP. HTTPS is not supported due to Berry language limitations in Tasmota.**
`FlashNextion http://ip-address-of-your-homeassistant:8123/local/nspanel.tft`
FlashNextion http://ip-address-of-your-homeassistant:8123/local/nspanel.tft
</details></div>
@@ -1305,10 +1486,11 @@ Upload the nspanel.tft from the lastest release to a Webserver (for example www
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.indexes", "navigation.sections", "navigation.top", "navigation.tracking", "navigation.expand", "search.highlight", "search.share", "search.suggest"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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": "Select version"}, "version": {"provider": "mike"}}</script>
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.indexes", "navigation.sections", "navigation.top", "navigation.tracking", "navigation.expand", "search.highlight", "search.share", "search.suggest"], "search": "../assets/javascripts/workers/search.7a47a382.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "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": "Select version"}, "version": {"provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
<script src="../assets/javascripts/bundle.e71a0d61.min.js"></script>
</body>