diff --git a/README.md b/README.md index 8666b52..2c31882 100644 --- a/README.md +++ b/README.md @@ -37,14 +37,18 @@ Monitor and control your Mikrotik device from Home Assistant. * Enable/disable interfaces * Monitor RX/TX traffic per interface * Monitor device presence per interface - * IP, MAC, Link information per interface for connected devices + * IP, MAC, Link information per an interface for connected devices * Enable/disable NAT rule switches * Enable/disable Simple Queue switches + * Enable/disable Mangle switches + * Monitor and control PPP users + * Kid Control * Mikrotik Accounting traffic sensors per hosts for RX/TX WAN/LAN * Device tracker for hosts in network * System sensors (CPU, Memory, HDD, Temperature) * Check firmware update - * Execute scripts using switches or services + * Execute scripts + * View environment variables * Configurable update interval * Configurable traffic unit (bps, Kbps, Mbps, B/s, KB/s, MB/s) * Supports monitoring of multiple mikrotik devices simultaneously @@ -60,26 +64,37 @@ Monitor and control status on each Mikrotik interface, both lan and wlan. Both p ## NAT Monitor and control individual NAT rules. -More information about NAT rules can be found on [Mikrotik support page](https://wiki.mikrotik.com/wiki/Manual:IP/Firewall/NAT). - -NOTE: dst-port and protocol combination must be unique for each rule. All conflicting NAT rules will not be available in HA. +More information about NAT rules can be found on [Mikrotik support page](https://help.mikrotik.com/docs/display/ROS/NAT). ![NAT switch](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/nat.png) +## Mangle +Monitor and control individual Mangle rules. + +More information about Mangle rules can be found on [Mikrotik support page](https://help.mikrotik.com/docs/display/ROS/Mangle). + +![Mangle switch](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/mangle_switch.png) + + ## Simple Queue Control simple queues. -More information about simple queues can be found on [Mikrotik support page](https://wiki.mikrotik.com/wiki/Manual:Queue#Simple_Queues). +More information about simple queues can be found on [Mikrotik support page](https://help.mikrotik.com/docs/display/ROS/Queues#heading-SimpleQueue). NOTE: FastTracked packets are not processed by Simple Queues. ![Queue switch](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/queue_switch.png) + +### PPP +Control and monitor PPP users. + +![PPP switch](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/ppp_switch.png) +![PPP tracker](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/ppp_tracker.png) + ## Host Tracking Track availability of all network devices. All devices visible to Mikrotik device can be tracked, including: LAN connected devices and both Wireless and CAPsMAN from Mikrotik wireless package. -NOTE: Host Tracking is disabled by default and has to be enabled in integration options. - ![Host tracker](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/host_tracker.png) ## Scripts @@ -88,7 +103,15 @@ You can execute scripts by automatically created switches or using services. ![Script Switch](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/script_switch.png) +## Kid Control +Monitor and control. + +![Kid Control](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/kidcontrol_switch.png) + + ## Accounting +*RouterOS 7+ no longer support accounting* + Monitor per-IP throughput tracking based on Mikrotik Accounting. 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. @@ -129,9 +152,11 @@ NOTE: Do not mistake "Mikrotik Router" integration with HA build-in integration * "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) +![Integration sensors](https://raw.githubusercontent.com/tomaae/homeassistant-mikrotik_router/master/docs/assets/images/ui/integration_options_sensors.png) +Select sensors + # Development ## Translation diff --git a/docs/assets/images/ui/integration_options.png b/docs/assets/images/ui/integration_options.png index bf8db45..b27489a 100644 Binary files a/docs/assets/images/ui/integration_options.png and b/docs/assets/images/ui/integration_options.png differ diff --git a/docs/assets/images/ui/integration_options_sensors.png b/docs/assets/images/ui/integration_options_sensors.png new file mode 100644 index 0000000..3d162cf Binary files /dev/null and b/docs/assets/images/ui/integration_options_sensors.png differ diff --git a/docs/assets/images/ui/interface.png b/docs/assets/images/ui/interface.png index 5fd5564..1f8d38b 100644 Binary files a/docs/assets/images/ui/interface.png and b/docs/assets/images/ui/interface.png differ diff --git a/docs/assets/images/ui/interface_switch.png b/docs/assets/images/ui/interface_switch.png index 8d78c24..0233e51 100644 Binary files a/docs/assets/images/ui/interface_switch.png and b/docs/assets/images/ui/interface_switch.png differ diff --git a/docs/assets/images/ui/kidcontrol_switch.png b/docs/assets/images/ui/kidcontrol_switch.png new file mode 100644 index 0000000..83ac592 Binary files /dev/null and b/docs/assets/images/ui/kidcontrol_switch.png differ diff --git a/docs/assets/images/ui/mangle_switch.png b/docs/assets/images/ui/mangle_switch.png new file mode 100644 index 0000000..b4cfda7 Binary files /dev/null and b/docs/assets/images/ui/mangle_switch.png differ diff --git a/docs/assets/images/ui/nat.png b/docs/assets/images/ui/nat.png index ec1fa3f..3349d36 100644 Binary files a/docs/assets/images/ui/nat.png and b/docs/assets/images/ui/nat.png differ diff --git a/docs/assets/images/ui/ppp_switch.png b/docs/assets/images/ui/ppp_switch.png new file mode 100644 index 0000000..e362e0d Binary files /dev/null and b/docs/assets/images/ui/ppp_switch.png differ diff --git a/docs/assets/images/ui/ppp_tracker.png b/docs/assets/images/ui/ppp_tracker.png new file mode 100644 index 0000000..575b1e8 Binary files /dev/null and b/docs/assets/images/ui/ppp_tracker.png differ diff --git a/docs/assets/images/ui/queue_switch.png b/docs/assets/images/ui/queue_switch.png index 95ca800..812aaf8 100644 Binary files a/docs/assets/images/ui/queue_switch.png and b/docs/assets/images/ui/queue_switch.png differ diff --git a/info.md b/info.md index df760a0..fd54836 100644 --- a/info.md +++ b/info.md @@ -1,6 +1,6 @@ {% if installed %} -{% if version_installed.replace("v", "").replace(".","") | int < 15 %} -**IMPORTANT: Integration needs to be re-added to take advantage of all new features.** +{% if version_installed.replace("v", "").replace(".","") | int == 16 %} +**IMPORTANT: This update changes some HA UIDs to improve handling of duplicate entries. After an update, delete old entries and check entity names in all your automations where you use this integration.** {% endif %} {% endif %} @@ -11,14 +11,18 @@ Monitor and control your Mikrotik device from Home Assistant. * Enable/disable interfaces * Monitor RX/TX traffic per interface * Monitor device presence per interface - * IP, MAC, Link information per interface for connected devices + * IP, MAC, Link information per an interface for connected devices * Enable/disable NAT rule switches * Enable/disable Simple Queue switches + * Enable/disable Mangle switches + * Monitor and control PPP users + * Kid Control * Mikrotik Accounting traffic sensors per hosts for RX/TX WAN/LAN * Device tracker for hosts in network * System sensors (CPU, Memory, HDD, Temperature) * Check firmware update * Execute scripts + * View environment variables * Configurable update interval * Configurable traffic unit (bps, Kbps, Mbps, B/s, KB/s, MB/s) * Supports monitoring of multiple mikrotik devices simultaneously