mirror.MikroTik/tomaae.homeassistant-mikrotik_router
1
0
Fork 0
mirror of https://github.com/tomaae/homeassistant-mikrotik_router.git synced 2025-07-10 01:14:33 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

fixes and code cleanup

Browse source
This commit is contained in:
Tomaae 2019-12-12 13:02:11 +01:00
parent e439a4062e
commit 6b2f9ae4e2
5 changed files with 58 additions and 60 deletions
Download patch file Download diff file Expand all files Collapse all files

32
custom_components/mikrotik_router/helper.py
View file

@ -42,7 +42,6 @@ async def from_list(data=None, source=None, key=None, key_search=None, vals=None
return data return data
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 await matches_only(entry, only):
continue continue
@ -50,6 +49,7 @@ async def from_list(data=None, source=None, key=None, key_search=None, vals=None
if skip and await can_skip(entry, skip): if skip and await can_skip(entry, skip):
continue continue
uid = None
if key or key_search: if key or key_search:
uid = await get_uid(entry, key, key_search, keymap) uid = await get_uid(entry, key, key_search, keymap)
if not uid: if not uid:
@ -58,12 +58,9 @@ async def from_list(data=None, source=None, key=None, key_search=None, vals=None
if uid not in data: if uid not in data:
data[uid] = {} data[uid] = {}
else: _LOGGER.debug("Processing entry %s, entry %s", source, entry)
uid=None
_LOGGER.debug("Processing entry {}, entry {}".format(source, entry))
if vals: if vals:
data = await fill_vals(data, uid, vals) data = await fill_vals(data, entry, uid, vals)
if ensure_vals: if ensure_vals:
data = await fill_ensure_vals(data, uid, ensure_vals) data = await fill_ensure_vals(data, uid, ensure_vals)
@ -89,7 +86,7 @@ async def get_uid(entry, key, key_search, keymap):
if not keymap or key_search not in entry or entry[key_search] not in keymap: if not keymap or key_search not in entry or entry[key_search] not in keymap:
return False return False
uid = keymap[entry[key_search]] key = keymap[entry[key_search]]
return entry[key] return entry[key]
@ -101,6 +98,7 @@ async def generate_keymap(data, key_search):
if not key_search: if not key_search:
return None return None
keymap = []
for uid in data: for uid in data:
if key_search not in uid: if key_search not in uid:
continue continue
@ -114,34 +112,34 @@ async def generate_keymap(data, key_search):
# matches_only # matches_only
# --------------------------- # ---------------------------
async def matches_only(entry, only): async def matches_only(entry, only):
can_continue = False ret = False
for val in only: for val in only:
if val['name'] in entry and entry[val['name']] == val['value']: if val['name'] in entry and entry[val['name']] == val['value']:
can_continue = True ret = True
else: else:
can_continue = False ret = False
break break
return can_continue return ret
# --------------------------- # ---------------------------
# can_skip # can_skip
# --------------------------- # ---------------------------
async def can_skip(entry, skip): async def can_skip(entry, skip):
can_skip = False ret = False
for val in skip: for val in skip:
if val['name'] in entry and entry[val['name']] == val['value']: if val['name'] in entry and entry[val['name']] == val['value']:
can_skip = True ret = True
break break
return can_skip return ret
# --------------------------- # ---------------------------
# fill_vals # fill_vals
# --------------------------- # ---------------------------
async def fill_vals(data, uid, vals): async def fill_vals(data, entry, uid, vals):
for val in vals: for val in vals:
_name = val['name'] _name = val['name']
_type = val['type'] if 'type' in val else 'str' _type = val['type'] if 'type' in val else 'str'
@ -185,12 +183,13 @@ async def fill_ensure_vals(data, uid, ensure_vals):
return data return data
# --------------------------- # ---------------------------
# fill_vals_proc # fill_vals_proc
# --------------------------- # ---------------------------
async def fill_vals_proc(data, uid, vals_proc): async def fill_vals_proc(data, uid, vals_proc):
_data = data[uid] if uid else data _data = data[uid] if uid else data
for val_sub in val_proc: for val_sub in vals_proc:
_name = None _name = None
_action = None _action = None
_value = None _value = None
@ -220,4 +219,3 @@ async def fill_vals_proc(data, uid, vals_proc):
data[_name] = _value data[_name] = _value
return data return data

72
custom_components/mikrotik_router/mikrotik_controller.py
View file

@ -14,7 +14,7 @@ from .const import (
) )
from .mikrotikapi import MikrotikAPI from .mikrotikapi import MikrotikAPI
from .helper import from_entry, from_entry_bool, from_list from .helper import from_entry, from_list
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
@ -101,8 +101,8 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
async def hwinfo_update(self): async def hwinfo_update(self):
"""Update Mikrotik hardware info""" """Update Mikrotik hardware info"""
self.get_system_routerboard() await self.get_system_routerboard()
self.get_system_resource() await self.get_system_resource()
return return
# --------------------------- # ---------------------------
@ -111,7 +111,7 @@ class MikrotikControllerData():
async def async_fwupdate_check(self): async def async_fwupdate_check(self):
"""Update Mikrotik data""" """Update Mikrotik data"""
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
@ -128,9 +128,9 @@ class MikrotikControllerData():
await self.get_interface() await self.get_interface()
await self.get_interface_traffic() await self.get_interface_traffic()
await self.get_interface_client() await self.get_interface_client()
self.get_nat() await self.get_nat()
self.get_system_resource() await self.get_system_resource()
self.get_script() await self.get_script()
async_dispatcher_send(self.hass, self.signal_update) async_dispatcher_send(self.hass, self.signal_update)
return return
@ -274,7 +274,7 @@ class MikrotikControllerData():
if not uid: if not uid:
continue continue
_LOGGER.debug("Processing entry {}, entry {}".format("/interface/bridge/host", entry)) _LOGGER.debug("Processing entry %s, entry %s", "/interface/bridge/host", entry)
# Create uid arp dict # Create uid arp dict
if uid not in self.data['arp']: if uid not in self.data['arp']:
self.data['arp'][uid] = {} self.data['arp'][uid] = {}
@ -305,7 +305,7 @@ class MikrotikControllerData():
if not uid: if not uid:
continue continue
_LOGGER.debug("Processing entry {}, entry {}".format("/interface/bridge/host", entry)) _LOGGER.debug("Processing entry %s, entry %s", "/interface/bridge/host", entry)
# Create uid arp dict # Create uid arp dict
if uid not in self.data['arp']: if uid not in self.data['arp']:
self.data['arp'][uid] = {} self.data['arp'][uid] = {}
@ -337,7 +337,7 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# get_nat # get_nat
# --------------------------- # ---------------------------
def get_nat(self): async def get_nat(self):
"""Get NAT data from Mikrotik""" """Get NAT data from Mikrotik"""
self.data['nat'] = await from_list( self.data['nat'] = await from_list(
data=self.data['nat'], data=self.data['nat'],
@ -361,7 +361,7 @@ class MikrotikControllerData():
{'text': ':'}, {'text': ':'},
{'key': 'dst-port'} {'key': 'dst-port'}
] ]
] ],
only=[ only=[
{'key': 'action', 'value': 'dst-nat'} {'key': 'action', 'value': 'dst-nat'}
] ]
@ -371,7 +371,7 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# get_system_routerboard # get_system_routerboard
# --------------------------- # ---------------------------
def get_system_routerboard(self): async def get_system_routerboard(self):
"""Get routerboard data from Mikrotik""" """Get routerboard data from Mikrotik"""
self.data['routerboard'] = await from_list( self.data['routerboard'] = await from_list(
data=self.data['routerboard'], data=self.data['routerboard'],
@ -380,7 +380,7 @@ class MikrotikControllerData():
{'name': 'routerboard', 'type': 'bool'}, {'name': 'routerboard', 'type': 'bool'},
{'name': 'model', 'default': 'unknown'}, {'name': 'model', 'default': 'unknown'},
{'name': 'serial-number', 'default': 'unknown'}, {'name': 'serial-number', 'default': 'unknown'},
{'name': 'firmware', 'default': 'unknown'}, {'name': 'firmware', 'default': 'unknown'}
] ]
) )
return return
@ -388,7 +388,7 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# get_system_resource # get_system_resource
# --------------------------- # ---------------------------
def get_system_resource(self): async def get_system_resource(self):
"""Get system resources data from Mikrotik""" """Get system resources data from Mikrotik"""
self.data['resource'] = await from_list( self.data['resource'] = await from_list(
data=self.data['resource'], data=self.data['resource'],
@ -406,13 +406,13 @@ class MikrotikControllerData():
] ]
) )
if entry['total-memory'] > 0: if self.data['resource']['total-memory'] > 0:
self.data['resource']['memory-usage'] = round(((entry['total-memory'] - entry['free-memory']) / entry['total-memory']) * 100) self.data['resource']['memory-usage'] = round(((self.data['resource']['total-memory'] - self.data['resource']['free-memory']) / self.data['resource']['total-memory']) * 100)
else: else:
self.data['resource']['memory-usage'] = "unknown" self.data['resource']['memory-usage'] = "unknown"
if entry['total-hdd-space'] > 0: if self.data['resource']['total-hdd-space'] > 0:
self.data['resource']['hdd-usage'] = round(((entry['total-hdd-space'] - entry['free-hdd-space']) / entry['total-hdd-space']) * 100) 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: else:
self.data['resource']['hdd-usage'] = "unknown" self.data['resource']['hdd-usage'] = "unknown"
@ -421,30 +421,30 @@ class MikrotikControllerData():
# --------------------------- # ---------------------------
# get_system_routerboard # get_system_routerboard
# --------------------------- # ---------------------------
def get_firmware_update(self): async def get_firmware_update(self):
"""Check for firmware update on Mikrotik""" """Check for firmware update on Mikrotik"""
self.data['fw-update'] = await from_list( self.data['fw-update'] = await from_list(
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=await self.hass.async_add_executor_job(self.api.path, "/system/package/update"),
vals=[ vals=[
{'name': 'status'}, {'name': 'status'},
{'name': 'channel', 'default': 'unknown'}, {'name': 'channel', 'default': 'unknown'},
{'name': 'installed-version', 'default': 'unknown'}, {'name': 'installed-version', 'default': 'unknown'},
{'name': 'latest-version', 'default': 'unknown'} {'name': 'latest-version', 'default': 'unknown'}
] ]
) )
if status in self.data['fw-update']: 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 self.data['fw-update']['available'] = True if self.data['fw-update']['status'] == "New version is available" else False
else: else:
self.data['fw-update']['available'] = False self.data['fw-update']['available'] = False
return return
# --------------------------- # ---------------------------
# get_script # get_script
# --------------------------- # ---------------------------
def get_script(self): async def get_script(self):
"""Get list of all scripts from Mikrotik""" """Get list of all scripts from Mikrotik"""
self.data['script'] = await from_list( self.data['script'] = await from_list(
data=self.data['script'], data=self.data['script'],

8
custom_components/mikrotik_router/mikrotikapi.py
View file

@ -98,7 +98,7 @@ class MikrotikAPI:
self.error = "cannot_connect" self.error = "cannot_connect"
if error == "invalid user name or password (6)": if error == "invalid user name or password (6)":
self.error = "wrong_login" self.error = "wrong_login"
if "ALERT_HANDSHAKE_FAILURE" in error: if "ALERT_HANDSHAKE_FAILURE" in error:
self.error = "ssl_handshake_failure" self.error = "ssl_handshake_failure"
@ -122,7 +122,7 @@ class MikrotikAPI:
try: try:
response = self._connection.path(path) response = self._connection.path(path)
_LOGGER.debug("API response ({}): {}".format(path, tuple(response))) _LOGGER.debug("API response (%s): %s", path, tuple(response))
except librouteros_custom.exceptions.ConnectionClosed: except librouteros_custom.exceptions.ConnectionClosed:
_LOGGER.error("Mikrotik %s connection closed", self._host) _LOGGER.error("Mikrotik %s connection closed", self._host)
self._connected = False self._connected = False
@ -247,11 +247,11 @@ class MikrotikAPI:
response = self.path('/interface') response = self.path('/interface')
if response is None: if response is None:
return None return None
args = {'interface': interfaces, 'once': True} args = {'interface': interfaces, 'once': True}
try: try:
traffic = response('monitor-traffic', **args) traffic = response('monitor-traffic', **args)
_LOGGER.debug("API response ({}): {}".format("/interface/monitor-traffic", tuple(response))) _LOGGER.debug("API response (%s): %s", "/interface/monitor-traffic", tuple(response))
except librouteros_custom.exceptions.ConnectionClosed: except librouteros_custom.exceptions.ConnectionClosed:
_LOGGER.error("Mikrotik %s connection closed", self._host) _LOGGER.error("Mikrotik %s connection closed", self._host)
self._connected = False self._connected = False

2
custom_components/mikrotik_router/sensor.py
View file

@ -255,4 +255,4 @@ class MikrotikControllerTrafficSensor(MikrotikControllerSensor):
async def async_added_to_hass(self): async def async_added_to_hass(self):
"""Port entity created.""" """Port entity created."""
_LOGGER.debug("New sensor %s (%s %s)", self._inst, self._data['default-name'], self._sensor) _LOGGER.debug("New sensor %s (%s %s)", self._inst, self._data['default-name'], self._sensor)
return return

4
custom_components/mikrotik_router/switch.py
View file

@ -94,8 +94,8 @@ def update_items(inst, mikrotik_controller, async_add_entities, switches):
# Add switches # Add switches
for sid, sid_func in zip( for sid, sid_func in zip(
["interface", "nat", "script"], ["interface", "nat", "script"],
[MikrotikControllerPortSwitch, MikrotikControllerNATSwitch, MikrotikControllerScriptSwitch] [MikrotikControllerPortSwitch, MikrotikControllerNATSwitch, MikrotikControllerScriptSwitch]
): ):
for uid in mikrotik_controller.data[sid]: for uid in mikrotik_controller.data[sid]:
item_id = "{}-{}-{}".format(inst, sid, mikrotik_controller.data[sid][uid]['name']) item_id = "{}-{}-{}".format(inst, sid, mikrotik_controller.data[sid][uid]['name'])