Mikrotik Router integration

Tomaae · April 23, 2020, 5:04am

Available in languages:

Monitor and control your Mikrotik device from Home Assistant.

Interfaces:
- Enable/disable interfaces
- SFP status and information
- POE status, control and information
- Monitor RX/TX traffic per interface
- Monitor device presence per interface
- IP, MAC, Link information per an interface for connected devices
Enable/disable NAT rule switches
Enable/disable Simple Queue switches
Enable/disable Mangle switches
Enable/disable Filter switches
Monitor and control PPP users
Kid Control
Client Traffic RX/TX WAN/LAN monitoring though Accounting or Kid Control Devices (depending on RouterOS FW version)
Device tracker for hosts in network
System sensors (CPU, Memory, HDD, Temperature)
Check firmware update
Execute scripts
View environment variables
Configurable update interval
Configurable traffic unit (bps, Kbps, Mbps, B/s, KB/s, MB/s)
Supports monitoring of multiple mikrotik devices simultaneously

Integration available via HACS

My other work

Features

Interfaces

Monitor and control status on each Mikrotik interface, both lan and wlan. Both physical and virtual.

NAT

Monitor and control individual NAT rules.

More information about NAT rules can be found on Mikrotik support page.

NAT switch

Mangle

Monitor and control individual Mangle rules.

More information about Mangle rules can be found on Mikrotik support page.

Simple Queue

Control simple queues.

More information about simple queues can be found on Mikrotik support page.

NOTE: FastTracked packets are not processed by Simple Queues.

PPP

Control and monitor PPP users.

PPP switch
PPP tracker

Host Tracking

Track availability of all network devices. All devices visible to Mikrotik device can be tracked, including: LAN connected devices and both Wireless and CAPsMAN from Mikrotik wireless package.

Host tracker

Scripts

Execute Mikrotik Router scripts.
You can execute scripts by automatically created switches or using services.

Script Switch

Kid Control

Monitor and control Kid Control.

Kid Control Enable

Client Traffic

Client Traffic for RouterOS v6

Monitor per-IP throughput tracking based on Mikrotik Accounting.

Feature is present in Winbox IP-Accounting. Make sure that threshold is set to reasonable value to store all connections between user defined scan interval. Max value is 8192 so for piece of mind I recommend setting that value.

More information about Accounting can be found on Mikrotik support page.

NOTE: Accounting does not count in FastTracked packets.

Client Traffic for RouterOS v7+

In RouterOS v7 Accounting feature is deprecated so alternative approach for is to use
Kid Control Devices feature (IP - Kid Control - Devices).

This feature requires at least one ‘kid’ to be defined,
after that Mikrotik will dynamically start tracking bandwidth usage of all known devices.

Simple dummy Kid entry can be defined with

/ip kid-control add name=Monitor mon=0s-1d tue=0s-1d wed=0s-1d thu=0s-1d fri=0s-1d sat=0s-1d sun=0s-1d

Accounting sensor

machine2669 · October 5, 2020, 4:44pm

My integration goes to unavailable immediately after the setup.
this is the log

Logger: homeassistant.util.logging
Source: util/logging.py:108
First occurred: 7:21:46 PM (20 occurrences)
Last logged: 7:23:46 PM

Exception in update_controller when dispatching ‘mikrotik_router-update-Mikrotik’: () Traceback (most recent call last): File “/config/custom_components/mikrotik_router/sensor.py”, line 149, in update_controller update_items(inst, mikrotik_controller, async_add_entities, sensors) File “/config/custom_components/mikrotik_router/sensor.py”, line 174, in update_items sensors[item_id].async_schedule_update_ha_state() File “/usr/src/homeassistant/homeassistant/helpers/entity.py”, line 441, in async_schedule_update_ha_state self.async_write_ha_state() File “/usr/src/homeassistant/homeassistant/helpers/entity.py”, line 292, in async_write_ha_state raise NoEntitySpecifiedError( homeassistant.exceptions.NoEntitySpecifiedError: No entity id specified for entity Mikrotik Temperature
Exception in update_controller when dispatching ‘mikrotik_router-update-Mikrotik’: () Traceback (most recent call last): File “/config/custom_components/mikrotik_router/binary_sensor.py”, line 48, in update_controller update_items(inst, mikrotik_controller, async_add_entities, sensors) File “/config/custom_components/mikrotik_router/binary_sensor.py”, line 71, in update_items sensors[item_id].async_schedule_update_ha_state() File “/usr/src/homeassistant/homeassistant/helpers/entity.py”, line 441, in async_schedule_update_ha_state self.async_write_ha_state() File “/usr/src/homeassistant/homeassistant/helpers/entity.py”, line 292, in async_write_ha_state raise NoEntitySpecifiedError( homeassistant.exceptions.NoEntitySpecifiedError: No entity id specified for entity Mikrotik Firmware update
Exception in update_controller when dispatching ‘mikrotik_router-update-Mikrotik’: () Traceback (most recent call last): File “/config/custom_components/mikrotik_router/switch.py”, line 89, in update_controller update_items(inst, mikrotik_controller, async_add_entities, switches) File “/config/custom_components/mikrotik_router/switch.py”, line 138, in update_items switches[item_id].async_schedule_update_ha_state() File “/usr/src/homeassistant/homeassistant/helpers/entity.py”, line 441, in async_schedule_update_ha_state self.async_write_ha_state() File “/usr/src/homeassistant/homeassistant/helpers/entity.py”, line 292, in async_write_ha_state raise NoEntitySpecifiedError( homeassistant.exceptions.NoEntitySpecifiedError: No entity id specified for entity Mikrotik port ether1
Exception in update_controller when dispatching ‘mikrotik_router-update-Mikrotik’: () Traceback (most recent call last): File “/config/custom_components/mikrotik_router/device_tracker.py”, line 91, in update_controller update_items( File “/config/custom_components/mikrotik_router/device_tracker.py”, line 142, in update_items tracked[item_id].async_schedule_update_ha_state() File “/usr/src/homeassistant/homeassistant/helpers/entity.py”, line 441, in async_schedule_update_ha_state self.async_write_ha_state() File “/usr/src/homeassistant/homeassistant/helpers/entity.py”, line 292, in async_write_ha_state raise NoEntitySpecifiedError( homeassistant.exceptions.NoEntitySpecifiedError: No entity id specified for entity Mikrotik ether1

Any idea?

Tomaae · October 8, 2020, 9:52pm

No idea, this needs closer look.
Open an issue on github and also include debugs. You can find how to enable debug on github page as well.

marine88 · October 9, 2020, 12:09pm

Hi there Im using the component mikrotik for device tracking but even when disconnected from network is reporting home anyone know how to fix that? i have a mikrotik hap ac.

Tomaae · October 9, 2020, 12:35pm

Open an issue on github. There is no way to discuss and track issues in single thread.

marine88 · October 9, 2020, 1:20pm

Im using now the component and is working good the official component don´t work they should replace by yours thank you.

Tomaae · October 9, 2020, 1:41pm

I will probably offer it to HA once everything is rock solid. But there is still lot of work on it

marine88 · October 9, 2020, 2:11pm

Device track work like a charm and in official one dosen´t so think you should at least give it a try

Aeiou · October 22, 2020, 8:08pm

@Tomaae I’ve been using this integration for a couple of months without any real problems. Installed it with HACS. Thanks a lot for your work

Quick question though. How is the firmware update sensor supposed to work? It keeps displaying ‘off’ while there’s a new firmware version available for my router. I’m not sure whether it’s a setting in HA or of the router itself.

By the way, an uptime sensor would be a nice addition. Currently using an SNMP-sensor which works well too. So if anyone needs it, here’s the code that’s working for me.

The template will display the uptime in this format: 95d 11hr 9min

- platform: snmp
  host: !secret mikrotik_ip
  name: mikrotik_uptime
  baseoid: .1.3.6.1.2.1.1.3.0
  version: '2c'
  value_template: >
    {%- set time = value | int // 100 %}
    {%- set minutes = ((time % 3600) // 60) %}
    {%- set minutes = '{}min'.format(minutes) if minutes > 0 else '' %}
    {%- set hours = ((time % 86400) // 3600) %}
    {%- set hours = '{}hr '.format(hours) if hours > 0 else '' %}
    {%- set days = (time // 86400) %}
    {%- set days = '{}d '.format(days) if days > 0 else '' %}
    {{ 'Less than 1 min' if time < 60 else days + hours + minutes }}

Tomaae · October 22, 2020, 10:28pm

Thats good to hear
Firmware update sensor is /system/package/update/status
It is working without issues for me. If its not for you, just open a issue on github and add details + debugs.

Sure, I can add uptime sensor. What are you using that for?

Tomaae · December 9, 2020, 6:00pm

I’m looking for testers for device tracking. Specially people who use mikrotik wireless as I’m not able to properly test that.
If you are having any issues with device tracking or are just interested in helping out, join conversation in following github issue:

cziterus · December 14, 2020, 10:45am

Hey, could you tell me why I can enable/disable only main (eth1) interface? On eth2 i get message that device_tracker/turn_off. Service not found. Should I used other option?

Tomaae · December 15, 2020, 4:37am

Cant really investigate that here. Open an issue on github and include all details.

Bibabutzi · December 20, 2020, 6:33pm

Hey tomaae. Thank you for the integration.

I have multiple mikrotik APs running. Is it possible to do device tracking over multiple APs?

Tomaae · December 20, 2020, 8:42pm

Should be, I have no way to test it since mikrotik wifi never worked reliably for me.
Give it a try, if there are problems, just open an issue on github and we can have a look.

Tomaae · January 15, 2021, 1:37am

Big update 1.6 released:

Support for RouterOS 7+ beta
Granular selection for available sensors
Added Firewall Mangle control
Added PoE control for PoE capable ports
Added PPP users tracking and control
Added CPU and Board temperatures for more systems
Added Kid Control
Added Uptime sensor
Added Environment sensors
Resolve tracked device manufacturer based on MAC address
Added Latvian translation
Improved handling of duplicate NAT entries
Fixed conflict with aggregatied interfaces
Fixed crash when wrong permissions were set
Integration will no longer override manufacturer and model for existing devices

KingRichard · January 15, 2021, 2:27am

upon upgrade all my connection is pushing out with error

Tomaae · January 15, 2021, 2:44am

you have to enable which sensors you want in integration option now.

KingRichard · January 15, 2021, 3:00am

heem where is the options menu?

Tomaae · January 15, 2021, 8:37am

Configuration>Integrations>Mikrotik Router>Options