Move complications/local_solar_time_face -> clock/solar_time_face

2026-03-04 12:34:23 +01:00
parent ff3c8a72fc
commit 1a33ae88f7
4 changed files with 40 additions and 40 deletions
@@ -0,0 +1,84 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2025 Raffael Mancini
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+#pragma once
+
+/*
+ * SOLAR TIME FACE
+ *
+ * Displays solar time information based on the user's location.
+ * Formulas follow the notation from:
+ *   https://www.pveducation.org/pvcdrom/properties-of-sunlight/solar-time
+ *
+ * Variables (pveducation.org notation):
+ *   LSTM  - Local Standard Time Meridian [degrees]  = 15 * ΔTUTC
+ *   B     - Seasonal angle [degrees]                = (360/365) * (d - 81)
+ *   EoT   - Equation of Time [minutes]              = 9.87*sin(2B) - 7.53*cos(B) - 1.5*sin(B)
+ *   TC    - Time Correction Factor [minutes]        = 4*(Longitude - LSTM) + EoT
+ *   LST   - Solar Time [hours]                = LT + TC/60
+ *   HRA   - Hour Angle [degrees]                    = 15*(LST - 12)
+ *
+ * B, EoT and TC only depend on the day-of-year d, so they are cached
+ * in state and recomputed exactly once per day: the cache key is d itself
+ * (1-366). Zero-initialisation of state guarantees a recompute on first use.
+ *
+ * Requires the location to be set via the Sunrise/Sunset face, stored in
+ * "location.u32" on the filesystem.  If no location is set, displays
+ * "SO  no Loc".
+ *
+ * Display modes (cycle with the Alarm / start-stop button):
+ *   SO  HH:MM:SS  — Solar Time (LST), live seconds display
+ *   nO  HH:MM     — Solar Noon in local clock time
+ *   Hr  ±DDD      — Hour Angle (HRA) in degrees; negative=morning, positive=afternoon
+ */
+
+#include "movement.h"
+
+typedef enum {
+    SOLAR_TIME_MODE_LST  = 0,  /* Solar Time    SO HH:MM:SS */
+    SOLAR_TIME_MODE_NOON = 1,  /* Solar Noon (local)  nO HH:MM    */
+    SOLAR_TIME_MODE_HRA  = 2,  /* Hour Angle          Hr ±DDD     */
+    SOLAR_TIME_NUM_MODES
+} solar_time_mode_t;
+
+typedef struct {
+    solar_time_mode_t mode;
+    uint16_t last_calc_d;  /* day-of-year (1-366) when EoT/TC were last computed;
+                              0 (zero-init) guarantees recomputation on first tick */
+    float    EoT;          /* Equation of Time [minutes]       */
+    float    TC;           /* Time Correction Factor [minutes] */
+} solar_time_state_t;
+
+void solar_time_face_setup(uint8_t watch_face_index, void **context_ptr);
+void solar_time_face_activate(void *context);
+bool solar_time_face_loop(movement_event_t event, void *context);
+void solar_time_face_resign(void *context);
+
+#define solar_time_face ((const watch_face_t){ \
+    solar_time_face_setup,    \
+    solar_time_face_activate, \
+    solar_time_face_loop,     \
+    solar_time_face_resign,   \
+    NULL,                           \
+})