{"id":7967,"date":"2022-09-08T08:12:58","date_gmt":"2022-09-08T15:12:58","guid":{"rendered":"https:\/\/visualgdb.com\/w\/?p=7967"},"modified":"2022-09-08T08:16:09","modified_gmt":"2022-09-08T15:16:09","slug":"using-the-raspberry-pi-pico-w-to-host-web-apps","status":"publish","type":"post","link":"https:\/\/visualgdb.com\/tutorials\/raspberry\/pico_w\/http\/","title":{"rendered":"Hosting Web Apps on Raspberry Pi Pico W with the HTTP Server"},"content":{"rendered":"

This tutorial shows how to turn the Raspberry Pi Pico W board<\/strong> into a Wi-Fi access point running a basic web app with its own CSS styles and API. We will start with our Raspberry Pi Pico W HTTP Server<\/a> sample and will then extend it, adding a new dialog that can be used to make the on-board LED blink with the specified period.<\/p>\n

Before you begin, we advise installing VisualGDB 5.6R7 or later, however you can also achieve the same results by editing the files manually and building the project via command line.<\/p>\n

    \n
  1. Clone the https:\/\/github.com\/sysprogs\/PicoHTTPServer\/<\/a> repository to your machine and open the PicoHTTPServer.sln<\/strong> file in Visual Studio. If this is the first time you are using VisualGDB with Raspberry Pi Pico, it will suggest automatically downloading and installing the toolchain and the Pico SDK:\"\"<\/a><\/li>\n
  2. Once the project loads, try building it. The initial build will fail with the missing “ip4_secondary_ip_address<\/strong>” error:\"\"<\/a><\/li>\n
  3. This happens because the lwIP stack does not support assigning multiple IP addresses to the same netconn<\/strong> object, which is necessary to generate the “sign into network” messages<\/a>. You can address it by applying the lwip.patch file<\/a> to the lwIP directory inside the Pico SDK, or by manually adding the 2 lines from it to the ip4.c<\/strong> file:\"\"<\/a>Now the project should build without errors.<\/li>\n
  4. If you have connected the SWD pins on your Pico W (see this tutorial<\/a>), right-click on the PicoHTTPServer<\/strong> project in Solution Explorer, go to the Debug Settings<\/strong> page and make sure the configuration matches your setup:\"\"<\/a>You will then be able to program the FLASH memory and begin debugging by simply pressing F5.
    \nIf not, you can deploy the built project into the Pico W by starting the board in the bootloader mode and copying the PicoHTTPServer.uf2<\/strong> file onto it.<\/li>\n
  5. Once the firmware starts, locate the PicoHTTP<\/strong> network from your computer or smartphone and click the “sign into network” link:\"\"<\/a><\/li>\n
  6. The link will lead to a simple web app allowing you to control the board pins from the browser: \"\"<\/a><\/li>\n
  7. We will now modify the web app, adding a new modal dialog and an underlying API to control the LED blinking period. First of all, locate the index.html<\/strong> file in Solution Explorer (or open it manually from the www<\/strong> subdirectory) and go to the <div><\/strong> with id=”popup_root”<\/strong>:\"\"<\/a>The index.html<\/strong> file is automatically served by the Pico W each time it is accessed via the browser. It contains HTML, CSS and JavaScript code necessary to run a basic web app. The <div><\/strong> element we selected corresponds the semi-transparent layer that is shown over the main page whenever any popup is shown.<\/li>\n
  8. Add the following HTML code inside the popup_root<\/strong> div after the settings_popup<\/strong>:\n
    <div id=\"blink_popup\" class=\"blink_popup modal_popup\">\r\n    <div class=\"popup_header\">\r\n        <span>LED Blinking Demo<\/span>\r\n        <span class=\"close_button\" style=\"cursor: pointer;\" onclick=\"show_blink_popup(false)\">&times;<\/span>\r\n    <\/div>\r\n    <div class=\"popup_body\">\r\n        <div class=\"setting_table\">\r\n            <span>Blinking period:<\/span>\r\n            <input id=\"blink_period\" value=\"1000\"\/>\r\n            <span>ms<\/span>\r\n            <button onclick=\"call_blink_api('period', document.getElementById('blink_period').value)\">Update<\/button>\r\n        <\/div>\r\n    <\/div>\r\n    <div class=\"popup_footer\">\r\n        <button onclick=\"call_blink_api('start')\">Start<\/button>\r\n        <button onclick=\"call_blink_api('stop')\">Stop<\/button>\r\n    <\/div>\r\n<\/div><\/pre>\n
    It defines a dialog consisting of a header with a close button, a body and a footer. It includes one input field for the period and 3 buttons for sending various requests to the device.<\/li>\n
  9. Now we need to add the styles so that the dialog will look like actual modal window (will have a blue header, close button shown in the right place, and sufficient padding around the edges). Locate the CSS stylesheet inside the index.html<\/strong> file and add the following code to it:\n
    .blink_popup {\r\n    width: 500px;\r\n    padding: 0;\r\n}\r\n\r\n.setting_table {\r\n    display: grid;\r\n    grid-gap: 5px;\r\n    grid-template-columns: auto 1fr auto auto;\r\n    align-items: center;\r\n}\r\n\r\n.popup_header {\r\n    background: blue;\r\n    margin: 0;\r\n    padding: 10px 20px;\r\n    color: white;\r\n    font-size: 22;\r\n    display: flex;\r\n    justify-content: space-between;\r\n}\r\n\r\n.popup_body {\r\n    margin: 0 20px;\r\n}\r\n\r\n.popup_footer {\r\n    margin: 0 20px 20px 20px;\r\n}<\/pre>\n<\/li>\n
  10. Add a function to show and hide the popup inside the <script><\/strong> element in index.html<\/strong>:\n
    function show_blink_popup(show) {\r\n    document.getElementById(\"popup_root\").style.display = show ? \"block\" : \"none\";\r\n    document.getElementById(\"blink_popup\").style.display = show ? \"block\" : \"none\";\r\n}<\/pre>\n<\/li>\n
  11. Finally, modify the header to show a “blink” button near the settings editing button:\n
    <h1>Raspberry Pi Pico W Demo\r\n    <a href=\"javascript:edit_settings()\" class=\"settings_link\"><img style=\"width: 32px; height: 32px; margin: 0px;\" src=\"img\/configure.png\"><\/a>\r\n    <a href=\"javascript:show_blink_popup(true)\" class=\"settings_link\"><img style=\"width: 32px; height: 32px; margin: 0px;\" src=\"img\/stopwatch.png\"><\/a>\r\n<\/h1><\/pre>\n
    Also download the stopwatch.png<\/a> icon and place it into the www\/img<\/strong> subdirectory.<\/li>\n
  12. Build the project and start debugging it. The CMake build scripts will automatically invoke the SimpleFSBuilder<\/a> tool to pack the modified index.html<\/strong> and stopwatch.png<\/strong> into a simple archive readable by the Pico HTTP server. Make sure you are still connected to the Wi-Fi network and refresh the page in the browser, then click the new stopwatch button:\"\"<\/a><\/li>\n
  13. If you still see the old index page, make sure the “Always Consider Outdated<\/strong>” setting is enabled in the CMake project properties:\"\"<\/a>Otherwise, changing the web server payload without modifying any of the source files will not trigger a rebuild.<\/li>\n
  14. The buttons in the newly added dialog won’t work yet because we have not implemented the call_blink_api()<\/strong> function used by them. Add the following code inside the <script><\/strong> element in index.html<\/strong>:\n
    function call_blink_api(path, content = null) {\r\n    let xhr = new XMLHttpRequest();\r\n    xhr.open(content ? \"POST\" : \"GET\", '\/api\/blink\/' + path, true);\r\n    if (content)\r\n        xhr.setRequestHeader(\"Content-Type\", \"text\/plain\");\r\n\r\n    xhr.onloadend = function () {\r\n        if (this.responseText != \"OK\")\r\n            alert(this.responseText);\r\n    };\r\n\r\n    if (content)\r\n        xhr.send(content + \"\\r\\n\");\r\n    else\r\n        xhr.send();\r\n}<\/pre>\n
    Each time you press either of the buttons, your browser will send a GET or POST request to the \/api\/blink\/<…><\/strong> endpoint. If the request returns anything other than the “OK” message, the browser will display the returned text in an error message.<\/li>\n
  15. The final thing we need to is handle these requests from the C code. Locate the calls to http_server_add_zone()<\/strong> in main.c<\/strong> and modify them as shown below:\n
    static http_zone zone1, zone2, zone3;\r\nhttp_server_add_zone(server, &zone1, \"\", do_retrieve_file, NULL);\r\nhttp_server_add_zone(server, &zone2, \"\/api\", do_handle_api_call, NULL);\r\nhttp_server_add_zone(server, &zone3, \"\/api\/blink\", do_handle_blink_api_call, NULL);<\/pre>\n
    This ensures that each request to \/api\/blink\/<…> will get routed to the do_handle_blink_api_call()<\/strong> function. Make sure you register the \/api\/blink<\/strong> zone AFTER the generic \/api<\/strong> zone, as the HTTP server checks the zone list in the backward order.<\/li>\n
  16. Add a function for actually handling the requests:\n
    xSemaphoreHandle s_BlinkSemaphore;\r\nstatic int s_BlinkPeriod = 1000;\r\n\r\nstatic void blink_task(void *arg)\r\n{\r\n    static bool on = false;\r\n    for (;;)\r\n    {\r\n        xSemaphoreTake(s_BlinkSemaphore, pdMS_TO_TICKS(s_BlinkPeriod));\r\n        cyw43_arch_gpio_put(0, on = !on);\r\n    }\r\n}\r\n\r\nstatic bool do_handle_blink_api_call(http_connection conn, enum http_request_type type, char *path, void *context)\r\n{\r\n    static TaskHandle_t s_BlinkTask;\r\n    if (!strcmp(path, \"start\"))\r\n    {\r\n        if (!s_BlinkSemaphore)\r\n            s_BlinkSemaphore = xSemaphoreCreateCounting(1, 0);\r\n        if (!s_BlinkTask)\r\n\t    xTaskCreate(blink_task, \"Blink\", configMINIMAL_STACK_SIZE, NULL, TEST_TASK_PRIORITY, &s_BlinkTask);\r\n        http_server_send_reply(conn, \"200 OK\", \"text\/plain\", \"OK\", -1);\r\n        return true;\r\n    }\r\n    else if (!strcmp(path, \"stop\"))\r\n    {\r\n        if (s_BlinkTask)\r\n        {\r\n            vTaskDelete(s_BlinkTask);\r\n            s_BlinkTask = NULL;\r\n        }\r\n        http_server_send_reply(conn, \"200 OK\", \"text\/plain\", \"OK\", -1);\r\n        cyw43_arch_gpio_put(0, false);\r\n        return true;\r\n    }\r\n    else if (!strcmp(path, \"period\"))\r\n    {\r\n        char *line = http_server_read_post_line(conn);\r\n        int period = line ? atoi(line) : 0;\r\n        if (period)\r\n        {\r\n            s_BlinkPeriod = period;\r\n            xSemaphoreGive(s_BlinkSemaphore);\r\n            http_server_send_reply(conn, \"200 OK\", \"text\/plain\", \"OK\", -1);\r\n        }\r\n        else\r\n            http_server_send_reply(conn, \"200 OK\", \"text\/plain\", \"Invalid period!\", -1);\r\n        return true;\r\n    }\r\n    else\r\n        return false;\r\n}<\/pre>\n
    Note how it cerates the Blink<\/strong> task in response to the start<\/strong> call, deletes it in response to stop<\/strong>, and updates the period in response to the period<\/strong> call. Signaling the s_BlinkSemaphore<\/strong> after updating the period is done to immediately wake up blink_task()<\/strong> without waiting for the previously set period to elapse.<\/li>\n
  17. Press F5 to build the project and start debugging it again. Open the blink dialog in the browser, click “Start” and try changing the period. The on-board LED will blink according to the entered value. If you try setting the period to 0 or a non-number, the browser will display the “Invalid period!” message relayed from the do_handle_blink_api_call()<\/strong> function: \"\"<\/a><\/li>\n
  18. You can view various debugging output from the project by using the Fast Semihosting feature of VisualGDB. As RP2040 device does not support detecting whether a debugger is attached, the example project comes with the semihosting disabled. You can enable it by setting “When running without debugger: wait for debugger to attach<\/strong>” in VisualGDB Project Properties:\"\"<\/a><\/li>\n
  19. The debug output will appear in the Debug->Windows->VisualGDB Output<\/strong> window:\"\"<\/a>You can also view various lwIP statistics (e.g. number of processed packets) in real time via Debug->Windows->Live Watch->lwip_stats<\/strong>.<\/li>\n<\/ol>\n
    You can find the code shown in this tutorial in the blink branch<\/a> of our GitHub repository. See this commit<\/a> for the exact changes described above.<\/p>\n","protected":false},"excerpt":{"rendered":"
    This tutorial shows how to turn the Raspberry Pi Pico W board into a Wi-Fi access point running a basic<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[18],"tags":[101,231,102],"_links":{"self":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/7967"}],"collection":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/comments?post=7967"}],"version-history":[{"count":5,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/7967\/revisions"}],"predecessor-version":[{"id":7986,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/posts\/7967\/revisions\/7986"}],"wp:attachment":[{"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/media?parent=7967"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/categories?post=7967"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/visualgdb.com\/w\/wp-json\/wp\/v2\/tags?post=7967"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}