Deployed 00d6b63 with MkDocs version: 1.6.0

bus_systems.html

@@ -196,7 +196,8 @@ <h2 id="the-local-process-bus-lpb">The Local Process Bus (LPB)</h2>
 <hr />
 <p><a href="" id="PPS"></a></p>
 <h2 id="the-point-to-point-interface-pps">The Point-to-Point Interface (PPS)</h2>
-<p>The Point-to-Point Interface (PPS deriving from the German term "Punkt-zu-Punkt Schnittstelle") is compatible to the other systems on a physical layer, but not in the way message telegrams are being exchanged. While BSB and LPB talk to each other by sending telegrams and acknowledging their receipt respectively, PPS is dominated by the heating unit. The heating unit constantly sends its data to the room unit and tells the room unit when and what kind of information it should send. It is a very timing sensitive protocol, therefore long other tasks that BSB-LAN is told to do will lead to a temporary interruption and possible error message on the heating system. However, after a short while, this should be clearing by itself when the two components "talk" to each other again.  </p>
+<p>The Point-to-Point Interface (PPS deriving from the German term "Punkt-zu-Punkt Schnittstelle") is compatible to the other systems on a physical layer, but not in the way message telegrams are being exchanged. While BSB and LPB talk to each other by sending telegrams and acknowledging their receipt respectively, PPS is dominated by the heating unit. The heating unit constantly sends its data to the room unit and tells the room unit when and what kind of information it should send. So it may take up to a few minutes until a value that is set in BSB-LAN is actually requested by the heating system and shown there.<br />
+It is also a very timing sensitive protocol, therefore long other tasks that BSB-LAN is told to do will lead to a temporary interruption and possible error message on the heating system. However, after a short while, this should be clearing by itself when the two components "talk" to each other again.  </p>
 <p>Other than BSB and LPB, changes made in BSB-LAN do not take immediate effect. Changing values, for example like the room temperature comfort setpoint, will be stored internally in BSB-LAN first to be sent out to the heating system once it tells the room unit (i.e. BSB-LAN) to do so. This may take up to a minute or so, so one should not be confused that settings do not show up on the heater immediately, as is the case with BSB and LPB.</p>
 <p>With PPS, BSB-LAN can run in two modes: passive and as a room unit. In passive mode, BSB-LAN can just listen to the data exchanged between the room unit and the heating device. It is not possible to send one's own data, for the simple fact that it would be overwritten in no time by the same type of data coming from the room unit.<br />
 In order to send parameter data to the heating system, BSB-LAN mus run in "room unit" mode, and this means that any room unit will have to be removed from the heating system. In this case, it is especially important to regularly send a room temperature value to BSB-LAN which in turn will send this value to the heating device. Only if the heater runs solely on outside temperature then this value can be ignored.<br />

configure.html

@@ -239,7 +239,7 @@ <h3 id="general-settings">General Settings</h3>
 <td><strong>On</strong>  (<code>1</code>)<br><strong>Off</strong> (<code>0</code>)</td>
 </tr>
 <tr>
-<td>Write access (level)</td>
+<td><a href="" id="WriteAccess"></a>Write access (level)</td>
 <td>-</td>
 <td>If <code>DEFAULT_FLAG</code>is set to <code>FL_SW_CTL_RONLY</code>, you can set the level of write access here.</td>
 <td><strong>Off</strong> (read-only)<br><strong>On (Standard)</strong><br><strong>On (Complete)</strong></td>
@@ -439,7 +439,7 @@ <h3 id="network-settings">Network settings</h3>
 <td><strong>192.168.178.90</strong> (<code>192,168,178,90</code>)</td>
 </tr>
 <tr>
-<td>-</td>
+<td><a href="" id="BSSID"></a>-</td>
 <td><code>bssid</code></td>
 <td>Enter a specific BSSID address here to ensure connecting to a specific access point. Set to all zeros under normal circumstances.</td>
 <td>(<code>0x00, 0x00, 0x00, 0x00, 0x00, 0x00</code>)</td>

de/bus_systems.html

@@ -196,7 +196,8 @@ <h2 id="the-local-process-bus-lpb">The Local Process Bus (LPB)</h2>
 <hr />
 <p><a href="" id="PPS"></a></p>
 <h2 id="the-point-to-point-interface-pps">The Point-to-Point Interface (PPS)</h2>
-<p>The Point-to-Point Interface (PPS deriving from the German term "Punkt-zu-Punkt Schnittstelle") is compatible to the other systems on a physical layer, but not in the way message telegrams are being exchanged. While BSB and LPB talk to each other by sending telegrams and acknowledging their receipt respectively, PPS is dominated by the heating unit. The heating unit constantly sends its data to the room unit and tells the room unit when and what kind of information it should send. It is a very timing sensitive protocol, therefore long other tasks that BSB-LAN is told to do will lead to a temporary interruption and possible error message on the heating system. However, after a short while, this should be clearing by itself when the two components "talk" to each other again.  </p>
+<p>The Point-to-Point Interface (PPS deriving from the German term "Punkt-zu-Punkt Schnittstelle") is compatible to the other systems on a physical layer, but not in the way message telegrams are being exchanged. While BSB and LPB talk to each other by sending telegrams and acknowledging their receipt respectively, PPS is dominated by the heating unit. The heating unit constantly sends its data to the room unit and tells the room unit when and what kind of information it should send. So it may take up to a few minutes until a value that is set in BSB-LAN is actually requested by the heating system and shown there.<br />
+It is also a very timing sensitive protocol, therefore long other tasks that BSB-LAN is told to do will lead to a temporary interruption and possible error message on the heating system. However, after a short while, this should be clearing by itself when the two components "talk" to each other again.  </p>
 <p>Other than BSB and LPB, changes made in BSB-LAN do not take immediate effect. Changing values, for example like the room temperature comfort setpoint, will be stored internally in BSB-LAN first to be sent out to the heating system once it tells the room unit (i.e. BSB-LAN) to do so. This may take up to a minute or so, so one should not be confused that settings do not show up on the heater immediately, as is the case with BSB and LPB.</p>
 <p>With PPS, BSB-LAN can run in two modes: passive and as a room unit. In passive mode, BSB-LAN can just listen to the data exchanged between the room unit and the heating device. It is not possible to send one's own data, for the simple fact that it would be overwritten in no time by the same type of data coming from the room unit.<br />
 In order to send parameter data to the heating system, BSB-LAN mus run in "room unit" mode, and this means that any room unit will have to be removed from the heating system. In this case, it is especially important to regularly send a room temperature value to BSB-LAN which in turn will send this value to the heating device. Only if the heater runs solely on outside temperature then this value can be ignored.<br />

de/configure.html

@@ -239,7 +239,7 @@ <h3 id="general-settings">General Settings</h3>
 <td><strong>On</strong>  (<code>1</code>)<br><strong>Off</strong> (<code>0</code>)</td>
 </tr>
 <tr>
-<td>Write access (level)</td>
+<td><a href="" id="WriteAccess"></a>Write access (level)</td>
 <td>-</td>
 <td>If <code>DEFAULT_FLAG</code>is set to <code>FL_SW_CTL_RONLY</code>, you can set the level of write access here.</td>
 <td><strong>Off</strong> (read-only)<br><strong>On (Standard)</strong><br><strong>On (Complete)</strong></td>
@@ -439,7 +439,7 @@ <h3 id="network-settings">Network settings</h3>
 <td><strong>192.168.178.90</strong> (<code>192,168,178,90</code>)</td>
 </tr>
 <tr>
-<td>-</td>
+<td><a href="" id="BSSID"></a>-</td>
 <td><code>bssid</code></td>
 <td>Enter a specific BSSID address here to ensure connecting to a specific access point. Set to all zeros under normal circumstances.</td>
 <td>(<code>0x00, 0x00, 0x00, 0x00, 0x00, 0x00</code>)</td>

de/install.html

@@ -202,7 +202,7 @@ <h2 id="installing-the-arduino-ide-and-flashing-bsb-lan">Installing the Arduino
 </ol>
 </li>
 <li>Again, go to <strong><em>Tools/Board</em></strong> and select the proper upload speed (460800 for ESP32, 115200 for Arduino Due).</li>
-<li>For ESP32-based microcontrollers, again, go to <strong><em>Tools/Board</em></strong> and select "Minimal SPIFFS (Large APPS with OTA)" for partition scheme (<strong>do not confuse this with the similar "Minimal" partition scheme</strong> which is different and not working in our case). <strong>If you don't set the correct parition scheme, the firmware will not fit into the ESP32!</strong></li>
+<li><a href="" id="SPIFFS"></a>For ESP32-based microcontrollers, again, go to <strong><em>Tools/Board</em></strong> and select "Minimal SPIFFS (Large APPS with OTA)" for partition scheme (<strong>do not confuse this with the similar "Minimal" partition scheme</strong> which is different and not working in our case). <strong>If you don't set the correct parition scheme, the firmware will not fit into the ESP32!</strong></li>
 <li>Go to <strong><em>File/Open</em></strong> and navigate to the BSB_LAN folder and double-click on <code>BSB_LAN.ino</code>. The project will open.</li>
 <li>You may now proceed to <a href="configure.html">configure</a> BSB-LAN.</li>
 <li>When you are done configuring, go to <strong><em>Sketch/Upload</em></strong> and upload the BSB-LAN software to the microcontroller.</li>
@@ -219,7 +219,7 @@ <h2 id="connecting-bsb-lan-to-the-heating-system">Connecting BSB-LAN to the heat
 <ol>
 <li>Unplug the microcontroller from your computer and turn off your heating system. Locate the BSB/LPB/PPS connectors. You may have to open your heating system for that. Have a look at the list of <a href="supported_heating_systems.html">supported heating systems</a> to get an idea where the pins are located.<br><strong><em>Do all this at your own risk!</em></strong><br><strong>Especially take care to prevent electrostatic discharge (ESD) which can destroy both BSB-LAN and the heating controller!</strong></li>
 <li>Now plug the BSB-LAN adapter onto the microcontroller and connect the <code>+</code> screw connector to the <code>CL+</code> (BSB), <code>DB</code> (LPB) or <code>A6</code> (PPS, different connector names are possible) connector, and the <code>-</code> screw connector to the <code>CL-</code> (BSB), <code>MB</code> (LPB) or <code>M</code> (PPS) connector. If there is no empty connector, there is no problem adding the wires for BSB-LAN to an already "used" connector, provided the wires are inserted carefully.</li>
-<li>Now you need to power on the microcontroller. Take note that the heating system does not power the microcontroller, even if the BSB-LAN adapter's LED turns on when you connect it to the heating system. You need to supply power to the microcontroller via its USB port (or via PoE on the Olimex POE-ISO). Make sure to use a stable power supply with at least 2 amperes. Once the microcontroller is powered on, turn on the heating system. The red LED of the BSB-LAN adapter should alight. It should flicker occasionally.</li>
+<li><a href="" id="PowerSupply"></a>Now you need to power on the microcontroller. Take note that the heating system does not power the microcontroller, even if the BSB-LAN adapter's LED turns on when you connect it to the heating system. You need to supply power to the microcontroller via its USB port (or via PoE on the Olimex POE-ISO). Make sure to use a stable power supply with at least 2 amperes. Once the microcontroller is powered on, turn on the heating system. The red LED of the BSB-LAN adapter should alight. It should flicker occasionally.</li>
 <li>Now open your webbrowser and open the IP address of BSB-LAN. If MDNS is enabled, you can directly go to <a href="http://bsb-lan.local"><code>http://bsb-lan.local</code></a>. Otherwise, you can find the IP address of BSB-LAN either in your router, or you connect the microcontroller to your PC and open the Arduino IDE and go to <strong><em>Tools/Serial Monitor</em></strong> and set the serial monitor speed to 115200. Restart the microcontroller, and the IP address will be displayed upon connecting to the network.</li>
 </ol>
 <hr />

de/troubleshooting.html

@@ -200,7 +200,8 @@
                     <div class="col-md-9" role="main">
 
 <h1 id="troubleshooting">Troubleshooting</h1>
-<p>BSB-LAN tries to make accessing your heating system as easy as possible, but there are always things that can go wrong. If you still have a problem after reading this document as well as the <a href="faq.html">FAQ</a>, please <a href="https://github.com/fredlcore/BSB-LAN/issues/new?assignees=&amp;labels=&amp;projects=&amp;template=bug_report.md&amp;title=%5BBUG%5D">open up a bug report</a> on the project's GitHub page and make sure that you provide us with all the necessary log files and further required details, especially from the Serial Monitor (or <em>SerMo</em> in short). </p>
+<p>BSB-LAN tries to make accessing your heating system as easy as possible, but there are always things that can go wrong. If you still have a problem after reading this document as well as the <a href="faq.html">FAQ</a>, please <a href="https://github.com/fredlcore/BSB-LAN/issues/new?assignees=&amp;labels=&amp;projects=&amp;template=bug_report.md&amp;title=%5BBUG%5D">open up a bug report</a> on the project's GitHub page and make sure that you provide us with all the necessary log files and further required details, especially from the Serial Monitor (or <em>SerMo</em> in short).<br />
+Before doing so, however, make sure that you install the most recent version of BSB-LAN from the master repository (not the release version), even if yours is "just" a few days old. Still, a lot could have happned since then :)!</p>
 <h3 id="using-the-serial-monitor">Using the Serial Monitor</h3>
 <ul>
 <li>Access the Serial Monitor by going to <strong><em>Tools/Serial Monitor</em></strong> in the Arduino IDE.</li>
@@ -212,7 +213,7 @@ <h3 id="using-the-serial-monitor">Using the Serial Monitor</h3>
 <hr />
 <h2 id="compiling-fails-sketch-too-big">Compiling fails: "Sketch too big"</h2>
 <ul>
-<li>Select the "Minimal SPIFFS (Large APPS with OTA)" partition scheme in the Arduino IDE under <strong><em>Tools/Partition Scheme</em></strong>. If you are using over-the-air updates, you have to flash the software once via USB after changing the partition scheme before OTA updates will work again.</li>
+<li><a class="autorefs autorefs-internal" href="install.html#SPIFFS">Select the <em>Minimal SPIFFS (Large APPS with OTA)</em> partition scheme</a> in the Arduino IDE under <strong><em>Tools/Partition Scheme</em></strong>. If you are using over-the-air updates, you have to flash the software once via USB after changing the partition scheme before OTA updates will work again.</li>
 </ul>
 <hr />
 <h2 id="no-access-to-web-interface-anymore">No access to web-interface anymore</h2>
@@ -258,9 +259,9 @@ <h2 id="cannot-read-any-parameters-device-family-is-0">Cannot read any parameter
 <h2 id="no-data-even-though-the-adapters-red-led-is-on">No data even though the adapter's red LED is on</h2>
 <ul>
 <li>Make sure the adapter is connected to CL+/CL- and not to the third (G+) pin: G+ will drive the LED, but it's not a data line.</li>
-<li>Make sure you have powered on the microcontroller. You may think that the heating system powers the microcontroller because the LED on the BSB-LAN adapter is on, but it doesn't. You need to power it separately.</li>
+<li><a class="autorefs autorefs-internal" href="install.html#PowerSupply">Make sure you have powered on the microcontroller</a>. You may think that the heating system powers the microcontroller because the LED on the BSB-LAN adapter is on, but it doesn't. You need to power it separately.</li>
 <li>With the adapter for the Olimex microcontrollers: Make sure that the BSB-LAN adapter board sits <strong>exactly</strong> in the center of the UEXT connector. It will still fit in, if it's shifted one pin left or right, but it won't work.</li>
-<li>Make sure the RX/TX pins are set/detected correctly.</li>
+<li>Make sure the RX/TX pins are set/detected correctly. The startup sequence in the Serial Monitor will show you what pins have are used or have been auto-detected.</li>
 </ul>
 <hr />
 <h2 id="no-or-unreliable-network-connection">No or unreliable network connection</h2>
@@ -271,12 +272,12 @@ <h2 id="no-or-unreliable-network-connection">No or unreliable network connection
 <hr />
 <h2 id="no-connection-to-hidden-wifi-network-possible">No connection to hidden WiFi network possible</h2>
 <ul>
-<li>Yes, that is a known restriction. The only way to do that is to set the BSSID specifically in <code>BSB_LAN_config.h</code>.</li>
+<li>Yes, that is a known restriction. The only way to do that is to <a class="autorefs autorefs-internal" href="configure.html#BSSID">set the BSSID explicitly</a> in <code>BSB_LAN_config.h</code>.</li>
 </ul>
 <hr />
 <h2 id="room-temperature-or-any-other-parameter-cannot-be-set">Room temperature (or any other parameter) cannot be set</h2>
 <ul>
-<li>Check BSB-LAN's settings and make sure that write access is enabled and set to <em>standard</em> or <em>complete</em>.</li>
+<li>Check BSB-LAN's settings and make sure that <a class="autorefs autorefs-internal" href="configure.html#WriteAccess">write access is enabled</a> and set to <em>standard</em> or <em>complete</em>.</li>
 </ul>
 <hr />
 <h2 id="web-interface-freezes-when-making-new-connection">Web-interface freezes when making new connection</h2>