From 6fc0be482ca6f72a36c0f8760ff5b34b50c1406e Mon Sep 17 00:00:00 2001
From: June Bennison <june_github@bennisons.net>
Date: Thu, 30 Jan 2025 16:38:06 +1100
Subject: [PATCH] grandfather-clock: metadata & documentation updates

---
 apps/grandfather-clock/README.md     | 15 +++++++++++++--
 apps/grandfather-clock/metadata.json |  2 +-
 apps/grandfather-clock/widget.js     |  2 +-
 3 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/apps/grandfather-clock/README.md b/apps/grandfather-clock/README.md
index 12ce92f9e..34b0d2892 100644
--- a/apps/grandfather-clock/README.md
+++ b/apps/grandfather-clock/README.md
@@ -1,10 +1,21 @@
 # Grandfather Clock
 
-A widget that runs in the background and chimes every 15mins (similar to Chimer), and counts out the fractions of an hour and the o'clock hour.
+A widget that runs in the background and chimes on every (configurable) fraction of an hour, similar to Chimer, and counts out the fractions and the o'clock hour.
 
 ## Usage
 
-Once installed, see the App Settings page for options.
+Once installed, see the App Settings page for options. ** This is not implemented yet. Await v0.02
+
+Defaults:
+- Twelve hour mode is ENABLED.
+- Swap meridian is DISABLED. (in the AM, there will be a single buzz after counting the hours. in the PM, there will be two buzzes after counting the hours)
+- The attention buzz for the hour chime is 1000ms long.
+- The buzz for each hour count is 250ms long.
+- The buzz for each fraction count is 250ms long.
+- The widget will count out 4 fractions of an hour (15 min interval).
+- The time between count buzzes is 500ms.
+- The meridian buzzes are 100ms long.
+- The time between meridian buzzes is 50ms long.
 
 ## Requests
 
diff --git a/apps/grandfather-clock/metadata.json b/apps/grandfather-clock/metadata.json
index f8fa52489..133ba3859 100644
--- a/apps/grandfather-clock/metadata.json
+++ b/apps/grandfather-clock/metadata.json
@@ -2,7 +2,7 @@
   "name": "Grandfather Clock Bell Widget",
   "shortName":"Grandfather Clock",
   "version":"0.01",
-  "description": "A widget that chimes every 15mins (similar to Chimer), and counts out the fractions of an hour and the o'clock hour.",
+  "description": "A widget that chimes every fraction of an hour (similar to Chimer), and counts out the fractions and the o'clock hour.",
   "icon": "icon.png",
   "type": "widget",
   "tags": "widget",
diff --git a/apps/grandfather-clock/widget.js b/apps/grandfather-clock/widget.js
index 33fb3059f..3cdf66af3 100644
--- a/apps/grandfather-clock/widget.js
+++ b/apps/grandfather-clock/widget.js
@@ -6,7 +6,7 @@
     const hour_attention_buzz_ms = 1000;
     const hour_count_buzz_ms = 250;
     const fraction_count_buzz_ms = 250;
-    const fractions_of_hour = 4; // 4 = 15min intervals
+    const fractions_of_hour = 4; // 4 = 15min intervals, 6 = 10min intervals
     const wait_ms = 500;
     const meridian_buzz_ms = 100;
     const meridian_buzz_wait_ms = 50;