mirror.MikroTik/tomaae.homeassistant-mikrotik_router
1
0
Fork 0
mirror of https://github.com/tomaae/homeassistant-mikrotik_router.git synced 2025-08-18 16:28:43 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update README.md

Browse source
This commit is contained in:
Tomaae 2019-12-04 18:47:02 +01:00 • committed by GitHub
parent 372c86edc7
commit 4954908bff
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -1,4 +1,4 @@
## Mikrotik Router # Mikrotik Router
![GitHub release (latest by date)](https://img.shields.io/github/v/release/tomaae/homeassistant-mikrotik_router?style=plastic) ![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) [![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) [![License](https://img.shields.io/github/license/tomaae/homeassistant-mikrotik_router?style=plastic)](LICENSE.md)
@ -7,12 +7,8 @@
![GitHub commits since latest release](https://img.shields.io/github/commits-since/tomaae/homeassistant-mikrotik_router/latest?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) ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/tomaae/homeassistant-mikrotik_router?style=plastic)
![aarch64-shield](https://img.shields.io/badge/aarch64-yes-green.svg?style=plastic)
![amd64-shield](https://img.shields.io/badge/amd64-yes-green.svg?style=plastic)
![armhf-shield](https://img.shields.io/badge/armhf-yes-green.svg?style=plastic)
![armv7-shield](https://img.shields.io/badge/armv7-yes-green.svg?style=plastic)
Monitor and control your Mikrotik Device from Home Assistant. Monitor and control your Mikrotik device from Home Assistant.
![Device Tracker](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/device_tracker.png) ![Device Tracker](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/device_tracker.png)
@ -34,15 +30,16 @@ Features:
* System sensors (CPU, Memory, HDD) * System sensors (CPU, Memory, HDD)
* Firmware update binary sensor * Firmware update binary sensor
## Add integration # Setup integration
You can add this integration to Home Assistant via `Configuration -> Integrations -> Add -> Mikrotik Router`. You can add this integration several times for different routers. 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) ![Add Integration](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/setup_integration.png)
* "Host" - Use hostname or IP * "Host" - Use hostname or IP
* "Port" - Leave at 0 for defaults * "Port" - Leave at 0 for defaults
* "Name of the integration" - Friendy name for this router * "Name of the integration" - Friendy name for this router
## Configuration # Configuration
![Integration options](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/integration_options.png) ![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. * "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. * "Scan interval" - Scan/refresh time in seconds. HA needs to be reloaded for scan interval change to be applied.