View source for 38. Lektion: Webserver

== Webserver==

=== Wlan einrichten===
Um einen Webserver betreiben zu können, müssen wir zuerst eine Verbindung zu einem Netzwerk herstellen.<br>
Hier noch einmal die klassische Einrichtung einer Wlan-Verbindung:
<pre>
import network

# Wlan Verbindung herstellen

wlan = network.WLAN(network.STA_IF)
wlan.active(True)
if not wlan.isconnected():
    print('connecting to network...')
    wlan.connect('ssid', 'key')
    while not wlan.isconnected():
        pass
print('network config:', wlan.ifconfig())
</pre>

=== Das Webserver Packet phew===
Für den Raspberry Pi Pico W gibt es ein Packet, das alles enthält, was zur Einrichtung eines Webservers auf dem Pico erforderlich ist. Es heißt "'''phew'''" und ist von Github unter [https://github.com/pimoroni/phew https://github.com/pimoroni/phew] zu beziehen. Das Archiv muss entpackt und dann das Unterverzeichnis "'''phew'''" ins Filesystem des Pico kopiert werden.
<br>
Der Webserver wird einfach gestartet. Es ist keine großartige Konfiguration erforderlich. Allerdings müssen vorher noch die Webseiten und ihre Routen definiert werden.
<pre>
from phew import server

# hier werden die auszuliefernden Webseiten definiert.   Siehe nächste Codebox.

server.run()
</pre>

==== Einfaches Wlan verbinden====
Phew bietet eine einfachere Möglichkeit die Verbindung zum Wlan herzustellen:
<pre>
from phew import server, connect_to_wifi

connect_to_wifi("Attraktor", "blafablafa")

2023-12-07 17:37:01 [debug    / 143kB]   - connecting
2023-12-07 17:37:04 [debug    / 141kB]   - connecting
'192.168.5.120'
</pre>
Lt. Beschreibung gibt es eine Funktion '''get_ip_address().''' Bei mir hat sie aber nicht funktioniert und ich habe sie auch nicht im Quellcode finden können. Deshalb macht es Sinn, die IP-Adresse in eine Variable zu speichern:
<pre>
from phew import server, connect_to_wifi

ip_adresse = connect_to_wifi("Attraktor", "blafablafa")

2023-12-07 17:48:47 [debug    / 146kB]   - got ip address

>>> ip_adresse
'192.168.5.120'
</pre>

=== Webseiten generieren===
Eine Webseite wird erstellt indem eine Funktion definiert wird, die den Inhalt des '''Response''' zurück gibt. Der Funktion muss '''request''' übergeben werden.
<br>
Damit der Server diese Funktion als Webseite erkennt muss sie entsprechend kenntlich gemacht werden. Dazu gibt es zwei Möglichkeiten:
<br>
==== Mit Decorator:====
Ein Decorator ist ein Konzept, dass eine Funktion dekoriert. D.h. Er ergänzt die Funktion, fügt also eine zusätzliche Funktionalität hinzu.
<br>
Es muss dem Decorator die Route - die Zeichen, die in der URL hinter der IP-Adresse stehen - und die HTTP-Methode (GET oder POST) ünergeben werden. Die Definition folgt in der nächsten Zeile.
<pre>
@server.route("/random", methods=["GET"])
def random_number(request):
    import random
    min = int(request.query.get("min", 0))
    max = int(request.query.get("max", 100))
    return str(random.randint(min, max))
</pre>

==== Mit Route-Tabelle:====
<pre>
# Webseiten definieren

def random_number(request):
    import random
    min = int(request.query.get("min", 0))
    max = int(request.query.get("max", 100))
    return str(random.randint(min, max))

def info_site(request):
      return "<h1>Infoseite vom Raspberry Pi Pico W</h1>"

# Routing Tabelle

server.add_route("/random", random_number, methods=["GET"])
server.add_route("/info", info_site, methods=["GET"])
</pre>

==== Response erzeugen====
Der Response ist ein String der alle Informationen enthält die an den Client zurückgegeben werden sollen.
<br>
Innerhalb der Definition kann alles das gemacht werden, was auch in einer Funktion möglich ist. Der Return-Wert ist der Response. Dieser kann auf unterschiedliche Weise erzeugt werden.

===== Einfacher Text=====
Hier steht hinter '''return''' ein String, der den Response enthält. Dieser kann, aber muss nicht, HTML-Auszeichnungen enthalten. Es kann ein kurzer Text sein, oder auch eine umfangreiche Webseite mit HTML-Header und -body. Als zweites Argument kann der HTTP-Code - hier 404 - agegeben werden.
<pre>
@server.catchall()
def catch_all(request):
    return "<h1>Hallo, diese Webseite gibt es nicht!</h1>", 404

# oder mit f-string:

@server.route("/test", methods=["GET"])
def test_seite(request):
    version = 1.0.0
    return f"Aktuelle Version {version}", 200

# oder mit einer Funktion:

@server.route("/random", methods=["GET"])
def random_number(request):
    import random
    min = int(request.query.get("min", 0))
    max = int(request.query.get("max", 100))
    return str(random.randint(min, max))
</pre>

===== In einer Variablen=====
<pre>
@server.route("/info", methods=["GET"])
def info_seite(request):
    content = '''
                 <html>
                     <header>
                          ....
                     </header>
                     <body>
                          ....
                     </body>
                 </html>
              '''
    return content, 200
</pre>

===== Aus einer Datei=====
Um den Response aus einer Datei zurück zu geben gibt es die Funktion '''render_template()'''.
<br>
So kann eine komplette Webseite aus einer Datei zurückgegeben werden, es können aber auch Werte in das Webseiten-Template eingesetzt werden.
<pre>
from phew.template import render_template
HTDOCS = 'htdocs/'

@server.route("/test", methods=["GET"])
def test_site(request):
    return render_template(HTDOCS + "html-test_001.html")

</pre>

===== Wenn die Seite nicht existiert=====
Der Server gibt üblicherweise die der Route zugeordnete Webseite zurück. Wenn eine Webseite angefordert wird, die nicht existiert, wird die Servermethode '''catchall()''' aufgerufen.
<pre>
@server.catchall()
def catch_all(request):
      return "<h1>Hallo, diese Webseite gibt es nicht!</h1>", 404

# oder aus einer Datei in /htdocs:

HTDOCS = 'htdocs/'

@server.catchall()
def catch_all(request):
    return render_template(HTDOCS + 'error_404.html')
</pre>

=== Beispiel===

==== Die verschiedenen Return-Methoden ausprobieren====
Hier gibt es ein Programm, das den phew-Server einrichtet und einige Seiten mit verschiedenen Return-Methoden bereitstellt. Welche Seiten abgerufen werden können ist unter '''IP/info''' abrufbar.

<pre>
# webserver_002.py
#
# V.0.0.1
# 07.12.2023
# Peter Stöck
#
# Hier werden die verschiedenen Returnmethoden getestet.



from phew import server, connect_to_wifi
from phew.template import render_template


# Konstanten und Variablen
HTDOCS = 'htdocs/'
ip_adresse = None

SSID = 'Attraktor'
PW = 'blafablafa'

# Wlan Verbindung herstellen

ip_adresse = connect_to_wifi(SSID, PW)
print(ip_adresse)

# Websiten erstellen

@server.route("/string1", methods=["GET"])
def string1(request):
    return str(42) + ' ist string1'

@server.route("/string2", methods=["GET"])
def string2(request):
    return '''<h1>Infoseite vom Raspberry Pi Pico W</h1><br>
            Dieses ist string2'''

@server.route("/string3", methods=["GET"])
def string3(request):
    return render_template(HTDOCS + "html-test_002.html")

@server.route("/var", methods=["GET"])
def var(request):
    content = 'Hallo, ich komme aus einer Variblen'
    return content

@server.route("/hallo/<name>", methods=["GET"])
def hallo(request, name):
    return f"Hallo {name}!"

@server.route("/info", methods=["GET"])
def string3(request):
    content = '''
                 <h1>Infoseite vom phew-Server</h1>
                 Folgende Seiten sind abrufbar:<br>
                 /string1<br>
                 /string2<br>
                 /string3<br>
                 /var<br>
                 /hallo/Hier Name eingeben<br>
                 /info - diese Seite<br>
              '''
    return content

@server.catchall()
def catch_all(request):
    return "<h1>Hallo, diese Webseite gibt es nicht!</h1><br>Sie steht f&#252;r catch_all.", 404

# Server starten - nun geht nichte anderes mehr:(

server.run()

</pre>

Hier die Datei '''html-test_002.html'''. Sie muss in das Verzeichnis '''htdocs''' kopiert werden.
<pre>
<h1>&amp;Uuml;berschrift</h1>
Dieses ist eine kleine HTML-Testseite.
<br>
Sie steht f&amp;uuml;r string3
<br>
Noch ist es nur ein einfacher Test!
</pre>

==== Ein praktisches Beispiel====
Dieses Programm ermöglicht es die LED ein-/auszuschalten und die Sensoren abzufragen.

<pre>
# webserver_003.py
#
# Version 0.0.1
# 07.12.2023
# Peter Stöck
#
# Dieses Programm hat folgende Funktionen:
# LED ein- und ausschalten
#

from phew import server, connect_to_wifi
from phew.template import render_template
from machine import Pin


# Konstanten und Variablen
HTDOCS = 'htdocs/'
ip_adresse = None
pin_von_led = 22

SSID = 'Attraktor'
PW = 'blafablafa'

# Led aktivieren

led_pin = Pin(pin_von_led, Pin.OUT)
led_pin.value(0)

# Wlan Verbindung herstellen

ip_adresse = connect_to_wifi(SSID, PW)
print(ip_adresse)


# Websiten erstellen

@server.route("/led/<led_status>", methods=["GET"])
def led_ctrl(request, led_status):
    if led_status == 'ein':
        led_pin.value(1)
    else:
        led_pin.value(0)
    return f"LED wurde {led_status}geschaltet."

@server.catchall()
def catch_all(request):
    return "<h1>Hallo, diese Webseite gibt es nicht!</h1>", 404

# Server starten - nun geht nichte anderes mehr:(

server.run()

</pre>

== Lager==
* Webserver
** https://github.com/jczic/MicroWebSrv2
** Raspberry Pi Pico
*** MicroWebSrv - geht nicht!
**** https://github.com/jczic/MicroWebSrv
**** https://forums.raspberrypi.com/viewtopic.php?t=338692
*** Andere Links mit Sockets:
**** http://www.doctormonk.com/2022/09/a-better-web-server-for-raspberry-pi.html
**** https://github.com/miguelgrinberg/microdot
**** https://microdot.readthedocs.io/en/latest/intro.html
**** https://wellys.com/posts/rp2040_microphyton_webserver/
**** https://github.com/miguelgrinberg/microdot
**** https://www.rasppishop.de/pico-w-als-webserver
**** https://www.elektronik-kompendium.de/sites/raspberry-pi/2707131.htm
**** https://www.youtube.com/watch?v=RN2k_0mrKxI
**** https://www.youtube.com/watch?v=Me7VM2z3_f8
**** https://draeger-it.blog/raspberry-pi-pico-w-programmieren-eines-webservers/
**** https://hackaday.io/project/189675-raspberry-pi-pico-w-super-simple-webserver
**** https://github.com/sciencedude1990/MicropythonPicoWebServer