MikroTik

The mikrotik platform offers presence detection by looking at connected devices to a MikroTik RouterOS based router.

There is currently support for the following device types within Home Assistant:

Presence Detection

Configuring mikrotik hub

You have to enable accessing the RouterOS API on your router to use this platform.

Terminal:

/ip service
set api disabled=no port=8728

Web Frontend:

Go to IP -> Services -> api and enable it.

Make sure that port 8728 or the port you choose is accessible from your network.

To use a MikroTik router in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
mikrotik:
  - host: IP_ADDRESS
    username: ROUTEROS_USERNAME
    password: ROUTEROS_PASSWORD

Configuration Variables

host

(string)(Required)

The IP address of your MikroTik device.

username

(string)(Required)

The username of a user on the MikroTik device.

password

(string)(Required)

The password of the given user account on the MikroTik device.

login_method

(string)(Optional)

The login method to use on the MikroTik device. The plain method is used by default, if you have an older RouterOS Version than 6.43, use token as the login method.

Default value:

plain

port

(integer)(Optional)

RouterOS API port.

Default value:

8728 (or 8729 if SSL is enabled)

ssl

(boolean)(Optional)

Use SSL to connect to the API.

Default value:

false

method

(string)(Optional)

Override autodetection of device scanning method. Can be wireless to use local wireless registration, capsman for capsman wireless registration, or dhcp for DHCP leases.

arp_ping

(boolean)(Optional)

Use ARP ping with DHCP method for device scanning.

Default value:

false

As of version 6.43 of RouterOS Mikrotik introduced a new login method (plain) in addition to the old login method (token). With Version 6.45.1 the old token login method got deprecated. In order to support both login mechanisms, the new config option login_method has been introduced. If this option is not set, the component will try to login with the plain method first and the token method if that fails. That can cause log entries on the router like login failure for user homeassistant from 192.168.23.10 via api but doesn’t keep the component from working. To get rid of these entries, set the login_method to plain for Routers with OS versions > 6.43 or token for routers with OS versions < 6.43.

Use a certificate

To use SSL to connect to the API (via api-ssl instead of api service) further configuration is required at RouterOS side. You have to upload or generate a certificate and configure api-ssl service to use it. Here is an example of a self-signed certificate:

/certificate add common-name="Self signed demo certificate for API" days-valid=3650 name="Self signed demo certificate for API" key-usage=digital-signature,key-encipherment,tls-server,key-cert-sign,crl-sign
/certificate sign "Self signed demo certificate for API"
/ip service set api-ssl certificate="Self signed demo certificate for API"
/ip service enable api-ssl

Then add ssl: true to mikrotik device tracker entry in your configuration.yaml file.

If everything is working fine you can disable the pure api service in RouterOS:

/ip service disable api

The user privileges in RouterOS

To use this device tracker you need restricted privileges only. To enhance the security of your MikroTik device create a “read only” user who is able to connect to API and perform ping test only:

/user group add name=homeassistant policy=read,api,!local,!telnet,!ssh,!ftp,!reboot,!write,!policy,test,!winbox,!password,!web,!sniff,!sensitive,!romon,!dude,!tikapp
/user add group=homeassistant name=homeassistant
/user set password="YOUR_PASSWORD" homeassistant

Using the additional configuration to the mikrotik entry in your configuration.yaml file:

mikrotik:
  - host: 192.168.88.1
    username: homeassistant
    password: YOUR_PASSWORD
    ssl: true
    arp_ping: true
    method: dhcp
    track_devices: true

  - host: 192.168.88.2
    username: homeassistant
    password: YOUR_PASSWORD
    ssl: true
    port: 8729
    method: capsman
    track_devices: true

See the device tracker integration page for instructions on how to configure the people to be tracked.