Skip to content

Commit

Permalink
Deployed ed240a1 with MkDocs version: 1.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
fredlcore committed Nov 11, 2024
1 parent 4b9a59a commit aa8ed28
Show file tree
Hide file tree
Showing 10 changed files with 59 additions and 56 deletions.
7 changes: 4 additions & 3 deletions de/homeautomation.html
Original file line number Diff line number Diff line change
Expand Up @@ -263,16 +263,17 @@ <h2 id="exchanging-data-via-mqtt">Exchanging data via MQTT</h2>
<p>This structure is followed by one of these topics that determine the action to be performed: </p>
<ul>
<li><code>/status</code> - contains the value of the parameter in the MQTT payload. </li>
<li><code>/set</code> - used to set a parameter with the value contained in the MQTT payload using the SET telegram (default way of setting parameters). </li>
<li><code>/set</code> - used to set a parameter with the value contained in the published MQTT payload using the SET telegram (default way of setting parameters). </li>
<li><code>/inf</code> - same as <code>/set</code>, but uses the INF telegram (used for sending room temperature parameter 10000, for example).</li>
<li><code>/poll</code> - forces BSB-LAN to immediately update <code>/status</code> of the same parameter with a freshly retrieved parameter value. </li>
<li><code>/poll</code> - ignores the published value and forces BSB-LAN to immediately update <code>/status</code> of the same parameter with a freshly retrieved parameter value. <code>/poll</code> can also be accessed directly below the main topic (e.g. <code>BSB-LAN/poll</code>) where it accepts a list of parameters separated by comma, dash, semicolon or pipe. These parameters will then immediately have their respective <code>/status</code> topics updated in one go. Non-default destination addresses can be accessed by adding <code>!&lt;addr&gt;</code> to the parameter, just as in the URL notation. </li>
</ul>
<p>At the same time, the legacy way of sending URL commands via MQTT directly to the main topic (as defined in the settings, defaulting to <code>BSB-LAN</code>), is still supported for compatibility reasons, but deprecated. Responses will always be written to <code>/status</code> of the above mentioned topic structure. </p>
<p>The <code>/status</code> topic is updated in three ways:</p>
<p>The <code>/status</code> topic is updated in four ways:</p>
<ul>
<li>via logging parameters to MQTT as explained above</li>
<li>every time a URL query is made to BSB-LAN</li>
<li>every time a parameter is changed through the room unit</li>
<li>every time the parameter is updated via the <code>/poll</code> topic as explained above</li>
</ul>
<p>In these cases, the respective values of the parameters affected will be sent to the MQTT broker, so even changes made outside of BSB-LAN are sent to the home automation system, which is why the MQTT approach is the recommended way to connect to a home automation system.<br />
This also means that, as an alternative to the built-in logging feature of BSB-LAN, you can also just periodically call a URL with the parameters you want to see updated. Since these parameters will also be sent to the MQTT broker, your home automation system will receive them as well.<br />
Expand Down
2 changes: 1 addition & 1 deletion de/install.html
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ <h2 id="connecting-bsb-lan-to-the-heating-system">Connecting BSB-LAN to the heat
<p>Once the microcontroller and the BSB-LAN adapter are ready, perform the following steps to connect BSB-LAN to the heating system:</p>
<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><em>If you are not careful, you may damage your equipment!</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 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. Regarding the cables, an (ideally screened/shielded) twisted two-core cable is recommended <a href="https://sid.siemens.com/v/u/20140">by Siemens</a>. However, a number of users have also been successful with plain bell wire if the distances are not too long.</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>
Expand Down
7 changes: 4 additions & 3 deletions fr/homeautomation.html
Original file line number Diff line number Diff line change
Expand Up @@ -263,16 +263,17 @@ <h2 id="exchanging-data-via-mqtt">Exchanging data via MQTT</h2>
<p>This structure is followed by one of these topics that determine the action to be performed: </p>
<ul>
<li><code>/status</code> - contains the value of the parameter in the MQTT payload. </li>
<li><code>/set</code> - used to set a parameter with the value contained in the MQTT payload using the SET telegram (default way of setting parameters). </li>
<li><code>/set</code> - used to set a parameter with the value contained in the published MQTT payload using the SET telegram (default way of setting parameters). </li>
<li><code>/inf</code> - same as <code>/set</code>, but uses the INF telegram (used for sending room temperature parameter 10000, for example).</li>
<li><code>/poll</code> - forces BSB-LAN to immediately update <code>/status</code> of the same parameter with a freshly retrieved parameter value. </li>
<li><code>/poll</code> - ignores the published value and forces BSB-LAN to immediately update <code>/status</code> of the same parameter with a freshly retrieved parameter value. <code>/poll</code> can also be accessed directly below the main topic (e.g. <code>BSB-LAN/poll</code>) where it accepts a list of parameters separated by comma, dash, semicolon or pipe. These parameters will then immediately have their respective <code>/status</code> topics updated in one go. Non-default destination addresses can be accessed by adding <code>!&lt;addr&gt;</code> to the parameter, just as in the URL notation. </li>
</ul>
<p>At the same time, the legacy way of sending URL commands via MQTT directly to the main topic (as defined in the settings, defaulting to <code>BSB-LAN</code>), is still supported for compatibility reasons, but deprecated. Responses will always be written to <code>/status</code> of the above mentioned topic structure. </p>
<p>The <code>/status</code> topic is updated in three ways:</p>
<p>The <code>/status</code> topic is updated in four ways:</p>
<ul>
<li>via logging parameters to MQTT as explained above</li>
<li>every time a URL query is made to BSB-LAN</li>
<li>every time a parameter is changed through the room unit</li>
<li>every time the parameter is updated via the <code>/poll</code> topic as explained above</li>
</ul>
<p>In these cases, the respective values of the parameters affected will be sent to the MQTT broker, so even changes made outside of BSB-LAN are sent to the home automation system, which is why the MQTT approach is the recommended way to connect to a home automation system.<br />
This also means that, as an alternative to the built-in logging feature of BSB-LAN, you can also just periodically call a URL with the parameters you want to see updated. Since these parameters will also be sent to the MQTT broker, your home automation system will receive them as well.<br />
Expand Down
2 changes: 1 addition & 1 deletion fr/install.html
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ <h2 id="connecting-bsb-lan-to-the-heating-system">Connecting BSB-LAN to the heat
<p>Once the microcontroller and the BSB-LAN adapter are ready, perform the following steps to connect BSB-LAN to the heating system:</p>
<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><em>If you are not careful, you may damage your equipment!</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 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. Regarding the cables, an (ideally screened/shielded) twisted two-core cable is recommended <a href="https://sid.siemens.com/v/u/20140">by Siemens</a>. However, a number of users have also been successful with plain bell wire if the distances are not too long.</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>
Expand Down
7 changes: 4 additions & 3 deletions homeautomation.html
Original file line number Diff line number Diff line change
Expand Up @@ -263,16 +263,17 @@ <h2 id="exchanging-data-via-mqtt">Exchanging data via MQTT</h2>
<p>This structure is followed by one of these topics that determine the action to be performed: </p>
<ul>
<li><code>/status</code> - contains the value of the parameter in the MQTT payload. </li>
<li><code>/set</code> - used to set a parameter with the value contained in the MQTT payload using the SET telegram (default way of setting parameters). </li>
<li><code>/set</code> - used to set a parameter with the value contained in the published MQTT payload using the SET telegram (default way of setting parameters). </li>
<li><code>/inf</code> - same as <code>/set</code>, but uses the INF telegram (used for sending room temperature parameter 10000, for example).</li>
<li><code>/poll</code> - forces BSB-LAN to immediately update <code>/status</code> of the same parameter with a freshly retrieved parameter value. </li>
<li><code>/poll</code> - ignores the published value and forces BSB-LAN to immediately update <code>/status</code> of the same parameter with a freshly retrieved parameter value. <code>/poll</code> can also be accessed directly below the main topic (e.g. <code>BSB-LAN/poll</code>) where it accepts a list of parameters separated by comma, dash, semicolon or pipe. These parameters will then immediately have their respective <code>/status</code> topics updated in one go. Non-default destination addresses can be accessed by adding <code>!&lt;addr&gt;</code> to the parameter, just as in the URL notation. </li>
</ul>
<p>At the same time, the legacy way of sending URL commands via MQTT directly to the main topic (as defined in the settings, defaulting to <code>BSB-LAN</code>), is still supported for compatibility reasons, but deprecated. Responses will always be written to <code>/status</code> of the above mentioned topic structure. </p>
<p>The <code>/status</code> topic is updated in three ways:</p>
<p>The <code>/status</code> topic is updated in four ways:</p>
<ul>
<li>via logging parameters to MQTT as explained above</li>
<li>every time a URL query is made to BSB-LAN</li>
<li>every time a parameter is changed through the room unit</li>
<li>every time the parameter is updated via the <code>/poll</code> topic as explained above</li>
</ul>
<p>In these cases, the respective values of the parameters affected will be sent to the MQTT broker, so even changes made outside of BSB-LAN are sent to the home automation system, which is why the MQTT approach is the recommended way to connect to a home automation system.<br />
This also means that, as an alternative to the built-in logging feature of BSB-LAN, you can also just periodically call a URL with the parameters you want to see updated. Since these parameters will also be sent to the MQTT broker, your home automation system will receive them as well.<br />
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -277,5 +277,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>

<!--
MkDocs version : 1.6.0
Build Date UTC : 2024-11-09 15:44:03.887914+00:00
Build Date UTC : 2024-11-11 11:37:59.919237+00:00
-->
2 changes: 1 addition & 1 deletion install.html
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ <h2 id="connecting-bsb-lan-to-the-heating-system">Connecting BSB-LAN to the heat
<p>Once the microcontroller and the BSB-LAN adapter are ready, perform the following steps to connect BSB-LAN to the heating system:</p>
<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><em>If you are not careful, you may damage your equipment!</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 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. Regarding the cables, an (ideally screened/shielded) twisted two-core cable is recommended <a href="https://sid.siemens.com/v/u/20140">by Siemens</a>. However, a number of users have also been successful with plain bell wire if the distances are not too long.</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>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

Loading

0 comments on commit aa8ed28

Please sign in to comment.