From 651a236c35415410e885390b7a4ce0cb78645ba7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franti=C5=A1ek=20Boh=C3=A1=C4=8Dek?= Date: Tue, 8 Aug 2023 10:38:03 +0200 Subject: [PATCH] docs: add usage guide --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.md b/README.md index 38537c3082e6a6b8b337650c395a95c1abbe5b51..b601bb745e00d40e5d089adc1d898e97653eb696 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,49 @@ Mapping of pins to peripherals is documented in [pins](docs/pins.md). - [ ] Set time, Get time - [ ] Show arbitrary text or number on the display - [ ] Start stopwatch + +## Usage +The clock has two modes, default mode, and edit mode. +Default mode displays the current time, edit mode is +for editing the current time. + +### Default mode +This is entered upon reset. Upon startup, +it displays only current time as hours and minutes. + +First button may change the current view, there are +four views. +1. time - hours and minutes only +2. time - with seconds +3. time and date - hours, minutes, day in month and month +4. date - year, day in month and month + +The second button switches to edit mode. + +Third and fourth buttons change brightness. +The brightness is normally automatically adjusted +based on the current time set on the clock. +It may be temporarily changed using these buttons. +The change will last 30 minutes. +Third button decreases brightness, fourth increases it. + +### Edit mode +In the edit mode, it's possible to change the time and date. +Upon entering edit mode, hours will be selected to be changed. + +The currently selected field will blink. To select the next field, +the first button should be used. The order of the fields edited is: +hours, minutes, seconds, year, month, day. + +To increment or decrement the current field, second and third +buttons should be used, respectively. + +To save the time and date, fourth button does the job. +It may be pressed when editing any field. + +When in the edit mode, the time is paused. If you enter the +edit mode by accident, the clock will probably get behind, +because a couple of seconds will pass before you exit the edit mode. ## Images of the clock ### Front, off