Skip to content

Commit 3ee0fdf

Browse files
committed
more updates to README
1 parent 919a6ff commit 3ee0fdf

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
![Config Page](images/config-page.png)
88

9-
This project can be used as a learning tool or as a template for starting a new ESP8266 project.
10-
It contains many of the components to build a ESP8266 project with web interface.
9+
This project can be used as a framework, learning tool or as a template for starting a new ESP8266 project.
10+
It contains many of the components to build a ESP8266 project with dynamic web interface.
1111

1212
This project includes:
1313
- ESP8266 Development
@@ -34,6 +34,8 @@ ESP8266-MyWidget can be used as a learning tool or as a template for starting a
3434

3535
## Requirements
3636

37+
ESP8266-based development board - I used the Wemos D1 Mini
38+
3739
Along with the Arduino IDE, you'll need the following software to build this project:
3840

3941
- [Adruino for ESP8266](https://github.com/esp8266/Arduino) - Arduino core for ESP8266
@@ -346,9 +348,12 @@ The original implementation used timer1
346348
Then I discovered [ESP8266TimerInterrupt](https://github.com/khoih-prog/ESP8266TimerInterrupt) which supports 16 ISR-based timers.
347349
- The interrupt timer is setup for 10 millisecond
348350

349-
- One ISR-based timer is used to flash the onboard timer (changeable speed - freq)
350-
- Second ISR-based timer is used to increment a counter - interruptCounter2 (fixed speed - freq)
351-
- Third ISR-based timer is used to increment a counter - interruptCounter3 (fixed speed - freq)
351+
- One ISR-based timer is used to flash the onboard timer and increment counter
352+
- interruptCount1 (changeable speed - freq)
353+
- Second ISR-based timer is used to increment counter
354+
- interruptCounter2 (fixed speed - freq)
355+
- Third ISR-based timer is used to increment counter
356+
- interruptCounter3 (fixed speed - freq)
352357

353358

354359
## Test & Debug
@@ -373,7 +378,10 @@ Later I went back and added an HTTP GET with JSON response example without any J
373378
## Future Enhancements
374379

375380
- [X] Support multiple interrupt timers (ESP8266TimerInterrupt)
381+
- [ ] Support dynamic interval timers on config page
382+
- [ ] Support HTTP GET INTERRUPT COUNT with args
376383
- [ ] Asynch NTP support
384+
- [ ] More code comments
377385
- [ ] Other?
378386

379387
## References

0 commit comments

Comments
 (0)