Skip to content

Commit a01d142

Browse files
phatpaulphatpaul
authored
Cgiwifi ajax (#100)
* refactor cgiwifi API to use modern AJAX style (was template). Also cleanup some other cgi. * formatted esp32_wifi.c with vscode default * cgiWiFi: Add a watchdog to monitor WiFi STA connection and reconnect if should be connected. Also added option to start STA connection on boot. * upgraded to work with IDF version 4.x
1 parent 2934a99 commit a01d142

12 files changed

+1303
-890
lines changed

‎CMakeLists.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ set (libesphttpd_SOURCES "core/auth.c"
44
"core/sha1.c"
55
"core/libesphttpd_base64.c"
66
"util/captdns.c"
7+
"util/cgi_common.c"
78
"util/cgiflash.c"
89
"util/cgiredirect.c"
910
"util/cgiwebsocket.c"
1011
"util/cgiwifi.c"
1112
"util/cgiredirect.c"
12-
"util/esp32_flash.c"
1313
"util/esp32_httpd_vfs.c"
1414
"util/esp32_wifi.c")
1515

‎README-wifi_api.md

+157
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
# Libesphttpd WiFi-API
2+
3+
Functions to configure ESP32 WiFi settings via HTTP API.
4+
5+
## GUI
6+
See the example js/html code for the GUI here: https://github.com/chmorgan/esphttpd-freertos/blob/master/html/wifi/index.html
7+
8+
## Functions defined in libesphttpd/cgiwifi.h
9+
10+
* __cgiWiFiScan()__
11+
12+
Gets the results of an earler scan in JSON format. Optionally start a new scan.
13+
14+
Examples:
15+
* `http://my-esp32-ip/wifi/scan?clear=1&start=1` - Clear the previous results and start a new scan. Returned APs list will be empty and inProgress will be true.
16+
17+
Note: If client is connected via WiFi, then start=1 may interrupt communication breifly, so use sparingly.
18+
* `http://my-esp32-ip/wifi/scan` - After sending start command, poll this until `inProgress:false` and APs list contains results.
19+
20+
Note: "enc" value is from `enum wifi_auth_mode_t`, where 0=Open, 1=WEP, 2+ is WPA.
21+
22+
GET/POST args:
23+
```js
24+
"clear": number // 1: Clear the previous results first.
25+
"start": number // 1: Start a new scan now.
26+
```
27+
Response:
28+
```js
29+
{
30+
"args": { // Args are repeated here in the response
31+
"clear": number,
32+
"start": number,
33+
},
34+
"APs": [{
35+
"essid": string, // Name of AP discovered
36+
"bssid": string, // MAC of AP discoverd
37+
"rssi": number, // Signal strength i.e. -55
38+
"enc": number, // WiFi security (encryption) type.
39+
"channel": number // Channel used by AP
40+
},{...}],
41+
"working": boolean, // A scan is in progress. Poll this.
42+
"success": boolean, // CGI success/fail
43+
"error": string, // Optional error message if failure
44+
}
45+
```
46+
47+
* __cgiWiFiConnect()__
48+
49+
Set WiFi STAtion (ESP WiFI Client) settings and trigger a connection.
50+
51+
Note: The "success" response of this CGI call does not indicate if the WiFi connection succeeds. Poll /wifi/sta (cgiWiFiConnStatus) for connection pending/success/fail.
52+
53+
Examples:
54+
* http://my-esp32-ip/wifi/connect?ssid=my-ssid&pass=mysecretpasswd - Trigger a connection attempt to the AP with the given SSID and password.
55+
56+
GET/POST args:
57+
```js
58+
"ssid": string
59+
"pass": string
60+
```
61+
Response:
62+
```js
63+
{
64+
"args": { // Args are repeated here in the response
65+
"ssid": string,
66+
"pass": string,
67+
},
68+
"success": boolean, // CGI success/fail
69+
"error": string, // Optional error message if failure
70+
}
71+
```
72+
73+
* __cgiWiFiSetMode()__
74+
75+
CGI used to get/set the WiFi mode.
76+
77+
The mode values are defined by `enum wifi_mode_t`
78+
```c
79+
0 /**< null mode */
80+
1 /**< WiFi station mode */
81+
2 /**< WiFi soft-AP mode */
82+
3 /**< WiFi station + soft-AP mode */
83+
```
84+
85+
Examples
86+
* i.e. http://ip/wifi/mode?mode=1 - Change mode to WIFI_MODE_STA
87+
88+
GET/POST args:
89+
```js
90+
"mode": number // The desired Mode (as number specified in enum wifi_mode_t)
91+
"force": number // 1: Force the change, regardless of whether ESP's STA is connected to an AP.
92+
```
93+
Response:
94+
```js
95+
{
96+
"args": { // Args are repeated here in the response
97+
"mode": number,
98+
"force": number,
99+
},
100+
"mode": number, // The current Mode (as number specified in enum wifi_mode_t)
101+
"mode_str": string, // The current Mode (as a string specified in wifi_mode_names[]= "Disabled","STA","AP""AP+STA")
102+
"success": boolean, // CGI success/fail
103+
"error": string, // Optional error message if failure
104+
}
105+
```
106+
107+
* __cgiWiFiStartWps()__
108+
109+
CGI for triggering a WPS push button connection attempt.
110+
111+
* __cgiWiFiAPSettings()__
112+
113+
CGI for get/set settings in AP mode.
114+
115+
Examples:
116+
* http://ip/wifi/ap?ssid=myssid&pass=mypass&chan=1 - Change AP settings
117+
118+
GET/POST args:
119+
```js
120+
"chan": number,
121+
"ssid": string,
122+
"pass": string
123+
```
124+
Response:
125+
```js
126+
{
127+
"args": { // Args are repeated here in the response
128+
"chan": number,
129+
"ssid": string,
130+
"pass": string,
131+
},
132+
"enabled" : boolean, // AP is enabled
133+
"success": boolean, // CGI success/fail
134+
"error": string, // Optional error message if failure
135+
}
136+
```
137+
138+
* __cgiWiFiConnStatus()__
139+
140+
CGI returning the current state of the WiFi STA connection to an AP.
141+
142+
Examples:
143+
* `http://my-esp32-ip/wifi/sta` - Get the state of the STAtion
144+
145+
Response:
146+
```js
147+
{
148+
"ssid": string, // SSID that the STAtion should connect to.
149+
"pass": string, // WiFi network password.
150+
"enabled" : boolean, // STA is enabled
151+
"ip" : string, // Optional IP address of STAtion (only if connected)
152+
"working": boolean, // A connect is in progress. Poll this.
153+
"connected": boolean, // STAtion is connected to a WiFi network. Poll this.
154+
"success": boolean, // CGI success/fail
155+
"error": string, // Optional error message if failure
156+
}
157+
```

‎README.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,9 @@ of a DNS-server (started by calling `captdnsInit()`) resolving all hostnames int
111111
ESP8266/ESP32. These redirect functions can then be used to further redirect the client to the hostname of
112112
the ESP8266/ESP32.
113113

114-
* Flash updating functions (OTA) - see [README-flash_api](./README-flash_api.md)
114+
* __Flash updating functions (OTA)__ - see [README-flash_api](./README-flash_api.md)
115115

116-
* __cgiWiFi* functions__ (arg: various)
117-
These are used to change WiFi mode, scan for access points, associate to an access point etcetera. See
118-
the example projects for an implementation that uses this function call. [FreeRTOS Example](https://github.com/chmorgan/esphttpd-freertos)
116+
* __WiFi settings functions__ - see [README-wifi_api.md](./README-wifi_api.md)
119117

120118
* __cgiWebsocket__ (arg: connect function)
121119
This CGI is used to set up a websocket. Websockets are described later in this document. See

‎include/libesphttpd/cgi_common.h

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
/* Functions commonly used in cgi handlers for libesphttpd */
2+
3+
#ifndef CGI_COMMON_H
4+
#define CGI_COMMON_H
5+
6+
#include "libesphttpd/httpd.h"
7+
#include "cJSON.h"
8+
9+
// Parses *allArgs (i.e. connData->getArgs or connData->post.buff) for a signed integer by name of *argName and returns int value at *pvalue.
10+
bool cgiGetArgDecS32(const char *allArgs, const char *argName, int *pvalue, char *buff, int buffLen);
11+
// Parses *allArgs (i.e. connData->getArgs or connData->post.buff) for a unsigned int (i.e. ?uintval=123)
12+
bool cgiGetArgDecU32(const char *allArgs, const char *argName, uint32_t *pvalue, char *buff, int buffLen);
13+
// Parses *allArgs (i.e. connData->getArgs or connData->post.buff) for a uint32_t from a hexadecimal string (i.e. ?hexval=0123ABCD )
14+
bool cgiGetArgHexU32(const char *allArgs, const char *argName, uint32_t *pvalue, char *buff, int buffLen);
15+
// Parses *allArgs (i.e. connData->getArgs or connData->post.buff) for a string value. (just a wrapper for httpdFindArg())
16+
bool cgiGetArgString(const char *allArgs, const char *argName, char *buff, int buffLen);
17+
18+
19+
void cgiJsonResponseHeaders(HttpdConnData *connData);
20+
void cgiJavascriptResponseHeaders(HttpdConnData *connData);
21+
22+
/**
23+
* Example usage of cgiJsonResponseCommonMulti for multipart json response (i.e. larger than 1kB)
24+
*
25+
CgiStatus cgiFn(HttpdConnData *connData)
26+
{
27+
cJSON *jsroot = NULL;
28+
if (connData->cgiData == NULL)
29+
{
30+
//First call to this cgi.
31+
jsroot = cJSON_CreateObject();
32+
...
33+
cgiJsonResponseHeaders(connData);
34+
}
35+
return cgiJsonResponseCommonMulti(connData, &connData->cgiData, jsroot); // Send the json response!
36+
}
37+
*/
38+
CgiStatus cgiJsonResponseCommonMulti(HttpdConnData *connData, void **statepp, cJSON *jsroot);
39+
CgiStatus cgiJsonResponseCommonSingle(HttpdConnData *connData, cJSON *jsroot);
40+
41+
CgiStatus cgiJavascriptResponseCommon(HttpdConnData *connData, cJSON *jsroot, const char *jsObjName);
42+
43+
#endif //CGI_COMMON_H

‎include/libesphttpd/cgiwifi.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ CgiStatus cgiWiFiConnStatus(HttpdConnData *connData);
1414
#ifdef ESP32
1515
#include <esp_event.h>
1616
esp_err_t initCgiWifi(void);
17-
void cgiWifiEventCb(system_event_t *event);
17+
esp_err_t startCgiWifi(void);
1818
CgiStatus cgiWiFiStartWps(HttpdConnData *connData);
1919
#endif
2020

‎util/captdns.c

+3-9
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ static const char* TAG = "captdns";
2121
#include "freertos/FreeRTOS.h"
2222
#include "freertos/task.h"
2323
#include "freertos/queue.h"
24-
#include "tcpip_adapter.h"
24+
#include "esp_netif.h"
2525
#else
2626
#include "FreeRTOS.h"
2727
#include "task.h"
@@ -234,8 +234,8 @@ static void ICACHE_FLASH_ATTR captdnsRecv(struct sockaddr_in *premote_addr, char
234234
setn16(&rf->rdlength, 4); //IPv4 addr is 4 bytes;
235235
//Grab the current IP of the softap interface
236236
#ifdef ESP32
237-
tcpip_adapter_ip_info_t info;
238-
tcpip_adapter_get_ip_info(TCPIP_ADAPTER_IF_AP, &info);
237+
esp_netif_ip_info_t info;
238+
esp_netif_get_ip_info(esp_netif_get_handle_from_ifkey("WIFI_AP_DEF"), &info);
239239
#else
240240
struct ip_info info;
241241
wifi_get_ip_info(SOFTAP_IF, &info);
@@ -301,13 +301,7 @@ static void captdnsTask(void *pvParameters) {
301301
int32 ret;
302302
struct sockaddr_in from;
303303
socklen_t fromlen;
304-
#ifdef ESP32
305-
tcpip_adapter_ip_info_t ipconfig;
306-
#else
307-
struct ip_info ipconfig;
308-
#endif
309304

310-
memset(&ipconfig, 0, sizeof(ipconfig));
311305
memset(&server_addr, 0, sizeof(server_addr));
312306
server_addr.sin_family = AF_INET;
313307
server_addr.sin_addr.s_addr = INADDR_ANY;

0 commit comments

Comments
 (0)