Skip to content
This repository was archived by the owner on Feb 4, 2023. It is now read-only.

Commit 6de53c5

Browse files
authored
v2.4.0 for ESP32 using LwIP Ethernet
### Releases v2.4.0 1. Initial coding to port [AsyncHTTPSRequest_Generic](https://github.com/khoih-prog/AsyncHTTPSRequest_Generic) to `ESP32/S2/S3/C3` boards using `LwIP W5500 / ENC28J60 / LAN8720 Ethernet` 2. Use `allman astyle` 3. Sync with [AsyncHTTPSRequest_Generic v2.4.0](https://github.com/khoih-prog/AsyncHTTPSRequest_Generic)
1 parent 999fd18 commit 6de53c5

26 files changed

+4730
-4
lines changed

.codespellrc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# See: https://github.com/codespell-project/codespell#using-a-config-file
2+
[codespell]
3+
# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
4+
ignore-words-list = ,
5+
check-filenames =
6+
check-hidden =
7+
skip = ./.git,./src,./examples,./Packages_Patches,./LibraryPatches

CONTRIBUTING.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
## Contributing to AsyncHTTPSRequest_ESP32_Ethernet
2+
3+
### Reporting Bugs
4+
5+
Please report bugs in [AsyncHTTPSRequest_ESP32_Ethernet](https://github.com/khoih-prog/AsyncHTTPSRequest_ESP32_Ethernet/issues/new) if you find them.
6+
7+
However, before reporting a bug please check through the following:
8+
9+
* [Existing Open Issues](https://github.com/khoih-prog/AsyncHTTPSRequest_ESP32_Ethernet/issues) - someone might have already encountered this.
10+
11+
If you don't find anything, please [open a new issue](https://github.com/khoih-prog/AsyncHTTPSRequest_ESP32_Ethernet/issues/new).
12+
13+
### How to submit a bug report
14+
15+
Please ensure to specify the following:
16+
17+
* Arduino IDE version (e.g. 1.8.19) or Platform.io version
18+
* Board Type (e.g. ESP32S3_DEV, ESP32S2_DEV, ESP32C3_DEV)
19+
* Board Core Version (e.g. ESP32 core v2.0.5)
20+
* Contextual information (e.g. what you were trying to achieve)
21+
* Simplest possible steps to reproduce
22+
* Anything that might be relevant in your opinion, such as:
23+
* Operating system (Windows, Ubuntu, etc.) and the output of `uname -a`
24+
* Network configuration
25+
26+
27+
Please be educated, civilized and constructive. Disrespective posts against [GitHub Code of Conduct](https://docs.github.com/en/site-policy/github-terms/github-event-code-of-conduct) will be ignored and deleted.
28+
29+
30+
### Example
31+
32+
```
33+
Arduino IDE version: 1.8.19
34+
ESP32S3_DEV board
35+
ESP32 core v2.0.5
36+
OS: Ubuntu 20.04 LTS
37+
Linux xy-Inspiron-3593 5.15.0-56-generic #62~20.04.1-Ubuntu SMP Tue Nov 22 21:24:20 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
38+
39+
Context:
40+
I encountered a crash while using this library
41+
Steps to reproduce:
42+
1. ...
43+
2. ...
44+
3. ...
45+
4. ...
46+
```
47+
48+
### Additional context
49+
50+
Add any other context about the problem here.
51+
52+
---
53+
54+
### Sending Feature Requests
55+
56+
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
57+
58+
There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/AsyncHTTPSRequest_ESP32_Ethernet/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
59+
60+
---
61+
62+
### Sending Pull Requests
63+
64+
Pull Requests with changes and fixes are also welcome!
65+
66+
Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
67+
68+
1. Change directory to the library GitHub
69+
70+
```
71+
xy@xy-Inspiron-3593:~$ cd Arduino/xy/AsyncHTTPSRequest_ESP32_Ethernet_GitHub/
72+
xy@xy-Inspiron-3593:~/Arduino/xy/AsyncHTTPSRequest_ESP32_Ethernet_GitHub$
73+
```
74+
75+
2. Issue astyle command
76+
77+
```
78+
xy@xy-Inspiron-3593:~/Arduino/xy/AsyncHTTPSRequest_ESP32_Ethernet_GitHub$ bash utils/restyle.sh
79+
```
80+
81+
82+

Images/ENC28J60.png

140 KB
Loading

Images/ESP32S3_DEV.png

294 KB
Loading

Images/W5500.png

209 KB
Loading

Images/W5500_small.png

96 KB
Loading

LICENSE

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
GNU GENERAL PUBLIC LICENSE
22
Version 3, 29 June 2007
33

4-
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
55
Everyone is permitted to copy and distribute verbatim copies
66
of this license document, but changing it is not allowed.
77

@@ -645,7 +645,7 @@ the "copyright" line and a pointer to where the full notice is found.
645645
GNU General Public License for more details.
646646

647647
You should have received a copy of the GNU General Public License
648-
along with this program. If not, see <https://www.gnu.org/licenses/>.
648+
along with this program. If not, see <http://www.gnu.org/licenses/>.
649649

650650
Also add information on how to contact you by electronic and paper mail.
651651

@@ -664,11 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
664664
You should also get your employer (if you work as a programmer) or school,
665665
if any, to sign a "copyright disclaimer" for the program, if necessary.
666666
For more information on this, and how to apply and follow the GNU GPL, see
667-
<https://www.gnu.org/licenses/>.
667+
<http://www.gnu.org/licenses/>.
668668

669669
The GNU General Public License does not permit incorporating your program
670670
into proprietary programs. If your program is a subroutine library, you
671671
may consider it more useful to permit linking proprietary applications with
672672
the library. If this is what you want to do, use the GNU Lesser General
673673
Public License instead of this License. But first, please read
674-
<https://www.gnu.org/licenses/why-not-lgpl.html>.
674+
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

changelog.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# AsyncHTTPSRequest_ESP32_Ethernet Library
2+
3+
[![arduino-library-badge](https://www.ardu-badge.com/badge/AsyncHTTPSRequest_ESP32_Ethernet.svg?)](https://www.ardu-badge.com/AsyncHTTPSRequest_ESP32_Ethernet)
4+
[![GitHub release](https://img.shields.io/github/release/khoih-prog/AsyncHTTPSRequest_ESP32_Ethernet.svg)](https://github.com/khoih-prog/AsyncHTTPSRequest_ESP32_Ethernet/releases)
5+
[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/khoih-prog/AsyncHTTPSRequest_ESP32_Ethernet/blob/main/LICENSE)
6+
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
7+
[![GitHub issues](https://img.shields.io/github/issues/khoih-prog/AsyncHTTPSRequest_ESP32_Ethernet.svg)](http://github.com/khoih-prog/AsyncHTTPSRequest_ESP32_Ethernet/issues)
8+
9+
10+
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Donate to my libraries using BuyMeACoffee" style="height: 50px !important;width: 181px !important;" ></a>
11+
<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="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>
12+
13+
14+
---
15+
---
16+
17+
## Table of Contents
18+
19+
* [Changelog](#changelog)
20+
* [Releases v2.4.0](#releases-v240)
21+
22+
---
23+
---
24+
25+
## Changelog
26+
27+
### Releases v2.4.0
28+
29+
1. Initial coding to port [AsyncHTTPSRequest_Generic](https://github.com/khoih-prog/AsyncHTTPSRequest_Generic) to `ESP32/S2/S3/C3` boards using `LwIP W5500 / ENC28J60 / LAN8720 Ethernet`
30+
2. Use `allman astyle`
31+
3. Sync with [AsyncHTTPSRequest_Generic v2.4.0](https://github.com/khoih-prog/AsyncHTTPSRequest_Generic)
32+
33+

0 commit comments

Comments
 (0)