Skip to content

Commit

Permalink
Readme tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
jwrw committed Jan 10, 2020
1 parent 901d34c commit 10bf2bf
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ There seem to be a few similar libraries, but none seemed to be quite right for

See the Examples for how to use but here's a summary.

a) Set up a list of all the functions that you want called and the time schedule on which you want them to be called. I was really thinking about tasks that need to be run every few ms, or possibly every few seconds. The timing will not be exact, as it relies on your code calling the scheduler on a regular basis and on your routines not taking a lot of time. (e.g. if you have a routine that needs to be called every 20ms but you have another routine called every 1000ms but that runs for 500ms then the 20ms routine will not get called whilst the 500ms routine is running)
a) Set up a list of all the functions that you want called and the time schedule on which you want them to be called. I was really thinking about tasks that need to be run every few ms, or possibly every few seconds. The timing will not be exact, as it relies on your code calling the scheduler on a regular basis and on your routines not taking a lot of time. (e.g. if you have a little routine that needs to be called every 20ms but you have another monster routine called every 1000ms but that runs for 500ms then the little routine will not get called all the time whilst the monster routine is running)

b) Call the Exec.delay() or Exec.yield() functions on a regular basis (as often as you can)
b) Call the Exec.delay() or Exec.yield() functions on a regular basis (as often as you can) from code outside your scheduled functions (e.g. in your topmost loop() routine)

c) The appropriate scheduled functions (your 'tasks') will be called during your Exec.delay() or Exec.yield() functions.

Expand All @@ -24,5 +24,6 @@ loop() {
Exec.loop();
}
```
In this case you don't need Exec.delay() or Exec.yield() this is all looked after for you in the Exec.loop()

HTML documentation will be found in the docs folder of the library.

0 comments on commit 10bf2bf

Please sign in to comment.