1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
|
import logging
import socket
import time
from enum import Enum
from getmac import get_mac_address
from zeroconf import Error as ZeroconfError
from zeroconf import (
IPVersion,
ServiceBrowser,
ServiceInfo,
ServiceStateChange,
current_time_millis,
)
from boschshcpy.exceptions import (
SHCAuthenticationError,
SHCConnectionError,
)
logger = logging.getLogger("boschshcpy")
class SHCListener:
"""SHC Listener for Zeroconf browser updates."""
def __init__(self, zeroconf, callback) -> None:
"""Initialize SHC Listener."""
self.shc_services = {}
self.waiting = True
browser = ServiceBrowser(
zeroconf, "_http._tcp.local.", handlers=[self.service_update]
)
current_millis = current_time_millis()
while (
self.waiting and current_time_millis() - current_millis < 10000
): # Give zeroconf some time to respond
time.sleep(0.1)
callback(self.shc_services)
browser.cancel()
def service_update(self, zeroconf, service_type, name, state_change):
"""Service state changed."""
if state_change != ServiceStateChange.Added:
return
try:
service_info = zeroconf.get_service_info(service_type, name)
except ZeroconfError:
logger.exception("Failed to get info for device %s", name)
return
if service_info is not None:
if service_info.name.startswith("Bosch SHC"):
self.waiting = False
self.shc_services[name] = service_info
return
class SHCInformation:
class UpdateState(Enum):
NO_UPDATE_AVAILABLE = "NO_UPDATE_AVAILABLE"
DOWNLOADING = "DOWNLOADING"
UPDATE_IN_PROGRESS = "UPDATE_IN_PROGRESS"
UPDATE_AVAILABLE = "UPDATE_AVAILABLE"
def __init__(self, api, authenticate=True, zeroconf=None):
self._api = api
self._unique_id = None
self._name = None
self._pub_info = self._api.get_public_information()
if self._pub_info == None:
raise SHCConnectionError
if authenticate:
if self._api.get_information() == None:
raise SHCAuthenticationError
self.get_unique_id(zeroconf)
@property
def version(self):
return self._pub_info["softwareUpdateState"]["swInstalledVersion"]
@property
def updateState(self) -> UpdateState:
return self.UpdateState(self._pub_info["softwareUpdateState"]["swUpdateState"])
@property
def shcIpAddress(self):
"""Get the ip address from public information."""
return (
self._pub_info["shcIpAddress"] if "shcIpAddress" in self._pub_info else None
)
@property
def macAddress(self):
"""Get the mac address from public information."""
return self._pub_info["macAddress"] if "macAddress" in self._pub_info else None
@property
def name(self):
return self._name
@property
def unique_id(self):
return self._unique_id
def filter(self, service_info: ServiceInfo):
mac_address = None
name = None
try:
host_ip = socket.gethostbyname(self.shcIpAddress)
except Exception as e:
host_ip = None
for info in service_info.values():
if "Bosch SHC" in info.name:
if (
host_ip in info.parsed_addresses(IPVersion.V4Only)
or host_ip is None
):
mac_address = info.name[
info.name.find("[") + 1 : info.name.find("]")
]
server_pos = info.server.find(".local.")
if server_pos > -1:
name = info.server[:server_pos]
if mac_address is None or name is None:
return
self._unique_id = format_mac(mac_address)
self._name = name
def get_unique_id(self, zeroconf):
if zeroconf is not None:
self._listener = SHCListener(zeroconf, self.filter)
if self._unique_id is not None:
logger.debug(
"Obtain unique_id for '%s' via zeroconf: '%s'",
self._name,
self._unique_id,
)
return
if self.macAddress is not None:
self._unique_id = self.macAddress
self._name = (
self.shcIpAddress if self.shcIpAddress is not None else self.macAddress
)
logger.debug(
"Obtain unique_id for '%s' via public information: '%s'",
self._name,
self._unique_id,
)
elif self.shcIpAddress is not None:
host = self.shcIpAddress
try:
mac_address = get_mac_address(ip=host)
if not mac_address:
mac_address = get_mac_address(hostname=host)
except Exception as err: # pylint: disable=broad-except
logger.exception("Unable to get mac address: %s", err)
if mac_address is not None:
self._unique_id = format_mac(mac_address)
logger.debug(
"Obtain unique_id for '%s' via host IP: '%s'",
self._name,
self._unique_id,
)
else:
self._unique_id = host
logger.warning(
"Cannot obtain unique id, using IP address '%s' instead. Please make sure the IP stays the same!",
host,
)
self._name = host
else:
raise SHCConnectionError
def summary(self):
print(f"Information:")
print(f" shcIpAddress : {self.shcIpAddress}")
print(f" macAddress : {self.macAddress}")
print(f" SW-Version : {self.version}")
print(f" updateState : {self.updateState.name}")
print(f" uniqueId : {self.unique_id}")
print(f" name : {self.name}")
def format_mac(mac: str) -> str:
"""
Format the mac address string.
Helper function from homeassistant.helpers.device_registry.py
"""
to_test = mac
if len(to_test) == 17 and to_test.count("-") == 5:
return to_test.lower()
if len(to_test) == 17 and to_test.count(":") == 5:
to_test = to_test.replace(":", "")
elif len(to_test) == 14 and to_test.count(".") == 2:
to_test = to_test.replace(".", "")
if len(to_test) == 12:
# no - included
return "-".join(to_test.lower()[i : i + 2] for i in range(0, 12, 2))
# Not sure how formatted, return original
return mac
|