"""Mikrotik Controller for Mikrotik Router.""" import asyncio import logging from datetime import timedelta from ipaddress import ip_address, IPv4Network from homeassistant.core import callback from homeassistant.helpers.dispatcher import async_dispatcher_send from homeassistant.helpers.event import async_track_time_interval from homeassistant.util.dt import utcnow from homeassistant.components.device_tracker import DOMAIN as DEVICE_TRACKER_DOMAIN from homeassistant.const import ( CONF_NAME, CONF_HOST, CONF_PORT, CONF_UNIT_OF_MEASUREMENT, CONF_USERNAME, CONF_PASSWORD, CONF_SSL, ) from .const import ( DOMAIN, CONF_TRACK_IFACE_CLIENTS, DEFAULT_TRACK_IFACE_CLIENTS, CONF_TRACK_HOSTS, DEFAULT_TRACK_HOSTS, CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL, DEFAULT_UNIT_OF_MEASUREMENT, ) from .exceptions import ApiEntryNotFound from .helper import from_entry, parse_api from .mikrotikapi import MikrotikAPI _LOGGER = logging.getLogger(__name__) # --------------------------- # MikrotikControllerData # --------------------------- class MikrotikControllerData: """MikrotikController Class""" def __init__(self, hass, config_entry): """Initialize MikrotikController.""" self.hass = hass self.config_entry = config_entry self.name = config_entry.data[CONF_NAME] self.host = config_entry.data[CONF_HOST] self.data = { "routerboard": {}, "resource": {}, "interface": {}, "arp": {}, "arp_tmp": {}, "nat": {}, "fw-update": {}, "script": {}, "queue": {}, "dns": {}, "dhcp-server": {}, "dhcp-network": {}, "dhcp": {}, "capsman_hosts": {}, "wireless_hosts": {}, "host": {}, "host_hass": {}, "accounting": {} } self.listeners = [] self.lock = asyncio.Lock() self.api = MikrotikAPI( config_entry.data[CONF_HOST], config_entry.data[CONF_USERNAME], config_entry.data[CONF_PASSWORD], config_entry.data[CONF_PORT], config_entry.data[CONF_SSL] ) self.nat_removed = {} self.host_hass_recovered = False self.support_capsman = False self.support_wireless = False async_track_time_interval( self.hass, self.force_update, self.option_scan_interval ) async_track_time_interval( self.hass, self.force_fwupdate_check, timedelta(hours=1) ) # --------------------------- # option_track_iface_clients # --------------------------- @property def option_track_iface_clients(self): """Config entry option to not track ARP.""" return self.config_entry.options.get(CONF_TRACK_IFACE_CLIENTS, DEFAULT_TRACK_IFACE_CLIENTS) # --------------------------- # option_track_network_hosts # --------------------------- @property def option_track_network_hosts(self): """Config entry option to not track ARP.""" return self.config_entry.options.get(CONF_TRACK_HOSTS, DEFAULT_TRACK_HOSTS) # --------------------------- # option_scan_interval # --------------------------- @property def option_scan_interval(self): """Config entry option scan interval.""" scan_interval = self.config_entry.options.get( CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL ) return timedelta(seconds=scan_interval) # --------------------------- # option_unit_of_measurement # --------------------------- @property def option_unit_of_measurement(self): """Config entry option to not track ARP.""" return self.config_entry.options.get( CONF_UNIT_OF_MEASUREMENT, DEFAULT_UNIT_OF_MEASUREMENT ) # --------------------------- # signal_update # --------------------------- @property def signal_update(self): """Event to signal new data.""" return f"{DOMAIN}-update-{self.name}" # --------------------------- # async_reset # --------------------------- async def async_reset(self): """Reset dispatchers""" for unsub_dispatcher in self.listeners: unsub_dispatcher() self.listeners = [] return True # --------------------------- # connected # --------------------------- def connected(self): """Return connected state""" return self.api.connected() # --------------------------- # set_value # --------------------------- def set_value(self, path, param, value, mod_param, mod_value): """Change value using Mikrotik API""" return self.api.update(path, param, value, mod_param, mod_value) # --------------------------- # run_script # --------------------------- def run_script(self, name): """Run script using Mikrotik API""" try: self.api.run_script(name) except ApiEntryNotFound as error: _LOGGER.error("Failed to run script: %s", error) # --------------------------- # get_capabilities # --------------------------- def get_capabilities(self): """Update Mikrotik data""" packages = parse_api( data={}, source=self.api.path("/system/package"), key="name", vals=[ {"name": "name"}, { "name": "enabled", "source": "disabled", "type": "bool", "reverse": True, }, ], ) if "wireless" in packages: self.support_capsman = packages["wireless"]["enabled"] self.support_wireless = packages["wireless"]["enabled"] else: self.support_capsman = False self.support_wireless = False # --------------------------- # async_get_host_hass # --------------------------- async def async_get_host_hass(self): """Get host data from HA entity registry""" registry = await self.hass.helpers.entity_registry.async_get_registry() for entity in registry.entities.values(): if entity.config_entry_id == self.config_entry.entry_id \ and entity.domain == DEVICE_TRACKER_DOMAIN \ and "-host-" in entity.unique_id: _, mac = entity.unique_id.split("-host-", 2) self.data["host_hass"][mac] = entity.original_name # --------------------------- # async_hwinfo_update # --------------------------- async def async_hwinfo_update(self): """Update Mikrotik hardware info""" try: await asyncio.wait_for(self.lock.acquire(), timeout=10) except: return await self.hass.async_add_executor_job(self.get_capabilities) await self.hass.async_add_executor_job(self.get_system_routerboard) await self.hass.async_add_executor_job(self.get_system_resource) self.lock.release() # --------------------------- # force_fwupdate_check # --------------------------- @callback async def force_fwupdate_check(self, _now=None): """Trigger hourly update by timer""" await self.async_fwupdate_check() # --------------------------- # async_fwupdate_check # --------------------------- async def async_fwupdate_check(self): """Update Mikrotik data""" await self.hass.async_add_executor_job(self.get_firmware_update) async_dispatcher_send(self.hass, self.signal_update) # --------------------------- # force_update # --------------------------- @callback async def force_update(self, _now=None): """Trigger update by timer""" await self.async_update() # --------------------------- # async_update # --------------------------- async def async_update(self): """Update Mikrotik data""" try: await asyncio.wait_for(self.lock.acquire(), timeout=10) except: return if "available" not in self.data["fw-update"]: await self.async_fwupdate_check() if not self.data["host_hass"]: await self.async_get_host_hass() if self.support_capsman: await self.hass.async_add_executor_job(self.get_capsman_hosts) if self.support_wireless: await self.hass.async_add_executor_job(self.get_wireless_hosts) await self.hass.async_add_executor_job(self.get_interface) await self.hass.async_add_executor_job(self.get_arp) await self.hass.async_add_executor_job(self.get_dns) await self.hass.async_add_executor_job(self.get_dhcp) await self.hass.async_add_executor_job(self.process_host) await self.hass.async_add_executor_job(self.get_interface_traffic) await self.hass.async_add_executor_job(self.get_interface_client) await self.hass.async_add_executor_job(self.get_nat) await self.hass.async_add_executor_job(self.get_system_resource) await self.hass.async_add_executor_job(self.get_script) await self.hass.async_add_executor_job(self.get_queue) await self.hass.async_add_executor_job(self.process_accounting) async_dispatcher_send(self.hass, self.signal_update) self.lock.release() # --------------------------- # get_interface # --------------------------- def get_interface(self): """Get all interfaces data from Mikrotik""" self.data["interface"] = parse_api( data=self.data["interface"], source=self.api.path("/interface"), key="default-name", vals=[ {"name": "default-name"}, {"name": "name", "default_val": "default-name"}, {"name": "type", "default": "unknown"}, {"name": "running", "type": "bool"}, { "name": "enabled", "source": "disabled", "type": "bool", "reverse": True, }, {"name": "port-mac-address", "source": "mac-address"}, {"name": "comment"}, {"name": "last-link-down-time"}, {"name": "last-link-up-time"}, {"name": "link-downs"}, {"name": "tx-queue-drop"}, {"name": "actual-mtu"}, ], ensure_vals=[ {"name": "client-ip-address"}, {"name": "client-mac-address"}, {"name": "rx-bits-per-second", "default": 0}, {"name": "tx-bits-per-second", "default": 0}, ], ) # --------------------------- # get_interface_traffic # --------------------------- def get_interface_traffic(self): """Get traffic for all interfaces from Mikrotik""" interface_list = "" for uid in self.data["interface"]: interface_list += self.data["interface"][uid]["name"] + "," interface_list = interface_list[:-1] self.data["interface"] = parse_api( data=self.data["interface"], source=self.api.get_traffic(interface_list), key_search="name", vals=[ {"name": "rx-bits-per-second", "default": 0}, {"name": "tx-bits-per-second", "default": 0}, ], ) uom_type, uom_div = self._get_unit_of_measurement() for uid in self.data["interface"]: self.data["interface"][uid][ "rx-bits-per-second-attr"] = uom_type self.data["interface"][uid][ "tx-bits-per-second-attr"] = uom_type self.data["interface"][uid]["rx-bits-per-second"] = round( self.data["interface"][uid]["rx-bits-per-second"] * uom_div ) self.data["interface"][uid]["tx-bits-per-second"] = round( self.data["interface"][uid]["tx-bits-per-second"] * uom_div ) # --------------------------- # get_interface_client # --------------------------- def get_interface_client(self): """Get ARP data from Mikrotik""" self.data["arp_tmp"] = {} # Remove data if disabled if not self.option_track_iface_clients: for uid in self.data["interface"]: self.data["interface"][uid]["client-ip-address"] = "disabled" self.data["interface"][uid]["client-mac-address"] = "disabled" return mac2ip = {} bridge_used = False mac2ip, bridge_used = self.update_arp(mac2ip, bridge_used) if bridge_used: self.update_bridge_hosts(mac2ip) # Map ARP to ifaces for uid in self.data["interface"]: if uid not in self.data["arp_tmp"]: continue self.data["interface"][uid]["client-ip-address"] = from_entry( self.data["arp_tmp"][uid], "address" ) self.data["interface"][uid]["client-mac-address"] = from_entry( self.data["arp_tmp"][uid], "mac-address" ) # --------------------------- # update_arp # --------------------------- def update_arp(self, mac2ip, bridge_used): """Get list of hosts in ARP for interface client data from Mikrotik""" data = self.api.path("/ip/arp") if not data: return mac2ip, bridge_used for entry in data: # Ignore invalid entries if entry["invalid"]: continue if "interface" not in entry: continue # Do not add ARP detected on bridge if entry["interface"] == "bridge": bridge_used = True # Build address table on bridge if "mac-address" in entry and "address" in entry: mac2ip[entry["mac-address"]] = entry["address"] continue # Get iface default-name from custom name uid = self._get_iface_from_entry(entry) if not uid: continue _LOGGER.debug("Processing entry %s, entry %s", "/ip/arp", entry) # Create uid arp dict if uid not in self.data["arp_tmp"]: self.data["arp_tmp"][uid] = {} # Add data self.data["arp_tmp"][uid]["interface"] = uid self.data["arp_tmp"][uid]["mac-address"] = ( from_entry(entry, "mac-address") if "mac-address" not in self.data["arp_tmp"][uid] else "multiple" ) self.data["arp_tmp"][uid]["address"] = ( from_entry(entry, "address") if "address" not in self.data["arp_tmp"][uid] else "multiple" ) return mac2ip, bridge_used # --------------------------- # update_bridge_hosts # --------------------------- def update_bridge_hosts(self, mac2ip): """Get list of hosts in bridge for interface client data from Mikrotik""" data = self.api.path("/interface/bridge/host") if not data: return for entry in data: # Ignore port MAC if entry["local"]: continue # Get iface default-name from custom name uid = self._get_iface_from_entry(entry) if not uid: continue _LOGGER.debug( "Processing entry %s, entry %s", "/interface/bridge/host", entry ) # Create uid arp dict if uid not in self.data["arp_tmp"]: self.data["arp_tmp"][uid] = {} # Add data self.data["arp_tmp"][uid]["interface"] = uid if "mac-address" in self.data["arp_tmp"][uid]: self.data["arp_tmp"][uid]["mac-address"] = "multiple" self.data["arp_tmp"][uid]["address"] = "multiple" else: self.data["arp_tmp"][uid]["mac-address"] = from_entry(entry, "mac-address") self.data["arp_tmp"][uid]["address"] = ( mac2ip[self.data["arp_tmp"][uid]["mac-address"]] if self.data["arp_tmp"][uid]["mac-address"] in mac2ip else "" ) # --------------------------- # get_nat # --------------------------- def get_nat(self): """Get NAT data from Mikrotik""" self.data["nat"] = parse_api( data=self.data["nat"], source=self.api.path("/ip/firewall/nat"), key=".id", vals=[ {"name": ".id"}, {"name": "protocol", "default": "any"}, {"name": "dst-port", "default": "any"}, {"name": "in-interface", "default": "any"}, {"name": "to-addresses"}, {"name": "to-ports"}, {"name": "comment"}, { "name": "enabled", "source": "disabled", "type": "bool", "reverse": True, }, ], val_proc=[ [ {"name": "name"}, {"action": "combine"}, {"key": "protocol"}, {"text": ":"}, {"key": "dst-port"}, ] ], only=[{"key": "action", "value": "dst-nat"}], ) # Remove duplicate NAT entries to prevent crash nat_uniq = {} nat_del = {} for uid in self.data["nat"]: tmp_name = self.data["nat"][uid]["name"] if tmp_name not in nat_uniq: nat_uniq[tmp_name] = uid else: nat_del[uid] = 1 nat_del[nat_uniq[tmp_name]] = 1 for uid in nat_del: if self.data["nat"][uid]["name"] not in self.nat_removed: self.nat_removed[self.data["nat"][uid]["name"]] = 1 _LOGGER.error("Mikrotik %s duplicate NAT rule %s, entity will be unavailable.", self.host, self.data["nat"][uid]["name"]) del self.data["nat"][uid] # --------------------------- # get_system_routerboard # --------------------------- def get_system_routerboard(self): # TODO: run only when firmware update changes from available to not available """Get routerboard data from Mikrotik""" self.data["routerboard"] = parse_api( data=self.data["routerboard"], source=self.api.path("/system/routerboard"), vals=[ {"name": "routerboard", "type": "bool"}, {"name": "model", "default": "unknown"}, {"name": "serial-number", "default": "unknown"}, {"name": "firmware", "default": "unknown"}, ], ) # --------------------------- # get_system_resource # --------------------------- def get_system_resource(self): """Get system resources data from Mikrotik""" self.data["resource"] = parse_api( data=self.data["resource"], source=self.api.path("/system/resource"), vals=[ {"name": "platform", "default": "unknown"}, {"name": "board-name", "default": "unknown"}, {"name": "version", "default": "unknown"}, {"name": "uptime", "default": "unknown"}, {"name": "cpu-load", "default": "unknown"}, {"name": "free-memory", "default": 0}, {"name": "total-memory", "default": 0}, {"name": "free-hdd-space", "default": 0}, {"name": "total-hdd-space", "default": 0}, ], ) if self.data["resource"]["total-memory"] > 0: self.data["resource"]["memory-usage"] = round( ( ( self.data["resource"]["total-memory"] - self.data["resource"]["free-memory"] ) / self.data["resource"]["total-memory"] ) * 100 ) else: self.data["resource"]["memory-usage"] = "unknown" if self.data["resource"]["total-hdd-space"] > 0: self.data["resource"]["hdd-usage"] = round( ( ( self.data["resource"]["total-hdd-space"] - self.data["resource"]["free-hdd-space"] ) / self.data["resource"]["total-hdd-space"] ) * 100 ) else: self.data["resource"]["hdd-usage"] = "unknown" # --------------------------- # get_firmware_update # --------------------------- def get_firmware_update(self): """Check for firmware update on Mikrotik""" self.data["fw-update"] = parse_api( data=self.data["fw-update"], source=self.api.path("/system/package/update"), vals=[ {"name": "status"}, {"name": "channel", "default": "unknown"}, {"name": "installed-version", "default": "unknown"}, {"name": "latest-version", "default": "unknown"}, ], ) if "status" in self.data["fw-update"]: self.data["fw-update"]["available"] = ( True if self.data["fw-update"][ "status"] == "New version is available" else False ) else: self.data["fw-update"]["available"] = False # --------------------------- # get_script # --------------------------- def get_script(self): # TODO: run less often """Get list of all scripts from Mikrotik""" self.data["script"] = parse_api( data=self.data["script"], source=self.api.path("/system/script"), key="name", vals=[ {"name": "name"}, {"name": "last-started", "default": "unknown"}, {"name": "run-count", "default": "unknown"}, ], ) # --------------------------- # get_queue # --------------------------- def get_queue(self): # TODO: run less often and on demand """Get Queue data from Mikrotik""" self.data["queue"] = parse_api( data=self.data["queue"], source=self.api.path("/queue/simple"), key="name", vals=[ {"name": ".id"}, {"name": "name", "default": "unknown"}, {"name": "target", "default": "unknown"}, {"name": "max-limit", "default": "0/0"}, {"name": "limit-at", "default": "0/0"}, {"name": "burst-limit", "default": "0/0"}, {"name": "burst-threshold", "default": "0/0"}, {"name": "burst-time", "default": "0s/0s"}, {"name": "packet-marks", "default": "none"}, {"name": "parent", "default": "none"}, {"name": "comment"}, { "name": "enabled", "source": "disabled", "type": "bool", "reverse": True, }, ] ) uom_type, uom_div = self._get_unit_of_measurement() for uid, vals in self.data["queue"].items(): upload_max_limit_bps, download_max_limit_bps = \ [int(x) for x in vals["max-limit"].split('/')] self.data["queue"][uid]["upload-max-limit"] = \ f"{round(upload_max_limit_bps * uom_div)} {uom_type}" self.data["queue"][uid]["download-max-limit"] = \ f"{round(download_max_limit_bps * uom_div)} {uom_type}" upload_limit_at_bps, download_limit_at_bps = \ [int(x) for x in vals["limit-at"].split('/')] self.data["queue"][uid]["upload-limit-at"] = \ f"{round(upload_limit_at_bps * uom_div)} {uom_type}" self.data["queue"][uid]["download-limit-at"] = \ f"{round(download_limit_at_bps * uom_div)} {uom_type}" upload_burst_limit_bps, download_burst_limit_bps = \ [int(x) for x in vals["burst-limit"].split('/')] self.data["queue"][uid]["upload-burst-limit"] = \ f"{round(upload_burst_limit_bps * uom_div)} {uom_type}" self.data["queue"][uid]["download-burst-limit"] = \ f"{round(download_burst_limit_bps * uom_div)} {uom_type}" upload_burst_threshold_bps, download_burst_threshold_bps = \ [int(x) for x in vals["burst-threshold"].split('/')] self.data["queue"][uid]["upload-burst-threshold"] = \ f"{round(upload_burst_threshold_bps * uom_div)} {uom_type}" self.data["queue"][uid]["download-burst-threshold"] = \ f"{round(download_burst_threshold_bps * uom_div)} {uom_type}" upload_burst_time, download_burst_time = vals["burst-time"].split('/') self.data["queue"][uid]["upload-burst-time"] = upload_burst_time self.data["queue"][uid]["download-burst-time"] = download_burst_time # --------------------------- # get_arp # --------------------------- def get_arp(self): """Get ARP data from Mikrotik""" self.data["arp"] = parse_api( data=self.data["arp"], source=self.api.path("/ip/arp"), key="mac-address", vals=[ {"name": "mac-address"}, {"name": "address"}, {"name": "interface"}, ], ) # --------------------------- # get_dns # --------------------------- def get_dns(self): """Get static DNS data from Mikrotik""" # TODO: run less often or on demand self.data["dns"] = parse_api( data=self.data["dns"], source=self.api.path("/ip/dns/static"), key="name", vals=[ {"name": "name"}, {"name": "address"}, ], ) # --------------------------- # get_dhcp # --------------------------- def get_dhcp(self): """Get DHCP data from Mikrotik""" # TODO: run only on demand self.data["dhcp-network"] = parse_api( data=self.data["dhcp-network"], source=self.api.path("/ip/dhcp-server/network"), key="address", vals=[ {"name": "address"}, {"name": "gateway", "default": ""}, {"name": "netmask", "default": ""}, {"name": "dns-server", "default": ""}, {"name": "domain", "default": ""}, ], ensure_vals=[ {"name": "address"}, {"name": "IPv4Network", "default": ""}, ] ) for uid, vals in self.data["dhcp-network"].items(): if vals["IPv4Network"] == "": self.data["dhcp-network"][uid]["IPv4Network"] = IPv4Network(vals["address"]) # TODO: run only on demand self.data["dhcp-server"] = parse_api( data=self.data["dhcp-server"], source=self.api.path("/ip/dhcp-server"), key="name", vals=[ {"name": "name"}, {"name": "interface", "default": ""}, ] ) self.data["dhcp"] = parse_api( data=self.data["dhcp"], source=self.api.path("/ip/dhcp-server/lease"), key="mac-address", vals=[ {"name": "mac-address"}, {"name": "address", "default": "unknown"}, {"name": "host-name", "default": "unknown"}, {"name": "status", "default": "unknown"}, {"name": "last-seen", "default": "unknown"}, {"name": "server", "default": "unknown"}, {"name": "comment", "default": ""}, ], ensure_vals=[ {"name": "interface"}, ] ) for uid in self.data["dhcp"]: self.data["dhcp"][uid]["interface"] = \ self.data["dhcp-server"][self.data["dhcp"][uid]["server"]]["interface"] # --------------------------- # get_capsman_hosts # --------------------------- def get_capsman_hosts(self): """Get CAPS-MAN hosts data from Mikrotik""" self.data["capsman_hosts"] = parse_api( data={}, source=self.api.path("/caps-man/registration-table"), key="mac-address", vals=[ {"name": "mac-address"}, {"name": "interface", "default": "unknown"}, {"name": "ssid", "default": "unknown"}, ] ) # --------------------------- # get_wireless_hosts # --------------------------- def get_wireless_hosts(self): """Get wireless hosts data from Mikrotik""" self.data["wireless_hosts"] = parse_api( data={}, source=self.api.path("/interface/wireless/registration-table"), key="mac-address", vals=[ {"name": "mac-address"}, {"name": "interface", "default": "unknown"}, {"name": "ap", "type": "bool"}, {"name": "uptime"}, ] ) # --------------------------- # process_host # --------------------------- def process_host(self): """Get host tracking data""" # Add hosts from CAPS-MAN if self.support_capsman: capsman_detected = {} for uid, vals in self.data["capsman_hosts"].items(): if uid not in self.data["host"]: self.data["host"][uid] = {} self.data["host"][uid]["source"] = "capsman" capsman_detected[uid] = True self.data["host"][uid]["available"] = True self.data["host"][uid]["last-seen"] = utcnow() for key in ["mac-address", "interface"]: if key not in self.data["host"][uid] or self.data["host"][uid][key] == "unknown": self.data["host"][uid][key] = vals[key] # Add hosts from wireless if self.support_wireless: wireless_detected = {} for uid, vals in self.data["wireless_hosts"].items(): if vals["ap"]: continue if uid not in self.data["host"]: self.data["host"][uid] = {} self.data["host"][uid]["source"] = "wireless" wireless_detected[uid] = True self.data["host"][uid]["available"] = True self.data["host"][uid]["last-seen"] = utcnow() for key in ["mac-address", "interface"]: if key not in self.data["host"][uid] or self.data["host"][uid][key] == "unknown": self.data["host"][uid][key] = vals[key] # Add hosts from DHCP for uid, vals in self.data["dhcp"].items(): if uid not in self.data["host"]: self.data["host"][uid] = {} self.data["host"][uid]["source"] = "dhcp" for key in ["address", "mac-address", "interface"]: if key not in self.data["host"][uid] or self.data["host"][uid][key] == "unknown": self.data["host"][uid][key] = vals[key] # Add hosts from ARP for uid, vals in self.data["arp"].items(): if uid not in self.data["host"]: self.data["host"][uid] = {} self.data["host"][uid]["source"] = "arp" for key in ["address", "mac-address", "interface"]: if key not in self.data["host"][uid] or self.data["host"][uid][key] == "unknown": self.data["host"][uid][key] = vals[key] # Add restored hosts from hass registry if not self.host_hass_recovered: self.host_hass_recovered = True for uid in self.data["host_hass"]: if uid not in self.data["host"]: self.data["host"][uid] = {} self.data["host"][uid]["source"] = "restored" self.data["host"][uid]["mac-address"] = uid self.data["host"][uid]["host-name"] = self.data["host_hass"][uid] # Process hosts for uid, vals in self.data["host"].items(): # Add missing default values for key, default in zip( ["address", "mac-address", "interface", "host-name", "last-seen", "available"], ["unknown", "unknown", "unknown", "unknown", False, False], ): if key not in self.data["host"][uid]: self.data["host"][uid][key] = default # CAPS-MAN availability if vals["source"] == "capsman" and uid not in capsman_detected: self.data["host"][uid]["available"] = False # Wireless availability if vals["source"] == "wireless" and uid not in wireless_detected: self.data["host"][uid]["available"] = False # Update IP and interface (DHCP/returned host) if uid in self.data["dhcp"] and "." in self.data["dhcp"][uid]["address"]: if self.data["dhcp"][uid]["address"] != self.data["host"][uid]["address"]: self.data["host"][uid]["address"] = self.data["dhcp"][uid]["address"] if vals["source"] not in ["capsman", "wireless"]: self.data["host"][uid]["source"] = "dhcp" self.data["host"][uid]["interface"] = self.data["dhcp"][uid]["interface"] elif uid in self.data["arp"] and "." in self.data["arp"][uid]["address"] \ and self.data["arp"][uid]["address"] != self.data["host"][uid]["address"]: self.data["host"][uid]["address"] = self.data["arp"][uid]["address"] if vals["source"] not in ["capsman", "wireless"]: self.data["host"][uid]["source"] = "arp" self.data["host"][uid]["interface"] = self.data["arp"][uid]["interface"] if vals["host-name"] == "unknown": # Resolve hostname from static DNS if vals["address"] != "unknown": for dns_uid, dns_vals in self.data["dns"].items(): if dns_vals["address"] == vals["address"]: self.data["host"][uid]["host-name"] = dns_vals["name"].split('.')[0] break # Resolve hostname from DHCP comment if self.data["host"][uid]["host-name"] == "unknown" \ and uid in self.data["dhcp"] and self.data["dhcp"][uid]["comment"] != "": self.data["host"][uid]["host-name"] = self.data["dhcp"][uid]["comment"] # Resolve hostname from DHCP hostname elif self.data["host"][uid]["host-name"] == "unknown" \ and uid in self.data["dhcp"] and self.data["dhcp"][uid]["host-name"] != "unknown": self.data["host"][uid]["host-name"] = self.data["dhcp"][uid]["host-name"] # Fallback to mac address for hostname elif self.data["host"][uid]["host-name"] == "unknown": self.data["host"][uid]["host-name"] = uid # Check host availability if vals["source"] not in ["capsman", "wireless"] \ and vals["address"] != "unknown" and vals["interface"] != "unknown": self.data["host"][uid]["available"] = \ self.api.arp_ping(vals["address"], vals["interface"]) # Update last seen if self.data["host"][uid]["available"]: self.data["host"][uid]["last-seen"] = utcnow() # --------------------------- # process_accounting # --------------------------- def process_accounting(self): """Get Accounting data from Mikrotik""" # Check if accounting and account-local-traffic is enabled accounting_enabled, local_traffic_enabled = self.api.is_accounting_and_local_traffic_enabled() uom_type, uom_div = self._get_unit_of_measurement() # Build missing hosts from main hosts dict for uid, vals in self.data["host"].items(): if uid not in self.data["accounting"]: self.data["accounting"][uid] = { 'address': vals['address'], 'mac-address': vals['mac-address'], 'host-name': vals['host-name'], 'tx-rx-attr': uom_type, 'available': False, 'local_accounting': False } _LOGGER.debug(f"Working with {len(self.data['accounting'])} accounting devices") # Build temp accounting values dict with ip address as key tmp_accounting_values = {} for uid, vals in self.data['accounting'].items(): tmp_accounting_values[vals['address']] = { "wan-tx": 0, "wan-rx": 0, "lan-tx": 0, "lan-rx": 0 } time_diff = self.api.take_accounting_snapshot() if time_diff: accounting_data = parse_api( data={}, source=self.api.path("/ip/accounting/snapshot"), key=".id", vals=[ {"name": ".id"}, {"name": "src-address"}, {"name": "dst-address"}, {"name": "bytes", "default": 0}, ], ) for item in accounting_data.values(): source_ip = str(item.get('src-address')).strip() destination_ip = str(item.get('dst-address')).strip() bits_count = int(str(item.get('bytes')).strip()) * 8 if self._address_part_of_local_network(source_ip) and \ self._address_part_of_local_network(destination_ip): # LAN TX/RX if source_ip in tmp_accounting_values: tmp_accounting_values[source_ip]['lan-tx'] += bits_count if destination_ip in tmp_accounting_values: tmp_accounting_values[destination_ip]['lan-rx'] += bits_count elif self._address_part_of_local_network(source_ip) and \ not self._address_part_of_local_network(destination_ip): # WAN TX if source_ip in tmp_accounting_values: tmp_accounting_values[source_ip]['wan-tx'] += bits_count elif not self._address_part_of_local_network(source_ip) and \ self._address_part_of_local_network(destination_ip) and \ destination_ip in tmp_accounting_values: # WAN RX tmp_accounting_values[destination_ip]['wan-rx'] += bits_count # Calculate real throughput and transform it to appropriate unit # Also handle availability of accounting and local_accounting from Mikrotik for addr, vals in tmp_accounting_values.items(): uid = self._get_accounting_uid_by_ip(addr) if not uid: _LOGGER.warning(f"Address {addr} not found in accounting data, skipping update") continue self.data['accounting'][uid]['tx-rx-attr'] = uom_type self.data['accounting'][uid]['available'] = accounting_enabled self.data['accounting'][uid]['local_accounting'] = local_traffic_enabled if not accounting_enabled: # Skip calculation for WAN and LAN if accounting is disabled continue self.data['accounting'][uid]['wan-tx'] = \ round(vals['wan-tx'] / time_diff * uom_div, 2) if vals['wan-tx'] else 0.0 self.data['accounting'][uid]['wan-rx'] = \ round(vals['wan-rx'] / time_diff * uom_div, 2) if vals['wan-rx'] else 0.0 if not local_traffic_enabled: # Skip calculation for LAN if LAN accounting is disabled continue self.data['accounting'][uid]['lan-tx'] = \ round(vals['lan-tx'] / time_diff * uom_div, 2) if vals['lan-tx'] else 0.0 self.data['accounting'][uid]['lan-rx'] = \ round(vals['lan-rx'] / time_diff * uom_div, 2) if vals['lan-rx'] else 0.0 # --------------------------- # _get_unit_of_measurement # --------------------------- def _get_unit_of_measurement(self): uom_type = self.option_unit_of_measurement if uom_type == "Kbps": uom_div = 0.001 elif uom_type == "Mbps": uom_div = 0.000001 elif uom_type == "B/s": uom_div = 0.125 elif uom_type == "KB/s": uom_div = 0.000125 elif uom_type == "MB/s": uom_div = 0.000000125 else: uom_type = "bps" uom_div = 1 return uom_type, uom_div # --------------------------- # _address_part_of_local_network # --------------------------- def _address_part_of_local_network(self, address): address = ip_address(address) for vals in self.data["dhcp-network"].values(): if address in vals["IPv4Network"]: return True return False # --------------------------- # _get_accounting_uid_by_ip # --------------------------- def _get_accounting_uid_by_ip(self, requested_ip): for mac, vals in self.data['accounting'].items(): if vals.get('address') is requested_ip: return mac return None # --------------------------- # _get_iface_from_entry # --------------------------- def _get_iface_from_entry(self, entry): """Get interface default-name using name from interface dict""" uid = None for ifacename in self.data["interface"]: if self.data["interface"][ifacename]["name"] == entry["interface"]: uid = ifacename break return uid