2019-12-04 18:47:02 +01:00
# Mikrotik Router
2019-12-02 01:55:25 +01:00
2019-12-07 15:33:25 +01:00
[](https://github.com/custom-components/hacs)
2019-12-02 09:52:37 +01:00
2019-12-02 01:55:25 +01:00
2020-04-05 03:38:42 +02:00
2019-12-02 01:55:25 +01:00
2019-12-04 18:47:02 +01:00
Monitor and control your Mikrotik device from Home Assistant.
2019-12-03 18:31:29 +01:00
2019-12-02 01:55:25 +01:00
Features:
2020-04-05 03:38:42 +02:00
* Interfaces:
* Enable/disable interfaces
* Monitor RX/TX traffic per interface
* Monitor device presence per interface
* IP, MAC, Link information per interface for connected devices
2019-12-03 18:31:29 +01:00
* Enable/disable NAT rule switches
2020-03-26 03:43:14 +01:00
* Enable/disable Simple Queue switches
2020-04-07 04:44:07 +02:00
* Device tracker for hosts in network
2019-12-03 03:09:46 +01:00
* System sensors (CPU, Memory, HDD)
2020-04-05 03:38:42 +02:00
* 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
2020-04-05 23:15:53 +02:00
* RX/TX WAN/LAN traffic sensors per hosts from Mikrotik Accounting feature
2020-04-07 10:54:19 +02:00
2020-03-26 03:43:14 +01:00
# Integration preview
2020-04-07 04:44:07 +02:00
2020-04-08 20:08:31 +02:00
2020-04-07 04:44:07 +02:00
2020-04-13 12:10:37 +02:00
# Install integration
This integration is distributed using [HACS ](https://hacs.xyz/ ).
You can find it under "Integrations", named "Mikrotik Router"
2019-12-04 18:47:02 +01:00
# Setup integration
2020-04-10 11:53:09 +02:00
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
2019-12-04 18:47:02 +01:00
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.
2019-12-02 01:55:25 +01:00
2020-04-13 12:10:37 +02:00
NOTE: Do not mistake "Mikrotik Router" integration with HA build-in integration named "Mikrotik".
2019-12-02 01:55:25 +01:00
2020-04-08 21:33:49 +02:00
* "Name of the integration" - Friendly name for this router
2019-12-02 01:55:25 +01:00
* "Host" - Use hostname or IP
* "Port" - Leave at 0 for defaults
2019-12-04 18:47:02 +01:00
# Configuration
2019-12-02 01:55:25 +01:00
* "Scan interval" - Scan/refresh time in seconds. HA needs to be reloaded for scan interval change to be applied.
2020-03-26 03:46:31 +01:00
* "Unit of measurement" - Traffic sensor measurement (bps, Kbps, Mbps, B/s, KB/s, MB/s)
2020-04-09 23:08:53 +02:00
* "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)
2019-12-02 01:55:25 +01:00
2020-04-05 23:15:53 +02:00
## Accounting
For per-IP throughput tracking Mikrotik's accounting feature is used.
[Mikrotik support page ](https://wiki.mikrotik.com/wiki/Manual:IP/Accounting )
2020-04-07 21:31:56 +02:00
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.
2020-04-05 23:15:53 +02:00
2020-04-08 16:01:27 +02:00
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).
2020-04-10 11:01:13 +02:00
2020-04-16 00:03:47 +02:00
## Development
### Translation
To help out with the translation you need an account on Lokalise, the easiest way to get one is to [click here ](https://lokalise.com/login/ ) then select "Log in with GitHub".
After you have created your account [click here to join Mikrotik Router project on Lokalise ](https://app.lokalise.com/public/581188395e9778a6060128.17699416/ )
If you want to add translations for a language that is not listed please [open a Feature request ](https://github.com/tomaae/homeassistant-mikrotik_router/issues/new?labels=enhancement&title=%5BLokalise%5D%20Add%20new%20translations%20language )
### Enabling debug
2020-04-10 11:01:13 +02:00
To enable debug for Mikrotik router integration, add following to your configuration.yaml:
```
logger:
default: info
logs:
custom_components.mikrotik_router: debug
```
