tomaae.homeassistant-mikrot.../README.md

# Mikrotik Router
![GitHub release (latest by date)](https://img.shields.io/github/v/release/tomaae/homeassistant-mikrotik_router?style=plastic)
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg?style=plastic)](https://github.com/custom-components/hacs)
[![License](https://img.shields.io/github/license/tomaae/homeassistant-mikrotik_router?style=plastic)](LICENSE.md)
![Project Stage](https://img.shields.io/badge/project%20stage-development-yellow.svg?style=plastic)

![GitHub commits since latest release](https://img.shields.io/github/commits-since/tomaae/homeassistant-mikrotik_router/latest?style=plastic)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/tomaae/homeassistant-mikrotik_router?style=plastic)


Monitor and control your Mikrotik device from Home Assistant.
![Tracker and sensors](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/device_tracker.png)

![Interface Info](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/interface.png)
![Interface Switch](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/interface_switch.png)
![Script Switch](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/script_switch.png)
![NAT switch](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/nat.png)


Features:
 * Interface device tracker
 * Enable/disable interface switches
 * Enable/disable NAT rule switches
 * System sensors (CPU, Memory, HDD)
 * Firmware update binary sensor
 * Switches to run scripts

# Setup integration
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.

![Add Integration](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/setup_integration.png)
* "Host" - Use hostname or IP
* "Port" - Leave at 0 for defaults
* "Name of the integration" - Friendy name for this router

# Configuration
![Integration options](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/integration_options.png)
* "Show client MAC and IP" - Display connected IP and MAC address for devices connected to ports on router.
* "Scan interval" - Scan/refresh time in seconds. HA needs to be reloaded for scan interval change to be applied.

## List of detected devices
![Integration options](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/integration_devices.png)
Update README.md 2019-12-04 18:47:02 +01:00			`# Mikrotik Router`
Create README.md 2019-12-02 01:55:25 +01:00			`![GitHub release (latest by date)](https://img.shields.io/github/v/release/tomaae/homeassistant-mikrotik_router?style=plastic)`
Update README.md 2019-12-02 02:11:40 +01:00			`[![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg?style=plastic)](https://github.com/custom-components/hacs)`
Update README.md 2019-12-02 10:52:05 +01:00			`[![License](https://img.shields.io/github/license/tomaae/homeassistant-mikrotik_router?style=plastic)](LICENSE.md)`
Update README.md 2019-12-02 09:52:37 +01:00			`![Project Stage](https://img.shields.io/badge/project%20stage-development-yellow.svg?style=plastic)`
Create README.md 2019-12-02 01:55:25 +01:00
			`![GitHub commits since latest release](https://img.shields.io/github/commits-since/tomaae/homeassistant-mikrotik_router/latest?style=plastic)`
			`![GitHub commit activity](https://img.shields.io/github/commit-activity/m/tomaae/homeassistant-mikrotik_router?style=plastic)`


Update README.md 2019-12-04 18:47:02 +01:00			`Monitor and control your Mikrotik device from Home Assistant.`
updated docs 2019-12-04 20:15:24 +01:00			`![Tracker and sensors](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/device_tracker.png)`
Create README.md 2019-12-02 01:55:25 +01:00
			`![Interface Info](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/interface.png)`
updated readme 2019-12-04 16:13:07 +01:00			`![Interface Switch](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/interface_switch.png)`
updated docs 2019-12-04 20:15:24 +01:00			`![Script Switch](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/script_switch.png)`
Update README.md 2019-12-04 20:19:02 +01:00			`![NAT switch](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/nat.png)`
updated readme 2019-12-03 18:31:29 +01:00

Create README.md 2019-12-02 01:55:25 +01:00			`Features:`
			`* Interface device tracker`
updated readme with switch support 2019-12-03 01:50:12 +01:00			`* Enable/disable interface switches`
updated readme 2019-12-03 18:31:29 +01:00			`* Enable/disable NAT rule switches`
updated readme 2019-12-03 03:09:46 +01:00			`* System sensors (CPU, Memory, HDD)`
updated readme 2019-12-04 16:13:07 +01:00			`* Firmware update binary sensor`
updated docs 2019-12-04 20:15:24 +01:00			`* Switches to run scripts`
Create README.md 2019-12-02 01:55:25 +01:00
Update README.md 2019-12-04 18:47:02 +01:00			`# Setup integration`
			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.`
Create README.md 2019-12-02 01:55:25 +01:00
			`![Add Integration](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/setup_integration.png)`
			`* "Host" - Use hostname or IP`
			`* "Port" - Leave at 0 for defaults`
			`* "Name of the integration" - Friendy name for this router`

Update README.md 2019-12-04 18:47:02 +01:00			`# Configuration`
Create README.md 2019-12-02 01:55:25 +01:00			`![Integration options](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/integration_options.png)`
			`* "Show client MAC and IP" - Display connected IP and MAC address for devices connected to ports on router.`
			`* "Scan interval" - Scan/refresh time in seconds. HA needs to be reloaded for scan interval change to be applied.`

			`## List of detected devices`
			`![Integration options](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/integration_devices.png)`