mirror.MikroTik/tomaae.homeassistant-mikrotik_router
1
0
Fork 0
mirror of https://github.com/tomaae/homeassistant-mikrotik_router.git synced 2025-06-24 17:58:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

fixes

Browse source
This commit is contained in:
tomaae 2019-12-12 23:01:57 +01:00
parent 7a58bc6a70
commit ec82b33cb9
2 changed files with 98 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

65
custom_components/mikrotik_router/helper.py
View file

@ -37,22 +37,23 @@ def from_entry_bool(entry, param, default=False, reverse=False) -> bool:
# --------------------------- # ---------------------------
# parse_api # parse_api
# --------------------------- # ---------------------------
async def parse_api(data=None, source=None, key=None, key_search=None, vals=None, val_proc=None, ensure_vals=None, only=None, skip=None) -> dict: def parse_api(data=None, source=None, key=None, key_search=None, vals=None, val_proc=None, ensure_vals=None, only=None, skip=None) -> dict:
"""Get data from API""" """Get data from API"""
if not source: if not source:
return data return data
#print(type(source))
keymap = generate_keymap(data, key_search) keymap = generate_keymap(data, key_search)
for entry in source: for entry in source:
if only and not await matches_only(entry, only): if only and not matches_only(entry, only):
continue continue
if skip and await can_skip(entry, skip): if skip and can_skip(entry, skip):
continue continue
uid = None uid = None
if key or key_search: if key or key_search:
uid = await get_uid(entry, key, key_search, keymap) uid = get_uid(entry, key, key_search, keymap)
if not uid: if not uid:
continue continue
@ -61,13 +62,13 @@ async def parse_api(data=None, source=None, key=None, key_search=None, vals=None
_LOGGER.debug("Processing entry %s, entry %s", source, entry) _LOGGER.debug("Processing entry %s, entry %s", source, entry)
if vals: if vals:
data = await fill_vals(data, entry, uid, vals) data = fill_vals(data, entry, uid, vals)
if ensure_vals: if ensure_vals:
data = await fill_ensure_vals(data, uid, ensure_vals) data = fill_ensure_vals(data, uid, ensure_vals)
if val_proc: if val_proc:
data = await fill_vals_proc(data, uid, val_proc) data = fill_vals_proc(data, uid, val_proc)
return data return data
@ -75,38 +76,40 @@ async def parse_api(data=None, source=None, key=None, key_search=None, vals=None
# --------------------------- # ---------------------------
# get_uid # get_uid
# --------------------------- # ---------------------------
async def get_uid(entry, key, key_search, keymap) -> str: def get_uid(entry, key, key_search, keymap) -> str:
"""Get UID for data list""" """Get UID for data list"""
uid = None
if not key_search: if not key_search:
if key not in entry: if key not in entry:
return False return None
if not entry[key]: if not entry[key]:
return False return None
uid = entry[key]
else: else:
if not keymap or key_search not in entry or entry[key_search] not in keymap: if keymap and key_search in entry and entry[key_search] in keymap:
return False uid = keymap[entry[key_search]]
else:
return None
key = keymap[entry[key_search]] return uid
return entry[key]
# --------------------------- # ---------------------------
# generate_keymap # generate_keymap
# --------------------------- # ---------------------------
async def generate_keymap(data, key_search) -> dict: def generate_keymap(data, key_search) -> dict:
"""Generate keymap""" """Generate keymap"""
if not key_search: if not key_search:
return None return None
keymap = [] keymap = {}
for uid in data: for uid in data:
if key_search not in uid: if key_search not in data[uid]:
continue continue
keymap[data[uid]['name']] = uid keymap[data[uid][key_search]] = uid
return keymap return keymap
@ -114,11 +117,11 @@ async def generate_keymap(data, key_search) -> dict:
# --------------------------- # ---------------------------
# matches_only # matches_only
# --------------------------- # ---------------------------
async def matches_only(entry, only) -> bool: def matches_only(entry, only) -> bool:
"""Return True if all variables are matched""" """Return True if all variables are matched"""
ret = False ret = False
for val in only: for val in only:
if val['name'] in entry and entry[val['name']] == val['value']: if val['key'] in entry and entry[val['key']] == val['value']:
ret = True ret = True
else: else:
ret = False ret = False
@ -130,7 +133,7 @@ async def matches_only(entry, only) -> bool:
# --------------------------- # ---------------------------
# can_skip # can_skip
# --------------------------- # ---------------------------
async def can_skip(entry, skip) -> bool: def can_skip(entry, skip) -> bool:
"""Return True if at least one variable matches""" """Return True if at least one variable matches"""
ret = False ret = False
for val in skip: for val in skip:
@ -144,7 +147,7 @@ async def can_skip(entry, skip) -> bool:
# --------------------------- # ---------------------------
# fill_vals # fill_vals
# --------------------------- # ---------------------------
async def fill_vals(data, entry, uid, vals) -> dict: def fill_vals(data, entry, uid, vals) -> dict:
"""Fill all data""" """Fill all data"""
for val in vals: for val in vals:
_name = val['name'] _name = val['name']
@ -176,7 +179,7 @@ async def fill_vals(data, entry, uid, vals) -> dict:
# --------------------------- # ---------------------------
# fill_ensure_vals # fill_ensure_vals
# --------------------------- # ---------------------------
async def fill_ensure_vals(data, uid, ensure_vals) -> dict: def fill_ensure_vals(data, uid, ensure_vals) -> dict:
"""Add required keys which are not available in data""" """Add required keys which are not available in data"""
for val in ensure_vals: for val in ensure_vals:
if uid: if uid:
@ -194,7 +197,7 @@ async def fill_ensure_vals(data, uid, ensure_vals) -> dict:
# --------------------------- # ---------------------------
# fill_vals_proc # fill_vals_proc
# --------------------------- # ---------------------------
async def fill_vals_proc(data, uid, vals_proc) -> dict: def fill_vals_proc(data, uid, vals_proc) -> dict:
"""Add custom keys""" """Add custom keys"""
_data = data[uid] if uid else data _data = data[uid] if uid else data
for val_sub in vals_proc: for val_sub in vals_proc:
@ -215,10 +218,18 @@ async def fill_vals_proc(data, uid, vals_proc) -> dict:
if _action == 'combine': if _action == 'combine':
if 'key' in val: if 'key' in val:
_value += _data[val['key']] if val['key'] in _data else 'unknown' tmp = _data[val['key']] if val['key'] in _data else 'unknown'
if not _value:
_value = tmp
else:
_value = "{}{}".format(_value, tmp)
if 'text' in val: if 'text' in val:
_value += val['text'] tmp = val['text']
if not _value:
_value = tmp
else:
_value = "{}{}".format(_value, tmp)
if _name and _value: if _name and _value:
if uid: if uid:

102
custom_components/mikrotik_router/mikrotik_controller.py
View file

@ -1,6 +1,7 @@
"""Mikrotik Controller for Mikrotik Router.""" """Mikrotik Controller for Mikrotik Router."""
from datetime import timedelta from datetime import timedelta
import asyncio
import logging import logging
from homeassistant.helpers.dispatcher import async_dispatcher_send from homeassistant.helpers.dispatcher import async_dispatcher_send
from homeassistant.helpers.event import async_track_time_interval from homeassistant.helpers.event import async_track_time_interval
@ -15,6 +16,7 @@ from .const import (
from .mikrotikapi import MikrotikAPI from .mikrotikapi import MikrotikAPI
from .helper import from_entry, parse_api from .helper import from_entry, parse_api
from .exceptions import ApiEntryNotFound
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
@ -40,6 +42,7 @@ class MikrotikControllerData():
} }
self.listeners = [] self.listeners = []
self.lock = asyncio.Lock()
self.api = MikrotikAPI(host, username, password, port, use_ssl) self.api = MikrotikAPI(host, username, password, port, use_ssl)
@ -101,8 +104,14 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
async def hwinfo_update(self): async def hwinfo_update(self):
"""Update Mikrotik hardware info""" """Update Mikrotik hardware info"""
await self.get_system_routerboard() try:
await self.get_system_resource() await asyncio.wait_for(self.lock.acquire(), timeout=10)
except:
return
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()
return return
# --------------------------- # ---------------------------
@ -110,8 +119,7 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
async def async_fwupdate_check(self): async def async_fwupdate_check(self):
"""Update Mikrotik data""" """Update Mikrotik data"""
await self.hass.async_add_executor_job(self.get_firmware_update)
await self.get_firmware_update()
async_dispatcher_send(self.hass, self.signal_update) async_dispatcher_send(self.hass, self.signal_update)
return return
@ -121,18 +129,23 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
async def async_update(self): async def async_update(self):
"""Update Mikrotik data""" """Update Mikrotik data"""
try:
await asyncio.wait_for(self.lock.acquire(), timeout=10)
except:
return
if 'available' not in self.data['fw-update']: if 'available' not in self.data['fw-update']:
await self.async_fwupdate_check() await self.async_fwupdate_check()
await self.get_interface() await self.hass.async_add_executor_job(self.get_interface)
await self.get_interface_traffic() await self.hass.async_add_executor_job(self.get_interface_traffic)
await self.get_interface_client() await self.hass.async_add_executor_job(self.get_interface_client)
await self.get_nat() await self.hass.async_add_executor_job(self.get_nat)
await self.get_system_resource() await self.hass.async_add_executor_job(self.get_system_resource)
await self.get_script() await self.hass.async_add_executor_job(self.get_script)
async_dispatcher_send(self.hass, self.signal_update) async_dispatcher_send(self.hass, self.signal_update)
self.lock.release()
return return
# --------------------------- # ---------------------------
@ -158,16 +171,21 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
def run_script(self, name): def run_script(self, name):
"""Run script using Mikrotik API""" """Run script using Mikrotik API"""
return self.api.run_script(name) try:
self.api.run_script(name)
except ApiEntryNotFound as error:
_LOGGER.error("Failed to run script: %s", error)
return
# --------------------------- # ---------------------------
# get_interface # get_interface
# --------------------------- # ---------------------------
async def get_interface(self): def get_interface(self):
"""Get all interfaces data from Mikrotik""" """Get all interfaces data from Mikrotik"""
self.data['interface'] = await parse_api( self.data['interface'] = parse_api(
data=self.data['interface'], data=self.data['interface'],
source=await self.hass.async_add_executor_job(self.api.path, "/interface"), source=self.api.path("/interface"),
key='default-name', key='default-name',
vals=[ vals=[
{'name': 'default-name'}, {'name': 'default-name'},
@ -196,7 +214,7 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# get_interface_traffic # get_interface_traffic
# --------------------------- # ---------------------------
async def get_interface_traffic(self): def get_interface_traffic(self):
"""Get traffic for all interfaces from Mikrotik""" """Get traffic for all interfaces from Mikrotik"""
interface_list = "" interface_list = ""
for uid in self.data['interface']: for uid in self.data['interface']:
@ -204,9 +222,9 @@ class MikrotikControllerData():
interface_list = interface_list[:-1] interface_list = interface_list[:-1]
self.data['interface'] = await parse_api( self.data['interface'] = parse_api(
data=self.data['interface'], data=self.data['interface'],
source=await self.hass.async_add_executor_job(self.api.get_traffic, interface_list), source=self.api.get_traffic(interface_list),
key_search='name', key_search='name',
vals=[ vals=[
{'name': 'rx-bits-per-second', 'default': 0}, {'name': 'rx-bits-per-second', 'default': 0},
@ -218,7 +236,7 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# get_interface_client # get_interface_client
# --------------------------- # ---------------------------
async def get_interface_client(self): def get_interface_client(self):
"""Get ARP data from Mikrotik""" """Get ARP data from Mikrotik"""
self.data['arp'] = {} self.data['arp'] = {}
@ -231,10 +249,10 @@ class MikrotikControllerData():
mac2ip = {} mac2ip = {}
bridge_used = False bridge_used = False
mac2ip, bridge_used = await self.update_arp(mac2ip, bridge_used) mac2ip, bridge_used = self.update_arp(mac2ip, bridge_used)
if bridge_used: if bridge_used:
await self.update_bridge_hosts(mac2ip) self.update_bridge_hosts(mac2ip)
# Map ARP to ifaces # Map ARP to ifaces
for uid in self.data['interface']: for uid in self.data['interface']:
@ -249,9 +267,9 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# update_arp # update_arp
# --------------------------- # ---------------------------
async def update_arp(self, mac2ip, bridge_used): def update_arp(self, mac2ip, bridge_used):
"""Get list of hosts in ARP for interface client data from Mikrotik""" """Get list of hosts in ARP for interface client data from Mikrotik"""
data = await self.hass.async_add_executor_job(self.api.path, "/ip/arp") data = self.api.path("/ip/arp")
if not data: if not data:
return mac2ip, bridge_used return mac2ip, bridge_used
@ -270,7 +288,7 @@ class MikrotikControllerData():
continue continue
# Get iface default-name from custom name # Get iface default-name from custom name
uid = await self.get_iface_from_entry(entry) uid = self.get_iface_from_entry(entry)
if not uid: if not uid:
continue continue
@ -289,9 +307,9 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# update_bridge_hosts # update_bridge_hosts
# --------------------------- # ---------------------------
async def update_bridge_hosts(self, mac2ip): def update_bridge_hosts(self, mac2ip):
"""Get list of hosts in bridge for interface client data from Mikrotik""" """Get list of hosts in bridge for interface client data from Mikrotik"""
data = await self.hass.async_add_executor_job(self.api.path, "/interface/bridge/host") data = self.api.path("/interface/bridge/host")
if not data: if not data:
return return
@ -301,7 +319,7 @@ class MikrotikControllerData():
continue continue
# Get iface default-name from custom name # Get iface default-name from custom name
uid = await self.get_iface_from_entry(entry) uid = self.get_iface_from_entry(entry)
if not uid: if not uid:
continue continue
@ -324,7 +342,7 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# get_iface_from_entry # get_iface_from_entry
# --------------------------- # ---------------------------
async def get_iface_from_entry(self, entry): def get_iface_from_entry(self, entry):
"""Get interface default-name using name from interface dict""" """Get interface default-name using name from interface dict"""
uid = None uid = None
for ifacename in self.data['interface']: for ifacename in self.data['interface']:
@ -337,11 +355,11 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# get_nat # get_nat
# --------------------------- # ---------------------------
async def get_nat(self): def get_nat(self):
"""Get NAT data from Mikrotik""" """Get NAT data from Mikrotik"""
self.data['nat'] = await parse_api( self.data['nat'] = parse_api(
data=self.data['nat'], data=self.data['nat'],
source=await self.hass.async_add_executor_job(self.api.path, "/ip/firewall/nat"), source=self.api.path("/ip/firewall/nat"),
key='.id', key='.id',
vals=[ vals=[
{'name': '.id'}, {'name': '.id'},
@ -371,11 +389,11 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# get_system_routerboard # get_system_routerboard
# --------------------------- # ---------------------------
async def get_system_routerboard(self): def get_system_routerboard(self):
"""Get routerboard data from Mikrotik""" """Get routerboard data from Mikrotik"""
self.data['routerboard'] = await parse_api( self.data['routerboard'] = parse_api(
data=self.data['routerboard'], data=self.data['routerboard'],
source=await self.hass.async_add_executor_job(self.api.path, "/system/routerboard"), source=self.api.path("/system/routerboard"),
vals=[ vals=[
{'name': 'routerboard', 'type': 'bool'}, {'name': 'routerboard', 'type': 'bool'},
{'name': 'model', 'default': 'unknown'}, {'name': 'model', 'default': 'unknown'},
@ -388,11 +406,11 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# get_system_resource # get_system_resource
# --------------------------- # ---------------------------
async def get_system_resource(self): def get_system_resource(self):
"""Get system resources data from Mikrotik""" """Get system resources data from Mikrotik"""
self.data['resource'] = await parse_api( self.data['resource'] = parse_api(
data=self.data['resource'], data=self.data['resource'],
source=await self.hass.async_add_executor_job(self.api.path, "/system/resource"), source=self.api.path("/system/resource"),
vals=[ vals=[
{'name': 'platform', 'default': 'unknown'}, {'name': 'platform', 'default': 'unknown'},
{'name': 'board-name', 'default': 'unknown'}, {'name': 'board-name', 'default': 'unknown'},
@ -421,11 +439,11 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# get_system_routerboard # get_system_routerboard
# --------------------------- # ---------------------------
async def get_firmware_update(self): def get_firmware_update(self):
"""Check for firmware update on Mikrotik""" """Check for firmware update on Mikrotik"""
self.data['fw-update'] = await parse_api( self.data['fw-update'] = parse_api(
data=self.data['fw-update'], data=self.data['fw-update'],
source=await self.hass.async_add_executor_job(self.api.path, "/system/package/update"), source=self.api.path("/system/package/update"),
vals=[ vals=[
{'name': 'status'}, {'name': 'status'},
{'name': 'channel', 'default': 'unknown'}, {'name': 'channel', 'default': 'unknown'},
@ -444,11 +462,11 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# get_script # get_script
# --------------------------- # ---------------------------
async def get_script(self): def get_script(self):
"""Get list of all scripts from Mikrotik""" """Get list of all scripts from Mikrotik"""
self.data['script'] = await parse_api( self.data['script'] = parse_api(
data=self.data['script'], data=self.data['script'],
source=await self.hass.async_add_executor_job(self.api.path, "/system/script"), source=self.api.path("/system/script"),
key='name', key='name',
vals=[ vals=[
{'name': 'name'}, {'name': 'name'},