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 18:39] – 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]]
  
  
-====== GPIO Web – didaktisch sauber (FastAPI + Apache + systemd) ======+//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.//
  
-Ziel: +|{{ :raspberry_pi:web_1.png?300 |}}| 
-  * Klare Trennung: Hardware / Web / HTML +|Die LED-Ampel kann nun über den Webbrowser gesteuert und die Temperatur ausgelesen werden.| 
-  * Keine Template-Engine +====== Überblick ====== 
-  * HTML als eigene Datei +  * Voraussetzungen 
-  * Einmalige Initialisierung +  * Software 
-  * Reboot-fest über systemd +  * Konfiguration
-  * VENV: ~/devel/projects/course_env+
  
 +====== Details ======
  
-===== 1. PROJEKTORDNER =====+===== 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 
 +</code> 
 + 
 +</note> 
 +Anschließend werden FastAPI und Uvicorn installiert:
  
 <code bash> <code bash>
-cd /home/pi/devel/projects +pip install fastapi uvicorn       
-mkdir -p gpio_web/src/core +
-mkdir -p gpio_web/src/static +
-cd gpio_web/src/core +
-touch __init__.py+
 </code> </code>
 +<note>
 +**FastAPI / Uvicorn**
  
 +  * **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>
  
-===== 2. VENV =====+==== 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>
-source ~/devel/projects/course_env/bin/activate +sudo mv /var/www/html/index.html /var/www/html/index_course_backup.html
-pip install fastapi uvicorn RPi.GPIO +
-which uvicorn+
 </code> </code>
 +</note>
  
-Erwartet: +<code html /var/www/html/index.html> 
-  /home/pi/devel/projects/course_env/bin/uvicorn+<!DOCTYPE html> 
 +<html> 
 +<head> 
 +    <title>Projekt Auswahl</title> 
 +</head> 
 +<body>
  
 +<h1>Projekt Auswahl</h1>
  
-===== 3. HARDWARE-SCHICHT =====+<ul> 
 +    <li><a href="/wiki">DokuWiki</a></li> 
 +    <li><a href="/led">LED Ampel</a></li> 
 +    <li><a href="/temp">Temperatur</a></li> 
 +</ul>
  
-Datei: +</body> 
-  /home/pi/devel/projects/gpio_web/src/core/hardware.py+</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.
  
-<code python> +===== Software ===== 
-""" +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. 
-Hardware-Schicht. +==== API ====
-Kapselt alle GPIO-Zugriffe. +
-"""+
  
 +<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 time
 +
 +# -----------------------------
 +# API-Funktionen GPIO LED Ampel
 +# -----------------------------
  
 PIN_R = 17 PIN_R = 17
Zeile 56: Zeile 110:
  
 _initialized = False _initialized = False
- 
  
 def init(): def init():
-    """ 
-    Wird genau einmal beim Start des Servers aufgerufen. 
-    """ 
     global _initialized     global _initialized
     if _initialized:     if _initialized:
Zeile 76: Zeile 126:
  
  
-def setRedLED(value: int): +def setLED(pin, value): 
-    GPIO.output(PIN_R, GPIO.HIGH if value == 1 else GPIO.LOW)+    GPIO.output(pin, GPIO.HIGH if value == 1 else GPIO.LOW)
  
  
-def setYellowLED(value: int): +def setRedLED(value): 
-    GPIO.output(PIN_Y, GPIO.HIGH if value == 1 else GPIO.LOW)+    setLED(PIN_R, value)
  
  
-def setGreenLED(value: int): +def setYellowLED(value): 
-    GPIO.output(PIN_G, GPIO.HIGH if value == 1 else GPIO.LOW)+    setLED(PIN_Y, value) 
 + 
 + 
 +def setGreenLED(value): 
 +    setLED(PIN_G, value)
  
  
 def status(): def status():
-    """ 
-    Liefert aktuellen Hardware-Zustand. 
-    """ 
     return (     return (
         int(GPIO.input(PIN_R)),         int(GPIO.input(PIN_R)),
Zeile 97: Zeile 148:
         int(GPIO.input(PIN_G)),         int(GPIO.input(PIN_G)),
     )     )
 +
 +
 +# -----------------------------
 +# API-Funktionen ds18b20
 +# -----------------------------
 +
 +SENSOR_TIMEOUT = 1
 +
 +def get_sensor():
 +    sensors = glob.glob("/sys/bus/w1/devices/28-*")
 +    if not sensors:
 +        return None
 +    return sensors[0] + "/w1_slave"
 +
 +
 +def get_temperature():
 +    sensor_file = get_sensor()
 +    if sensor_file is None:
 +        return None
 +
 +    start_time = time.time()
 +
 +    while True:
 +        with open(sensor_file, "r") as f:
 +            lines = f.readlines()
 +
 +        if lines[0].strip().endswith("YES"):
 +            break
 +
 +        if time.time() - start_time > SENSOR_TIMEOUT:
 +            return None
 +
 +        time.sleep(0.1)
 +
 +    temp_line = lines[1]
 +    temp_str = temp_line.split("t=")[1]
 +    return float(temp_str) / 1000.0
 </code> </code>
  
  
-===== 4. HTML (GETRENNT, KEIN TEMPLATE-FRAMEWORK) =====+====  HTML ==== 
 + 
 +=== LED ===
  
-Datei: 
-  /home/pi/devel/projects/gpio_web/src/static/index.html 
  
-<code html>+<code html /home/pi/devel/projects/course_web/src/html/led.html>
 <!DOCTYPE html> <!DOCTYPE html>
 <html> <html>
 <head> <head>
-    <title>GPIO Web</title>+    <title>LED Ampel</title>
 </head> </head>
 <body> <body>
  
-<h1>LED Steuerung</h1>+<h1>LED Ampel</h1>
  
-<h2>Rot (Status: {{R}})</h2> +<h2>Rot</h2> 
-<a href="/web/led/r/1">ON</a> +<p>Status: {{R}}</p> 
-<a href="/web/led/r/0">OFF</a>+<a href="/led/r/1">ON</a> 
 +<a href="/led/r/0">OFF</a>
  
-<h2>Gelb (Status: {{Y}})</h2> +<h2>Gelb</h2> 
-<a href="/web/led/y/1">ON</a> +<p>Status: {{Y}}</p> 
-<a href="/web/led/y/0">OFF</a>+<a href="/led/y/1">ON</a> 
 +<a href="/led/y/0">OFF</a>
  
-<h2>Grün (Status: {{G}})</h2> +<h2>Grün</h2> 
-<a href="/web/led/g/1">ON</a> +<p>Status: {{G}}</p> 
-<a href="/web/led/g/0">OFF</a>+<a href="/led/g/1">ON</a> 
 +<a href="/led/g/0">OFF</a> 
 + 
 +<br><br> 
 +<a href="/">Zurück</a>
  
 </body> </body>
Zeile 132: Zeile 226:
  
  
-===== 5. WEB-SCHICHT =====+=== 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 ==== 
  
-Datei: +<code python /home/pi/devel/projects/course_web/src/app.py>
-  /home/pi/devel/projects/gpio_web/src/app.py+
  
-<code python> 
-""" 
-Web-Schicht. 
-Verantwortlich für HTTP. 
-Keine GPIO-Logik hier. 
-""" 
  
 from fastapi import FastAPI, HTTPException from fastapi import FastAPI, HTTPException
Zeile 148: Zeile 259:
 from core import hardware from core import hardware
  
-app = FastAPI(root_path="/web")+app = FastAPI()
  
  
Zeile 156: Zeile 267:
  
  
-def load_html(r, y, g): +def load_template(name, replacements): 
-    with open("static/index.html", "r") as f: +    try: 
-        html = f.read()+        with open(f"html/{name}", "r") as f: 
 +            html = f.read() 
 +    except FileNotFoundError: 
 +        raise HTTPException(status_code=500, detail="Template nicht gefunden")
  
-    html = html.replace("{{R}}", str(r)) +    for key, value in replacements.items(): 
-    html = html.replace("{{Y}}", str(y)) +        html = html.replace(key, str(value))
-    html = html.replace("{{G}}", str(g))+
  
     return html     return html
  
- +@app.get("/led", response_class=HTMLResponse) 
-@app.get("/", response_class=HTMLResponse) +def led_page():
-def index():+
     r, y, g = hardware.status()     r, y, g = hardware.status()
-    return HTMLResponse(load_html(r, y, g)) 
  
 +    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}")
Zeile 177: Zeile 298:
  
     if value not in (0, 1):     if value not in (0, 1):
-        raise HTTPException(status_code=400, detail="Value must be 0 or 1")+        raise HTTPException(status_code=400)
  
     if color == "r":     if color == "r":
Zeile 186: Zeile 307:
         hardware.setGreenLED(value)         hardware.setGreenLED(value)
     else:     else:
-        raise HTTPException(status_code=400, detail="Invalid color")+        raise HTTPException(status_code=400)
  
-    return RedirectResponse(url="/web", status_code=303)+    return RedirectResponse(url="/led", status_code=303) 
 + 
 + 
 +@app.get("/temp", response_class=HTMLResponse) 
 +def temp_page(): 
 +    t = hardware.get_temperature() 
 + 
 +    if t is None: 
 +        value = "Sensorfehler" 
 +    else: 
 +        value = f"{t:.2f}" 
 + 
 +    return HTMLResponse( 
 +        load_template("temp.html", { 
 +            "{{T}}": value 
 +        }) 
 +    )
 </code> </code>
  
  
-===== 6. APACHE =====+ 
 + 
 +===== 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 ==== 
 + 
 +=== Konfiguration === 
 + 
 +In der Datei '' /etc/apache2/sites-available/000-default.conf'', 
 +innerhalb von ''<VirtualHost *:80>'' folgendes einfügen: 
 + 
 + 
 +<note tip> **Tip** 
 + 
 +Bevor die Datei ''/etc/apache2/sites-available/000-default.conf'' geändert wird, 
 +sollte die vorhandene Konfiguration gesichert werden.
  
 <code bash> <code bash>
-sudo a2enmod proxy +cd  /etc/apache2/sites-available/ 
-sudo a2enmod proxy_http +sudo  cp 000-default.conf 000-default.conf.course_backup
-sudo systemctl restart apache2+
 </code> </code>
  
-In: +</note>
-  /etc/apache2/sites-available/000-default.conf+
  
-Einfügen: 
  
-<code>+<code bash /etc/apache2/sites-available/000-default.conf>
 ProxyPreserveHost On ProxyPreserveHost On
-ProxyPass        /web  http://127.0.0.1:8000/ + 
-ProxyPassReverse /web  http://127.0.0.1:8000/ +ProxyPass        /led   http://127.0.0.1:8000/led 
-RedirectMatch 301 ^/wiki$ /web+ProxyPassReverse /led   http://127.0.0.1:8000/led 
 + 
 +ProxyPass        /temp  http://127.0.0.1:8000/temp 
 +ProxyPassReverse /temp  http://127.0.0.1:8000/temp
 </code> </code>
 +
 +=== 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 systemctl reload apache2+sudo a2enmod proxy 
 +sudo a2enmod proxy_http 
 +sudo systemctl restart apache2
 </code> </code>
  
 +==== Systemd ====
  
-===== 7. SYSTEMD =====+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/gpio_web.service 
  
-<code>+<code bash /etc/systemd/system/course_web.service>
 [Unit] [Unit]
-Description=GPIO Web FastAPI+Description=Python Web FastAPI
 After=network-online.target After=network-online.target
 Wants=network-online.target Wants=network-online.target
Zeile 230: Zeile 387:
 [Service] [Service]
 User=pi User=pi
-WorkingDirectory=/home/pi/devel/projects/gpio_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 237: Zeile 394:
 WantedBy=multi-user.target WantedBy=multi-user.target
 </code> </code>
 +
 +=== 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 gpio_web +sudo systemctl enable course_web 
-sudo systemctl start gpio_web+sudo systemctl start course_web       # starten 
 </code> </code>
  
- +Nützlich:
-===== 8. TEST ===== +
- +
-  * http://raspberrypi/web +
-  * http://raspberrypi/wiki +
- +
-===== 9. REBOOT ===== +
 <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 aufrufen. 
- 
-Eigenschaften: 
-  * HTML sauber getrennt 
-  * Hardware sauber getrennt 
-  * Keine versteckte Reinitialisierung 
-  * Für Anfänger klar strukturiert 
- 
projekt/python_fastapi.1771612741.txt.gz · Zuletzt geändert: von torsten.roehl