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

flake8 complaint

Browse source
This commit is contained in:
tomaae 2019-12-02 03:19:07 +01:00
parent bb0db7f64a
commit 3b5acc2393
5 changed files with 56 additions and 55 deletions
Download patch file Download diff file Expand all files Collapse all files

30
custom_components/mikrotik_router/__init__.py
View file

@ -4,25 +4,25 @@ from .mikrotikapi import MikrotikAPI
from datetime import timedelta from datetime import timedelta
import logging import logging
from homeassistant.exceptions import ConfigEntryNotReady
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, async_track_time_change from homeassistant.helpers.event import async_track_time_interval
from homeassistant import config_entries #from homeassistant.util import Throttle
from homeassistant.util import Throttle
from homeassistant.const import CONF_NAME, CONF_HOST, CONF_PORT, CONF_USERNAME, CONF_PASSWORD, CONF_SSL from homeassistant.const import CONF_NAME, CONF_HOST, CONF_PORT, CONF_USERNAME, CONF_PASSWORD, CONF_SSL
from .const import ( from .const import (
DEFAULT_NAME, DOMAIN,
DOMAIN, DATA_CLIENT,
DATA_CLIENT, CONF_TRACK_ARP,
CONF_TRACK_ARP, DEFAULT_TRACK_ARP,
DEFAULT_TRACK_ARP, CONF_SCAN_INTERVAL,
CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL,
DEFAULT_SCAN_INTERVAL,
) )
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
#DEFAULT_SCAN_INTERVAL = timedelta(seconds=DEFAULT_SCAN_INTERVAL) #DEFAULT_SCAN_INTERVAL = timedelta(seconds=DEFAULT_SCAN_INTERVAL)
#--------------------------- #---------------------------
# async_setup # async_setup
#--------------------------- #---------------------------
@ -32,6 +32,7 @@ async def async_setup(hass, config):
hass.data[DOMAIN][DATA_CLIENT] = {} hass.data[DOMAIN][DATA_CLIENT] = {}
return True return True
#--------------------------- #---------------------------
# async_setup_entry # async_setup_entry
#--------------------------- #---------------------------
@ -72,6 +73,7 @@ async def async_setup_entry(hass, config_entry):
return True return True
#--------------------------- #---------------------------
# async_unload_entry # async_unload_entry
#--------------------------- #---------------------------
@ -84,6 +86,7 @@ async def async_unload_entry(hass, config_entry):
hass.data[DOMAIN][DATA_CLIENT].pop(config_entry.entry_id) hass.data[DOMAIN][DATA_CLIENT].pop(config_entry.entry_id)
return True return True
#--------------------------- #---------------------------
# MikrotikControllerData # MikrotikControllerData
#--------------------------- #---------------------------
@ -113,7 +116,6 @@ class MikrotikControllerData():
async def force_update(self, now=None): async def force_update(self, now=None):
"""Periodic update.""" """Periodic update."""
await self.async_update() await self.async_update()
#async_track_time_change(self.hass, self.force_update, self.option_scan_interval)
return return
#--------------------------- #---------------------------
@ -197,8 +199,8 @@ class MikrotikControllerData():
self.data['interface'][uid]['default-name'] = iface['default-name'] self.data['interface'][uid]['default-name'] = iface['default-name']
self.data['interface'][uid]['name'] = iface['name'] if 'name' in iface else iface['default-name'] self.data['interface'][uid]['name'] = iface['name'] if 'name' in iface else iface['default-name']
self.data['interface'][uid]['type'] = iface['type'] if 'type' in iface else "unknown" self.data['interface'][uid]['type'] = iface['type'] if 'type' in iface else "unknown"
self.data['interface'][uid]['running'] = True if iface['running'] == True else False self.data['interface'][uid]['running'] = True if iface['running'] else False
self.data['interface'][uid]['enabled'] = True if iface['disabled'] == False else False self.data['interface'][uid]['enabled'] = True if not iface['disabled'] else False
self.data['interface'][uid]['port-mac-address'] = iface['mac-address'] if 'mac-address' in iface else "" self.data['interface'][uid]['port-mac-address'] = iface['mac-address'] if 'mac-address' in iface else ""
self.data['interface'][uid]['comment'] = iface['comment'] if 'comment' in iface else "" self.data['interface'][uid]['comment'] = iface['comment'] if 'comment' in iface else ""
self.data['interface'][uid]['last-link-down-time'] = iface['last-link-down-time'] if 'last-link-down-time' in iface else "" self.data['interface'][uid]['last-link-down-time'] = iface['last-link-down-time'] if 'last-link-down-time' in iface else ""
@ -317,7 +319,7 @@ class MikrotikControllerData():
def get_system_routerboard(self): def get_system_routerboard(self):
data = self.api.path("/system/routerboard") data = self.api.path("/system/routerboard")
for entry in data: for entry in data:
self.data['routerboard']['routerboard'] = True if entry['routerboard'] == True else False self.data['routerboard']['routerboard'] = True if entry['routerboard'] else False
self.data['routerboard']['model'] = entry['model'] if 'model' in entry else "unknown" self.data['routerboard']['model'] = entry['model'] if 'model' in entry else "unknown"
self.data['routerboard']['serial-number'] = entry['serial-number'] if 'serial-number' in entry else "unknown" self.data['routerboard']['serial-number'] = entry['serial-number'] if 'serial-number' in entry else "unknown"
self.data['routerboard']['firmware'] = entry['current-firmware'] if 'current-firmware' in entry else "unknown" self.data['routerboard']['firmware'] = entry['current-firmware'] if 'current-firmware' in entry else "unknown"

44
custom_components/mikrotik_router/config_flow.py
View file

@ -9,23 +9,23 @@ import voluptuous as vol
from homeassistant import config_entries from homeassistant import config_entries
from homeassistant.core import callback from homeassistant.core import callback
from homeassistant.const import ( from homeassistant.const import (
CONF_NAME, CONF_NAME,
CONF_HOST, CONF_HOST,
CONF_PORT, CONF_PORT,
CONF_USERNAME, CONF_USERNAME,
CONF_PASSWORD, CONF_PASSWORD,
CONF_SSL, CONF_SSL,
) )
from .const import ( from const import (
DEFAULT_NAME, DOMAIN,
DOMAIN, CONF_TRACK_ARP,
CONF_TRACK_ARP, DEFAULT_TRACK_ARP,
DEFAULT_TRACK_ARP, CONF_SCAN_INTERVAL,
CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL,
DEFAULT_SCAN_INTERVAL,
) )
#--------------------------- #---------------------------
# configured_instances # configured_instances
#--------------------------- #---------------------------
@ -36,6 +36,7 @@ def configured_instances(hass):
entry.data[CONF_NAME] for entry in hass.config_entries.async_entries(DOMAIN) entry.data[CONF_NAME] for entry in hass.config_entries.async_entries(DOMAIN)
) )
#--------------------------- #---------------------------
# MikrotikControllerConfigFlow # MikrotikControllerConfigFlow
#--------------------------- #---------------------------
@ -63,7 +64,7 @@ class MikrotikControllerConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
errors["base"] = "name_exists" errors["base"] = "name_exists"
## Test connection ## Test connection
api = MikrotikAPI(host = user_input["host"], username = user_input["username"], password = user_input["password"], port = user_input["port"], use_ssl= user_input["ssl"]) api = MikrotikAPI(host=user_input["host"], username=user_input["username"], password=user_input["password"], port=user_input["port"], use_ssl=user_input["ssl"])
if not api.connect(): if not api.connect():
errors[CONF_HOST] = api.error errors[CONF_HOST] = api.error
@ -81,17 +82,17 @@ class MikrotikControllerConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
#--------------------------- #---------------------------
# _show_config_form # _show_config_form
#--------------------------- #---------------------------
def _show_config_form(self, host='10.0.0.1', username='admin', password='admin', port=0, name='Mikrotik', use_ssl=False, errors = None): def _show_config_form(self, host='10.0.0.1', username='admin', password='admin', port=0, name='Mikrotik', use_ssl=False, errors=None):
"""Show the configuration form to edit data.""" """Show the configuration form to edit data."""
return self.async_show_form( return self.async_show_form(
step_id='user', step_id='user',
data_schema=vol.Schema({ data_schema=vol.Schema({
vol.Required(CONF_HOST, default=host): str, vol.Required(CONF_HOST, default=host): str,
vol.Required(CONF_USERNAME, default=username): str, vol.Required(CONF_USERNAME, default=username): str,
vol.Required(CONF_PASSWORD, default=password): str, vol.Required(CONF_PASSWORD, default=password): str,
vol.Optional(CONF_PORT, default=port): int, vol.Optional(CONF_PORT, default=port): int,
vol.Optional(CONF_NAME, default=name): str, vol.Optional(CONF_NAME, default=name): str,
vol.Optional(CONF_SSL, default=use_ssl): bool, vol.Optional(CONF_SSL, default=use_ssl): bool,
}), }),
errors=errors, errors=errors,
) )
@ -137,4 +138,3 @@ class MikrotikControllerOptionsFlowHandler(config_entries.OptionsFlow):
} }
), ),
) )

2
custom_components/mikrotik_router/const.py
View file

@ -8,4 +8,4 @@ ATTRIBUTION = "Data provided by Mikrotik"
CONF_SCAN_INTERVAL = "scan_interval" CONF_SCAN_INTERVAL = "scan_interval"
DEFAULT_SCAN_INTERVAL = 30 DEFAULT_SCAN_INTERVAL = 30
CONF_TRACK_ARP = "track_arp" CONF_TRACK_ARP = "track_arp"
DEFAULT_TRACK_ARP = True DEFAULT_TRACK_ARP = True

30
custom_components/mikrotik_router/device_tracker.py
View file

@ -2,13 +2,16 @@
import logging import logging
from homeassistant.core import callback from homeassistant.core import callback
from homeassistant.helpers import entity_registry
from homeassistant.helpers.device_registry import CONNECTION_NETWORK_MAC from homeassistant.helpers.device_registry import CONNECTION_NETWORK_MAC
from homeassistant.helpers.dispatcher import async_dispatcher_connect from homeassistant.helpers.dispatcher import async_dispatcher_connect
from homeassistant.components.device_tracker import DOMAIN as DEVICE_TRACKER_DOMAIN
from homeassistant.components.device_tracker.config_entry import ScannerEntity from homeassistant.components.device_tracker.config_entry import ScannerEntity
from homeassistant.components.device_tracker.const import SOURCE_TYPE_ROUTER from homeassistant.components.device_tracker.const import SOURCE_TYPE_ROUTER
from .const import DEFAULT_NAME, DOMAIN, DATA_CLIENT, ATTRIBUTION from .const import (
DOMAIN,
DATA_CLIENT,
ATTRIBUTION,
)
from homeassistant.const import ( from homeassistant.const import (
CONF_NAME, CONF_NAME,
ATTR_ATTRIBUTION, ATTR_ATTRIBUTION,
@ -16,8 +19,6 @@ from homeassistant.const import (
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
ATTRIBUTION = "Data provided by Mikrotik"
DEVICE_ATTRIBUTES = [ DEVICE_ATTRIBUTES = [
"running", "running",
"enabled", "enabled",
@ -34,6 +35,7 @@ DEVICE_ATTRIBUTES = [
"default-name", "default-name",
] ]
#--------------------------- #---------------------------
# async_setup_entry # async_setup_entry
#--------------------------- #---------------------------
@ -41,16 +43,11 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
"""Set up device tracker for Mikrotik Router component.""" """Set up device tracker for Mikrotik Router component."""
name = config_entry.data[CONF_NAME] name = config_entry.data[CONF_NAME]
mikrotik_controller = hass.data[DOMAIN][DATA_CLIENT][config_entry.entry_id] mikrotik_controller = hass.data[DOMAIN][DATA_CLIENT][config_entry.entry_id]
tracked = {}
registry = await entity_registry.async_get_registry(hass)
@callback @callback
def update_controller(): def update_controller():
"""Update the values of the controller.""" """Update the values of the controller."""
update_items(name, mikrotik_controller, async_add_entities, tracked) update_items(name, mikrotik_controller, async_add_entities)
mikrotik_controller.listeners.append( mikrotik_controller.listeners.append(
async_dispatcher_connect(hass, mikrotik_controller.signal_update, update_controller) async_dispatcher_connect(hass, mikrotik_controller.signal_update, update_controller)
@ -59,15 +56,16 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
update_controller() update_controller()
return return
#--------------------------- #---------------------------
# update_items # update_items
#--------------------------- #---------------------------
@callback @callback
def update_items(name, mikrotik_controller, async_add_entities, tracked): def update_items(name, mikrotik_controller, async_add_entities):
"""Update tracked device state from the controller.""" """Update tracked device state from the controller."""
tracked = {}
new_tracked = [] new_tracked = []
sensors = []
for uid in mikrotik_controller.data['interface']: for uid in mikrotik_controller.data['interface']:
if mikrotik_controller.data['interface'][uid]['type'] == "ether": if mikrotik_controller.data['interface'][uid]['type'] == "ether":
item_id = name + "-" + mikrotik_controller.data['interface'][uid]['default-name'] item_id = name + "-" + mikrotik_controller.data['interface'][uid]['default-name']
@ -84,6 +82,7 @@ def update_items(name, mikrotik_controller, async_add_entities, tracked):
return return
#--------------------------- #---------------------------
# MikrotikControllerPortDeviceTracker # MikrotikControllerPortDeviceTracker
#--------------------------- #---------------------------
@ -114,7 +113,6 @@ class MikrotikControllerPortDeviceTracker(ScannerEntity):
"""Synchronize state with controller.""" """Synchronize state with controller."""
#await self.mikrotik_controller.async_update() #await self.mikrotik_controller.async_update()
return return
@property @property
def is_connected(self): def is_connected(self):
@ -158,7 +156,7 @@ class MikrotikControllerPortDeviceTracker(ScannerEntity):
"connections": {(CONNECTION_NETWORK_MAC, self.mikrotik_controller.data['interface'][self._uid]['port-mac-address'])}, "connections": {(CONNECTION_NETWORK_MAC, self.mikrotik_controller.data['interface'][self._uid]['port-mac-address'])},
"manufacturer": self.mikrotik_controller.data['resource']['platform'], "manufacturer": self.mikrotik_controller.data['resource']['platform'],
"model": "Port", "model": "Port",
"name": self.mikrotik_controller.data['interface'][self._uid]['default-name'] , "name": self.mikrotik_controller.data['interface'][self._uid]['default-name'],
} }
return info return info
@ -171,4 +169,4 @@ class MikrotikControllerPortDeviceTracker(ScannerEntity):
if variable in self.mikrotik_controller.data['interface'][self._uid]: if variable in self.mikrotik_controller.data['interface'][self._uid]:
attributes[variable] = self.mikrotik_controller.data['interface'][self._uid][variable] attributes[variable] = self.mikrotik_controller.data['interface'][self._uid][variable]
return attributes return attributes

5
custom_components/mikrotik_router/mikrotikapi.py
View file

@ -5,13 +5,14 @@ import librouteros
import logging import logging
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
#--------------------------- #---------------------------
# MikrotikAPI # MikrotikAPI
#--------------------------- #---------------------------
class MikrotikAPI: class MikrotikAPI:
"""Handle all communication with the Mikrotik API.""" """Handle all communication with the Mikrotik API."""
def __init__(self, host, username, password, port = 0, use_ssl = True, login_method = "plain", encoding = "utf-8"): def __init__(self, host, username, password, port=0, use_ssl=True, login_method="plain", encoding="utf-8"):
"""Initialize the Mikrotik Client.""" """Initialize the Mikrotik Client."""
self._host = host self._host = host
self._use_ssl = use_ssl self._use_ssl = use_ssl
@ -114,4 +115,4 @@ class MikrotikAPI:
_LOGGER.error("Mikrotik %s connection error %s", self._host, api_error) _LOGGER.error("Mikrotik %s connection error %s", self._host, api_error)
return None return None
return response if response else None return response if response else None