You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 4, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+24-3Lines changed: 24 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ If you don't find anything, please [open a new issue](https://github.com/khoih-p
15
15
Please ensure to specify the following:
16
16
17
17
* Arduino IDE version (e.g. 1.8.19) or Platform.io version
18
-
*`ESP8266` or `ESP32` Core Version (e.g. ESP8266 core v3.0.2 or ESP32 v2.0.4)
18
+
*`ESP8266` or `ESP32` Core Version (e.g. ESP8266 core v3.0.2 or ESP32 v2.0.5)
19
19
* Contextual information (e.g. what you were trying to achieve)
20
20
* Simplest possible steps to reproduce
21
21
* Anything that might be relevant in your opinion, such as:
@@ -29,10 +29,10 @@ Please ensure to specify the following:
29
29
Arduino IDE version: 1.8.19
30
30
ESP8266 Core Version 3.0.2
31
31
OS: Ubuntu 20.04 LTS
32
-
Linux xy-Inspiron-3593 5.15.0-46-generic #49~20.04.1-Ubuntu SMP Thu Aug 4 19:15:44 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
32
+
Linux xy-Inspiron-3593 5.15.0-52-generic #58~20.04.1-Ubuntu SMP Thu Oct 13 13:09:46 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
33
33
34
34
Context:
35
-
The board couldn't autoreconnect to Local Blynk Server after router power recycling.
35
+
I encountered a crash while trying to use the library
36
36
37
37
Steps to reproduce:
38
38
1. ...
@@ -41,12 +41,33 @@ Steps to reproduce:
41
41
4. ...
42
42
```
43
43
44
+
---
45
+
44
46
### Sending Feature Requests
45
47
46
48
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
47
49
48
50
There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/ESP_WiFiManager_Lite/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
49
51
52
+
---
53
+
50
54
### Sending Pull Requests
51
55
52
56
Pull Requests with changes and fixes are also welcome!
57
+
58
+
Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
59
+
60
+
1. Change directory to the library GitHub
61
+
62
+
```
63
+
xy@xy-Inspiron-3593:~$ cd Arduino/xy/ESP_WiFiManager_Lite_GitHub/
Copy file name to clipboardExpand all lines: README.md
+26-24Lines changed: 26 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,8 @@
8
8
9
9
<ahref="https://www.buymeacoffee.com/khoihprog6"title="Donate to my libraries using BuyMeACoffee"><imgsrc="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png"alt="Donate to my libraries using BuyMeACoffee"style="height: 50px!important;width: 181px!important;" ></a>
10
10
<ahref="https://www.buymeacoffee.com/khoihprog6"title="Donate to my libraries using BuyMeACoffee"><imgsrc="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00"style="height: 20px!important;width: 200px!important;" ></a>
@@ -169,10 +171,10 @@ This [**ESP_WiFiManager_Lite** library](https://github.com/khoih-prog/ESP_WiFiMa
169
171
## Prerequisites
170
172
171
173
1.[`Arduino IDE 1.8.19+` for Arduino](https://github.com/arduino/Arduino). [](https://github.com/arduino/Arduino/releases/latest)
172
-
2.[`ESP32 Core 2.0.4+`](https://github.com/espressif/arduino-esp32) for ESP32-based boards. [](https://github.com/espressif/arduino-esp32/releases/latest/)
174
+
2.[`ESP32 Core 2.0.5+`](https://github.com/espressif/arduino-esp32) for ESP32-based boards. [](https://github.com/espressif/arduino-esp32/releases/latest/)
173
175
3.[`ESP8266 Core 3.0.2+`](https://github.com/esp8266/Arduino) for ESP8266-based boards. [](https://github.com/esp8266/Arduino/releases/latest/). SPIFFS is deprecated from ESP8266 core 2.7.1+, to use LittleFS.
174
-
4.[`ESP_DoubleResetDetector v1.3.1+`](https://github.com/khoih-prog/ESP_DoubleResetDetector) if using DRD feature. To install, check [](https://www.ardu-badge.com/ESP_DoubleResetDetector).
175
-
5.[`ESP_MultiResetDetector v1.3.1+`](https://github.com/khoih-prog/ESP_MultiResetDetector) if using MRD feature. To install, check [](https://www.ardu-badge.com/ESP_MultiResetDetector).
176
+
4.[`ESP_DoubleResetDetector v1.3.2+`](https://github.com/khoih-prog/ESP_DoubleResetDetector) if using DRD feature. To install, check [](https://www.ardu-badge.com/ESP_DoubleResetDetector).
177
+
5.[`ESP_MultiResetDetector v1.3.2+`](https://github.com/khoih-prog/ESP_MultiResetDetector) if using MRD feature. To install, check [](https://www.ardu-badge.com/ESP_MultiResetDetector).
176
178
6.[`LittleFS_esp32 v1.0.6+`](https://github.com/lorol/LITTLEFS) for ESP32-based boards using LittleFS with ESP32 core **v1.0.5-**. To install, check [](https://www.ardu-badge.com/LittleFS_esp32). **Notice**: This [`LittleFS_esp32 library`](https://github.com/lorol/LITTLEFS) has been integrated to Arduino [ESP32 core v1.0.6+](https://github.com/espressif/arduino-esp32/tree/master/libraries/LITTLEFS) and **you don't need to install it if using ESP32 core v1.0.6+**
177
179
178
180
---
@@ -214,13 +216,13 @@ In Platform IO, to fix the error when using [`LittleFS_esp32 v1.0`](https://gith
214
216
215
217
from
216
218
217
-
```
219
+
```cpp
218
220
//#define CONFIG_LITTLEFS_FOR_IDF_3_2 /* For old IDF - like in release 1.0.4 */
219
221
```
220
222
221
223
to
222
224
223
-
```
225
+
```cpp
224
226
#defineCONFIG_LITTLEFS_FOR_IDF_3_2 /* For old IDF - like in release 1.0.4 */
@@ -455,7 +457,7 @@ Once Credentials / WiFi network information is saved in the host non-volatile me
455
457
456
458
#### 11.1 If you need to use and input only one set of WiFi SSID/PWD
457
459
458
-
```
460
+
```cpp
459
461
// Permit input only one set of WiFi SSID/PWD. The other can be "NULL or "blank"
460
462
// Default is false (if not defined) => must input 2 sets of SSID/PWD
461
463
#define REQUIRE_ONE_SET_SSID_PW true
@@ -464,7 +466,7 @@ But it's always advisable to use and input both sets for reliability.
464
466
465
467
#### 11.2 If you need to use both sets of WiFi SSID/PWD
466
468
467
-
```
469
+
```cpp
468
470
// Permit input only one set of WiFi SSID/PWD. The other can be "NULL or "blank"
469
471
// Default is false (if not defined) => must input 2 sets of SSID/PWD
470
472
#defineREQUIRE_ONE_SET_SSID_PW false
@@ -475,15 +477,15 @@ But it's always advisable to use and input both sets for reliability.
475
477
#### 12.1 Enable auto-scan of WiFi networks for selection in Configuration Portal
476
478
477
479
478
-
```
480
+
```cpp
479
481
#defineSCAN_WIFI_NETWORKS true
480
482
```
481
483
482
484
The manual input of SSIDs is default enabled, so that users can input arbitrary SSID, not only from the scanned list. This is for the sample use-cases in which users can input the known SSIDs of another place, then send the boards to that place. The boards can connect to WiFi without users entering Config Portal to re-configure.
483
485
484
486
#### 12.2 Disable manually input SSIDs
485
487
486
-
```
488
+
```cpp
487
489
// To disable manually input SSID, only from a scanned SSID lists
488
490
#defineMANUAL_SSID_INPUT_ALLOWED false
489
491
```
@@ -495,7 +497,7 @@ This is for normal use-cases in which users can only select an SSID from a scann
495
497
The maximum number of SSIDs in the list is seletable from 2 to 15. If invalid number of SSIDs is selected, the default number of 10 will be used.
496
498
497
499
498
-
```
500
+
```cpp
499
501
// From 2-15
500
502
#defineMAX_SSID_IN_LIST 8
501
503
```
@@ -512,7 +514,7 @@ To use, uncomment in `defines.h`.
512
514
513
515
Check [retries block the main loop #18](https://github.com/khoih-prog/WiFiManager_NINA_Lite/issues/18#issue-1094004380)
514
516
515
-
```
517
+
```cpp
516
518
#defineMAX_NUM_WIFI_RECON_TRIES_PER_LOOP 2
517
519
```
518
520
@@ -526,7 +528,7 @@ Only use whenever urgent tasks in loop() can't be delayed. But if so, it's bette
526
528
527
529
Check [retries block the main loop #18](https://github.com/khoih-prog/WiFiManager_NINA_Lite/issues/18#issuecomment-1006197561)
528
530
529
-
```
531
+
```cpp
530
532
#defineWIFI_RECON_INTERVAL 30000 // 30s
531
533
```
532
534
@@ -608,7 +610,7 @@ See this example and modify as necessary
608
610
609
611
#### 1. To always load [Default Credentials](examples//Credentials.h) and override Config Portal data
610
612
611
-
```
613
+
```cpp
612
614
// Used mostly for development and debugging. FORCES default values to be loaded each run.
613
615
// Config Portal data input will be ignored and overridden by DEFAULT_CONFIG_DATA
<ahref="https://www.buymeacoffee.com/khoihprog6"title="Donate to my libraries using BuyMeACoffee"><imgsrc="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png"alt="Donate to my libraries using BuyMeACoffee"style="height: 50px!important;width: 181px!important;" ></a>
10
+
<ahref="https://www.buymeacoffee.com/khoihprog6"title="Donate to my libraries using BuyMeACoffee"><imgsrc="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00"style="height: 20px!important;width: 200px!important;" ></a>
0 commit comments