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

Commit e5c4b66

Browse files
authored
v1.0.0 for ESP32_S3 + LwIP ENC28J60
1. Initial coding to port [ESPAsync_WiFiManager](https://github.com/khoih-prog/ESPAsync_WiFiManager) to ESP32_S3 boards using `LwIP ENC28J60 Ethernet`. 2. Use `allman astyle`
1 parent 04c1e49 commit e5c4b66

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+10889
-0
lines changed

.codespellrc

+7
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

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
## Contributing to AsyncESP32_SC_ENC_Manager
2+
3+
### Reporting Bugs
4+
5+
Please report bugs in AsyncESP32_SC_ENC_Manager 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/AsyncESP32_SC_ENC_Manager/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/AsyncESP32_SC_ENC_Manager/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/AsyncESP32_SC_ENC_Manager/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/AsyncESP32_SC_ENC_Manager_GitHub/
72+
xy@xy-Inspiron-3593:~/Arduino/xy/AsyncESP32_SC_ENC_Manager_GitHub$
73+
```
74+
75+
2. Issue astyle command
76+
77+
```
78+
xy@xy-Inspiron-3593:~/Arduino/xy/AsyncESP32_SC_ENC_Manager_GitHub$ bash utils/restyle.sh
79+
```
80+

Images/Configuration_Standard.png

16.8 KB
Loading

Images/ENC28J60.png

140 KB
Loading

Images/ESP32S3_DEV.png

294 KB
Loading

Images/Info.png

69.9 KB
Loading

Images/Main.png

12.9 KB
Loading

Images/Saved.png

2.42 KB
Loading

changelog.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# AsyncESP32_SC_ENC_Manager Library
2+
3+
[![arduino-library-badge](https://www.ardu-badge.com/badge/AsyncESP32_SC_ENC_Manager.svg?)](https://www.ardu-badge.com/AsyncESP32_SC_ENC_Manager)
4+
[![GitHub release](https://img.shields.io/github/release/khoih-prog/AsyncESP32_SC_ENC_Manager.svg)](https://github.com/khoih-prog/AsyncESP32_SC_ENC_Manager/releases)
5+
[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/khoih-prog/AsyncESP32_SC_ENC_Manager/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/AsyncESP32_SC_ENC_Manager.svg)](http://github.com/khoih-prog/AsyncESP32_SC_ENC_Manager/issues)
8+
9+
<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>
10+
<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>
11+
12+
13+
---
14+
---
15+
16+
## Table of contents
17+
18+
* [Changelog](#changelog)
19+
* [Releases v1.0.0](#releases-v100)
20+
21+
22+
23+
---
24+
---
25+
26+
## Changelog
27+
28+
#### Releases v1.0.0
29+
30+
1. Initial coding to port [ESPAsync_WiFiManager](https://github.com/khoih-prog/ESPAsync_WiFiManager) to ESP32_S3 boards using `LwIP ENC28J60 Ethernet`.
31+
2. Use `allman astyle`
32+
33+

0 commit comments

Comments
 (0)