base_presence.py

   1 #!/usr/bin/env python3
   2
   3 import datetime
   4 from collections import defaultdict
   5 import logging
   6 import re
   7 from typing import Dict, List, Optional, Set
   8 import warnings
   9
  10 # Note: this module is fairly early loaded.  Be aware of dependencies.
  11 import argparse_utils
  12 import bootstrap
  13 import config
  14 from type.locations import Location
  15 from type.people import Person
  16 import site_config
  17
  18
  19 logger = logging.getLogger(__name__)
  20
  21 cfg = config.add_commandline_args(
  22     f"Presence Detection ({__file__})",
  23     "Args related to detection of human beings in locations.",
  24 )
  25 cfg.add_argument(
  26     "--presence_macs_file",
  27     type=argparse_utils.valid_filename,
  28     default="/home/scott/cron/persisted_mac_addresses.txt",
  29     metavar="FILENAME",
  30     help="The location of persisted_mac_addresses.txt to use.",
  31 )
  32 cfg.add_argument(
  33     '--presence_tolerable_staleness_seconds',
  34     type=argparse_utils.valid_duration,
  35     default=datetime.timedelta(seconds=60 * 5),
  36     metavar='DURATION',
  37     help='Max acceptable age of location data before auto-refreshing',
  38 )
  39
  40
  41 class PresenceDetection(object):
  42     def __init__(self) -> None:
  43         # Note: list most important devices first.
  44         self.devices_by_person: Dict[Person, List[str]] = {
  45             Person.SCOTT: [
  46                 "DC:E5:5B:0F:03:3D",  # pixel6
  47                 "6C:40:08:AE:DC:2E",  # laptop
  48             ],
  49             Person.LYNN: [
  50                 "08:CC:27:63:26:14",  # motog7
  51                 "B8:31:B5:9A:4F:19",  # laptop
  52             ],
  53             Person.ALEX: [
  54                 "0C:CB:85:0C:8B:AE",  # phone
  55                 "D0:C6:37:E3:36:9A",  # laptop
  56             ],
  57             Person.AARON_AND_DANA: [
  58                 "98:B6:E9:E5:5A:7C",
  59                 "D6:2F:37:CA:B2:9B",
  60                 "6C:E8:5C:ED:17:26",
  61                 "90:E1:7B:13:7C:E5",
  62                 "6E:DC:7C:75:02:1B",
  63                 "B2:16:1A:93:7D:50",
  64                 "18:65:90:DA:3A:35",
  65                 "22:28:C8:7D:3C:85",
  66                 "B2:95:23:69:91:F8",
  67                 "96:69:2C:88:7A:C3",
  68             ],
  69         }
  70         self.run_location = site_config.get_location()
  71         logger.debug(f"run_location is {self.run_location}")
  72         self.weird_mac_at_cabin = False
  73         self.location_ts_by_mac: Dict[
  74             Location, Dict[str, datetime.datetime]
  75         ] = defaultdict(dict)
  76         self.names_by_mac: Dict[str, str] = {}
  77         self.dark_locations: Set[Location] = set()
  78         self.last_update: Optional[datetime.datetime] = None
  79
  80     def maybe_update(self) -> None:
  81         if self.last_update is None:
  82             self.update()
  83         else:
  84             now = datetime.datetime.now()
  85             delta = now - self.last_update
  86             if (
  87                 delta.total_seconds()
  88                 > config.config['presence_tolerable_staleness_seconds'].total_seconds()
  89             ):
  90                 logger.debug(
  91                     f"It's been {delta.total_seconds()}s since last update; refreshing now."
  92                 )
  93                 self.update()
  94
  95     def update(self) -> None:
  96         self.dark_locations = set()
  97         if self.run_location is Location.HOUSE:
  98             self.update_from_house()
  99         elif self.run_location is Location.CABIN:
 100             self.update_from_cabin()
 101         else:
 102             raise Exception("Where the hell is this running?!")
 103         self.last_update = datetime.datetime.now()
 104
 105     def update_from_house(self) -> None:
 106         from exec_utils import cmd
 107
 108         try:
 109             persisted_macs = config.config['presence_macs_file']
 110         except KeyError:
 111             persisted_macs = '/home/scott/cron/persisted_mac_addresses.txt'
 112         self.read_persisted_macs_file(persisted_macs, Location.HOUSE)
 113         try:
 114             raw = cmd(
 115                 "ssh [email protected] 'cat /home/scott/cron/persisted_mac_addresses.txt'",
 116                 timeout_seconds=10.0,
 117             )
 118             self.parse_raw_macs_file(raw, Location.CABIN)
 119         except Exception as e:
 120             logger.exception(e)
 121             msg = "Can't see the cabin right now; presence detection impared."
 122             warnings.warn(msg)
 123             logger.warning(msg, stacklevel=2)
 124             self.dark_locations.add(Location.CABIN)
 125
 126     def update_from_cabin(self) -> None:
 127         from exec_utils import cmd
 128
 129         try:
 130             persisted_macs = config.config['presence_macs_file']
 131         except KeyError:
 132             persisted_macs = '/home/scott/cron/persisted_mac_addresses.txt'
 133         self.read_persisted_macs_file(persisted_macs, Location.CABIN)
 134         try:
 135             raw = cmd(
 136                 "ssh [email protected] 'cat /home/scott/cron/persisted_mac_addresses.txt'",
 137                 timeout_seconds=10.0,
 138             )
 139             self.parse_raw_macs_file(raw, Location.HOUSE)
 140         except Exception as e:
 141             logger.exception(e)
 142             msg = "Can't see the house right now; presence detection impared."
 143             logger.warning(msg)
 144             warnings.warn(msg, stacklevel=2)
 145             self.dark_locations.add(Location.HOUSE)
 146
 147     def read_persisted_macs_file(self, filename: str, location: Location) -> None:
 148         if location is Location.UNKNOWN:
 149             return
 150         with open(filename, "r") as rf:
 151             lines = rf.read()
 152         self.parse_raw_macs_file(lines, location)
 153
 154     def parse_raw_macs_file(self, raw: str, location: Location) -> None:
 155         lines = raw.split("\n")
 156
 157         # CC:F4:11:D7:FA:EE, 2240, 10.0.0.22 (side_deck_high_home), Google, 1611681990
 158         cabin_count = 0
 159         for line in lines:
 160             line = line.strip()
 161             if len(line) == 0:
 162                 continue
 163             logger.debug(f'{location}> {line}')
 164             if "cabin_" in line:
 165                 continue
 166             if location == Location.CABIN:
 167                 logger.debug(f'Cabin count: {cabin_count}')
 168                 cabin_count += 1
 169             try:
 170                 (mac, count, ip_name, mfg, ts) = line.split(",")
 171             except Exception as e:
 172                 logger.error(f'SKIPPED BAD LINE> {line}')
 173                 logger.exception(e)
 174                 continue
 175             mac = mac.strip()
 176             (self.location_ts_by_mac[location])[mac] = datetime.datetime.fromtimestamp(
 177                 int(ts.strip())
 178             )
 179             ip_name = ip_name.strip()
 180             match = re.match(r"(\d+\.\d+\.\d+\.\d+) +\(([^\)]+)\)", ip_name)
 181             if match is not None:
 182                 name = match.group(2)
 183                 self.names_by_mac[mac] = name
 184         if cabin_count > 0:
 185             logger.debug('Weird MAC at the cabin')
 186             self.weird_mac_at_cabin = True
 187
 188     def is_anyone_in_location_now(self, location: Location) -> bool:
 189         self.maybe_update()
 190         if location in self.dark_locations:
 191             raise Exception(f"Can't see {location} right now; answer undefined.")
 192         for person in Person:
 193             if person is not None:
 194                 loc = self.where_is_person_now(person)
 195                 if location == loc:
 196                     return True
 197         if location == location.CABIN and self.weird_mac_at_cabin:
 198             return True
 199         return False
 200
 201     def where_is_person_now(self, name: Person) -> Location:
 202         self.maybe_update()
 203         if len(self.dark_locations) > 0:
 204             msg = (
 205                 f"Can't see {self.dark_locations} right now; answer confidence impacted"
 206             )
 207             logger.warning(msg)
 208             warnings.warn(msg, stacklevel=2)
 209         logger.debug(f'Looking for {name}...')
 210
 211         if name is Person.UNKNOWN:
 212             if self.weird_mac_at_cabin:
 213                 return Location.CABIN
 214             else:
 215                 return Location.UNKNOWN
 216
 217         import dict_utils
 218
 219         votes: Dict[Location, int] = {}
 220         tiebreaks: Dict[Location, datetime.datetime] = {}
 221         credit = 10000
 222         for mac in self.devices_by_person[name]:
 223             if mac not in self.names_by_mac:
 224                 continue
 225             mac_name = self.names_by_mac[mac]
 226             logger.debug(f'Looking for {name}... check for mac {mac} ({mac_name})')
 227             for location in self.location_ts_by_mac:
 228                 if mac in self.location_ts_by_mac[location]:
 229                     ts = (self.location_ts_by_mac[location])[mac]
 230                     logger.debug(f'Seen {mac} ({mac_name}) at {location} since {ts}')
 231                     tiebreaks[location] = ts
 232
 233             (
 234                 most_recent_location,
 235                 first_seen_ts,
 236             ) = dict_utils.item_with_max_value(tiebreaks)
 237             bonus = credit
 238             v = votes.get(most_recent_location, 0)
 239             votes[most_recent_location] = v + bonus
 240             logger.debug(f'{name}: {location} gets {bonus} votes.')
 241             credit = int(credit * 0.2)  # Note: list most important devices first
 242             if credit <= 0:
 243                 credit = 1
 244         if len(votes) > 0:
 245             (location, value) = dict_utils.item_with_max_value(votes)
 246             if value > 2001:
 247                 return location
 248         return Location.UNKNOWN
 249
 250
 251 @bootstrap.initialize
 252 def main() -> None:
 253     p = PresenceDetection()
 254     for person in Person:
 255         print(f'{person} => {p.where_is_person_now(person)}')
 256     print()
 257
 258
 259 #    for location in Location:
 260 #        print(f'{location} => {p.is_anyone_in_location_now(location)}')
 261
 262
 263 if __name__ == '__main__':
 264     main()