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

Commit bf9eb90

Browse files
authored
v1.0.2
#### Release v1.0.2 1. Add [STM32_LAN8720 examples](./STM32_LAN8720)
1 parent 804f9be commit bf9eb90

File tree

3 files changed

+57
-4
lines changed

3 files changed

+57
-4
lines changed

README.md

Lines changed: 45 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
1-
## Small Projects to demonstrate the usage of ISR-based timers for ESP8266, ESP32 and Arduino Mega, Nano, etc.
1+
# SmallProjects Library
22

3+
[![arduino-library-badge](https://www.ardu-badge.com/badge/SmallProjects.svg?)](https://www.ardu-badge.com/SmallProjects)
34
[![GitHub release](https://img.shields.io/github/release/khoih-prog/SmallProjects.svg)](https://github.com/khoih-prog/SmallProjects/releases)
45
[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/khoih-prog/SmallProjects/blob/master/LICENSE)
56
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
67
[![GitHub issues](https://img.shields.io/github/issues/khoih-prog/SmallProjects.svg)](http://github.com/khoih-prog/SmallProjects/issues)
78

9+
10+
---
11+
---
12+
13+
### Why do we need this [SmallProjects library](https://github.com/khoih-prog/SmallProjects)
14+
15+
### Features
16+
17+
[SmallProjects library](https://github.com/khoih-prog/SmallProjects) collects all complicated projects to demonstrate the usage of [Khoi Hoang's libraries](https://github.com/khoih-prog/SmallProjects), such as ISR-based timers for ESP8266, ESP32 and Arduino Mega, Nano, etc. These projects are much more complicated than the ordinary libraries' examples. Some can even be used directly in real-life.
18+
19+
820
### ISR-based Fire Smoke Alarm demonstrate how to use ESP8266TimerInterrupt, ESP32TimerInterrupt and TimerInterrupt Library
921

1022
These are examples how to use, design and convert the code from normal `software timer` to `ISR-based timer`.
@@ -25,9 +37,10 @@ Functions using normal software timers, relying on loop() and calling millis(),
2537

2638
The catch is your function is now part of an `ISR (Interrupt Service Routine)`, and must be `lean / mean`, and follow certain rules. More to read on:
2739

28-
[Attach Interrupt](https://www.arduino.cc/reference/en/language/functions/external-interrupts/attachinterrupt/)
40+
https://www.arduino.cc/reference/en/language/functions/external-interrupts/attachinterrupt/
41+
42+
## Important Notes:
2943

30-
**Important Notes:**
3144
1. Inside the attached function, delay() won’t work and the value returned by millis() will not increment. Serial data received while in the function may be lost. You should declare as volatile any variables that you modify within the attached function.
3245

3346
2. Typically global variables are used to pass data between an ISR and the main program. To make sure variables shared between an ISR and the main program are updated correctly, declare them as volatile.
@@ -44,7 +57,15 @@ Certainly, with Blynk GUI, we can achieve many more great features, such as `rem
4457

4558
This can be applied in many projects requiring reliable system control, where `good, bad, or no connection has no effect on the operation of the system`.
4659

47-
### Projects
60+
---
61+
---
62+
63+
### Changelog
64+
65+
#### Release v1.0.2
66+
67+
1. Add [STM32_LAN8720 examples](./STM32_LAN8720)
68+
4869

4970
#### Release v1.0.1
5071

@@ -70,12 +91,32 @@ Sample codes:
7091

7192
The corresponding codes using Software Timers are also included to help understand the steps taken in order to convert those codes to be ISR-based.
7293

94+
---
95+
---
96+
97+
### Issues
98+
99+
Submit issues to: [SmallProjects issues](https://github.com/khoih-prog/SmallProjects/issues)
100+
101+
---
102+
---
103+
73104
## Contributing
105+
74106
If you want to contribute to this project:
75107
- Report bugs and errors
76108
- Ask for enhancements
77109
- Create issues and pull requests
78110
- Tell other people about this library
79111

112+
---
113+
114+
### License
115+
116+
- The library is licensed under [MIT](https://github.com/khoih-prog/SmallProjects/blob/master/LICENSE)
117+
118+
---
119+
80120
## Copyright
121+
81122
Copyright 2019- Khoi Hoang

library.properties

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name=SmallProjects
2+
version=1.0.2
3+
author=Khoi Hoang <[email protected]>
4+
maintainer=Khoi Hoang <[email protected]>
5+
sentence=Small Projects to demonstrate the usage of ISR-based timers for ESP8266, ESP32 and Arduino Mega, Nano, etc.
6+
paragraph=
7+
category=Other,Timing,Control,Device,Time,Timer,AVR,SAM-DUE,ESP32,ESP8266,SAMD,interrupt
8+
url=https://github.com/khoih-prog/SmallProjects
9+
architectures=*
10+
repository=https://github.com/khoih-prog/SmallProjects
11+
license=MIT

src/SmallProjects.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
// Dummy h. file for SmallProjects library

0 commit comments

Comments
 (0)