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 Jan 29, 2023. It is now read-only.
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+23-4
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
-
*`ArduinoCore-mbed` Core Version (e.g. `ArduinoCore-mbed` mbed_portenta core v3.0.1)
18
+
*`ArduinoCore-mbed` Core Version (e.g. `ArduinoCore-mbed` mbed_portenta core v3.4.1)
19
19
*`Portenta_H7` Board type (e.g. Portenta_H7 Rev2 ABX00042, etc.)
20
20
* Contextual information (e.g. what you were trying to achieve)
21
21
* Simplest possible steps to reproduce
@@ -28,13 +28,13 @@ Please ensure to specify the following:
28
28
29
29
```
30
30
Arduino IDE version: 1.8.19
31
-
`ArduinoCore-mbed` mbed_portenta core v3.0.1
31
+
`ArduinoCore-mbed` mbed_portenta core v3.4.1
32
32
Portenta_H7 Rev2 ABX00042
33
33
OS: Ubuntu 20.04 LTS
34
-
Linux xy-Inspiron-3593 5.13.0-40-generic #45~20.04.1-Ubuntu SMP Mon Apr 4 09:38:31 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
34
+
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
35
35
36
36
Context:
37
-
I encountered a crash while using TimerInterrupt.
37
+
I encountered a crash while trying to use the library
38
38
39
39
Steps to reproduce:
40
40
1. ...
@@ -43,14 +43,33 @@ Steps to reproduce:
43
43
4. ...
44
44
```
45
45
46
+
---
46
47
47
48
### Sending Feature Requests
48
49
49
50
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
50
51
51
52
There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/WiFiManager_Portenta_H7_Lite/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
52
53
54
+
---
55
+
53
56
### Sending Pull Requests
54
57
55
58
Pull Requests with changes and fixes are also welcome!
56
59
60
+
Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
61
+
62
+
1. Change directory to the library GitHub
63
+
64
+
```
65
+
xy@xy-Inspiron-3593:~$ cd Arduino/xy/WiFiManager_Portenta_H7_Lite_GitHub/
Copy file name to clipboardexpand all lines: README.md
+31-29
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>
@@ -128,7 +130,7 @@ The current `mbed_portenta core v2.6.1` has bug that once WiFi is connected and
128
130
129
131
The current fix for this bug is to use `WiFi.end()` before `WiFi.begin()`, such as
130
132
131
-
```
133
+
```cpp
132
134
// Must have to reconnect after WiFi lost
133
135
WiFi.end();
134
136
@@ -206,12 +208,12 @@ This [**WiFiManager_Portenta_H7_Lite** library](https://github.com/khoih-prog/Wi
206
208
## Prerequisites
207
209
208
210
1.[`Arduino IDE 1.8.19+` for Arduino](https://github.com/arduino/Arduino). [](https://github.com/arduino/Arduino/releases/latest)
209
-
2.[`ArduinoCore-mbed mbed_portenta core 3.0.1+`](https://github.com/arduino/ArduinoCore-mbed) for Arduino **Portenta_H7** boards, such as **Portenta_H7 Rev2 ABX00042, etc.**. [](https://github.com/arduino/ArduinoCore-mbed/releases/latest)
211
+
2.[`ArduinoCore-mbed mbed_portenta core 3.4.1+`](https://github.com/arduino/ArduinoCore-mbed) for Arduino **Portenta_H7** boards, such as **Portenta_H7 Rev2 ABX00042, etc.**. [](https://github.com/arduino/ArduinoCore-mbed/releases/latest)
210
212
3.[`Functional-Vlpp library v1.0.2+`](https://github.com/khoih-prog/functional-vlpp) to use server's lambda function. To install. check [](https://www.ardu-badge.com/Functional-Vlpp)
211
-
4.[`WiFiWebServer library v1.8.0+`](https://github.com/khoih-prog/WiFiWebServer). To install. check [](https://www.ardu-badge.com/WiFiWebServer)
212
-
5.[`LittleFS_Portenta_H7 v1.1.0+`](https://github.com/khoih-prog/LittleFS_Portenta_H7). To install, check [](https://www.ardu-badge.com/LittleFS_Portenta_H7)
213
+
4.[`WiFiWebServer library v1.10.0+`](https://github.com/khoih-prog/WiFiWebServer). To install. check [](https://www.ardu-badge.com/WiFiWebServer)
214
+
5.[`LittleFS_Portenta_H7 v1.2.0+`](https://github.com/khoih-prog/LittleFS_Portenta_H7). To install, check [](https://www.ardu-badge.com/LittleFS_Portenta_H7)
213
215
6.[`DoubleResetDetector_Generic v1.8.1+`](https://github.com/khoih-prog/DoubleResetDetector_Generic). To install, check [](https://www.ardu-badge.com/DoubleResetDetector_Generic)
214
-
7.[`WiFiMulti_Generic library v1.1.1+`](https://github.com/khoih-prog/WiFiMulti_Generic) to use WiFiMulti function. To install, check [](https://www.ardu-badge.com/WiFiMulti_Generic). **New**
216
+
7.[`WiFiMulti_Generic library v1.2.2+`](https://github.com/khoih-prog/WiFiMulti_Generic) to use WiFiMulti function. To install, check [](https://www.ardu-badge.com/WiFiMulti_Generic). **New**
215
217
216
218
---
217
219
@@ -244,12 +246,12 @@ You can also use this link [**, you have to copy the file [portenta_post_install.sh](Packages_Patches/arduino/hardware/mbed_portenta/3.0.1/portenta_post_install.sh) into mbed_portenta directory (~/.arduino15/packages/arduino/hardware/mbed_portenta/3.0.1/portenta_post_install.sh).
249
+
**To be able to upload firmware to Portenta_H7 using Arduino IDE in Linux (Ubuntu, etc.)**, you have to copy the file [portenta_post_install.sh](Packages_Patches/arduino/hardware/mbed_portenta/3.4.1/portenta_post_install.sh) into mbed_portenta directory (~/.arduino15/packages/arduino/hardware/mbed_portenta/3.4.1/portenta_post_install.sh).
248
250
249
251
Then run the following command using `sudo`
250
252
251
253
```
252
-
$ cd ~/.arduino15/packages/arduino/hardware/mbed_portenta/3.0.1
254
+
$ cd ~/.arduino15/packages/arduino/hardware/mbed_portenta/3.4.1
253
255
$ chmod 755 portenta_post_install.sh
254
256
$ sudo ./portenta_post_install.sh
255
257
```
@@ -262,9 +264,9 @@ This will create the file `/etc/udev/rules.d/49-portenta_h7.rules` as follows:
@@ -457,7 +459,7 @@ Once Credentials / WiFi network information is saved in the host non-volatile me
457
459
458
460
#### 11.1 If you need to use and input only one set of WiFi SSID/PWD
459
461
460
-
```
462
+
```cpp
461
463
// Permit input only one set of WiFi SSID/PWD. The other can be "NULL or "blank"
462
464
// Default is false (if not defined) => must input 2 sets of SSID/PWD
463
465
#define REQUIRE_ONE_SET_SSID_PW true
@@ -466,7 +468,7 @@ But it's always advisable to use and input both sets for reliability.
466
468
467
469
#### 11.2 If you need to use both sets of WiFi SSID/PWD
468
470
469
-
```
471
+
```cpp
470
472
// Permit input only one set of WiFi SSID/PWD. The other can be "NULL or "blank"
471
473
// Default is false (if not defined) => must input 2 sets of SSID/PWD
472
474
#defineREQUIRE_ONE_SET_SSID_PW false
@@ -477,15 +479,15 @@ But it's always advisable to use and input both sets for reliability.
477
479
#### 12.1 Enable auto-scan of WiFi networks for selection in Configuration Portal
478
480
479
481
480
-
```
482
+
```cpp
481
483
#defineSCAN_WIFI_NETWORKS true
482
484
```
483
485
484
486
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.
485
487
486
488
#### 12.2 Disable manually input SSIDs
487
489
488
-
```
490
+
```cpp
489
491
// To disable manually input SSID, only from a scanned SSID lists
490
492
#defineMANUAL_SSID_INPUT_ALLOWED false
491
493
```
@@ -497,7 +499,7 @@ This is for normal use-cases in which users can only select an SSID from a scann
497
499
The maximum number of SSIDs in the list is selectable from 2 to 15 (for ESP8266/ESP32-AT shields, from 2-6). If invalid number of SSIDs is selected, the default number of 10 will be used.
498
500
499
501
500
-
```
502
+
```cpp
501
503
// From 2-15
502
504
#defineMAX_SSID_IN_LIST 8
503
505
```
@@ -515,7 +517,7 @@ To use, uncomment in `defines.h`.
515
517
516
518
Check [retries block the main loop #18](https://github.com/khoih-prog/WiFiManager_NINA_Lite/issues/18#issue-1094004380)
517
519
518
-
```
520
+
```cpp
519
521
#defineMAX_NUM_WIFI_RECON_TRIES_PER_LOOP 2
520
522
```
521
523
@@ -529,7 +531,7 @@ Only use whenever urgent tasks in loop() can't be delayed. But if so, it's bette
529
531
530
532
Check [retries block the main loop #18](https://github.com/khoih-prog/WiFiManager_NINA_Lite/issues/18#issuecomment-1006197561)
531
533
532
-
```
534
+
```cpp
533
535
#defineWIFI_RECON_INTERVAL 30000 // 30s
534
536
```
535
537
@@ -598,7 +600,7 @@ See this example and modify as necessary
598
600
599
601
#### 1. To always load [Default Credentials](examples/Portenta_H7_WiFi/Credentials.h) and override Config Portal data
600
602
601
-
```
603
+
```cpp
602
604
// Used mostly for development and debugging. FORCES default values to be loaded each run.
603
605
// 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