3 # © Copyright 2021-2022, Scott Gasch
5 """This is a module dealing with trying to guess a person's location
6 based on the location of certain devices (e.g. phones, laptops)
7 belonging to that person. It works with networks I run that log
8 device MAC addresses active.
16 from collections import defaultdict
17 from typing import Dict, List, Optional, Set
19 # Note: this module is fairly early loaded. Be aware of dependencies.
24 from type.locations import Location
25 from type.people import Person
27 logger = logging.getLogger(__name__)
29 cfg = config.add_commandline_args(
30 f"Presence Detection ({__file__})",
31 "Args related to detection of human beings in locations.",
34 "--presence_macs_file",
36 default="/home/scott/cron/persisted_mac_addresses.txt",
38 help="The location of persisted_mac_addresses.txt to use.",
41 '--presence_tolerable_staleness_seconds',
42 type=argparse_utils.valid_duration,
43 default=datetime.timedelta(seconds=60 * 5),
45 help='Max acceptable age of location data before auto-refreshing',
49 class PresenceDetection(object):
50 """This is a module dealing with trying to guess a person's location
51 based on the location of certain devices (e.g. phones, laptops)
52 belonging to that person. It works with networks I run that log
53 device MAC addresses active.
56 def __init__(self) -> None:
59 # Note: list most important devices first.
60 self.devices_by_person: Dict[Person, List[str]] = {
62 "DC:E5:5B:0F:03:3D", # pixel6
63 "6C:40:08:AE:DC:2E", # laptop
66 "08:CC:27:63:26:14", # motog7
67 "B8:31:B5:9A:4F:19", # laptop
70 "0C:CB:85:0C:8B:AE", # phone
71 "D0:C6:37:E3:36:9A", # laptop
73 Person.AARON_AND_DANA: [
86 self.run_location = site_config.get_location()
87 logger.debug("base_presence run_location is %s", self.run_location)
88 self.weird_mac_at_cabin = False
89 self.location_ts_by_mac: Dict[Location, Dict[str, datetime.datetime]] = defaultdict(dict)
90 self.names_by_mac: Dict[str, str] = {}
91 self.dark_locations: Set[Location] = set()
92 self.last_update: Optional[datetime.datetime] = None
94 def maybe_update(self) -> None:
95 """Determine if our state is stale and needs to be updated and do
99 if self.last_update is None:
102 now = datetime.datetime.now()
103 delta = now - self.last_update
105 delta.total_seconds()
106 > config.config['presence_tolerable_staleness_seconds'].total_seconds()
109 "It's been %ss since last update; refreshing now.", delta.total_seconds()
113 def update(self) -> None:
114 """Unconditionally update our state."""
116 self.dark_locations = set()
119 self.last_update = datetime.datetime.now()
122 def _get_raw_data_via_ssh(location: Location) -> Optional[str]:
123 from exec_utils import cmd
131 f"ssh {canonical[location]} 'cat /home/scott/cron/persisted_mac_addresses.txt'",
132 timeout_seconds=30.0,
137 def _get_raw_data(self, location: Location) -> Optional[str]:
138 from os.path import exists
140 if self.run_location == location:
141 persisted_macs = config.config.get(
142 'presence_macs_file', '/home/scott/cron/persisted_mac_addresses.txt'
144 if exists(persisted_macs):
145 with open(persisted_macs, 'r') as rf:
148 return PresenceDetection._get_raw_data_via_ssh(location)
150 return PresenceDetection._get_raw_data_via_ssh(location)
153 def _update_house(self) -> None:
154 data = self._get_raw_data(Location.HOUSE)
156 self._parse_raw_macs_file(data, Location.HOUSE)
158 msg = "Can't see the house right now; presence detection impared."
160 logger.warning(msg, stacklevel=2)
161 self.dark_locations.add(Location.HOUSE)
163 def _update_cabin(self) -> None:
164 data = self._get_raw_data(Location.CABIN)
166 self._parse_raw_macs_file(data, Location.CABIN)
168 msg = "Can't see the cabin right now; presence detection impared."
170 logger.warning(msg, stacklevel=2)
171 self.dark_locations.add(Location.CABIN)
173 def _parse_raw_macs_file(self, raw: str, location: Location) -> None:
174 """Internal method that parses the contents of the MACs file."""
176 lines = raw.split("\n")
178 # CC:F4:11:D7:FA:EE, 2240, 10.0.0.22 (side_deck_high_home), Google, 1611681990
184 logger.debug('%s> %s', location, line)
187 if location == Location.CABIN:
188 logger.debug('Cabin count: %d', cabin_count)
191 (mac, _, ip_name, _, ts) = line.split(",") # type: ignore
192 except Exception as e:
194 logger.error('SKIPPED BAD LINE> %s', line)
197 (self.location_ts_by_mac[location])[mac] = datetime.datetime.fromtimestamp(
200 ip_name = ip_name.strip()
201 match = re.match(r"(\d+\.\d+\.\d+\.\d+) +\(([^\)]+)\)", ip_name)
202 if match is not None:
203 name = match.group(2)
204 self.names_by_mac[mac] = name
206 logger.debug('Weird MAC at the cabin')
207 self.weird_mac_at_cabin = True
209 def is_anyone_in_location_now(self, location: Location) -> bool:
210 """Determine if anyone is in a given location based on the presence of
211 MAC files seen recently on the network.
214 location: the location in question
217 True if someone is detected or False otherwise.
221 if location in self.dark_locations:
222 raise Exception(f"Can't see {location} right now; answer undefined.")
223 for person in Person:
224 if person is not None:
225 loc = self.where_is_person_now(person)
228 if location == location.CABIN and self.weird_mac_at_cabin:
232 def where_is_person_now(self, name: Person) -> Location:
233 """Given a person, see if we can determine their location based on
234 network MAC addresses.
237 name: The person we're looking for.
240 The Location where we think they are (including UNKNOWN).
244 if len(self.dark_locations) > 0:
245 msg = f"Can't see {self.dark_locations} right now; answer confidence impacted"
247 warnings.warn(msg, stacklevel=2)
248 logger.debug('Looking for %s...', name)
250 if name is Person.UNKNOWN:
251 if self.weird_mac_at_cabin:
252 return Location.CABIN
254 return Location.UNKNOWN
258 votes: Dict[Location, int] = {}
259 tiebreaks: Dict[Location, datetime.datetime] = {}
262 for mac in self.devices_by_person[name]:
263 if mac not in self.names_by_mac:
265 mac_name = self.names_by_mac[mac]
266 logger.debug('Looking for %s... check for mac %s (%s)', name, mac, mac_name)
267 for location in self.location_ts_by_mac:
268 if mac in self.location_ts_by_mac[location]:
269 ts = (self.location_ts_by_mac[location])[mac]
270 logger.debug('Seen %s (%s) at %s since %s', mac, mac_name, location, ts)
271 tiebreaks[location] = ts
274 most_recent_location,
276 ) = dict_utils.item_with_max_value(tiebreaks)
278 v = votes.get(most_recent_location, 0)
279 votes[most_recent_location] = v + bonus
280 logger.debug('%s: %s gets %d votes.', name, most_recent_location, bonus)
281 credit = int(credit * 0.2) # Note: list most important devices first
285 (location, value) = dict_utils.item_with_max_value(votes)
289 return Location.UNKNOWN
292 @bootstrap.initialize
294 p = PresenceDetection()
295 for person in Person:
296 print(f'{person} => {p.where_is_person_now(person)}')
298 for location in Location:
299 print(f'{location} => {p.is_anyone_in_location_now(location)}')
302 if __name__ == '__main__':