Modular Weather Station for ESP32 / Modulare Wetterstation für ESP32

English | Deutsch

English

A versatile and modular weather station using ESP32 microcontrollers, with support for multiple sensors and data transmission options.

This project is designed to be easily extended and customized to suit your needs. Whether you want to use different sensors or transmit data to different platforms, the Modular Weather Station for ESP32 makes it simple to create your own personalized weather station.

Features

• Support for BME280 sensor (temperature, humidity, and pressure)
• Wi-Fi connectivity
• MQTT data transmission
• Easy integration with other sensors and data platforms
• Compatible with ESP32-S2-Saola-1 and ESP32-S2-Kaluga-1 development boards

For the planned features and improvements, please refer to the Roadmap.

Getting Started

1. Clone this repository.
2. Copy src/credentials_template.h to src/credentials.h and fill in your Wi-Fi and MQTT details.
3. Follow the steps in the setup guide to build and upload the firmware.

Documentation

Detailed API documentation generated with Doxygen is available in the doc directory. Run doxygen doxygen_config to rebuild the documentation.

Contributing

We welcome contributions from the community! If you'd like to contribute to the project, please read our contributing guidelines and code of conduct.

Reporting Security Issues

If you discover a security vulnerability in the Modular Weather Station for ESP32 project, please follow our security policy for responsibly reporting and disclosing the issue.

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Deutsch

Eine vielseitige und modulare Wetterstation mit ESP32-Mikrocontrollern, die Unterstützung für mehrere Sensoren und Datenübertragungsoptionen bietet.

Dieses Projekt wurde entwickelt, um einfach erweitert und an Ihre Bedürfnisse angepasst zu werden. Ob Sie verschiedene Sensoren verwenden oder Daten auf unterschiedliche Plattformen übertragen möchten, die modulare Wetterstation für ESP32 macht es einfach, Ihre eigene personalisierte Wetterstation zu erstellen.

Funktionen

• Unterstützung für BME280-Sensor (Temperatur, Luftfeuchtigkeit und Druck)
• WLAN-Konnektivität
• MQTT-Datenübertragung
• Einfache Integration mit anderen Sensoren und Datenplattformen
• Kompatibel mit ESP32-S2-Saola-1 und ESP32-S2-Kaluga-1-Entwicklungsboards

Für die geplanten Funktionen und Verbesserungen, bitte schauen Sie in die Roadmap.

Erste Schritte

1. Klonen Sie dieses Repository.
2. Kopieren Sie src/credentials_template.h nach src/credentials.h und tragen Sie Ihre WLAN- und MQTT-Daten ein.
3. Folgen Sie dem Einrichtungsleitfaden, um die Firmware zu bauen und auf das Board zu flashen.

Dokumentation

Die mit Doxygen erzeugte API-Dokumentation befindet sich im Ordner doc. Mit doxygen doxygen_config kann sie erneut erstellt werden.

Beiträge

Wir freuen uns über Beiträge aus der Community! Wenn Sie zum Projekt beitragen möchten, lesen Sie bitte unsere Richtlinien für Beiträge und den Verhaltenskodex.

Melden von Sicherheitsproblemen

Wenn Sie eine Sicherheitslücke im Projekt Modular Weather Station for ESP32 entdecken, befolgen Sie bitte unsere Sicherheitsrichtlinie, um das Problem verantwortungsvoll zu melden und offenzulegen.

Lizenz

Dieses Projekt steht unter der MIT-Lizenz - siehe die LICENSE für Details.