X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=base_presence.py;h=4b8791d3b0b2220c6d61b7392a3e71a905d152ce;hb=903843730a9916105352c729e94136a755b5e529;hp=ad852f9f7ebce82d5a76c6d7f1436a78670489e7;hpb=31c81f6539969a5eba864d3305f9fb7bf716a367;p=python_utils.git diff --git a/base_presence.py b/base_presence.py index ad852f9..4b8791d 100755 --- a/base_presence.py +++ b/base_presence.py @@ -1,5 +1,14 @@ #!/usr/bin/env python3 +# © Copyright 2021-2022, Scott Gasch + +"""This is a module dealing with trying to guess a person's location +based on the location of certain devices (e.g. phones, laptops) +belonging to that person. It works with networks I run that log +device MAC addresses active. + +""" + import datetime import logging import re @@ -38,7 +47,15 @@ cfg.add_argument( class PresenceDetection(object): + """This is a module dealing with trying to guess a person's location + based on the location of certain devices (e.g. phones, laptops) + belonging to that person. It works with networks I run that log + device MAC addresses active. + """ + def __init__(self) -> None: + """C'tor""" + # Note: list most important devices first. self.devices_by_person: Dict[Person, List[str]] = { Person.SCOTT: [ @@ -67,16 +84,18 @@ class PresenceDetection(object): ], } self.run_location = site_config.get_location() - logger.debug(f"run_location is {self.run_location}") + logger.debug("base_presence run_location is %s", self.run_location) self.weird_mac_at_cabin = False - self.location_ts_by_mac: Dict[ - Location, Dict[str, datetime.datetime] - ] = defaultdict(dict) + self.location_ts_by_mac: Dict[Location, Dict[str, datetime.datetime]] = defaultdict(dict) self.names_by_mac: Dict[str, str] = {} self.dark_locations: Set[Location] = set() self.last_update: Optional[datetime.datetime] = None def maybe_update(self) -> None: + """Determine if our state is stale and needs to be updated and do + it, if so. + """ + if self.last_update is None: self.update() else: @@ -87,34 +106,39 @@ class PresenceDetection(object): > config.config['presence_tolerable_staleness_seconds'].total_seconds() ): logger.debug( - f"It's been {delta.total_seconds()}s since last update; refreshing now." + "It's been %ss since last update; refreshing now.", delta.total_seconds() ) self.update() def update(self) -> None: + """Unconditionally update our state.""" + self.dark_locations = set() if self.run_location is Location.HOUSE: - self.update_from_house() + self._update_from_house() elif self.run_location is Location.CABIN: - self.update_from_cabin() + self._update_from_cabin() else: raise Exception("Where the hell is this running?!") self.last_update = datetime.datetime.now() - def update_from_house(self) -> None: + def _update_from_house(self) -> None: + """Internal method for updating from code running on the house + network.""" + from exec_utils import cmd try: persisted_macs = config.config['presence_macs_file'] except KeyError: persisted_macs = '/home/scott/cron/persisted_mac_addresses.txt' - self.read_persisted_macs_file(persisted_macs, Location.HOUSE) + self._read_persisted_macs_file(persisted_macs, Location.HOUSE) try: raw = cmd( "ssh scott@meerkat.cabin 'cat /home/scott/cron/persisted_mac_addresses.txt'", - timeout_seconds=10.0, + timeout_seconds=20.0, ) - self.parse_raw_macs_file(raw, Location.CABIN) + self._parse_raw_macs_file(raw, Location.CABIN) except Exception as e: logger.exception(e) msg = "Can't see the cabin right now; presence detection impared." @@ -122,20 +146,23 @@ class PresenceDetection(object): logger.warning(msg, stacklevel=2) self.dark_locations.add(Location.CABIN) - def update_from_cabin(self) -> None: + def _update_from_cabin(self) -> None: + """Internal method for updating from code running on the cabing + network.""" + from exec_utils import cmd try: persisted_macs = config.config['presence_macs_file'] except KeyError: persisted_macs = '/home/scott/cron/persisted_mac_addresses.txt' - self.read_persisted_macs_file(persisted_macs, Location.CABIN) + self._read_persisted_macs_file(persisted_macs, Location.CABIN) try: raw = cmd( - "ssh scott@wennabe.house 'cat /home/scott/cron/persisted_mac_addresses.txt'", + "ssh scott@wannabe.house 'cat /home/scott/cron/persisted_mac_addresses.txt'", timeout_seconds=10.0, ) - self.parse_raw_macs_file(raw, Location.HOUSE) + self._parse_raw_macs_file(raw, Location.HOUSE) except Exception as e: logger.exception(e) msg = "Can't see the house right now; presence detection impared." @@ -143,14 +170,25 @@ class PresenceDetection(object): warnings.warn(msg, stacklevel=2) self.dark_locations.add(Location.HOUSE) - def read_persisted_macs_file(self, filename: str, location: Location) -> None: + def _read_persisted_macs_file(self, filename: str, location: Location) -> None: + """Internal method that, Given a filename that contains MAC addresses + seen on the network recently, reads it in and calls + _parse_raw_macs_file with the contents. + + Args: + filename: The name of the file to read + location: The location we're reading from + + """ if location is Location.UNKNOWN: return with open(filename, "r") as rf: lines = rf.read() - self.parse_raw_macs_file(lines, location) + self._parse_raw_macs_file(lines, location) + + def _parse_raw_macs_file(self, raw: str, location: Location) -> None: + """Internal method that parses the contents of the MACs file.""" - def parse_raw_macs_file(self, raw: str, location: Location) -> None: lines = raw.split("\n") # CC:F4:11:D7:FA:EE, 2240, 10.0.0.22 (side_deck_high_home), Google, 1611681990 @@ -159,17 +197,17 @@ class PresenceDetection(object): line = line.strip() if len(line) == 0: continue - logger.debug(f'{location}> {line}') + logger.debug('%s> %s', location, line) if "cabin_" in line: continue if location == Location.CABIN: - logger.debug(f'Cabin count: {cabin_count}') + logger.debug('Cabin count: %d', cabin_count) cabin_count += 1 try: - (mac, count, ip_name, mfg, ts) = line.split(",") + (mac, _, ip_name, _, ts) = line.split(",") # type: ignore except Exception as e: - logger.error(f'SKIPPED BAD LINE> {line}') logger.exception(e) + logger.error('SKIPPED BAD LINE> %s', line) continue mac = mac.strip() (self.location_ts_by_mac[location])[mac] = datetime.datetime.fromtimestamp( @@ -185,6 +223,16 @@ class PresenceDetection(object): self.weird_mac_at_cabin = True def is_anyone_in_location_now(self, location: Location) -> bool: + """Determine if anyone is in a given location based on the presence of + MAC files seen recently on the network. + + Args: + location: the location in question + + Returns: + True if someone is detected or False otherwise. + """ + self.maybe_update() if location in self.dark_locations: raise Exception(f"Can't see {location} right now; answer undefined.") @@ -198,14 +246,22 @@ class PresenceDetection(object): return False def where_is_person_now(self, name: Person) -> Location: + """Given a person, see if we can determine their location based on + network MAC addresses. + + Args: + name: The person we're looking for. + + Returns: + The Location where we think they are (including UNKNOWN). + """ + self.maybe_update() if len(self.dark_locations) > 0: - msg = ( - f"Can't see {self.dark_locations} right now; answer confidence impacted" - ) + msg = f"Can't see {self.dark_locations} right now; answer confidence impacted" logger.warning(msg) warnings.warn(msg, stacklevel=2) - logger.debug(f'Looking for {name}...') + logger.debug('Looking for %s...', name) if name is Person.UNKNOWN: if self.weird_mac_at_cabin: @@ -218,31 +274,33 @@ class PresenceDetection(object): votes: Dict[Location, int] = {} tiebreaks: Dict[Location, datetime.datetime] = {} credit = 10000 + location = None for mac in self.devices_by_person[name]: if mac not in self.names_by_mac: continue mac_name = self.names_by_mac[mac] - logger.debug(f'Looking for {name}... check for mac {mac} ({mac_name})') + logger.debug('Looking for %s... check for mac %s (%s)', name, mac, mac_name) for location in self.location_ts_by_mac: if mac in self.location_ts_by_mac[location]: ts = (self.location_ts_by_mac[location])[mac] - logger.debug(f'Seen {mac} ({mac_name}) at {location} since {ts}') + logger.debug('Seen %s (%s) at %s since %s', mac, mac_name, location, ts) tiebreaks[location] = ts ( most_recent_location, - first_seen_ts, + _, ) = dict_utils.item_with_max_value(tiebreaks) bonus = credit v = votes.get(most_recent_location, 0) votes[most_recent_location] = v + bonus - logger.debug(f'{name}: {location} gets {bonus} votes.') + logger.debug('%s: %s gets %d votes.', name, most_recent_location, bonus) credit = int(credit * 0.2) # Note: list most important devices first if credit <= 0: credit = 1 if len(votes) > 0: (location, value) = dict_utils.item_with_max_value(votes) if value > 2001: + assert location return location return Location.UNKNOWN @@ -253,10 +311,8 @@ def main() -> None: for person in Person: print(f'{person} => {p.where_is_person_now(person)}') print() - - -# for location in Location: -# print(f'{location} => {p.is_anyone_in_location_now(location)}') + for location in Location: + print(f'{location} => {p.is_anyone_in_location_now(location)}') if __name__ == '__main__':