From 40a9ccbef4e5b8bc406de5209e11ccbf72cf32da Mon Sep 17 00:00:00 2001 From: blockcrafter21 <72599189+blockcrafter21@users.noreply.github.com> Date: Sat, 9 Jul 2022 13:17:47 +0200 Subject: [PATCH 1/2] Update README.md/ add Table of Contents --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index d87f695..2fdeb37 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Ftravisghansen%2Fhass-opnsense%2Fbadge%3Fref%3Dmain&style=for-the-badge)](https://actions-badge.atrox.dev/travisghansen/hass-opnsense/goto?ref=main) [![hacs_badge](https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge)](https://github.com/hacs/integration) + # hass-opnsense Join `OPNsense` with `home-assistant`! @@ -11,6 +12,19 @@ at any time. Initial development was done againt `OPNsense` `21.7` and `home-assistant` `2021.10`. +# Overview + +- [Installation](#installation) +- [Configuration](#configuration) + - [OPNsense](#OPNsense) + - [HA Config](#config) + - [Options](#options) +- [Entities](#entities) + - [Binary Sensor](#binary_sensor) + - [Device Tracker](#device_tracker) + - [Sensor](#sensor) + - [Switch](#switch) + - [Services](#services) # installation This integration currenlty **replaces** the built-in `opnsense` integration From 8bc8065fbc5e046c74d8a450fc57b1420c0e3231 Mon Sep 17 00:00:00 2001 From: blockcrafter21 <72599189+blockcrafter21@users.noreply.github.com> Date: Sat, 9 Jul 2022 13:26:21 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 2fdeb37..eaba99d 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ Initial development was done againt `OPNsense` `21.7` and `home-assistant` `2021 - [Sensor](#sensor) - [Switch](#switch) - [Services](#services) +- [Known Issues](#known-issues) + - [Adguard](#adguard) # installation This integration currenlty **replaces** the built-in `opnsense` integration @@ -189,3 +191,9 @@ data: interface: lan mac: "B9:7B:A6:46:B3:8B" ``` +# Known Issues + +## Adguard + +As mentioned [here](https://github.com/travisghansen/hass-opnsense/issues/22) using Adguard can lead to problems with the plugin. +Setting the Ratelimit in Adguard to 0 will resolve this problem.