5 from typing import List, Optional, Set
11 import smart_home.device as device
12 import smart_home.cameras as cameras
13 import smart_home.chromecasts as chromecasts
14 import smart_home.lights as lights
15 import smart_home.outlets as outlets
17 args = config.add_commandline_args(
18 f"Smart Home Registry ({__file__})",
19 "Args related to the smart home configuration registry."
22 '--smart_home_registry_file_location',
23 default='/home/scott/bin/network_mac_addresses.txt',
25 help='The location of network_mac_addresses.txt',
26 type=argparse_utils.valid_filename,
30 logger = logging.getLogger(__file__)
33 class SmartHomeRegistry(object):
36 registry_file: Optional[str] = None,
37 filters: List[str] = ['smart'],
39 self._macs_by_name = {}
40 self._keywords_by_name = {}
41 self._keywords_by_mac = {}
42 self._names_by_mac = {}
43 self._corpus = logical_search.Corpus()
45 # Read the disk config file...
46 if registry_file is None:
47 registry_file = config.config[
48 'smart_home_registry_file_location'
50 assert file_utils.does_file_exist(registry_file)
51 logger.debug(f'Reading {registry_file}')
52 with open(registry_file, "r") as f:
53 contents = f.readlines()
55 # Parse the contents...
57 line = line.rstrip("\n")
58 line = re.sub(r"#.*$", r"", line)
62 logger.debug(f'SH-CONFIG> {line}')
64 (mac, name, keywords) = line.split(",")
66 msg = f'SH-CONFIG> "{line}" is malformed?! Skipping it.'
71 keywords = keywords.strip()
74 if filters is not None:
77 logger.debug(f'Skipping this entry b/c of filter {f}')
81 self._macs_by_name[name] = mac
82 self._keywords_by_name[name] = keywords
83 self._keywords_by_mac[mac] = keywords
84 self._names_by_mac[mac] = name
85 self.index_device(name, keywords, mac)
87 def index_device(self, name: str, keywords: str, mac: str) -> None:
88 properties = [("name", name)]
90 for kw in keywords.split():
92 key, value = kw.split(":")
93 properties.append((key, value))
96 device = logical_search.Document(
99 properties=properties,
102 logger.debug(f'Indexing document {device}')
103 self._corpus.add_doc(device)
105 def __repr__(self) -> str:
106 s = "Known devices:\n"
107 for name, keywords in self._keywords_by_name.items():
108 mac = self._macs_by_name[name]
109 s += f" {name} ({mac}) => {keywords}\n"
112 def get_keywords_by_name(self, name: str) -> Optional[device.Device]:
113 return self._keywords_by_name.get(name, None)
115 def get_macs_by_name(self, name: str) -> Set[str]:
117 for (mac, lname) in self._names_by_mac.items():
122 def get_macs_by_keyword(self, keyword: str) -> Set[str]:
124 for (mac, keywords) in self._keywords_by_mac.items():
125 if keyword in keywords:
129 def get_device_by_name(self, name: str) -> Optional[device.Device]:
130 if name in self._macs_by_name:
131 return self.get_device_by_mac(self._macs_by_name[name])
134 def get_all_devices(self) -> List[device.Device]:
136 for (mac, kws) in self._keywords_by_mac.items():
138 device = self.get_device_by_mac(mac)
139 if device is not None:
140 retval.append(device)
143 def get_device_by_mac(self, mac: str) -> Optional[device.Device]:
144 if mac in self._keywords_by_mac:
145 name = self._names_by_mac[mac]
146 kws = self._keywords_by_mac[mac]
147 logger.debug(f'Found {name} -> {mac} ({kws})')
149 if 'light' in kws.lower():
150 if 'tplink' in kws.lower():
151 logger.debug(' ...a TPLinkLight')
152 return lights.TPLinkLight(name, mac, kws)
153 elif 'tuya' in kws.lower():
154 logger.debug(' ...a TuyaLight')
155 return lights.TuyaLight(name, mac, kws)
156 elif 'goog' in kws.lower():
157 logger.debug(' ...a GoogleLight')
158 return lights.GoogleLight(name, mac, kws)
160 raise Exception(f'Unknown light device: {name}, {mac}, {kws}')
161 elif 'outlet' in kws.lower():
162 if 'tplink' in kws.lower():
163 if 'children' in kws.lower():
164 logger.debug(' ...a TPLinkOutletWithChildren')
165 return outlets.TPLinkOutletWithChildren(name, mac, kws)
167 logger.debug(' ...a TPLinkOutlet')
168 return outlets.TPLinkOutlet(name, mac, kws)
169 elif 'meross' in kws.lower():
170 logger.debug(' ...a MerossOutlet')
171 return outlets.MerossOutlet(name, mac, kws)
172 elif 'goog' in kws.lower():
173 logger.debug(' ...a GoogleOutlet')
174 return outlets.GoogleOutlet(name, mac, kws)
176 raise Exception(f'Unknown outlet device: {name}, {mac}, {kws}')
177 elif 'camera' in kws.lower():
178 logger.debug(' ...a BaseCamera')
179 return cameras.BaseCamera(name, mac, kws)
180 elif 'ccast' in kws.lower():
181 logger.debug(' ...a Chromecast')
182 return chromecasts.BaseChromecast(name, mac, kws)
184 logger.debug(' ...an unknown device (should this be here?)')
185 return device.Device(name, mac, kws)
186 except Exception as e:
189 f'Device {name} at {mac} with {kws} confused me, returning a generic Device'
191 return device.Device(name, mac, kws)
192 msg = f'{mac} is not a known smart home device, returning None'
196 def query(self, query: str) -> List[device.Device]:
197 """Evaluates a lighting query expression formed of keywords to search
198 for, logical operators (and, or, not), and parenthesis.
199 Returns a list of matching lights.
202 logger.debug(f'Executing query {query}')
203 results = self._corpus.query(query)
204 if results is not None:
207 device = self.get_device_by_mac(mac)
208 if device is not None:
209 retval.append(device)