Deployed fbdc44c with MkDocs version: 1.6.0

fredlcore · Nov 5, 2024 · b844d4f · b844d4f
1 parent b6b2bbb
commit b844d4f
Show file tree

Hide file tree

Showing 16 changed files with 83 additions and 95 deletions.
diff --git a/CHANGELOG.html b/CHANGELOG.html
@@ -389,12 +389,19 @@
 
 <h1 id="changelog">ChangeLog</h1>
 <h2 id="current-master">Current Master</h2>
+<ul>
+<li><strong>ATTENTION: BREAKING CHANGE!</strong> Changed unique_id for MQTT auto-discovery. This means that all MQTT entities that have been created via auto-discovery will have to be created anew!</li>
+<li><strong>ATTENTION:</strong> Configuration options <code>fixed_device_family</code> and <code>fixed_device_variant</code> have been removed since they no longer work for device-specific parameter lists. If your heating system is off when turning on the microcontroller, BSB-LAN will try to acquire the details every 60 seconds.</li>
+<li><strong>ATTENTION:</strong> Change of configuration options results in new EEPROM layout, therefore EEPROM will be reinitialized based on configuration of <code>BSB_LAN_config.h</code>.</li>
+<li>MQTT auto-discovery now works for all devices, not only device ID 0. Use /M1!<x> or /M0!<x> to create/remove entities for device ID <x>.</li>
+<li>Changed MQTT auto-discovery messages' flag to "retain" so that parameters remain available after reboot of Home Assistant.</li>
+</ul>
 <h2 id="version-40">Version 4.0</h2>
 <p><strong>01.11.2024</strong>  </p>
 <ul>
-<li><strong>ATTENTION: BREAKING CHANGE!</strong> Room temperature parameter 10000, 10001 and 10002 must now have the additional flag <code>FL_SPECIAL_INF</code>, otherwise setting temperature will not work! </li>
-<li><strong>ATTENTION: BREAKING CHANGE!</strong> Outside temperature simulation parameter 10017 must have <code>FL_SPECIAL_INF</code> flag removed, otherwise setting temperature will not work! </li>
-<li><strong>ATTENTION: BREAKING CHANGE!</strong> Room temperature parameter 10000, 10001 and 10002 for Weishaupt heaters (device families 49, 50, 51 and 59) must now have <code>FL_SPECIAL_INF</code> flag removd, otherwise setting temperature will not work! </li>
+<li><strong>ATTENTION: BREAKING CHANGE!</strong> Room temperature parameter 10000, 10001 and 10002 must now have the additional flag <code>FL_SPECIAL_INF</code>, otherwise setting temperature will not work!</li>
+<li><strong>ATTENTION: BREAKING CHANGE!</strong> Outside temperature simulation parameter 10017 must have <code>FL_SPECIAL_INF</code> flag removed, otherwise setting temperature will not work!</li>
+<li><strong>ATTENTION: BREAKING CHANGE!</strong> Room temperature parameter 10000, 10001 and 10002 for Weishaupt heaters (device families 49, 50, 51 and 59) must now have <code>FL_SPECIAL_INF</code> flag removd, otherwise setting temperature will not work!</li>
 <li><strong>ATTENTION: BREAKING CHANGE!</strong> URL commands <code>/U</code> (dislpay user-defined variables) and <code>/X</code> (display MAX! values) have been removed as these values can now be accessed via parameters 20000++</li>
 <li><strong>ATTENTION: BREAKING CHANGE!</strong> PPS time program parameters (15050-15091) have been streamlined with BSB/LPB time program parameters, resulting in only one parameter per day (instead of six), covering three switch points (start and end) per parameter.</li>
 <li><strong>ATTENTION:</strong> For ESP32, BSB-LAN requires ESP32 framework version 3.0.x - please look out for errors or strange behaviour (1-Wire sensors are still not tested) as well as any other kind of strange behaviour/crashes.</li>

diff --git a/configure.html b/configure.html
@@ -330,18 +330,6 @@ <h3 id="bus-settings">Bus settings</h3>
 <td><strong>0</strong> (<code>0</code>)</td>
 </tr>
 <tr>
-<td>Device family</td>
-<td><code>fixed_device_family</code></td>
-<td>Set the device family that BSB-LAN should emulate. Leave at <code>0</code> for auto-detection.</td>
-<td><strong>0</strong> (<code>0</code>)</td>
-</tr>
-<tr>
-<td>Device variant</td>
-<td><code>fixed_device_variant</code></td>
-<td>Set the device variant that BSB-LAN should emulate. Leave at <code>0</code> for auto-detection</td>
-<td><strong>0</strong> (<code>0</code>)</td>
-</tr>
-<tr>
 <td>RX pin number<br>TX pin number</td>
 <td><code>bus_pins</code></td>
 <td>Define the RX/TX pins to communicate with the BSB-LAN adapter. Leave at <code>0</code> for auto-detection.</td>

diff --git a/de/CHANGELOG.html b/de/CHANGELOG.html
@@ -389,12 +389,19 @@
 
 <h1 id="changelog">ChangeLog</h1>
 <h2 id="current-master">Current Master</h2>
+<ul>
+<li><strong>ATTENTION: BREAKING CHANGE!</strong> Changed unique_id for MQTT auto-discovery. This means that all MQTT entities that have been created via auto-discovery will have to be created anew!</li>
+<li><strong>ATTENTION:</strong> Configuration options <code>fixed_device_family</code> and <code>fixed_device_variant</code> have been removed since they no longer work for device-specific parameter lists. If your heating system is off when turning on the microcontroller, BSB-LAN will try to acquire the details every 60 seconds.</li>
+<li><strong>ATTENTION:</strong> Change of configuration options results in new EEPROM layout, therefore EEPROM will be reinitialized based on configuration of <code>BSB_LAN_config.h</code>.</li>
+<li>MQTT auto-discovery now works for all devices, not only device ID 0. Use /M1!<x> or /M0!<x> to create/remove entities for device ID <x>.</li>
+<li>Changed MQTT auto-discovery messages' flag to "retain" so that parameters remain available after reboot of Home Assistant.</li>
+</ul>
 <h2 id="version-40">Version 4.0</h2>
 <p><strong>01.11.2024</strong>  </p>
 <ul>
-<li><strong>ATTENTION: BREAKING CHANGE!</strong> Room temperature parameter 10000, 10001 and 10002 must now have the additional flag <code>FL_SPECIAL_INF</code>, otherwise setting temperature will not work! </li>
-<li><strong>ATTENTION: BREAKING CHANGE!</strong> Outside temperature simulation parameter 10017 must have <code>FL_SPECIAL_INF</code> flag removed, otherwise setting temperature will not work! </li>
-<li><strong>ATTENTION: BREAKING CHANGE!</strong> Room temperature parameter 10000, 10001 and 10002 for Weishaupt heaters (device families 49, 50, 51 and 59) must now have <code>FL_SPECIAL_INF</code> flag removd, otherwise setting temperature will not work! </li>
+<li><strong>ATTENTION: BREAKING CHANGE!</strong> Room temperature parameter 10000, 10001 and 10002 must now have the additional flag <code>FL_SPECIAL_INF</code>, otherwise setting temperature will not work!</li>
+<li><strong>ATTENTION: BREAKING CHANGE!</strong> Outside temperature simulation parameter 10017 must have <code>FL_SPECIAL_INF</code> flag removed, otherwise setting temperature will not work!</li>
+<li><strong>ATTENTION: BREAKING CHANGE!</strong> Room temperature parameter 10000, 10001 and 10002 for Weishaupt heaters (device families 49, 50, 51 and 59) must now have <code>FL_SPECIAL_INF</code> flag removd, otherwise setting temperature will not work!</li>
 <li><strong>ATTENTION: BREAKING CHANGE!</strong> URL commands <code>/U</code> (dislpay user-defined variables) and <code>/X</code> (display MAX! values) have been removed as these values can now be accessed via parameters 20000++</li>
 <li><strong>ATTENTION: BREAKING CHANGE!</strong> PPS time program parameters (15050-15091) have been streamlined with BSB/LPB time program parameters, resulting in only one parameter per day (instead of six), covering three switch points (start and end) per parameter.</li>
 <li><strong>ATTENTION:</strong> For ESP32, BSB-LAN requires ESP32 framework version 3.0.x - please look out for errors or strange behaviour (1-Wire sensors are still not tested) as well as any other kind of strange behaviour/crashes.</li>

diff --git a/de/configure.html b/de/configure.html
@@ -330,18 +330,6 @@ <h3 id="bus-settings">Bus settings</h3>
 <td><strong>0</strong> (<code>0</code>)</td>
 </tr>
 <tr>
-<td>Device family</td>
-<td><code>fixed_device_family</code></td>
-<td>Set the device family that BSB-LAN should emulate. Leave at <code>0</code> for auto-detection.</td>
-<td><strong>0</strong> (<code>0</code>)</td>
-</tr>
-<tr>
-<td>Device variant</td>
-<td><code>fixed_device_variant</code></td>
-<td>Set the device variant that BSB-LAN should emulate. Leave at <code>0</code> for auto-detection</td>
-<td><strong>0</strong> (<code>0</code>)</td>
-</tr>
-<tr>
 <td>RX pin number<br>TX pin number</td>
 <td><code>bus_pins</code></td>
 <td>Define the RX/TX pins to communicate with the BSB-LAN adapter. Leave at <code>0</code> for auto-detection.</td>

diff --git a/de/homeautomation.html b/de/homeautomation.html
@@ -211,6 +211,7 @@ <h2 id="exchanging-data-via-mqtt">Exchanging data via MQTT</h2>
 </ul>
 <p>If your home automation system supports MQTT auto-discovery (as is the case with Home Assistant), you can call URL command <code>/M1</code> and BSB-LAN will send auto-discovery messages for <strong>all available parameters</strong> to the MQTT broker and thus to the home automation system. You may have to clean up afterwards or send a removal message for all these parameters using URL command <code>/M0</code>.<br />
 Every time a query is made in BSB-LAN or a parameter changes its value through the room unit, the new value will be sent to the MQTT broker, so even changes made outside of BSB-LAN should be updated into the home automation system, which is why the MQTT approach is the recommended way to connect to a home automation system.</p>
+<p>Here is a link to a <a href="https://youtu.be/DbHEiWm5nBs">video in the BSB-LAN YouTube channel</a> that shows how to set up BSB-LAN in Home Assistant using the auto-discovery feature of Home Assistant.</p>
 <p>Examples for querying or setting parameters via MQTT would look like this (using mosquitto):<br />
 Query the outside temperature (parameter 8700):<br />
 <code>mosquitto_pub -h my.mosquitto-broker.local -u USER -P PASSWORD -m "8700" -t BSB-LAN -d</code>  </p>

diff --git a/de/using.html b/de/using.html
@@ -481,8 +481,8 @@ <h3 id="misceallaneous">Misceallaneous</h3>
 </thead>
 <tbody>
 <tr>
-<td style="text-align: left;"><code>/M&lt;x&gt;</code></td>
-<td style="text-align: left;">Send (<code>1</code>) or revoke (<code>0</code>) MQTT auto-discovery messages for all parameters from controller at default destination address.</td>
+<td style="text-align: left;"><code>/M&lt;x&gt;!&lt;y&gt;</code></td>
+<td style="text-align: left;">Send (<code>&lt;x&gt;=1</code>) or revoke (<code>&lt;x&gt;=0</code>) MQTT auto-discovery messages for all parameters from controller at destination address <code>&lt;y&gt;</code>.</td>
 </tr>
 <tr>
 <td style="text-align: left;"><code>/N</code></td>

diff --git a/fr/CHANGELOG.html b/fr/CHANGELOG.html
@@ -389,12 +389,19 @@
 
 <h1 id="changelog">ChangeLog</h1>
 <h2 id="current-master">Current Master</h2>
+<ul>
+<li><strong>ATTENTION: BREAKING CHANGE!</strong> Changed unique_id for MQTT auto-discovery. This means that all MQTT entities that have been created via auto-discovery will have to be created anew!</li>
+<li><strong>ATTENTION:</strong> Configuration options <code>fixed_device_family</code> and <code>fixed_device_variant</code> have been removed since they no longer work for device-specific parameter lists. If your heating system is off when turning on the microcontroller, BSB-LAN will try to acquire the details every 60 seconds.</li>
+<li><strong>ATTENTION:</strong> Change of configuration options results in new EEPROM layout, therefore EEPROM will be reinitialized based on configuration of <code>BSB_LAN_config.h</code>.</li>
+<li>MQTT auto-discovery now works for all devices, not only device ID 0. Use /M1!<x> or /M0!<x> to create/remove entities for device ID <x>.</li>
+<li>Changed MQTT auto-discovery messages' flag to "retain" so that parameters remain available after reboot of Home Assistant.</li>
+</ul>
 <h2 id="version-40">Version 4.0</h2>
 <p><strong>01.11.2024</strong>  </p>
 <ul>
-<li><strong>ATTENTION: BREAKING CHANGE!</strong> Room temperature parameter 10000, 10001 and 10002 must now have the additional flag <code>FL_SPECIAL_INF</code>, otherwise setting temperature will not work! </li>
-<li><strong>ATTENTION: BREAKING CHANGE!</strong> Outside temperature simulation parameter 10017 must have <code>FL_SPECIAL_INF</code> flag removed, otherwise setting temperature will not work! </li>
-<li><strong>ATTENTION: BREAKING CHANGE!</strong> Room temperature parameter 10000, 10001 and 10002 for Weishaupt heaters (device families 49, 50, 51 and 59) must now have <code>FL_SPECIAL_INF</code> flag removd, otherwise setting temperature will not work! </li>
+<li><strong>ATTENTION: BREAKING CHANGE!</strong> Room temperature parameter 10000, 10001 and 10002 must now have the additional flag <code>FL_SPECIAL_INF</code>, otherwise setting temperature will not work!</li>
+<li><strong>ATTENTION: BREAKING CHANGE!</strong> Outside temperature simulation parameter 10017 must have <code>FL_SPECIAL_INF</code> flag removed, otherwise setting temperature will not work!</li>
+<li><strong>ATTENTION: BREAKING CHANGE!</strong> Room temperature parameter 10000, 10001 and 10002 for Weishaupt heaters (device families 49, 50, 51 and 59) must now have <code>FL_SPECIAL_INF</code> flag removd, otherwise setting temperature will not work!</li>
 <li><strong>ATTENTION: BREAKING CHANGE!</strong> URL commands <code>/U</code> (dislpay user-defined variables) and <code>/X</code> (display MAX! values) have been removed as these values can now be accessed via parameters 20000++</li>
 <li><strong>ATTENTION: BREAKING CHANGE!</strong> PPS time program parameters (15050-15091) have been streamlined with BSB/LPB time program parameters, resulting in only one parameter per day (instead of six), covering three switch points (start and end) per parameter.</li>
 <li><strong>ATTENTION:</strong> For ESP32, BSB-LAN requires ESP32 framework version 3.0.x - please look out for errors or strange behaviour (1-Wire sensors are still not tested) as well as any other kind of strange behaviour/crashes.</li>

diff --git a/fr/configure.html b/fr/configure.html
@@ -330,18 +330,6 @@ <h3 id="bus-settings">Bus settings</h3>
 <td><strong>0</strong> (<code>0</code>)</td>
 </tr>
 <tr>
-<td>Device family</td>
-<td><code>fixed_device_family</code></td>
-<td>Set the device family that BSB-LAN should emulate. Leave at <code>0</code> for auto-detection.</td>
-<td><strong>0</strong> (<code>0</code>)</td>
-</tr>
-<tr>
-<td>Device variant</td>
-<td><code>fixed_device_variant</code></td>
-<td>Set the device variant that BSB-LAN should emulate. Leave at <code>0</code> for auto-detection</td>
-<td><strong>0</strong> (<code>0</code>)</td>
-</tr>
-<tr>
 <td>RX pin number<br>TX pin number</td>
 <td><code>bus_pins</code></td>
 <td>Define the RX/TX pins to communicate with the BSB-LAN adapter. Leave at <code>0</code> for auto-detection.</td>

diff --git a/fr/homeautomation.html b/fr/homeautomation.html
@@ -211,6 +211,7 @@ <h2 id="exchanging-data-via-mqtt">Exchanging data via MQTT</h2>
 </ul>
 <p>If your home automation system supports MQTT auto-discovery (as is the case with Home Assistant), you can call URL command <code>/M1</code> and BSB-LAN will send auto-discovery messages for <strong>all available parameters</strong> to the MQTT broker and thus to the home automation system. You may have to clean up afterwards or send a removal message for all these parameters using URL command <code>/M0</code>.<br />
 Every time a query is made in BSB-LAN or a parameter changes its value through the room unit, the new value will be sent to the MQTT broker, so even changes made outside of BSB-LAN should be updated into the home automation system, which is why the MQTT approach is the recommended way to connect to a home automation system.</p>
+<p>Here is a link to a <a href="https://youtu.be/DbHEiWm5nBs">video in the BSB-LAN YouTube channel</a> that shows how to set up BSB-LAN in Home Assistant using the auto-discovery feature of Home Assistant.</p>
 <p>Examples for querying or setting parameters via MQTT would look like this (using mosquitto):<br />
 Query the outside temperature (parameter 8700):<br />
 <code>mosquitto_pub -h my.mosquitto-broker.local -u USER -P PASSWORD -m "8700" -t BSB-LAN -d</code>  </p>

diff --git a/fr/using.html b/fr/using.html
@@ -481,8 +481,8 @@ <h3 id="misceallaneous">Misceallaneous</h3>
 </thead>
 <tbody>
 <tr>
-<td style="text-align: left;"><code>/M&lt;x&gt;</code></td>
-<td style="text-align: left;">Send (<code>1</code>) or revoke (<code>0</code>) MQTT auto-discovery messages for all parameters from controller at default destination address.</td>
+<td style="text-align: left;"><code>/M&lt;x&gt;!&lt;y&gt;</code></td>
+<td style="text-align: left;">Send (<code>&lt;x&gt;=1</code>) or revoke (<code>&lt;x&gt;=0</code>) MQTT auto-discovery messages for all parameters from controller at destination address <code>&lt;y&gt;</code>.</td>
 </tr>
 <tr>
 <td style="text-align: left;"><code>/N</code></td>

diff --git a/homeautomation.html b/homeautomation.html
@@ -211,6 +211,7 @@ <h2 id="exchanging-data-via-mqtt">Exchanging data via MQTT</h2>
 </ul>
 <p>If your home automation system supports MQTT auto-discovery (as is the case with Home Assistant), you can call URL command <code>/M1</code> and BSB-LAN will send auto-discovery messages for <strong>all available parameters</strong> to the MQTT broker and thus to the home automation system. You may have to clean up afterwards or send a removal message for all these parameters using URL command <code>/M0</code>.<br />
 Every time a query is made in BSB-LAN or a parameter changes its value through the room unit, the new value will be sent to the MQTT broker, so even changes made outside of BSB-LAN should be updated into the home automation system, which is why the MQTT approach is the recommended way to connect to a home automation system.</p>
+<p>Here is a link to a <a href="https://youtu.be/DbHEiWm5nBs">video in the BSB-LAN YouTube channel</a> that shows how to set up BSB-LAN in Home Assistant using the auto-discovery feature of Home Assistant.</p>
 <p>Examples for querying or setting parameters via MQTT would look like this (using mosquitto):<br />
 Query the outside temperature (parameter 8700):<br />
 <code>mosquitto_pub -h my.mosquitto-broker.local -u USER -P PASSWORD -m "8700" -t BSB-LAN -d</code>  </p>

diff --git a/index.html b/index.html
@@ -277,5 +277,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.6.0
-Build Date UTC : 2024-11-03 17:14:28.828426+00:00
+Build Date UTC : 2024-11-05 19:12:46.543637+00:00
 -->
diff --git a/search/search_index.json b/search/search_index.json