informatics4kids.de

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Zuletzt angesehen:
projekt:python_fastapi

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung		Vorhergehende Überarbeitung
projekt:python_fastapi [2026/02/20 19:18] – torsten.roehlprojekt:python_fastapi [2026/02/23 07:26] (aktuell) – [Systemd] torsten.roehl
Zeile 1: Zeile 1:
-====== GPIO mit FastAPI (Websteuerung) ======+====== Python FASTAPI ======
  
 [[raspberry_pi:einstiegskurs_raspberry_pi|☚ zurück - Einstiegskurs Raspberry Pi]] [[raspberry_pi:einstiegskurs_raspberry_pi|☚ zurück - Einstiegskurs Raspberry Pi]]
  
  
-===== 0. ENV (VENV) =====+//In diesem Projekt wird auf dem Raspberry Pi eine Weboberfläche mit FastAPI erstellt, über die eine LED-Ampel geschaltet und die Temperatur eines DS18B20 angezeigt werden kann. Die Anwendung ist im lokalen Netzwerk erreichbar, sodass LEDs und Temperatursensor bequem über einen Webbrowser im LAN gesteuert und überwacht werden können.//
  
-<code bash>+|{{ :raspberry_pi:web_1.png?300 |}}| 
 +|Die LED-Ampel kann nun über den Webbrowser gesteuert und die Temperatur ausgelesen werden.| 
 +====== Überblick ====== 
 +  * Voraussetzungen 
 +  * Software 
 +  * Konfiguration 
 + 
 +====== Details ====== 
 + 
 +===== Voraussetzungen ===== 
 + 
 +==== ENV ==== 
 + 
 +<note important> 
 +**Aktivierung der Python-Environment: ''course_env''** 
 + 
 +Alle weiteren Schritte erfolgen mit der aktivierten Python-Umgebung. 
 + 
 +<code>
 source ~/devel/projects/course_env/bin/activate source ~/devel/projects/course_env/bin/activate
-pip install fastapi uvicorn RPi.GPIO 
-which uvicorn 
 </code> </code>
  
-Erwartet: +</note> 
-  /home/pi/devel/projects/course_env/bin/uvicorn+Anschließend werden FastAPI und Uvicorn installiert:
  
 +<code bash>
 +pip install fastapi uvicorn       
 +</code>
 +<note>
 +**FastAPI / Uvicorn**
  
-===== 1. PROJEKTORDNER =====+  * **FastAPI** 
 +    * stellt das Web-Framework bereit, mit dem die Webseiten und Routen programmiert werden. 
 +  * **Uvicorn** 
 +    * startet die Anwendung und sorgt dafür, dass sie im Browser erreichbar ist. 
 +</note>
  
 +==== Projektstruktur ====
 +
 +'' cd ~/devel/projects/''
 +<code>
 +course_web/
 +└── src/
 +    ├── app.py
 +    ├── core/
 +    │   |── __init__.py    # kann leer sein!    
 +    │   └── hardware.py
 +    └── html/
 +        ├── led.html
 +        └── temp.html
 +
 +</code>
 +==== Apache2 Startseite ====
 +Im Verzeichnis des Apache2-Webservers (''/var/www/html'') wird eine ''index.html'' bereitgestellt. 
 +Beim Aufruf der **IP-Adresse des Raspberry Pi im Browser** wird diese Startseite geladen, über die anschließend das gewünschte Projekt ausgewählt werden kann.
 +
 +<note tip> **Tip**
 +
 +Bevor die neue ''index.html'' im Verzeichnis ''/var/www/html'' erstellt wird, sollte die vorhandene Apache-Standardseite ''index.html'' gesichert werden.
 <code bash> <code bash>
-cd /home/pi/devel/projects +sudo mv /var/www/html/index.html /var/www/html/index_course_backup.html
-mkdir -p python_web/src/core +
-cd python_web/src/core +
-touch __init__.py+
 </code> </code>
 +</note>
  
 +<code html /var/www/html/index.html>
 +<!DOCTYPE html>
 +<html>
 +<head>
 +    <title>Projekt Auswahl</title>
 +</head>
 +<body>
  
-===== 2. HARDWARE (LED + DS18B20) =====+<h1>Projekt Auswahl</h1> 
 + 
 +<ul> 
 +    <li><a href="/wiki">DokuWiki</a></li> 
 +    <li><a href="/led">LED Ampel</a></li> 
 +    <li><a href="/temp">Temperatur</a></li> 
 +</ul> 
 + 
 +</body> 
 +</html> 
 +</code> 
 +==== Hardware ==== 
 +Die Hardware, also die LED-Ampel und der Temperatursensor, wurden in den vorausgegangenen Projekten ausführlich behandelt und werden exakt so verwendet wie dort beschrieben.
  
-Datei: +===== Software ===== 
-  /home/pi/devel/projects/python_web/src/core/hardware.py+Im folgenden Abschnitt werden die für die Webanwendung benötigten Python- und HTML-Dateien vorgestellt. Dazu gehören die Hardware-Anbindung über GPIO und den Temperatursensor, die HTML-Seiten zur Darstellung im Browser sowie die FastAPI-Anwendung, welche die Routen bereitstellt und die einzelnen Komponenten miteinander verbindet. 
 +==== API ====
  
-<code python>+<code python /home/pi/devel/projects/course_web/src/core/hardware.py >
 import RPi.GPIO as GPIO import RPi.GPIO as GPIO
 import glob import glob
 import time import time
- 
  
 # ----------------------------- # -----------------------------
Zeile 46: Zeile 110:
  
 _initialized = False _initialized = False
- 
  
 def init(): def init():
Zeile 64: Zeile 127:
  
 def setLED(pin, value): def setLED(pin, value):
-    if value == 1: +    GPIO.output(pin, GPIO.HIGH if value == 1 else GPIO.LOW)
-        GPIO.output(pin, GPIO.HIGH) +
-    else: +
-        GPIO.output(pin, GPIO.LOW)+
  
  
Zeile 83: Zeile 143:
  
 def status(): def status():
-    r = GPIO.input(PIN_R) +    return ( 
-    y = GPIO.input(PIN_Y) +        int(GPIO.input(PIN_R)), 
-    g = GPIO.input(PIN_G) +        int(GPIO.input(PIN_Y)), 
-    return r, y, g +        int(GPIO.input(PIN_G)), 
- +    )
- +
-def cleanup(): +
-    GPIO.cleanup()+
  
  
Zeile 97: Zeile 154:
 # ----------------------------- # -----------------------------
  
-SENSOR_TIMEOUT = 1  # Sekunden +SENSOR_TIMEOUT = 1
- +
- +
-def is_sensor(): +
-    sensors = glob.glob("/sys/bus/w1/devices/28-*") +
-    return len(sensors) > 0 +
  
 def get_sensor(): def get_sensor():
Zeile 137: Zeile 188:
  
  
-===== 3. FASTAPI APP =====+====  HTML ====
  
-Datei: +=== LED ===
-  /home/pi/devel/projects/python_web/src/app.py+
  
-<code python> 
-from fastapi import FastAPI, HTTPException 
-from fastapi.responses import HTMLResponse, RedirectResponse 
-from core import hardware 
  
-app = FastAPI() +<code html /home/pi/devel/projects/course_web/src/html/led.html>
- +
- +
-@app.on_event("startup") +
-def startup(): +
-    hardware.init() +
- +
- +
-@app.get("/led", response_class=HTMLResponse) +
-def led_page(): +
-    r, y, g = hardware.status() +
-    return HTMLResponse(f"""+
 <!DOCTYPE html> <!DOCTYPE html>
 <html> <html>
-<head><title>LED Ampel</title></head>+<head> 
 +    <title>LED Ampel</title> 
 +</head>
 <body> <body>
  
 <h1>LED Ampel</h1> <h1>LED Ampel</h1>
  
-<h2>Rot (Status: {r})</h2>+<h2>Rot</h2> 
 +<p>Status: {{R}}</p>
 <a href="/led/r/1">ON</a> <a href="/led/r/1">ON</a>
 <a href="/led/r/0">OFF</a> <a href="/led/r/0">OFF</a>
  
-<h2>Gelb (Status: {y})</h2>+<h2>Gelb</h2> 
 +<p>Status: {{Y}}</p>
 <a href="/led/y/1">ON</a> <a href="/led/y/1">ON</a>
 <a href="/led/y/0">OFF</a> <a href="/led/y/0">OFF</a>
  
-<h2>Grün (Status: {g})</h2>+<h2>Grün</h2> 
 +<p>Status: {{G}}</p>
 <a href="/led/g/1">ON</a> <a href="/led/g/1">ON</a>
 <a href="/led/g/0">OFF</a> <a href="/led/g/0">OFF</a>
Zeile 183: Zeile 223:
 </body> </body>
 </html> </html>
-""")+</code>
  
 +
 +=== Temperature ===
 +
 +
 +<code html /home/pi/devel/projects/course_web/src/html/temp.html>
 +<!DOCTYPE html>
 +<html>
 +<head>
 +    <title>Temperatur</title>
 +</head>
 +<body>
 +
 +<h1>Temperatur</h1>
 +
 +<p>Temperatur: {{T}} °C</p>
 +
 +<br>
 +<a href="/">Zurück</a>
 +
 +</body>
 +</html>
 +</code>
 +
 +
 +==== FASTAPI APP ====
 +
 +
 +<code python /home/pi/devel/projects/course_web/src/app.py>
 +
 +
 +from fastapi import FastAPI, HTTPException
 +from fastapi.responses import HTMLResponse, RedirectResponse
 +from core import hardware
 +
 +app = FastAPI()
 +
 +
 +@app.on_event("startup")
 +def startup():
 +    hardware.init()
 +
 +
 +def load_template(name, replacements):
 +    try:
 +        with open(f"html/{name}", "r") as f:
 +            html = f.read()
 +    except FileNotFoundError:
 +        raise HTTPException(status_code=500, detail="Template nicht gefunden")
 +
 +    for key, value in replacements.items():
 +        html = html.replace(key, str(value))
 +
 +    return html
 +
 +@app.get("/led", response_class=HTMLResponse)
 +def led_page():
 +    r, y, g = hardware.status()
 +
 +    return HTMLResponse(
 +        load_template("led.html", {
 +            "{{R}}": r,
 +            "{{Y}}": y,
 +            "{{G}}": g,
 +            "{{R_ON}}": "on" if r == 1 else "",
 +            "{{Y_ON}}": "on" if y == 1 else "",
 +            "{{G_ON}}": "on" if g == 1 else "",
 +        })
 +    )
  
 @app.get("/led/{color}/{value}") @app.get("/led/{color}/{value}")
 def set_led(color: str, value: int): def set_led(color: str, value: int):
 +
     if value not in (0, 1):     if value not in (0, 1):
         raise HTTPException(status_code=400)         raise HTTPException(status_code=400)
Zeile 206: Zeile 315:
 def temp_page(): def temp_page():
     t = hardware.get_temperature()     t = hardware.get_temperature()
 +
     if t is None:     if t is None:
         value = "Sensorfehler"         value = "Sensorfehler"
     else:     else:
-        value = f"{t:.2f} °C"+        value = f"{t:.2f}"
  
-    return HTMLResponse(f""" +    return HTMLResponse( 
-<!DOCTYPE html> +        load_template("temp.html", { 
-<html> +            "{{T}}": value 
-<head><title>Temperatur</title></head> +        }) 
-<body>+    ) 
 +</code>
  
-<h1>Temperatur</h1> 
-<p>{value}</p> 
  
-<br> 
-<a href="/">Zurück</a> 
  
-</body> 
-</html> 
-""") 
-</code> 
  
 +===== Konfiguration =====
 +In diesem Abschnitt wird die Einbindung der **FastAPI-Anwendung** in den Apache-Webserver sowie die Einrichtung als ''systemd-Service'' beschrieben, damit die Anwendung automatisch startet und im lokalen Netzwerk erreichbar ist.
 +==== Apache Proxy ====
  
-===== 4. APACHE STARTSEITE =====+=== Konfiguration ===
  
-Datei: +In der Datei '' /etc/apache2/sites-available/000-default.conf'', 
-  /var/www/html/index.html+innerhalb von ''<VirtualHost *:80>'' folgendes einfügen:
  
-<code html> 
-<!DOCTYPE html> 
-<html> 
-<head> 
-    <title>Projekt Auswahl</title> 
-</head> 
-<body> 
  
-<h1>Projekt Auswahl</h1>+<note tip> **Tip**
  
-<ul> +Bevor die Datei ''/etc/apache2/sites-available/000-default.conf'' geändert wird, 
-    <li><a href="/wiki">DokuWiki</a></li> +sollte die vorhandene Konfiguration gesichert werden.
-    <li><a href="/led">LED Ampel</a></li> +
-    <li><a href="/temp">Temperatur</a></li> +
-</ul>+
  
-</body> +<code bash> 
-</html>+cd  /etc/apache2/sites-available/ 
 +sudo  cp 000-default.conf 000-default.conf.course_backup
 </code> </code>
  
 +</note>
  
-===== 5. APACHE PROXY ===== 
  
-Datei: +<code bash /etc/apache2/sites-available/000-default.conf>
-  /etc/apache2/sites-available/000-default.conf +
- +
-Innerhalb von <VirtualHost *:80>: +
- +
-<code>+
 ProxyPreserveHost On ProxyPreserveHost On
  
Zeile 272: Zeile 364:
 </code> </code>
  
-Module aktivieren und Apache neu laden:+=== Aktivieren === 
 +Damit die Weiterleitung an die FastAPI-Anwendung funktioniert, müssen die benötigten Apache-Module aktiviert und der Webserver neu gestartet werden.
  
 <code bash> <code bash>
 sudo a2enmod proxy sudo a2enmod proxy
 sudo a2enmod proxy_http sudo a2enmod proxy_http
-sudo systemctl reload apache2+sudo systemctl restart apache2
 </code> </code>
  
 +==== Systemd ====
  
-===== 6. SYSTEMD (AUTOSTART) =====+Die Service-Datei muss unter ''/etc/systemd/system/course_web.service'' neu erstellt und anschließend bei ''systemd'' registriert werden. 
 +=== Service ===
  
-Datei: 
-  /etc/systemd/system/python_web.service 
  
-<code>+<code bash /etc/systemd/system/course_web.service>
 [Unit] [Unit]
 Description=Python Web FastAPI Description=Python Web FastAPI
Zeile 294: Zeile 387:
 [Service] [Service]
 User=pi User=pi
-WorkingDirectory=/home/pi/devel/projects/python_web/src+WorkingDirectory=/home/pi/devel/projects/course_web/src
 ExecStart=/home/pi/devel/projects/course_env/bin/uvicorn app:app --host 127.0.0.1 --port 8000 ExecStart=/home/pi/devel/projects/course_env/bin/uvicorn app:app --host 127.0.0.1 --port 8000
 Restart=always Restart=always
Zeile 302: Zeile 395:
 </code> </code>
  
-Aktivieren:+=== Registrierung === 
 +Damit die neu erstellte Service-Datei von ''systemd'' erkannt wird und die Anwendung automatisch beim Systemstart gestartet wird, muss der Dienst neu geladen, aktiviert und gestartet werden.
  
 <code bash> <code bash>
 sudo systemctl daemon-reload sudo systemctl daemon-reload
-sudo systemctl enable python_web +sudo systemctl enable course_web 
-sudo systemctl start python_web+sudo systemctl start course_web       # starten 
 </code> </code>
  
- +Nützlich:
-===== 7. TEST ===== +
- +
-  * http://raspberrypi/ +
-  * http://raspberrypi/wiki +
-  * http://raspberrypi/led +
-  * http://raspberrypi/temp +
- +
- +
-===== 8. REBOOT TEST ===== +
 <code bash> <code bash>
-sudo reboot+sudo systemctl restart course_web     # neu starten 
 +sudo systemctl status course_web      # prüfen!!!
 </code> </code>
- 
-Nach Neustart erneut prüfen: 
- 
-  * http://raspberrypi/ 
-  * http://raspberrypi/wiki 
-  * http://raspberrypi/led 
-  * http://raspberrypi/temp 
- 
- 
- 
projekt/python_fastapi.1771615091.txt.gz · Zuletzt geändert: von torsten.roehl