jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 17:57:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add new condition and update style for pi-hole (#5492)

Browse Source 
* Add new condition and update style

* Update description
This commit is contained in:
Fabian Affolter 2018-06-04 22:58:07 +02:00 committed by Martin Hjelmare
parent 6964de5f38
commit 6b7ade4981
1 changed files with 51 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
source/_components/sensor.pi_hole.markdown
View File

@ -1,7 +1,7 @@
--- ---
layout: page layout: page
title: "Pi-Hole Sensor" title: "Pi-hole Sensor"
description: "Instructions on how to integrate REST sensors into Home Assistant." description: "Instructions on how to integrate Pi-hole sensors into Home Assistant."
date: 2016-09-03 16:30 date: 2016-09-03 16:30
sidebar: true sidebar: true
comments: false comments: false
@ -14,7 +14,9 @@ ha_release: 0.28
--- ---
The `pi_hole` sensor platform is displaying the statistical summary of a [Pi-Hole](https://pi-hole.net/) system. The `pi_hole` sensor platform is displaying the statistical summary of a [Pi-hole](https://pi-hole.net/) system.
## {% linkable_title Configuration %}
To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request: To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request:
@ -24,18 +26,50 @@ sensor:
- platform: pi_hole - platform: pi_hole
``` ```
Configuration variables: {% configuration %}
host:
description: IP address of the host where Pi-hole is running.
required: false
type: string
default: localhost
location:
description: The installation location of the Pi-hole API.
required: false
type: string
default: admin
ssl:
description: "If `true`, use SSL/TLS to connect to the Pi-Hole system."
required: false
type: boolean
default: false
verify_ssl:
description: Verify the certification of the system.
required: false
type: boolean
default: true
monitored_conditions:
description: Defines the stats to monitor as sensors.
required: false
type: string
default: all
keys:
ads_blocked_today:
description: Total number of blocked ads today.
ads_percentage_today:
description: Percentage of blocked ads.
dns_queries_today:
description: Total number of DNS queries handled by Pi-hole today.
domains_being_blocked:
description: Total number of domains blocked by Pi-hole.
queries_cached:
description: Total number of cache queries on the last 24 hours.
queries_forwarded:
description: Total number of forwarded queries on the last 24 hours.
unique_clients:
description: Total number of unique clients on the last 24 hours.
unique_domains:
description: Total number of unique domains on the last 24 hours.
clients_ever_seen:
description: Total number of seen clients.
{% endconfiguration %}
- **host** (*Optional*): The IP address of the Pi-Hole system. Defaults to `localhost`.
- **location** (*Optional*): The installation location of the Pi-Hole API. Defaults to `admin`.
- **ssl** (*Optional*): If `true`, use SSL/TLS to connect to the Pi-Hole system. Defaults to `False`.
- **verify_ssl** (*Optional*): Verify the certification of the system. Default to `True`.
- **monitored_conditions** (*Optional*): Defines the stats to monitor as sensors.
- **ads_blocked_today**: Total number of blocked ads today.
- **ads_percentage_today**: Percentage of blocked ads.
- **dns_queries_today**: Total number of DNS queries handled by Pi-Hole today.
- **domains_being_blocked**: Total number of domains blocked by Pi-Hole.
- **queries_cached**: Total number of cache queries on the last 24 hours.
- **queries_forwarded**: Total number of forwarded queries on the last 24 hours.
- **unique_clients**: Total number of unique clients on the last 24 hours.
- **unique_domains**: Total number of unique domains on the last 24 hours.