4 from datetime import datetime
5 from difflib import SequenceMatcher
10 from threading import Thread
13 from typing import Dict, List, Optional
14 from queue import Queue
16 import astral # type: ignore
17 from astral.sun import sun # type: ignore
26 from pyutils.datetimes import datetime_utils
27 from pyutils.files import file_utils
29 import kiosk_constants
31 import renderer_catalog
34 import trigger_catalog
37 cfg = config.add_commandline_args(
38 f'Kiosk Server ({__file__})',
39 'A python server that runs a kiosk.'
41 logger = logging.getLogger(__file__)
44 def thread_janitor() -> None:
46 tracemalloc_target = 0.0
50 # Main janitor loop; dump the largest pigs and force regular gcs.
53 if now > tracemalloc_target:
54 tracemalloc_target = now + 30.0
55 snapshot = tracemalloc.take_snapshot()
56 snapshot = snapshot.filter_traces((
57 tracemalloc.Filter(False, "<frozen importlib._bootstrap>"),
58 tracemalloc.Filter(False, "<unknown>"),
62 top_stats = snapshot.statistics(key_type)
63 logger.info(f'janitor: Top {limit} lines')
64 for index, stat in enumerate(top_stats[:limit], 1):
65 frame = stat.traceback[0]
67 # replace "/path/to/module/file.py" with "module/file.py"
68 filename = os.sep.join(frame.filename.split(os.sep)[-2:])
70 f'janitor: #{index}: {filename}:{frame.lineno}: {stat.size / 1024:.1f} KiB'
73 other = top_stats[limit:]
75 size = sum(stat.size for stat in other)
77 f'janitor: {len(other)} others: {size/1024:.1f} KiB'
79 total = sum(stat.size for stat in top_stats)
81 f'janitor: Total allocated size: {total / 1024:.1f} KiB'
84 logger.info('janitor: kicking off a manual gc operation now.')
86 gc_target = now + 120.0
90 def guess_page(command: str, page_chooser: chooser.chooser) -> str:
92 def normalize_page(page: str) -> str:
93 logger.debug(f'normalize_page input: {page}')
94 page = page.replace('(', ' ')
95 page = page.replace('_', ' ')
96 page = page.replace(')', ' ')
97 page = page.replace('.html', '')
98 page = page.replace('CNNNews', 'news')
99 page = page.replace('CNNTechnology', 'technology')
100 page = page.replace('gocostco', 'costco list')
101 page = page.replace('gohardware', 'hardware list')
102 page = page.replace('gohouse', 'house list honey do')
103 page = page.replace('gcal', 'google calendar events')
104 page = page.replace('mynorthwest', 'northwest news')
105 page = page.replace('myq', 'myq garage door status')
106 page = page.replace('gomenu', 'dinner menu')
107 page = page.replace('gmaps-seattle-unwrapped', 'traffic')
108 page = page.replace('gomenu', 'dinner menu')
109 page = page.replace('WSJNews', 'news')
110 page = page.replace('telma', 'telma cabin')
111 page = page.replace('WSJBusiness', 'business news')
112 page = re.sub(r'[0-9]+', '', page)
113 logger.debug(f'normalize_page output: {page}')
116 logger.info(f'No exact match for f{command}; trying to guess...')
119 for page in page_chooser.get_page_list():
120 npage = normalize_page(page)
121 score = SequenceMatcher(None, command, npage).ratio()
122 if best_score is None or score > best_score:
125 assert best_page is not None
126 logger.info(f'Best guess for f{command} => {best_page} (score = {best_score})')
130 def process_command(command: str, page_history: List[str], page_chooser) -> str:
131 command = command.lower()
132 logger.info(f'Parsing verbal command: {command}')
134 if 'hold' in command:
135 page = page_history[0]
136 elif 'down' in command:
138 "xdotool search --onlyvisible \"chrom\" windowactivate click --repeat 8 5"
141 elif 'up' in command:
143 "xdotool search --onlyvisible \"chrom\" windowactivate click --repeat 8 4"
146 elif 'back' in command:
147 page = page_history[1]
148 elif 'skip' in command:
150 (page, _) = page_chooser.choose_next_page()
151 if page == page_history[0]:
152 logger.debug(f'chooser: {page} is the same as last time! Try again.')
155 elif 'internal' in command:
156 if 'render' in command:
157 page = kiosk_constants.render_stats_pagename
159 page = kiosk_constants.render_stats_pagename
160 elif 'weather' in command:
161 if 'telma' in command or 'cabin' in command:
162 page = 'weather-telma_3_10800.html'
163 elif 'stevens' in command:
164 page = 'weather-stevens_3_10800.html'
166 page = 'weather-home_3_10800.html'
167 elif 'cabin' in command:
168 if 'list' in command:
169 page = 'Cabin-(gocabin)_2_3600.html'
171 page = 'hidden/cabin_driveway.html'
172 elif 'news' in command or 'headlines' in command:
173 page = 'cnn-CNNNews_4_25900.html'
174 elif 'clock' in command or 'time' in command:
175 page = 'clock_10_none.html'
176 elif 'countdown' in command or 'countdowns' in command:
177 page = 'countdown_3_7200.html'
178 elif 'costco' in command:
179 page = 'Costco-(gocostco)_2_3600.html'
180 elif 'calendar' in command or 'events' in command:
181 page = 'gcal_3_86400.html'
182 elif 'countdown' in command or 'countdowns' in command:
183 page = 'countdown_3_7200.html'
184 elif 'grocery' in command or 'groceries' in command:
185 page = 'Grocery-(gogrocery)_2_3600.html'
186 elif 'hardware' in command:
187 page = 'Hardware-(gohardware)_2_3600.html'
188 elif 'garage' in command:
189 page = 'myq_4_300.html'
190 elif 'menu' in command:
191 page = 'Menu-(gomenu)_2_3600.html'
192 elif 'cron' in command or 'health' in command:
193 page = 'periodic-health_6_300.html'
194 elif 'photo' in command or 'picture' in command:
195 page = 'photo_23_3600.html'
196 elif 'quote' in command or 'quotation' in command or 'quotes' in command:
197 page = 'quotes_4_10800.html'
198 elif 'stevens' in command:
199 page = 'stevens-conditions_1_86400.html'
200 elif 'stock' in command or 'stocks' in command:
201 page = 'stock_3_86400.html'
202 elif 'twitter' in command:
203 page = 'twitter_10_3600.html'
204 elif 'traffic' in command:
205 page = 'gmaps-seattle-unwrapped_5_none.html'
206 elif 'front' in command and 'door' in command:
207 page = 'hidden/frontdoor.html'
208 elif 'driveway' in command:
209 page = 'hidden/driveway.html'
210 elif 'backyard' in command:
211 page = 'hidden/backyard.html'
213 page = guess_page(command, page_chooser)
214 assert page is not None
215 logger.info(f'Parsed to {page}')
219 def thread_change_current(command_queue: Queue) -> None:
220 page_history = ["", ""]
221 swap_page_target = 0.0
223 def filter_news_during_dinnertime(page: str) -> bool:
224 now = datetime.now(tz=pytz.timezone("US/Pacific"))
225 is_dinnertime = now.hour >= 18 and now.hour <= 20
226 return not is_dinnertime or not (
229 or "mynorthwest" in page
234 page_chooser = chooser.weighted_random_chooser_with_triggers(
235 trigger_catalog.get_triggers(), [filter_news_during_dinnertime]
237 current_file = os.path.join(kiosk_constants.pages_dir, "current.shtml")
238 emergency_file = os.path.join(kiosk_constants.pages_dir, "reload_immediately.html")
244 # Check for a verbal command.
247 command = command_queue.get(block=False)
251 if command is not None:
252 logger.info(f'chooser: We got a verbal command ("{command}"), parsing it...')
253 page = process_command(command, page_history, page_chooser)
259 (page, triggered) = page_chooser.choose_next_page()
261 logger.info('chooser: A trigger is active...')
264 if page == page_history[0]:
265 logger.debug(f'chooser: {page} is the same as last time! Try again.')
270 if page != page_history[0] or (swap_page_target - now) < 10.0:
271 logger.info(f'chooser: An emergency page reload to {page} is needed at this time.')
272 swap_page_target = now + kiosk_constants.emergency_refresh_period_sec
274 # Set current.shtml to the right page.
276 with open(current_file, "w") as f:
280 override_refresh_sec = kiosk_constants.emergency_refresh_period_sec,
283 logger.debug(f'chooser: Wrote {current_file}.')
284 except Exception as e:
286 logger.error(f'chooser: Unexpected exception; assuming {page} doesn\'t exist?!')
289 # Also notify XMLHTTP clients that they need to refresh now.
290 with open(emergency_file, "w") as f:
291 f.write(f'Reload, suckers... you HAVE to see {page}!')
292 logger.debug(f'chooser: Wrote {emergency_file}...')
294 # Fix this hack... maybe read the webserver logs and see if it
295 # actually was picked up?
297 os.remove(emergency_file)
298 logger.debug(f'chooser: ...and removed {emergency_file}.')
300 elif now >= swap_page_target:
301 assert page != page_history[0]
303 f'chooser: Nominal choice of {page} as the next to show.'
305 swap_page_target = now + kiosk_constants.refresh_period_sec
307 with open(current_file, "w") as f:
309 logger.debug(f'chooser: Wrote {current_file}.')
310 except Exception as e:
312 logger.error(f'chooser: Unexpected exception; assuming {page} doesn\'t exist?!')
314 page_history.insert(0, page)
315 page_history = page_history[0:10]
322 override_refresh_sec: int = None,
323 command: str = None):
324 if 'unwrapped' not in filename:
325 logger.debug(f'Emitting {filename} wrapped.')
326 emit_wrapped(f, filename, override_refresh_sec=override_refresh_sec, command=command)
328 logger.debug(f'Emitting {filename} raw.')
329 emit_raw(f, filename)
332 def emit_raw(f, filename: str):
333 f.write(f'<!--#include virtual="{filename}"-->')
339 override_refresh_sec: int = None,
340 command: str = None) -> None:
342 def pick_background_color() -> str:
343 now = datetime_utils.now_pacific()
344 city = astral.LocationInfo(
345 "Bellevue", "USA", "US/Pacific", 47.610, -122.201
347 s = sun(city.observer, date=now, tzinfo=pytz.timezone("US/Pacific"))
348 sunrise_mod = datetime_utils.minute_number(s["sunrise"].hour, s["sunrise"].minute)
349 sunset_mod = datetime_utils.minute_number(s["sunset"].hour, s["sunset"].minute)
350 now_mod = datetime_utils.minute_number(now.hour, now.minute)
351 if now_mod < sunrise_mod or now_mod > (sunset_mod + 45):
353 elif now_mod < (sunrise_mod + 45) or now_mod > (sunset_mod + 120):
358 def get_refresh_period() -> float:
359 if override_refresh_sec is not None:
360 return float(override_refresh_sec * 1000.0)
361 now = datetime.now(tz=pytz.timezone("US/Pacific"))
363 return float(kiosk_constants.refresh_period_night_sec * 1000.0)
365 return float(kiosk_constants.refresh_period_sec * 1000.0)
367 age = file_utils.describe_file_ctime(f"pages/{filename}")
368 bgcolor = pick_background_color()
372 pageid = f'"{command}" -> {filename}'
377 <TITLE>Kitchen Kiosk</TITLE>
378 <LINK rel="stylesheet" type="text/css" href="style.css">
379 <meta name="google" content="notranslate">
380 <SCRIPT TYPE="text/javascript">
382 // Zoom the 'contents' div to fit without scrollbars and then make
384 function zoomScreen() {
387 document.getElementById("content").style.zoom = z+"%";
388 var body = document.body;
389 var html = document.documentElement;
390 var height = Math.max(body.scrollHeight,
395 var windowHeight = window.innerHeight;
396 var width = Math.max(body.scrollWidth,
401 var windowWidth = window.innerWidth;
402 var heightRatio = height / windowHeight;
403 var widthRatio = width / windowWidth;
405 if (heightRatio <= 1.0 && widthRatio <= 1.0) {
410 document.getElementById("content").style.visibility = "visible";
413 // Load IMG tags with DATA-SRC attributes late.
414 function lateLoadImages() {
415 var image = document.getElementsByTagName('img');
416 for (var i = 0; i < image.length; i++) {
417 if (image[i].getAttribute('DATA-SRC')) {
418 image[i].setAttribute('SRC', image[i].getAttribute('DATA-SRC'));
426 // Operate the clock at the top of the page.
427 function runClock() {
428 var today = new Date();
429 var h = today.getHours();
430 var ampm = h >= 12 ? 'pm' : 'am';
432 h = h ? h : 12; // the hour '0' should be '12'
433 var m = maybeAddZero(today.getMinutes());
435 if (today.getSeconds() %% 2 == 0) {
436 colon = "<FONT STYLE='color: #%s; font-size: 4vmin; font-weight: bold'>:</FONT>";
438 document.getElementById("time").innerHTML = h + colon + m + ampm;
439 document.getElementById("date").innerHTML = today.toDateString();
440 var t = setTimeout(function(){runClock()}, 1000);
446 // Helper method for running the clock.
447 function maybeAddZero(x) {
448 return (x < 10) ? "0" + x : x;
451 // Do something on page load.
452 function addLoadEvent(func) {
453 var oldonload = window.onload;
454 if (typeof window.onload != 'function') {
455 window.onload = func;
457 window.onload = function() {
466 // Sleep thread helper.
467 const sleep = (milliseconds) => {
468 return new Promise(resolve => setTimeout(resolve, milliseconds))
471 var loadedDate = new Date();
473 addLoadEvent(zoomScreen);
474 addLoadEvent(runClock);
475 addLoadEvent(lateLoadImages);
480 // Runs the countdown line at the bottom and is responsible for
481 // normal page reloads caused by the expiration of a timer.
482 (function countdown() {
485 var now = new Date();
486 var deltaMs = now.getTime() - loadedDate.getTime();
488 var remainingMs = (totalMs - deltaMs);
490 if (remainingMs > 0) {
491 var hr = document.getElementById("countdown");
492 var width = (remainingMs / (totalMs - 5000)) * 100.0;
494 hr.style.visibility = "visible";
495 hr.style.width = " ".concat(width, "%%");
496 hr.style.backgroundColor = "maroon";
499 // Reload unconditionally after 22 sec.
500 window.location.reload(true);
503 // Brief sleep before doing it all over again.
504 sleep(50).then(() => {
509 """ % get_refresh_period()
513 function check_reload() {
514 var xhr = new XMLHttpRequest();
516 '%s/reload_immediately.html');
519 if (xhr.status === 200) {
520 window.location.reload(true);
526 // Periodically checks for emergency reload events.
527 setInterval(check_reload, 500);
530 """ % kiosk_constants.root_url)
531 f.write(f'<BODY BGCOLOR="#{bgcolor}">')
534 <TABLE style="height:100%; width:100%" BORDER=0>
537 <DIV id="date"> </DIV>
539 <TD ALIGN="center"><FONT COLOR=#bbbbbb>
540 <DIV id="info"></DIV></FONT>
543 <DIV id="time"> </DIV>
546 <TR STYLE="vertical-align:top">
548 <DIV ID="content" STYLE="zoom: 1; visibility: hidden;">
549 <!-- BEGIN main page contents. -->
552 f.write(f'<!--#include virtual="{filename}"-->')
555 <!-- END main page contents. -->
558 <DIV STYLE="position: absolute; top:1030px; width:99%">
562 f.write(f'<FONT SIZE=2 COLOR=#bbbbbb>{pageid} @ {age} ago.</FONT>')
566 <HR id="countdown" STYLE="width:0px;
573 background-color:#ffffff;">
582 def renderer_update_internal_stats_page(
583 last_render: Dict[str, datetime],
584 render_counts: collections.Counter,
585 render_times: Dict[str, np.array],
588 'renderer: Updating internal render statistics page.'
590 with file_writer.file_writer(kiosk_constants.render_stats_pagename) as f:
594 <TABLE BORDER=0 WIDTH=95%>
596 <TH><B>Renderer Name</B></TH>
597 <TH><B>Last Run</B></TH>
598 <TH><B>Num Invocations</B></TH>
599 <TH><B>Render Latency</B></TH>
602 for n, r in enumerate(renderer_catalog.get_renderers()):
604 style = 'style="margin: 0; padding: 0; background: #c6b0b0;"'
606 style = 'style="margin: 0; padding: 0; background: #eeeeee;"'
608 last = last_render.get(name, None)
612 last = last.strftime('%Y/%m/%d %I:%M:%S%P')
613 count = render_counts.get(name, 0)
614 latency = render_times.get(name, np.array([]))
615 p25 = p50 = p75 = p90 = p99 = 'N/A'
617 p25 = np.percentile(latency, 25)
618 p50 = np.percentile(latency, 50)
619 p75 = np.percentile(latency, 75)
620 p90 = np.percentile(latency, 90)
621 p99 = np.percentile(latency, 99)
625 <TD {style}>{name} </TD>
626 <TD {style}> {last} </TD>
627 <TD {style}><CENTER> {count} </CENTER></TD>
628 <TD {style}> p25={p25:5.2f}, p50={p50:5.2f}, p75={p75:5.2f}, p90={p90:5.2f}, p99={p99:5.2f}</TD>
637 def thread_invoke_renderers() -> None:
638 render_times: Dict[str, np.array] = {}
639 render_counts: collections.Counter = collections.Counter()
640 last_render: Dict[str, datetime] = {}
642 # Touch the internal render page now to signal that we're alive.
643 renderer_update_internal_stats_page(last_render, render_counts, render_times)
648 'renderer: invoking all overdue renderers in catalog...'
650 for r in renderer_catalog.get_renderers():
653 logger.info(f'renderer: Invoking {name}\'s render method.')
656 except Exception as e:
659 f'renderer: Unexpected and unhandled exception ({e}) in {name}, swallowing it.'
663 # Increment the count of render operations per renderer.
664 render_counts[name] += 1
666 # Keep track of the last time we invoked each renderer.
667 last_render[name] = datetime_utils.now_pacific()
669 # Record how long each render operation takes and warn if very long.
670 delta = time.time() - now
671 times = render_times.get(name, np.array([]))
672 times = np.insert(times, 0, delta)
673 render_times[name] = times
678 {hdr} Warning: {name}'s rendering took {delta:5.2f}s.
679 {hdr} FYI: {name}'s render times: p25={np.percentile(times, 25):5.2f}, p50={np.percentile(times, 50):5.2f}, p75={np.percentile(times, 75):5.2f}, p90={np.percentile(times, 90):5.2f}, p99={np.percentile(times, 99):5.2f}
683 # Update a page about internal stats of renderers.
684 renderer_update_internal_stats_page(last_render, render_counts, render_times)
685 logger.info('renderer: having a little nap...')
686 time.sleep(kiosk_constants.render_period_sec)
689 @bootstrap.initialize
691 command_queue: Queue = Queue()
692 changer_thread: Optional[Thread] = None
693 renderer_thread: Optional[Thread] = None
694 janitor_thread: Optional[Thread] = None
695 hotword_thread: Optional[Thread] = None
697 if hotword_thread is None or not hotword_thread.is_alive():
698 if hotword_thread is None:
699 logger.info('watchdog: Starting up the hotword detector thread...')
702 'watchdog: The hotword detector thread seems to have died; restarting it and hoping for the best.'
704 keyword_paths = [pvporcupine.KEYWORD_PATHS[x] for x in ["bumblebee"]]
705 sensitivities = [0.7] * len(keyword_paths)
706 listener = listen.HotwordListener(
711 hotword_thread = Thread(target=listener.listen_forever, args=())
712 hotword_thread.start()
714 if changer_thread is None or not changer_thread.is_alive():
715 if changer_thread is None:
716 logger.info('watchdog: Starting up the current page changer thread...')
719 'watchdog: The current page changer thread seems to have died; restarting it and hoping for the best.'
721 changer_thread = Thread(target=thread_change_current, args=(command_queue,))
722 changer_thread.start()
724 if renderer_thread is None or not renderer_thread.is_alive():
725 if renderer_thread is None:
726 logger.info('watchdog: Starting up the page renderer thread...')
729 'watchdog: The page renderer thread seems to have died; restarting it and hoping for the best.'
731 renderer_thread = Thread(target=thread_invoke_renderers, args=())
732 renderer_thread.start()
734 if janitor_thread is None or not janitor_thread.is_alive():
735 if janitor_thread is None:
736 logger.info('watchdog: Starting up the memory janitor thread...')
739 'watchdog: The memory janitor thread seems to have died; restarting it and hoping for the best.'
741 janitor_thread = Thread(target=thread_janitor, args=())
742 janitor_thread.start()
744 # Have a little break and then check to make sure all threads are still alive.
745 logger.debug('watchdog: having a little nap.')
746 time.sleep(kiosk_constants.check_threads_period_sec)
749 if __name__ == "__main__":