├── .gitignore ├── LICENSE ├── Makefile ├── README.md └── main └── main.c /.gitignore: -------------------------------------------------------------------------------- 1 | # Prerequisites 2 | *.d 3 | 4 | # Object files 5 | *.o 6 | *.ko 7 | *.obj 8 | *.elf 9 | 10 | # Linker output 11 | *.ilk 12 | *.map 13 | *.exp 14 | 15 | # Precompiled Headers 16 | *.gch 17 | *.pch 18 | 19 | # Libraries 20 | *.lib 21 | *.a 22 | *.la 23 | *.lo 24 | 25 | # Shared objects (inc. Windows DLLs) 26 | *.dll 27 | *.so 28 | *.so.* 29 | *.dylib 30 | 31 | # Executables 32 | *.exe 33 | *.out 34 | *.app 35 | *.i*86 36 | *.x86_64 37 | *.hex 38 | 39 | # Debug files 40 | *.dSYM/ 41 | *.su 42 | *.idb 43 | *.pdb 44 | 45 | # Kernel Module Compile Results 46 | *.mod* 47 | *.cmd 48 | .tmp_versions/ 49 | modules.order 50 | Module.symvers 51 | Mkfile.old 52 | dkms.conf 53 | /build/ 54 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # 2 | # This is a project Makefile. It is assumed the directory this Makefile resides in is a 3 | # project subdirectory. 4 | # 5 | 6 | PROJECT_NAME := esp32-httpserver 7 | 8 | include $(IDF_PATH)/make/project.mk 9 | 10 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ESP32: Simple HTTP-server 2 | 3 | This project is a basic HTTP-server capable of receiving http requests and responding accordingly. 4 | By default it implements the following HTTP verbs: GET, POST, PUT, PATCH, and DELETE so it can also be easily RESTfull servers. 5 | 6 | This server uses the ESP32's [oficial development framework](http://esp-idf.readthedocs.io/en/latest/index.html) (ESP-IDF) 7 | 8 | ## Getting Started 9 | 10 | These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. 11 | 12 | ### Prerequisites 13 | 14 | What things you need to install the software and how to install them 15 | 16 | * The toolchain [Guide](http://esp-idf.readthedocs.io/en/latest/get-started/windows-setup.html) 17 | * The latest ESP-IDF [Github](https://github.com/espressif/esp-idf) 18 | 19 | ### Running 20 | 21 | Before compiling you should first specify the SSID and Password: 22 | ``` 23 | #define AP_TARGET_SSID "Your SSID" 24 | #define AP_TARGET_PASSWORD "Your password" 25 | ``` 26 | 27 | By default the ESP32 is setup to use a dynamic IP. If you wish to use a static IP uncomment, and adjust the following settings: 28 | 29 | ``` 30 | #define DEVICE_IP "192.168.178.4" 31 | #define DEVICE_GW "192.168.178.1" 32 | #define DEVICE_NETMASK "255.255.255.0" 33 | ``` 34 | 35 | 36 | If the ESP32 has sucesfully connected to the WIFI network you should something like: 37 | ``` 38 | I (275) wifi: mode : sta (30:ae:a4:8f:6b:a8) 39 | I (761) wifi: n:4 0, o:1 0, ap:255 255, sta:4 0, prof:1 40 | I (1420) wifi: state: init -> auth (b0) 41 | I (1424) wifi: state: auth -> assoc (0) 42 | I (1428) wifi: state: assoc -> run (10) 43 | I (1460) wifi: connected with 'Your SSID', channel 4 44 | I (1461) wifi: pm start, type: 1 45 | 46 | I (3837) event: sta ip: 192.168.178.122, mask: 255.255.255.0, gw: 192.168.178.1 47 | ``` 48 | 49 | 50 | ### configuration 51 | 52 | #### Starting the server 53 | 54 | Like all the examples using the ESP-IDF this server uses freeRTOS. 55 | To start the http server you have to create a task that runs the function 'http_server 56 | ``` 57 | xTaskCreate(&http_server, "http_server", 2048, NULL, 5, NULL); // Starts server at port 80 58 | xTaskCreate(&http_server, "http_server", 2048, (void *) 123, 5, NULL); // Starts server at port 123 59 | ``` 60 | Here pvParameters is abbused to pass the desired port to the function (normally this is a pointer, but this is converted back to int in 'http_server'). If pvParameters is left to be NULL it defaults to port 80. 61 | 62 | 63 | #### Handling requests 64 | When a request is received the payload is placed in a variable called 'payload'. 65 | the following request below results in payload holding the string '/index.html?param1=value1¶m2=value2' 66 | ``` 67 | GET /index.html?param1=value1¶m2=value2 HTTP/1.1 68 | Host: 192.168.178.122:404 69 | Cache-Control: no-cache 70 | ``` 71 | 72 | As this is a minimal server the actual parsing of the string is not implemented (note that the cJSON library is suplied with the ESP_IDF, so parsing json can be implemented quite easily). 73 | 74 | 75 | before sending data or properly terminate a connection, the ESP32 should always send a html header containing the http status code. 76 | This is done with `netconn_write(conn, HDR_200, sizeof(HDR_200)-1, NETCONN_NOCOPY);` 77 | 78 | The implemented http status codes are: 79 | * HDR_200 'OK' 80 | * HDR_201 'created' 81 | * HDR_204 'No content' 82 | * HDR_404 'Not found' 83 | * HDR_405 'Method not allowed' 84 | * HDR_409 'conflict' 85 | * HDR_501 'Not implemented' 86 | 87 | *the selection is based on the [REST API tutorial](http://www.restapitutorial.com/lessons/httpmethods.html) but can easily be extended.* 88 | 89 | to reply with data (consecutive) calls to `netconn_write(conn, "html code as string", sizeof("html code as string")-1, NETCONN_NOCOPY);` can be made. -------------------------------------------------------------------------------- /main/main.c: -------------------------------------------------------------------------------- 1 | #include "freertos/FreeRTOS.h" 2 | #include "esp_wifi.h" 3 | #include "esp_system.h" 4 | #include "esp_event.h" 5 | #include "esp_event_loop.h" 6 | #include "nvs_flash.h" 7 | #include "driver/gpio.h" 8 | #include "freertos/portmacro.h" 9 | #include "freertos/event_groups.h" 10 | #include "esp_log.h" 11 | #include "tcpip_adapter.h" 12 | static EventGroupHandle_t wifi_event_group; 13 | const int CONNECTED_BIT = BIT0; 14 | 15 | #include "lwip/err.h" 16 | #include "string.h" 17 | 18 | #define AP_TARGET_SSID "ssid" 19 | #define AP_TARGET_PASSWORD "password" 20 | 21 | /* if code below is uncommented static ip is used */ 22 | /* 23 | #define DEVICE_IP "192.168.178.4" 24 | #define DEVICE_GW "192.168.178.1" 25 | #define DEVICE_NETMASK "255.255.255.0" 26 | */ 27 | 28 | #define HDR_200 "HTTP/1.1 200 OK\r\nContent-type: text/html\r\n\r\n" 29 | #define HDR_201 "HTTP/1.1 201 Created\r\nContent-type: text/html\r\n\r\n" 30 | #define HDR_204 "HTTP/1.1 204 No Content\r\nContent-type: text/html\r\n\r\n" 31 | #define HDR_404 "HTTP/1.1 404 Not Found\r\nContent-type: text/html\r\n\r\n" 32 | #define HDR_405 "HTTP/1.1 405 Method not allowed\r\nContent-type: text/html\r\n\r\n" 33 | #define HDR_409 "HTTP/1.1 409 Conflict\r\nContent-type: text/html\r\n\r\n" 34 | #define HDR_501 "HTTP/1.1 501 Not Implemented\r\nContent-type: text/html\r\n\r\n" 35 | 36 | #include "lwip/sys.h" 37 | #include "lwip/netdb.h" 38 | #include "lwip/api.h" 39 | 40 | 41 | static esp_err_t event_handler(void *ctx, system_event_t *event) 42 | { 43 | switch(event->event_id) { 44 | case SYSTEM_EVENT_STA_START: 45 | esp_wifi_connect(); 46 | break; 47 | case SYSTEM_EVENT_STA_GOT_IP: 48 | xEventGroupSetBits(wifi_event_group, CONNECTED_BIT); 49 | break; 50 | case SYSTEM_EVENT_STA_DISCONNECTED: 51 | esp_wifi_connect(); 52 | xEventGroupClearBits(wifi_event_group, CONNECTED_BIT); 53 | break; 54 | default: 55 | break; 56 | } 57 | return ESP_OK; 58 | } 59 | 60 | 61 | static void initialise_wifi(void) 62 | { 63 | tcpip_adapter_init(); 64 | wifi_event_group = xEventGroupCreate(); 65 | ESP_ERROR_CHECK( esp_event_loop_init(event_handler, NULL) ); 66 | wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT(); 67 | 68 | #ifdef DEVICE_IP 69 | tcpip_adapter_dhcpc_stop(TCPIP_ADAPTER_IF_STA); 70 | tcpip_adapter_ip_info_t ipInfo; 71 | inet_pton(AF_INET, DEVICE_IP, &ipInfo.ip); 72 | inet_pton(AF_INET, DEVICE_GW, &ipInfo.gw); 73 | inet_pton(AF_INET, DEVICE_NETMASK, &ipInfo.netmask); 74 | tcpip_adapter_set_ip_info(TCPIP_ADAPTER_IF_STA, &ipInfo); 75 | #endif 76 | 77 | ESP_ERROR_CHECK( esp_wifi_init(&cfg) ); 78 | ESP_ERROR_CHECK( esp_wifi_set_storage(WIFI_STORAGE_RAM) ); 79 | ESP_ERROR_CHECK( esp_wifi_set_mode(WIFI_MODE_STA) ); 80 | wifi_config_t sta_config = { 81 | .sta = { 82 | .ssid = AP_TARGET_SSID, 83 | .password = AP_TARGET_PASSWORD, 84 | .bssid_set = false 85 | } 86 | }; 87 | 88 | ESP_ERROR_CHECK( esp_wifi_set_config(WIFI_IF_STA, &sta_config) ); 89 | ESP_ERROR_CHECK( esp_wifi_start() ); 90 | } 91 | 92 | 93 | static void 94 | http_server_netconn_serve(struct netconn *conn) 95 | { 96 | struct netbuf *inbuf; 97 | char *buf, *payload, *start, *stop; 98 | u16_t buflen; 99 | err_t err; 100 | 101 | /* Read the data from the port, blocking if nothing yet there. 102 | We assume the request (the part we care about) is in one netbuf */ 103 | err = netconn_recv(conn, &inbuf); 104 | 105 | if (err == ERR_OK) { 106 | netbuf_data(inbuf, (void**)&buf, &buflen); 107 | // find the first and seconds space (those delimt the url) 108 | start = strstr(buf, " "); 109 | stop = strstr(start + 1, " "); 110 | // allocate memory for the payload 111 | payload = (char *) malloc(stop - start + 1); 112 | memcpy(payload, start, stop - start); 113 | payload[stop - start] = '\0'; 114 | 115 | /* For now only GET results in a valid respons */ 116 | if (strncmp(buf, "GET /", 5) == 0){ 117 | printf("GET = '%s' \n", payload); 118 | /* send HTTP Ok to client */ 119 | netconn_write(conn, HDR_200, sizeof(HDR_200)-1, NETCONN_NOCOPY); 120 | /* send "hello world to client" */ 121 | netconn_write(conn, "Hello World", sizeof("Hello World")-1, NETCONN_NOCOPY); 122 | }else if (strncmp(buf, "POST /", 6) == 0){ 123 | /* send '501 Not implementd' reply */ 124 | netconn_write(conn, HDR_501, sizeof(HDR_501)-1, NETCONN_NOCOPY); 125 | }else if (strncmp(buf, "PUT /", 5) == 0){ 126 | netconn_write(conn, HDR_501, sizeof(HDR_501)-1, NETCONN_NOCOPY); 127 | }else if (strncmp(buf, "PATCH /", 7) == 0){ 128 | /* send '501 Not implementd' reply */ 129 | netconn_write(conn, HDR_501, sizeof(HDR_501)-1, NETCONN_NOCOPY); 130 | }else if (strncmp(buf, "DELETE /", 8) == 0){ 131 | /* send '501 Not implementd' reply */ 132 | netconn_write(conn, HDR_501, sizeof(HDR_501)-1, NETCONN_NOCOPY); 133 | }else{ 134 | /* Any unrecognized verb will automatically 135 | result in '501 Not implementd' reply */ 136 | netconn_write(conn, HDR_501, sizeof(HDR_501)-1, NETCONN_NOCOPY); 137 | } 138 | free(payload); 139 | } 140 | /* Close the connection (server closes in HTTP) and clean up after ourself */ 141 | netconn_close(conn); 142 | netbuf_delete(inbuf); 143 | } 144 | 145 | static void http_server(void *pvParameters) 146 | { 147 | uint32_t port; 148 | if (pvParameters == NULL){ 149 | port = 80; 150 | }else{ 151 | port = (uint32_t) pvParameters; 152 | } 153 | // printf("\n Creating socket at\n %d \n", (uint32_t) pvParameters); 154 | struct netconn *conn, *newconn; 155 | err_t err; 156 | conn = netconn_new(NETCONN_TCP); 157 | netconn_bind(conn, NULL, port); 158 | netconn_listen(conn); 159 | do { 160 | err = netconn_accept(conn, &newconn); 161 | if (err == ERR_OK) { 162 | http_server_netconn_serve(newconn); 163 | netconn_delete(newconn); 164 | } 165 | } while(err == ERR_OK); 166 | netconn_close(conn); 167 | netconn_delete(conn); 168 | } 169 | 170 | 171 | int app_main(void) 172 | { 173 | nvs_flash_init(); 174 | initialise_wifi(); 175 | 176 | xTaskCreate(&http_server, "http_server", 2048, NULL, 5, NULL); 177 | return 0; 178 | } 179 | 180 | --------------------------------------------------------------------------------