Updated the NeoPixel example to also show using values from POST data

Author: michalpokusa

docs/examples.rst

@@ -109,17 +109,23 @@ In example below, handler for ``/api`` route will be called when any of ``GET``,
 Change NeoPixel color
 ---------------------
 
-In your handler function you can access the query/GET parameters using ``request.query_params``.
-This allows you to pass data to the handler function and use it in your code.
-Alternatively you can use URL parameters, which are described later in this document.
+There are several ways to pass data to the handler function:
+
+- In your handler function you can access the query/GET parameters using ``request.query_params``
+- You can also access the POST data directly using ``request.body`` or if you data is in JSON format,
+  you can use ``request.json()`` to parse it into a dictionary
+- Alternatively for short pieces of data you can use URL parameters, which are described later in this document
+  For more complex data, it is recommended to use JSON format.
+
+All of these approaches allow you to pass data to the handler function and use it in your code.
 
 For example by going to ``/change-neopixel-color?r=255&g=0&b=0`` or ``/change-neopixel-color/255/0/0``
 you can change the color of the NeoPixel to red.
 Tested on ESP32-S2 Feather.
 
 .. literalinclude:: ../examples/httpserver_neopixel.py
     :caption: examples/httpserver_neopixel.py
-    :emphasize-lines: 24-26,34-35
+    :emphasize-lines: 25-27,39-40,52-53,61,69
     :linenos:
 
 Get CPU information

examples/httpserver_neopixel.py

@@ -7,7 +7,7 @@
 import socketpool
 import wifi
 
-from adafruit_httpserver import Server, Request, Response
+from adafruit_httpserver import Server, Request, Response, GET, POST
 
 
 pool = socketpool.SocketPool(wifi.radio)
@@ -16,27 +16,57 @@
 pixel = neopixel.NeoPixel(board.NEOPIXEL, 1)
 
 
-@server.route("/change-neopixel-color")
+@server.route("/change-neopixel-color", GET)
 def change_neopixel_color_handler_query_params(request: Request):
-    """
-    Changes the color of the built-in NeoPixel using query/GET params.
-    """
-    r = request.query_params.get("r")
-    g = request.query_params.get("g")
-    b = request.query_params.get("b")
+    """Changes the color of the built-in NeoPixel using query/GET params."""
 
-    pixel.fill((int(r or 0), int(g or 0), int(b or 0)))
+    # e.g. /change-neopixel-color?r=255&g=0&b=0
+
+    r = request.query_params.get("r") or 0
+    g = request.query_params.get("g") or 0
+    b = request.query_params.get("b") or 0
+
+    pixel.fill((int(r), int(g), int(b)))
+
+    with Response(request, content_type="text/plain") as response:
+        response.send(f"Changed NeoPixel to color ({r}, {g}, {b})")
+
+
+@server.route("/change-neopixel-color", POST)
+def change_neopixel_color_handler_post_body(request: Request):
+    """Changes the color of the built-in NeoPixel using POST body."""
+
+    data = request.body  # e.g b"255,0,0"
+    r, g, b = data.decode().split(",")  # ["255", "0", "0"]
+
+    pixel.fill((int(r), int(g), int(b)))
 
     with Response(request, content_type="text/plain") as response:
         response.send(f"Changed NeoPixel to color ({r}, {g}, {b})")
 
 
-@server.route("/change-neopixel-color/<r>/<g>/<b>")
-def change_neopixel_color_handler_url_params(request: Request, r: str, g: str, b: str):
-    """
-    Changes the color of the built-in NeoPixel using URL params.
-    """
-    pixel.fill((int(r or 0), int(g or 0), int(b or 0)))
+@server.route("/change-neopixel-color/json", POST)
+def change_neopixel_color_handler_post_json(request: Request):
+    """Changes the color of the built-in NeoPixel using JSON POST body."""
+
+    data = request.json()  # e.g {"r": 255, "g": 0, "b": 0}
+    r, g, b = data.get("r", 0), data.get("g", 0), data.get("b", 0)
+
+    pixel.fill((r, g, b))
+
+    with Response(request, content_type="text/plain") as response:
+        response.send(f"Changed NeoPixel to color ({r}, {g}, {b})")
+
+
+@server.route("/change-neopixel-color/<r>/<g>/<b>", GET)
+def change_neopixel_color_handler_url_params(
+    request: Request, r: str = "0", g: str = "0", b: str = "0"
+):
+    """Changes the color of the built-in NeoPixel using URL params."""
+
+    # e.g. /change-neopixel-color/255/0/0
+
+    pixel.fill((int(r), int(g), int(b)))
 
     with Response(request, content_type="text/plain") as response:
         response.send(f"Changed NeoPixel to color ({r}, {g}, {b})")