aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2023-02-21 21:52:56 +0100
committerThomas White <taw@physics.org>2023-02-22 08:35:41 +0100
commit7352ae0cb2baad0c7f72febf85362c544442d5ea (patch)
tree08258b9c546affc3f0638e7eed174e6e82045577
parent273677e6696ea4efbcdbc199fc05bef9f2742130 (diff)
Update README.md and add photo
-rw-r--r--README.md30
-rw-r--r--photo.jpgbin0 -> 28186 bytes
2 files changed, 24 insertions, 6 deletions
diff --git a/README.md b/README.md
index d4cf34c..778c661 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,10 @@ All that you really need is an indicator of whether or not it's a sensible time
to get up, or whether you should go back to sleep. That's all that MorningTown
will give you.
+In contrast to a clock radio or "artificial sunrise" lamp, there is no danger
+of disturbing any other beings who share the room and may run on different
+schedules.
+
Obviously, you should set an audible alarm clock for important wake-up calls.
But, in combination with regular sleep hygiene, two LEDs might be all you need
to synchronise your sleep pattern!
@@ -36,19 +40,29 @@ You'll need a Raspberry Pi Pico W. Solder red and green LEDs to GPIOs 21 and
22 respectively, each with a 1.5 kOhm series resistor (you won't need much
brightness). There is a ground pad conveniently placed between the two pins.
-![Circuit diagram](circuit.png)
+![Circuit diagram](circuit.png) ![Photo](photo.jpg)
+
+(Hopefully your soldering is a little neater than mine).
+
+You can use other GPIOs if you prefer - just change the definitions of
+`LED_RED` and `LED_GREEN` in `morningtown.c`. The positions of 21 and 22 just
+happen to work well for the geometry of my own nightstand.
+
Software
--------
-Edit `compile` to set the path to the Pico SDK, as well as your WLAN name and
-password.
+Edit `compile` to set the path to the [Pico SDK](https://github.com/raspberrypi/pico-sdk),
+as well as your WLAN name and password.
-Set your offset from UTC in ntp_client.h, e.g. for UTC+1:
+Set your offset from UTC in `ntp_client.h`, e.g. if you live in time zone UTC+1:
```
#define UTC_OFFSET_SEC 3600
```
-Sorry, no automatic DST handling yet.
+Sorry, there's no automatic handling of daylight savings yet.
+
+To set different wake-up times, edit routine `check_clock()` in
+`morningtown.c`.
Run `compile`, then copy `build/morningtown.uf2` to the Pico.
@@ -56,8 +70,10 @@ Run `compile`, then copy `build/morningtown.uf2` to the Pico.
Boot up sequence
----------------
+Connect the Pico to any USB power supply. Afterwards:
+
1. All three LEDs (red, green and the one on Pi board itself) light for 2
- seconds.
+ seconds, then switch off.
2. Board LED lights to indicate WLAN connection
3. Flashing red LED indicates a problem. It will try again shortly.
4. Alternating red and green LEDs indicate successful NTP synchronisation.
@@ -87,6 +103,8 @@ MorningTown. If not, see <http://www.gnu.org/licenses/>.
About the name
--------------
+It's like a railway signal for your sleep:
+
> Somewhere there is sunshine
> Somewhere there is day
> Somewhere there is Morning town
diff --git a/photo.jpg b/photo.jpg
new file mode 100644
index 0000000..54260f6
--- /dev/null
+++ b/photo.jpg
Binary files differ