presence.py

   1 #!/usr/bin/env python3
   2
   3 import datetime
   4 from collections import defaultdict
   5 import enum
   6 import logging
   7 import re
   8 from typing import Dict, List
   9
  10 # Note: this module is fairly early loaded.  Be aware of dependencies.
  11 import argparse_utils
  12 import bootstrap
  13 import config
  14
  15 logger = logging.getLogger(__name__)
  16
  17 cfg = config.add_commandline_args(
  18     f"Presence Detection ({__file__})",
  19     "Args related to detection of human beings in locations.",
  20 )
  21 cfg.add_argument(
  22     "--presence_macs_file",
  23     type=argparse_utils.valid_filename,
  24     default = "/home/scott/cron/persisted_mac_addresses.txt",
  25     metavar="FILENAME",
  26     help="The location of persisted_mac_addresses.txt to use."
  27 )
  28
  29
  30 class Person(enum.Enum):
  31     UNKNOWN = 0
  32     SCOTT = 1
  33     LYNN = 2
  34     ALEX = 3
  35     AARON_AND_DANA = 4
  36     AARON = 4
  37     DANA = 4
  38
  39
  40 @enum.unique
  41 class Location(enum.Enum):
  42     UNKNOWN = 0
  43     HOUSE = 1
  44     CABIN = 2
  45
  46
  47 class PresenceDetection(object):
  48     def __init__(self) -> None:
  49         # Note: list most important devices first.
  50         self.devices_by_person: Dict[Person, List[str]] = {
  51             Person.SCOTT: [
  52                 "3C:28:6D:10:6D:41", # pixel3
  53                 "6C:40:08:AE:DC:2E", # laptop
  54 #                "D4:61:2E:88:18:09", # watch
  55 #                "14:7D:DA:6A:20:D7", # work laptop
  56             ],
  57             Person.LYNN: [
  58                 "08:CC:27:63:26:14",
  59                 "B8:31:B5:9A:4F:19",
  60             ],
  61             Person.ALEX: [
  62                 "0C:CB:85:0C:8B:AE",
  63                 "D0:C6:37:E3:36:9A",
  64             ],
  65             Person.AARON_AND_DANA: [
  66                 "98:B6:E9:E5:5A:7C",
  67                 "D6:2F:37:CA:B2:9B",
  68                 "6C:E8:5C:ED:17:26",
  69                 "90:E1:7B:13:7C:E5",
  70                 "6E:DC:7C:75:02:1B",
  71                 "B2:16:1A:93:7D:50",
  72                 "18:65:90:DA:3A:35",
  73                 "22:28:C8:7D:3C:85",
  74                 "B2:95:23:69:91:F8",
  75                 "96:69:2C:88:7A:C3",
  76             ],
  77         }
  78         self.weird_mac_at_cabin = False
  79         self.location_ts_by_mac: Dict[
  80             Location, Dict[str, datetime.datetime]
  81         ] = defaultdict(dict)
  82         self.names_by_mac: Dict[str, str] = {}
  83         self.update()
  84
  85     def update(self) -> None:
  86         from exec_utils import cmd
  87         try:
  88             persisted_macs = config.config['presence_macs_file']
  89         except KeyError:
  90             persisted_macs = '/home/scott/cron/persisted_mac_addresses.txt'
  91         self.read_persisted_macs_file(persisted_macs, Location.HOUSE)
  92         raw = cmd(
  93             "ssh [email protected] 'cat /home/scott/cron/persisted_mac_addresses.txt'"
  94         )
  95         self.parse_raw_macs_file(raw, Location.CABIN)
  96
  97     def read_persisted_macs_file(
  98         self, filename: str, location: Location
  99     ) -> None:
 100         if location is Location.UNKNOWN:
 101             return
 102         with open(filename, "r") as rf:
 103             lines = rf.read()
 104         self.parse_raw_macs_file(lines, location)
 105
 106     def parse_raw_macs_file(self, raw: str, location: Location) -> None:
 107         lines = raw.split("\n")
 108
 109         # CC:F4:11:D7:FA:EE, 2240, 10.0.0.22 (side_deck_high_home), Google, 1611681990
 110         cabin_count = 0
 111         for line in lines:
 112             line = line.strip()
 113             if len(line) == 0:
 114                 continue
 115             logger.debug(f'{location}> {line}')
 116             if "cabin_" in line:
 117                 continue
 118             if location == Location.CABIN:
 119                 logger.debug('Cabin count: {cabin_count}')
 120                 cabin_count += 1
 121             try:
 122                 (mac, count, ip_name, mfg, ts) = line.split(",")
 123             except Exception as e:
 124                 logger.error(f'SKIPPED BAD LINE> {line}')
 125                 logger.exception(e)
 126                 continue
 127             mac = mac.strip()
 128             (self.location_ts_by_mac[location])[
 129                 mac
 130             ] = datetime.datetime.fromtimestamp(int(ts.strip()))
 131             ip_name = ip_name.strip()
 132             match = re.match(r"(\d+\.\d+\.\d+\.\d+) +\(([^\)]+)\)", ip_name)
 133             if match is not None:
 134                 name = match.group(2)
 135                 self.names_by_mac[mac] = name
 136         if cabin_count > 0:
 137             logger.debug('Weird MAC at the cabin')
 138             self.weird_mac_at_cabin = True
 139
 140     def is_anyone_in_location_now(self, location: Location) -> bool:
 141         for person in Person:
 142             if person is not None:
 143                 loc = self.where_is_person_now(person)
 144                 if location == loc:
 145                     return True
 146         if location == location.CABIN and self.weird_mac_at_cabin:
 147             return True
 148         return False
 149
 150     def where_is_person_now(self, name: Person) -> Location:
 151         import dict_utils
 152
 153         if name is Person.UNKNOWN:
 154             if self.weird_mac_at_cabin:
 155                 return Location.CABIN
 156             else:
 157                 return Location.UNKNOWN
 158         votes: Dict[Location, int] = {}
 159         tiebreaks: Dict[Location, datetime.datetime] = {}
 160         credit = 10000
 161         for mac in self.devices_by_person[name]:
 162             logger.debug(f'Looking for {name}... check for mac {mac}')
 163             if mac not in self.names_by_mac:
 164                 continue
 165             for location in self.location_ts_by_mac:
 166                 if mac in self.location_ts_by_mac[location]:
 167                     ts = (self.location_ts_by_mac[location])[mac]
 168                     logger.debug(f'I saw {mac} at {location} at {ts}')
 169                     tiebreaks[location] = ts
 170             location = dict_utils.key_with_min_value(tiebreaks)
 171             v = votes.get(location, 0)
 172             votes[location] = v + credit
 173             logger.debug(f'{name}: {location} gets {credit} votes.')
 174             credit = int(
 175                 credit * 0.667
 176             )  # Note: list most important devices first
 177             if credit <= 0:
 178                 credit = 1
 179         if len(votes) > 0:
 180             item = dict_utils.item_with_max_value(votes)
 181             return item[0]
 182         return Location.UNKNOWN
 183
 184
 185 @bootstrap.initialize
 186 def main() -> None:
 187     p = PresenceDetection()
 188     for person in Person:
 189         print(f'{person} => {p.where_is_person_now(person)}')
 190     print()
 191     for location in Location:
 192         print(f'{location} => {p.is_anyone_in_location_now(location)}')
 193
 194
 195 if __name__ == '__main__':
 196     main()