File size: 7,075 Bytes
938949f | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 | """
TrackerScheduler: time-based tracking plan with sunrise/sunset resolution.
Loads a JSON tracking plan (timeline of events) and resolves the active
event for any given timestamp. Supports literal times ("10:30") and
astronomical events ("sunrise", "sunset") via the ``astral`` library.
Adapted from the tracker repo's AsyncSolarTrackerScheduler — made synchronous
and integrated with Baseline's site config.
Plan JSON format
----------------
::
{
"timeline": [
{"start": "sunrise", "mode": "tracking", "angle": null},
{"start": "10:00", "mode": "antiTracking", "angle": 15},
{"start": "16:00", "mode": "tracking", "angle": null},
{"start": "sunset", "mode": "fixed_angle", "angle": 180}
]
}
Modes
-----
- ``tracking`` — follow the sun (astronomical tracking)
- ``antiTracking`` — offset from astronomical position by ``angle`` degrees
- ``fixed_angle`` — hold a fixed tilt angle
"""
from __future__ import annotations
import json
import logging
from datetime import datetime, date
from pathlib import Path
from typing import Optional
from zoneinfo import ZoneInfo
from astral import LocationInfo
from astral.sun import sun
from config.settings import SITE_LATITUDE, SITE_LONGITUDE
logger = logging.getLogger(__name__)
# Default timezone for the Yeruham site
_SITE_TZ = ZoneInfo("Asia/Jerusalem")
class TrackerScheduler:
"""Load a JSON tracking plan and resolve events by time.
Parameters
----------
plan_file : Path or str, optional
Path to the JSON plan file. Either this or ``plan_data`` must be given.
plan_data : dict, optional
Pre-loaded plan dict (must contain ``"timeline"`` key).
latitude, longitude : float
Site coordinates for sunrise/sunset calculation.
timezone : str
IANA timezone name.
"""
def __init__(
self,
plan_file: Optional[Path | str] = None,
plan_data: Optional[dict] = None,
latitude: float = SITE_LATITUDE,
longitude: float = SITE_LONGITUDE,
timezone: str = "Asia/Jerusalem",
):
self.latitude = latitude
self.longitude = longitude
self.tz = ZoneInfo(timezone)
self.location = LocationInfo(
timezone=timezone,
latitude=latitude,
longitude=longitude,
)
self.timeline: list[dict] = []
if plan_data is not None:
self.timeline = plan_data.get("timeline", [])
elif plan_file is not None:
self._load_plan(Path(plan_file))
def _load_plan(self, path: Path) -> None:
with open(path) as f:
data = json.load(f)
self.timeline = data.get("timeline", [])
logger.info("Loaded plan %s: %d events", path.name, len(self.timeline))
def _resolve_time(self, event_start: str, ref_date: date) -> datetime:
"""Resolve an event start string to a timezone-aware datetime."""
if event_start in ("sunrise", "sunset"):
s = sun(self.location.observer, date=ref_date, tzinfo=self.tz)
return s[event_start]
# Parse "HH:MM" literal time
t = datetime.strptime(event_start, "%H:%M").time()
return datetime.combine(ref_date, t, tzinfo=self.tz)
def get_event(self, current_time: Optional[datetime] = None) -> Optional[dict]:
"""Return the active event for the given time.
Walks the timeline in reverse and returns the first event
whose start time is <= current_time. If no event matches,
returns the last event in the timeline (wrap-around).
Returns
-------
dict with keys: ``start``, ``mode``, ``angle`` (may be None).
None if the timeline is empty.
"""
if not self.timeline:
return None
now = current_time or datetime.now(self.tz)
ref_date = now.date() if hasattr(now, "date") else now
for event in reversed(self.timeline):
try:
event_dt = self._resolve_time(event["start"], ref_date)
if now >= event_dt:
return event
except Exception as exc:
logger.warning("Failed to resolve event %s: %s", event, exc)
continue
# Before any event today — use the last event (wrap from yesterday)
return self.timeline[-1]
def get_all_events(self, ref_date: Optional[date] = None) -> list[dict]:
"""Return all events with resolved timestamps for a given date.
Useful for display / debugging.
"""
today = ref_date or date.today()
result = []
for event in self.timeline:
try:
dt = self._resolve_time(event["start"], today)
result.append({
"start_raw": event["start"],
"start_resolved": dt.isoformat(),
"mode": event.get("mode"),
"angle": event.get("angle"),
})
except Exception as exc:
result.append({
"start_raw": event["start"],
"error": str(exc),
})
return result
# ---------------------------------------------------------------------------
# Plan library — built-in plans from the tracker repo
# ---------------------------------------------------------------------------
PLAN_LIBRARY = {
"night-east": {
"description": "Track sun during day, face east at night",
"timeline": [
{"start": "sunrise", "mode": "tracking", "angle": None},
{"start": "sunset", "mode": "fixed_angle", "angle": 180},
],
},
"day-max": {
"description": "Fixed east-facing during day (max morning light), track at night",
"timeline": [
{"start": "sunrise", "mode": "fixed_angle", "angle": 180},
{"start": "sunset", "mode": "tracking", "angle": None},
],
},
"day-mid": {
"description": "Fixed mid position during day, track at night",
"timeline": [
{"start": "sunrise", "mode": "fixed_angle", "angle": 90},
{"start": "sunset", "mode": "tracking", "angle": None},
],
},
"full-tracking": {
"description": "Full astronomical tracking 24/7 (default)",
"timeline": [
{"start": "sunrise", "mode": "tracking", "angle": None},
],
},
"shading-midday": {
"description": "Track morning/evening, anti-track during midday heat",
"timeline": [
{"start": "sunrise", "mode": "tracking", "angle": None},
{"start": "10:00", "mode": "antiTracking", "angle": 15},
{"start": "16:00", "mode": "tracking", "angle": None},
],
},
}
def get_plan(name: str) -> dict:
"""Look up a built-in plan by name."""
if name not in PLAN_LIBRARY:
raise KeyError(f"Unknown plan: {name}. Available: {list(PLAN_LIBRARY.keys())}")
return PLAN_LIBRARY[name]
|