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

Commit d9d51a3

Browse files
authored
v1.0.0 for ESP8266 + LwIP ENC28J60
#### Releases v1.0.0 1. Initial coding to port `synchronous` [ESP_WiFiManager](https://github.com/khoih-prog/ESP_WiFiManager) to ESP8266 boards using `LwIP ENC28J60 Ethernet`. 2. Use `allman astyle`
1 parent a579d3d commit d9d51a3

Some content is hidden

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

50 files changed

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

+79
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
## Contributing to ESP8266_ENC_Manager
2+
3+
### Reporting Bugs
4+
5+
Please report bugs in ESP8266_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/ESP8266_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/ESP8266_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 Core Version (e.g. ESP8266 core v3.0.2)
19+
* Contextual information (e.g. what you were trying to achieve)
20+
* Simplest possible steps to reproduce
21+
* Anything that might be relevant in your opinion, such as:
22+
* Operating system (Windows, Ubuntu, etc.) and the output of `uname -a`
23+
* Network configuration
24+
25+
26+
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.
27+
28+
29+
### Example
30+
31+
```
32+
Arduino IDE version: 1.8.19
33+
ESP8266 Core Version v3.0.2
34+
ESP8266_NODEMCU
35+
OS: Ubuntu 20.04 LTS
36+
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
37+
38+
Context:
39+
I encountered a crash while using this library
40+
Steps to reproduce:
41+
1. ...
42+
2. ...
43+
3. ...
44+
4. ...
45+
```
46+
47+
### Additional context
48+
49+
Add any other context about the problem here.
50+
51+
---
52+
53+
### Sending Feature Requests
54+
55+
Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
56+
57+
There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/ESP8266_ENC_Manager/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
58+
59+
---
60+
61+
### Sending Pull Requests
62+
63+
Pull Requests with changes and fixes are also welcome!
64+
65+
Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
66+
67+
1. Change directory to the library GitHub
68+
69+
```
70+
xy@xy-Inspiron-3593:~$ cd Arduino/xy/ESP8266_ENC_Manager_GitHub/
71+
xy@xy-Inspiron-3593:~/Arduino/xy/ESP8266_ENC_Manager_GitHub$
72+
```
73+
74+
2. Issue astyle command
75+
76+
```
77+
xy@xy-Inspiron-3593:~/Arduino/xy/ESP8266_ENC_Manager_GitHub$ bash utils/restyle.sh
78+
```
79+

Images/Configuration_AIO_MQTT.png

35.5 KB
Loading

Images/Configuration_Standard.png

16.8 KB
Loading

Images/ENC28J60.png

140 KB
Loading

Images/Info.png

59.4 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+
# ESP8266_ENC_Manager Library
2+
3+
[![arduino-library-badge](https://www.ardu-badge.com/badge/ESP8266_ENC_Manager.svg?)](https://www.ardu-badge.com/ESP8266_ENC_Manager)
4+
[![GitHub release](https://img.shields.io/github/release/khoih-prog/ESP8266_ENC_Manager.svg)](https://github.com/khoih-prog/ESP8266_ENC_Manager/releases)
5+
[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/khoih-prog/ESP8266_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/ESP8266_ENC_Manager.svg)](http://github.com/khoih-prog/ESP8266_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 `synchronous` [ESP_WiFiManager](https://github.com/khoih-prog/ESP_WiFiManager) to ESP8266 boards using `LwIP ENC28J60 Ethernet`.
31+
2. Use `allman astyle`
32+
33+

0 commit comments

Comments
 (0)