Mikrotik Router

Monitor and control your Mikrotik device from Home Assistant.

Features:

• Interfaces:
  • Enable/disable interfaces
  • Monitor RX/TX traffic per interface
  • Monitor device presence per interface
  • IP, MAC, Link information per interface for connected devices
• Enable/disable NAT rule switches
• Enable/disable Simple Queue switches
• Device tracker for hosts in network
• System sensors (CPU, Memory, HDD)
• Check firmware update
• Execute scripts
• Configurable update interval
• Configurable traffic unit (bps, Kbps, Mbps, B/s, KB/s, MB/s)
• Supports monitoring of multiple mikrotik devices simultaneously
• RX/TX WAN/LAN traffic sensors per hosts from Mikrotik Accounting feature

Integration preview

Install integration

This integration is distributed using HACS.

You can find it under "Integrations", named "Mikrotik Router"

Setup integration

Create user for homeassistant on your mikrotik router with following permissions:

• read, write, api, test

If you want to be able to execute scripts on your mikrotik router from HA, script needs to have only following policies:

• read, write, test or check "Don't Require Permissions" option

Setup this integration for your Mikrotik device in Home Assistant via Configuration -> Integrations -> Add -> Mikrotik Router. You can add this integration several times for different devices.

NOTE: Do not mistake "Mikrotik Router" integration with HA build-in integration named "Mikrotik".

• "Name of the integration" - Friendly name for this router
• "Host" - Use hostname or IP
• "Port" - Leave at 0 for defaults

Configuration

• "Scan interval" - Scan/refresh time in seconds. HA needs to be reloaded for scan interval change to be applied.
• "Unit of measurement" - Traffic sensor measurement (bps, Kbps, Mbps, B/s, KB/s, MB/s)
• "Show client MAC and IP on interfaces" - Display connected IP and MAC address for devices connected to ports on router.
• "Track network devices" - Enable device tracker
• "Track network devices timeout" - Tracked devices will be marked as away after timeout (does not apply to Mikrotik wireless and caps-man)

Accounting

For per-IP throughput tracking Mikrotik's accounting feature is used.

Mikrotik support page

Feature will be automatically used if accounting is enabled in Mikrotik. 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. Web Access is not needed, integration is using API access.

Integration will scan DHCP Lease table and ARP table to generate all known hosts. For every host aleast two sensors for WAN traffic (mikrotik-XXX-wan-rx and mikrotik-XXX-wan-tx) are created. If the parameter account-local-traffic is set in Mikrotik's accounting configuration it will also create two sensors for LAN traffic (mikrotik-XXX-lan-rx and mikrotik-XXX-lan-tx).

Enabling debug

To enable debug for Mikrotik router integration, add following to your configuration.yaml:

logger:
  default: info
  logs:
    custom_components.mikrotik_router: debug