diff --git a/source/_components/adguard.markdown b/source/_components/adguard.markdown new file mode 100644 index 00000000000..298351a35de --- /dev/null +++ b/source/_components/adguard.markdown @@ -0,0 +1,117 @@ +--- +layout: page +title: "AdGuard Home" +description: "Instructions on how to integrate AdGuard Home with Home Assistant." +date: 2019-05-31 00:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: adguard.png +ha_category: + - Network + - Sensor + - Switch +ha_release: 0.95 +ha_iot_class: Local Polling +--- + +AdGuard Home is a network-wide ad-and-tracker blocking DNS server with parental +control (adult content blocking) capabilities. The `adguard` integration allows +you to control and monitor your AdGuard Home instance in Home Assistant. + +## {% linkable_title Configuration via the frontend %} + +Menu: **Configuration** -> **Integrations**. + +Click on the `+` sign to add an integration and click on **AdGuard Home**. +Follow the configuration flow, after finishing, the AdGuard Home +integration will be available. + +## {% linkable_title Sensors %} + +This integration provides sensors for the following information from AdGuard Home: + +- Number of DNS queries. +- Number of blocked DNS queries. +- Ratio (%) of blocked DNS queries. +- Number of requests blocked by safe browsing. +- Number of safe searches enforced. +- Number of requests blocked by parental control. +- Total number of active filter rules loaded. +- Average response time of AdGuard's DNS server in milliseconds. + +## {% linkable_title Switches %} + +The integration will create a number of switches: + +- AdGuard Protection (master switch). +- Filtering. +- Safe Browsing. +- Parental Control. +- Safe Search. +- Query Log. + +These switches allow you to automate things easily. For example, one could +write an automation to turn off Safe Search after the kids' bedtime. + +The "AdGuard Protection" switch, is a master switch. It will turn off and +bypass all AdGuard feature, regardless if they are switched on or not. + +
+Turning off Query Log will result in all sensors not receiving updates anymore. +AdGuard relies on Query Log to provide stats. +
+ +## {% linkable_title Services %} + +These services allow one to manage filter subscriptions in AdGuard Home. +Using these services in automations could be helpful to block certain +sites/domains at certain times. + +For example, you could create a custom filter list blocking social media sites, +during the day and release them during the evening, using a simple automation. + +### {% linkable_title Service `add_url` %} + +Add a new filter subscription to AdGuard Home. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------------------------------------ | +| `name` | No | The name of the filter subscription. | +| `url` | No | The filter URL to subscribe to, containing the filter rules. | + +### {% linkable_title Service `remove_url` %} + +Removes a filter subscription from AdGuard Home. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | -------------------------------------- | +| `url` | No | The filter subscription URL to remove. | + +### {% linkable_title Service `enable_url` %} + +Enables a filter subscription in AdGuard Home. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | -------------------------------------- | +| `url` | No | The filter subscription URL to enable. | + +### {% linkable_title Service `disable_url` %} + +Disables a filter subscription in AdGuard Home. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | --------------------------------------- | +| `url` | No | The filter subscription URL to disable. | + +### {% linkable_title Service `refresh` %} + +Refresh all filter subscriptions in AdGuard Home. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------------------------- | +| `force` | Yes | Force update (bypasses AdGuard Home throttling). | + +By default, `force` is set to `false`. Forcing an update bypasses AdGuard Home's +throttling logic, so use with care. diff --git a/source/_components/google_assistant.markdown b/source/_components/google_assistant.markdown index 5f1c75b766f..498a9910ae3 100644 --- a/source/_components/google_assistant.markdown +++ b/source/_components/google_assistant.markdown @@ -193,6 +193,7 @@ Currently, the following domains are available to be used with Google Assistant, - media_player (on/off/set volume (via set brightness)/source (via set input source)) - climate (temperature setting, operation_mode) - vacuum (dock/start/stop/pause) +- sensor (temperature setting, only for temperature sensor)The domain groups contains groups containing all items, by example group.all_automations. When telling Google Assistant to shut down everything, this will lead in this example to disabling all automations diff --git a/source/images/supported_brands/adguard.png b/source/images/supported_brands/adguard.png new file mode 100644 index 00000000000..6bfd89b7b66 Binary files /dev/null and b/source/images/supported_brands/adguard.png differ