Skip to content

Commit 6a616ba

Browse files
committed
SCHEDULE.md: Add reference to astronomy doc.
1 parent e815e9b commit 6a616ba

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

v3/docs/SCHEDULE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121
8. [The simulate script](./SCHEDULE.md#8-the-simulate-script) Rapidly test sequences.
2222

2323
Release note:
24+
11th Dec 2023 Document astronomy module, allowing scheduling based on Sun and
25+
Moon rise and set times.
2426
23rd Nov 2023 Add asynchronous iterator interface.
2527
3rd April 2023 Fix issue #100. Where an iterable is passed to `secs`, triggers
2628
must now be at least 10s apart (formerly 2s).
@@ -48,6 +50,10 @@ also be used in synchronous code and an example is provided.
4850
It is cross-platform and has been tested on Pyboard, Pyboard D, ESP8266, ESP32
4951
and the Unix build.
5052

53+
The `astronomy` module extends this to enable tasks to be scheduled at times
54+
related to Sun and Moon rise and set times. This is documented
55+
[here](https://github.com/peterhinch/micropython-samples/blob/master/astronomy/README.md).
56+
5157
# 2. Overview
5258

5359
The `schedule` coroutine (`sched/sched.py`) is the interface for use with
@@ -103,6 +109,12 @@ The following files are installed in the `sched` directory.
103109
The `crontest` script is only of interest to those wishing to adapt `cron.py`.
104110
It will run on any MicroPython target.
105111

112+
The [astronomy](https://github.com/peterhinch/micropython-samples/blob/master/astronomy/README.md)
113+
module may be installed with
114+
```bash
115+
$ mpremote mip install "github:peterhinch/micropython-samples/astronomy"
116+
```
117+
106118
# 4. The schedule coroutine
107119

108120
This enables a response to be triggered at intervals. The response can be

0 commit comments

Comments
 (0)