v1.0.0 for ESP32 + LwIP W5500 / ENC28J60

#### Releases v1.0.0 1. Initial coding to port `synchronous` [ESP_WiFiManager](https://github.com/khoih-prog/ESP_WiFiManager) to ESP32 boards using `LwIP W5500 / ENC28J60 Ethernet` 2. Use `allman astyle`
khoih-prog · Dec 13, 2022 · 04a739f · 04a739f
1 parent 3f2f46f
commit 04a739f
Show file tree

Hide file tree

Showing 50 changed files with 11,922 additions and 0 deletions.
diff --git a/.codespellrc b/.codespellrc
@@ -0,0 +1,7 @@
+# See: https://github.com/codespell-project/codespell#using-a-config-file
+[codespell]
+# In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here:
+ignore-words-list = ,
+check-filenames =
+check-hidden =
+skip = ./.git,./src,./examples,./Packages_Patches,./LibraryPatches
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,79 @@
+## Contributing to ESP32_Ethernet_Manager
+
+### Reporting Bugs
+
+Please report bugs in ESP32_Ethernet_Manager if you find them.
+
+However, before reporting a bug please check through the following:
+
+* [Existing Open Issues](https://github.com/khoih-prog/ESP32_Ethernet_Manager/issues) - someone might have already encountered this.
+
+If you don't find anything, please [open a new issue](https://github.com/khoih-prog/ESP32_Ethernet_Manager/issues/new).
+
+### How to submit a bug report
+
+Please ensure to specify the following:
+
+* Arduino IDE version (e.g. 1.8.19) or Platform.io version
+* Board Core Version (e.g. ESP32 core v2.0.5)
+* Contextual information (e.g. what you were trying to achieve)
+* Simplest possible steps to reproduce
+* Anything that might be relevant in your opinion, such as:
+  * Operating system (Windows, Ubuntu, etc.) and the output of `uname -a`
+  * Network configuration
+
+
+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.
+
+
+### Example
+
+```
+Arduino IDE version: 1.8.19
+ESP32_DEV board
+ESP32 core v2.0.5
+OS: Ubuntu 20.04 LTS
+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
+
+Context:
+I encountered a crash while using this library
+Steps to reproduce:
+1. ...
+2. ...
+3. ...
+4. ...
+```
+
+### Additional context
+
+Add any other context about the problem here.
+
+---
+
+### Sending Feature Requests
+
+Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
+
+There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/ESP32_Ethernet_Manager/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
+
+---
+
+### Sending Pull Requests
+
+Pull Requests with changes and fixes are also welcome!
+
+Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
+
+1. Change directory to the library GitHub
+
+```
+xy@xy-Inspiron-3593:~$ cd Arduino/xy/ESP32_Ethernet_Manager_GitHub/
+xy@xy-Inspiron-3593:~/Arduino/xy/ESP32_Ethernet_Manager_GitHub$
+```
+
+2. Issue astyle command
+
+```
+xy@xy-Inspiron-3593:~/Arduino/xy/ESP32_Ethernet_Manager_GitHub$ bash utils/restyle.sh
+```
+
diff --git a/Images/Configuration_AIO_MQTT.png b/Images/Configuration_AIO_MQTT.png
diff --git a/Images/Configuration_Standard.png b/Images/Configuration_Standard.png
diff --git a/Images/ENC28J60.png b/Images/ENC28J60.png
diff --git a/Images/Info.png b/Images/Info.png
diff --git a/Images/Main.png b/Images/Main.png
diff --git a/Images/Saved.png b/Images/Saved.png
diff --git a/Images/W5500.png b/Images/W5500.png
diff --git a/Images/W5500_small.png b/Images/W5500_small.png
diff --git a/changelog.md b/changelog.md
@@ -0,0 +1,33 @@
+# ESP32_Ethernet_Manager Library
+
+[![arduino-library-badge](https://www.ardu-badge.com/badge/ESP32_Ethernet_Manager.svg?)](https://www.ardu-badge.com/ESP32_Ethernet_Manager)
+[![GitHub release](https://img.shields.io/github/release/khoih-prog/ESP32_Ethernet_Manager.svg)](https://github.com/khoih-prog/ESP32_Ethernet_Manager/releases)
+[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/khoih-prog/ESP32_Ethernet_Manager/blob/main/LICENSE)
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
+[![GitHub issues](https://img.shields.io/github/issues/khoih-prog/ESP32_Ethernet_Manager.svg)](http://github.com/khoih-prog/ESP32_Ethernet_Manager/issues)
+
+<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>
+<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>
+
+
+---
+---
+
+## Table of contents
+
+* [Changelog](#changelog)
+  * [Releases v1.0.0](#releases-v100)
+
+
+
+---
+---
+
+## Changelog
+
+#### Releases v1.0.0
+
+1. Initial coding to port `synchronous` [ESP_WiFiManager](https://github.com/khoih-prog/ESP_WiFiManager) to ESP32 boards using `LwIP W5500 / ENC28J60 Ethernet`
+2. Use `allman astyle`
+
+