Skip to content

Commit

Permalink
Added missing port selection
Browse files Browse the repository at this point in the history
  • Loading branch information
fredlcore committed Dec 25, 2024
1 parent 7e8919f commit 3f041d9
Show file tree
Hide file tree
Showing 6 changed files with 63 additions and 57 deletions.
3 changes: 2 additions & 1 deletion docs/EN/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ Installing BSB-LAN requires three steps:
1. *Olimex ESP32-EVB* for the ESP32-based Olimex EVB .
1. *Olimex ESP32-POE-ISO* for the ESP32-based Olimex POE ISO
1. *Arduino Due (Programming Port)* for the Arduino Due. **Do not use the Native USB Port here**!
1. Again, go to ***Tools/Board*** and select the proper upload speed (up to 460800 for ESP32, 115200 for Arduino Due).
1. Now, go to ***Tools*** and select the port that your microcontroller is connected to.
1. Again, go to ***Tools*** and select the proper upload speed (up to 460800 for ESP32, 115200 for Arduino Due).
1. [](){#SPIFFS}For ESP32-based microcontrollers, again, go to ***Tools/Board*** and select "Minimal SPIFFS" for partition scheme (**do not confuse this with the similar "Minimal" partition scheme** which is different and not working in our case). **If you don't set the correct parition scheme, the firmware will not fit into the ESP32!**
1. Go to ***File/Open*** and navigate to the BSB_LAN folder and double-click on `BSB_LAN.ino`. The project will open.
1. You may now proceed to [configure](configure.md) BSB-LAN.
Expand Down
3 changes: 2 additions & 1 deletion docs/EN/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ These quickstart instructions are for users who are familiar with installing and
1. *Olimex ESP32-EVB* for the ESP32-based Olimex EVB .
1. *Olimex ESP32-POE-ISO* for the ESP32-based Olimex POE ISO
1. *Arduino Due (Programming Port)* for the Arduino Due. **Do not use the Native USB Port here**!
1. Again, go to ***Tools/Board*** and select the proper upload speed (up to 460800 for ESP32, 115200 for Arduino Due).
1. Now, go to ***Tools*** and select the port that your microcontroller is connected to.
1. Again, go to ***Tools*** and select the proper upload speed (up to 460800 for ESP32, 115200 for Arduino Due).
1. For ESP32-based microcontrollers, again, go to ***Tools/Partition Scheme*** and select "Minimal SPIFFS" or for partition scheme (**do not confuse this with the similar "Minimal" partition scheme** which is different and not working in our case). **If you don't set the correct parition scheme, the firmware will not fit into the ESP32!**
1. Go to ***File/Open*** and navigate to the BSB_LAN folder and double-click on `BSB_LAN.ino`. The project will open.
1. Click on the tab with the filename `BSB_LAN_config.h` and configure at least the following:
Expand Down
3 changes: 2 additions & 1 deletion docs/de/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ Die Installation von BSB-LAN besteht aus drei Schritten:
1. *Olimex ESP32-EVB* für den ESP32-basierten Olimex EVB.
1. *OlimeMultiplier-ESP32-POE-ISO* für den ESP32-basierten Olimex POE ISO
1. *Arduino Due (Programming Port)* für den Arduino Due. **Verwende hier nicht den nativen USB-Port!**
1. Gehe wieder zu ***Tools/Board*** und wähle die richtige Upload-Geschwindigkeit aus (bis zu 460800 für ESP32, 115200 für Arduino Due).
1. Gehe jetzt zu ***Tools*** und wähle den passenden Port aus, an den der Microcontroller angeschlossen ist.
1. Gehe wieder zu ***Tools*** und wähle die richtige Upload-Geschwindigkeit aus (bis zu 460800 für ESP32, 115200 für Arduino Due).
1. [](){#SPIFFS}Für ESP32-basierte Mikrocontroller, gehe wieder zu ***Tools/Board*** und wähle "Minimal SPIFFS" als Partitionsschema aus (**verwechsle dies nicht mit dem ähnlichen "Minimal"-Partitionsschema**, das anders ist und in unserem Fall nicht funktioniert). **Wenn du das falsche Partitionsschema auswählst, passt die Firmware nicht auf den ESP32!**
1. Gehe zu ***File/Open***, navigiere zum BSB_LAN-Ordner und doppelklicke auf `BSB_LAN.ino`. Das Projekt wird geöffnet.
1. Du kannst jetzt mit der [Konfiguration](configure.md) von BSB-LAN fortfahren.
Expand Down
55 changes: 28 additions & 27 deletions docs/de/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,37 +3,38 @@
Diese Kurzanleitung ist für Nutzer gedacht, die Erfahrung mit der Installation und Konfiguration von Software auf ihrem Computer haben. Wenn du detailliertere Anweisungen benötigst, wirf bitte einen Blick in die [Installationsanweisungen](install.md)!

1. Stelle sicher, dass deine Heizung mit BSB-LAN [kompatibel](supported_heating_systems.md) ist!
2. [Lade](https://github.com/fredlcore/BSB-LAN/archive/refs/heads/master.zip) die aktuelle BSB-LAN Version aus dem Master Repository herunter und entpacke sie, oder verwende *git* um das [Repository zu klonen](https://github.com/fredlcore/BSB-LAN.git).
3. Navigiere zum BSB_LAN Ordner und benenne die folgenden Dateien um:
1. [Lade](https://github.com/fredlcore/BSB-LAN/archive/refs/heads/master.zip) die aktuelle BSB-LAN Version aus dem Master Repository herunter und entpacke sie, oder verwende *git* um das [Repository zu klonen](https://github.com/fredlcore/BSB-LAN.git).
1. Navigiere zum BSB_LAN Ordner und benenne die folgenden Dateien um:
1. `BSB_LAN_custom_defs.h.default` in `BSB_LAN_custom_defs.h`
2. `BSB_LAN_config.h.default` in `BSB_LAN_config.h`
4. [Lade](https://www.arduino.cc/en/software) die Arduino IDE für dein System herunter und installiere sie.
5. Verbinde deinen Mikrocontroller (ESP32 oder Arduino Due) mit deinem Computer und starte die Arduino IDE.
6. Gehe zu ***Tools/Board/Board Manager*** und stelle sicher, dass das Framework für deine Platine installiert ist ("esp32 by Espressif Systems" für ESP32 Mikrocontroller, "Arduino SAM Boards (32-bits ARM Cortex-M3) by Arduino" für Arduino Due Mikrocontroller)
7. Gehe wieder zu ***Tools/Board*** und wähle deinen Mikrocontroller aus:
1. `BSB_LAN_config.h.default` in `BSB_LAN_config.h`
1. [Lade](https://www.arduino.cc/en/software) die Arduino IDE für dein System herunter und installiere sie.
1. Verbinde deinen Mikrocontroller (ESP32 oder Arduino Due) mit deinem Computer und starte die Arduino IDE.
1. Gehe zu ***Tools/Board/Board Manager*** und stelle sicher, dass das Framework für deine Platine installiert ist ("esp32 by Espressif Systems" für ESP32 Mikrocontroller, "Arduino SAM Boards (32-bits ARM Cortex-M3) by Arduino" für Arduino Due Mikrocontroller)
1. Gehe wieder zu ***Tools/Board*** und wähle deinen Mikrocontroller aus:
1. *ESP32 Dev Module* für den Joy-It ESP32 NodeMCU.
2. *Olimex ESP32-EVB* für den ESP32-basierten Olimex EVB.
3. *Olimex ESP32-POE-ISO* für den ESP32-basierten Olimex POE ISO
4. *Arduino Due (Programming Port)* für den Arduino Due. **Verwende hier nicht den nativen USB Port!**
8. Gehe wieder zu ***Tools/Board*** und wähle die richtige Upload-Geschwindigkeit aus (bis zu 460800 für ESP32, 115200 für Arduino Due).
9. Für ESP32-basierte Mikrocontroller, gehe wieder zu ***Tools/Partition Scheme*** und wähle "Minimal SPIFFS" als Partitionsschema aus (**verwechsele dies nicht mit dem ähnlichen "Minimal" Partitionsschema**, welches anders ist und in unserem Fall nicht funktioniert). **Wenn du das falsche Partitionsschema auswählst, passt die Firmware nicht auf den ESP32!**
10. Gehe zu ***File/Open*** und navigiere zum BSB_LAN Ordner, doppelklicke dann auf `BSB_LAN.ino`. Das Projekt wird geöffnet.
11. Klicke auf die Registerkarte mit dem Dateinamen `BSB_LAN_config.h` und konfiguriere mindestens Folgendes:
1. *Olimex ESP32-EVB* für den ESP32-basierten Olimex EVB.
1. *Olimex ESP32-POE-ISO* für den ESP32-basierten Olimex POE ISO
1. *Arduino Due (Programming Port)* für den Arduino Due. **Verwende hier nicht den nativen USB Port!**
1. Gehe jetzt zu ***Tools*** und wähle den passenden Port aus, an den der Microcontroller angeschlossen ist.
1. Gehe wieder zu ***Tools*** und wähle die richtige Upload-Geschwindigkeit aus (bis zu 460800 für ESP32, 115200 für Arduino Due).
1. Für ESP32-basierte Mikrocontroller, gehe wieder zu ***Tools/Partition Scheme*** und wähle "Minimal SPIFFS" als Partitionsschema aus (**verwechsele dies nicht mit dem ähnlichen "Minimal" Partitionsschema**, welches anders ist und in unserem Fall nicht funktioniert). **Wenn du das falsche Partitionsschema auswählst, passt die Firmware nicht auf den ESP32!**
1. Gehe zu ***File/Open*** und navigiere zum BSB_LAN Ordner, doppelklicke dann auf `BSB_LAN.ino`. Das Projekt wird geöffnet.
1. Klicke auf die Registerkarte mit dem Dateinamen `BSB_LAN_config.h` und konfiguriere mindestens Folgendes:
1. Suche nach `#define LANG DE`: Ändere `DE` zu `EN` für Englisch, `FR` für Französisch usw.
2. Suche nach `uint8_t network_type`: Setze dies auf `LAN`, wenn du eine Ethernet/LAN Verbindung verwendest. Setze es auf `WLAN`, wenn du eine WiFi/WLAN Verbindung verwendest.
3. Wenn du DHCP nicht verwendest, konfiguriere die folgenden Optionen entsprechend deinem Netzwerk (stelle sicher, dass du ein Komma anstelle eines Punkts für IP-Adressen verwendest!):
1. Suche nach `uint8_t network_type`: Setze dies auf `LAN`, wenn du eine Ethernet/LAN Verbindung verwendest. Setze es auf `WLAN`, wenn du eine WiFi/WLAN Verbindung verwendest.
1. Wenn du DHCP nicht verwendest, konfiguriere die folgenden Optionen entsprechend deinem Netzwerk (stelle sicher, dass du ein Komma anstelle eines Punkts für IP-Adressen verwendest!):
1. `byte ip_addr[4] = {192,168,178,88};`
2. `byte gateway_addr[4] = {192,168,178,1};`
3. `byte dns_addr[4] = {192,168,178,1};`
4. `byte subnet_addr[4] = {255,255,255,0};`
5. `char wifi_ssid[32] = "Your_Wifi_network_name";`
6. `char wifi_pass[32] = "Your_WiFi_network_password";`
12. Klicke jetzt auf ***Sketch/Upload***, um die BSB-LAN Software auf den Mikrocontroller zu laden.
13. Trenne den Mikrocontroller und schalte deine Heizung aus. Suche die BSB/LPB/PPS Anschlüsse. Möglicherweise musst du dazu deine Heizung öffnen. ***Du machst all dies auf eigene Gefahr!***
14. Verbinde jetzt den BSB-LAN Adapter mit dem Mikrocontroller und verbinde den `+` Schraubanschluss mit dem `CL+` (BSB), `DB` (LPB) oder `A6` (PPS, andere Bezeichnungen sind möglich) Anschluss, und den `-` Schraubanschluss mit dem `CL-` (BSB), `MB` (LPB) oder `M` (PPS) Anschluss.
15. Schalte den Mikrocontroller über den USB-Port oder PoE (nur Olimex POE-ISO) ein. Schalte dann die Heizung ein. Die rote LED des BSB-LAN Adapters sollte leuchten. Sie sollte gelegentlich blinken.
16. Öffne jetzt deinen Webbrowser und gib die IP-Adresse von BSB-LAN ein. Wenn MDNS aktiviert ist, kannst du direkt zu `http://bsb-lan.local` gehen. Du findest die IP-Adresse von BSB-LAN entweder in deinem Router oder du verbindest den Mikrocontroller mit deinem PC, öffnest die Arduino IDE und gehst zu ***Tools/Serial Monitor***. Starte den Mikrocontroller neu, und die IP-Adresse wird angezeigt, sobald er mit dem Netzwerk verbunden ist.
17. **Fertig :-)**
1. `byte gateway_addr[4] = {192,168,178,1};`
1. `byte dns_addr[4] = {192,168,178,1};`
1. `byte subnet_addr[4] = {255,255,255,0};`
1. `char wifi_ssid[32] = "Your_Wifi_network_name";`
1. `char wifi_pass[32] = "Your_WiFi_network_password";`
1. Klicke jetzt auf ***Sketch/Upload***, um die BSB-LAN Software auf den Mikrocontroller zu laden.
1. Trenne den Mikrocontroller und schalte deine Heizung aus. Suche die BSB/LPB/PPS Anschlüsse. Möglicherweise musst du dazu deine Heizung öffnen. ***Du machst all dies auf eigene Gefahr!***
1. Verbinde jetzt den BSB-LAN Adapter mit dem Mikrocontroller und verbinde den `+` Schraubanschluss mit dem `CL+` (BSB), `DB` (LPB) oder `A6` (PPS, andere Bezeichnungen sind möglich) Anschluss, und den `-` Schraubanschluss mit dem `CL-` (BSB), `MB` (LPB) oder `M` (PPS) Anschluss.
1. Schalte den Mikrocontroller über den USB-Port oder PoE (nur Olimex POE-ISO) ein. Schalte dann die Heizung ein. Die rote LED des BSB-LAN Adapters sollte leuchten. Sie sollte gelegentlich blinken.
1. Öffne jetzt deinen Webbrowser und gib die IP-Adresse von BSB-LAN ein. Wenn MDNS aktiviert ist, kannst du direkt zu `http://bsb-lan.local` gehen. Du findest die IP-Adresse von BSB-LAN entweder in deinem Router oder du verbindest den Mikrocontroller mit deinem PC, öffnest die Arduino IDE und gehst zu ***Tools/Serial Monitor***. Starte den Mikrocontroller neu, und die IP-Adresse wird angezeigt, sobald er mit dem Netzwerk verbunden ist.
1. **Fertig :-)**

---

Expand Down
9 changes: 5 additions & 4 deletions docs/fr/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ L'installation de BSB-LAN nécessite trois étapes :
1. *Olimex ESP32-EVB* pour l'Olimex EVB basé sur ESP32.
1. *OlimeMultiplier l'option Olimex ESP32-POE-ISO* pour l'Olimex POE ISO basé sur ESP32
1. *Arduino Due (Programming Port)* pour l'Arduino Due. **N'utilisez pas le port USB natif ici** !
1. À nouveau, accédez à ***Outils/Conseil*** et sélectionnez la vitesse de téléchargement appropriée (jusqu'à 460800 pour ESP32, 115200 pour Arduino Due).
1. Maintenant, accédez à ***Outils*** et sélectionnez le port auquel votre microcontrôleur est connecté.
1. À nouveau, accédez à ***Outils*** et sélectionnez la vitesse de téléchargement appropriée (jusqu'à 460800 pour ESP32, 115200 pour Arduino Due).
1. [](){#SPIFFS}Pour les microcontrôleurs basés sur ESP32, accédez à nouveau à ***Outils/Conseil*** et sélectionnez "Minimal SPIFFS" pour le schéma de partition (**ne confondez pas ceci avec le schéma de partition "Minimal" similaire** qui est différent et ne fonctionne pas dans notre cas). **Si vous ne définissez pas le bon schéma de partition, le micrologiciel ne rentrera pas dans l'ESP32 !**
1. Accédez à ***Fichier/Ouvrir*** et accédez au dossier BSB_LAN, puis double-cliquez sur `BSB_LAN.ino`. Le projet s'ouvrira.
1. Vous pouvez maintenant passer à la [configuration](configure.md) de BSB-LAN.
Expand All @@ -39,9 +40,9 @@ Vous pouvez obtenir un adaptateur entièrement assemblé auprès de Frederik (bs
Une fois le microcontrôleur et l'adaptateur BSB-LAN prêts, effectuez les étapes suivantes pour connecter BSB-LAN au système de chauffage :

1. Débranchez le microcontrôleur de votre ordinateur et éteignez votre système de chauffage. Localisez les connecteurs BSB/LPB/PPS. Vous devrez peut-être ouvrir votre système de chauffage pour cela. Consultez la liste des [systèmes de chauffage pris en charge](supported_heating_systems.md) pour savoir où se trouvent les broches.<br>***Faites tout cela à vos propres risques !***<br>***Si vous n'êtes pas prudent, vous risquez d'endommager votre équipement !***<br>**Prenez particulièrement soin d'éviter les décharges électrostatiques (ESD) qui peuvent détruire à la fois BSB-LAN et le contrôleur de chauffage !**
2. Branchez maintenant l'adaptateur BSB-LAN sur le microcontrôleur et connectez le connecteur à vis `+` au connecteur `CL+` (BSB), `DB` (LPB) ou `A6` (PPS, différents noms de connecteurs sont possibles), et le connecteur à vis `-` au connecteur `CL-` (BSB), `MB` (LPB) ou `M` (PPS). S'il n'y a pas de connecteur vide, il n'y a aucun problème à ajouter les fils pour BSB-LAN à un connecteur déjà "utilisé", à condition que les fils soient insérés avec soin. En ce qui concerne les câbles, un câble torsadé à deux cœurs (idéalement blindé/blindé) est recommandé [par Siemens](https://sid.siemens.com/v/u/20140). Cependant, un certain nombre d'utilisateurs ont également réussi avec un simple fil de téléphone si les distances ne sont pas trop longues.
3. [](){#PowerSupply}Vous devez maintenant alimenter le microcontrôleur. Notez que le système de chauffage n'alimente pas le microcontrôleur, même si la LED de l'adaptateur BSB-LAN s'allume lorsque vous le connectez au système de chauffage. Vous devez alimenter le microcontrôleur via son port USB (ou via PoE sur l'Olimex POE-ISO). Assurez-vous d'utiliser une alimentation stable d'au moins 2 ampères. Une fois le microcontrôleur alimenté, allumez le système de chauffage. La LED rouge de l'adaptateur BSB-LAN doit s'allumer. Il devrait clignoter de temps en temps.
4. Ouvrez maintenant votre navigateur web et accédez à l'adresse IP de BSB-LAN. Si MDNS est activé, vous pouvez directement accéder à [`http://bsb-lan.local`](http://bsb-lan.local). Sinon, vous pouvez trouver l'adresse IP de BSB-LAN dans votre routeur, ou vous pouvez connecter le microcontrôleur à votre PC et ouvrir l'IDE Arduino, puis accéder à ***Outils/Moniteur série*** et définir la vitesse du moniteur série sur 115200. Redémarrez le microcontrôleur, et l'adresse IP s'affichera lors de la connexion au réseau.
1. Branchez maintenant l'adaptateur BSB-LAN sur le microcontrôleur et connectez le connecteur à vis `+` au connecteur `CL+` (BSB), `DB` (LPB) ou `A6` (PPS, différents noms de connecteurs sont possibles), et le connecteur à vis `-` au connecteur `CL-` (BSB), `MB` (LPB) ou `M` (PPS). S'il n'y a pas de connecteur vide, il n'y a aucun problème à ajouter les fils pour BSB-LAN à un connecteur déjà "utilisé", à condition que les fils soient insérés avec soin. En ce qui concerne les câbles, un câble torsadé à deux cœurs (idéalement blindé/blindé) est recommandé [par Siemens](https://sid.siemens.com/v/u/20140). Cependant, un certain nombre d'utilisateurs ont également réussi avec un simple fil de téléphone si les distances ne sont pas trop longues.
1. [](){#PowerSupply}Vous devez maintenant alimenter le microcontrôleur. Notez que le système de chauffage n'alimente pas le microcontrôleur, même si la LED de l'adaptateur BSB-LAN s'allume lorsque vous le connectez au système de chauffage. Vous devez alimenter le microcontrôleur via son port USB (ou via PoE sur l'Olimex POE-ISO). Assurez-vous d'utiliser une alimentation stable d'au moins 2 ampères. Une fois le microcontrôleur alimenté, allumez le système de chauffage. La LED rouge de l'adaptateur BSB-LAN doit s'allumer. Il devrait clignoter de temps en temps.
1. Ouvrez maintenant votre navigateur web et accédez à l'adresse IP de BSB-LAN. Si MDNS est activé, vous pouvez directement accéder à [`http://bsb-lan.local`](http://bsb-lan.local). Sinon, vous pouvez trouver l'adresse IP de BSB-LAN dans votre routeur, ou vous pouvez connecter le microcontrôleur à votre PC et ouvrir l'IDE Arduino, puis accéder à ***Outils/Moniteur série*** et définir la vitesse du moniteur série sur 115200. Redémarrez le microcontrôleur, et l'adresse IP s'affichera lors de la connexion au réseau.

## Génération de la liste des paramètres spécifiques à l'appareil

Expand Down
Loading

0 comments on commit 3f041d9

Please sign in to comment.