c12e1cc164
* Update to reflect that this is now an intergration, not just a sensor * ✏️ Tweak * ✏️ Tweak
2.6 KiB
title, description, ha_category, ha_iot_class, logo, ha_release
| title | description | ha_category | ha_iot_class | logo | ha_release | |
|---|---|---|---|---|---|---|
| Pi-hole | Instructions on how to integrate Pi-hole with Home Assistant. |
|
Local Polling | pi_hole.png | 0.28 |
The pi_hole integration allows you to retrieve statistics and interact with a single Pi-hole system.
Configuration
To enable this integration with the default configuration, add the following lines to your configuration.yaml file
# Example configuration.yaml entry
pi_hole:
{% configuration %}
host:
description: >
The hostname (and port), e.g., '192.168.0.3:4865' of the host where Pi-hole is running. If your Pi-Hole instance is the Hass.io add-on, you must specify port 4865.
required: false
type: string
default: pi.hole
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 SSL/TLS certificate of the system. If your Pi-Hole instance uses a self-signed certificate, you should specify false.
required: false
type: boolean
default: true
api_key:
description: API Key for interacting with the Pi-hole. This is not required if you want to just query the Pi-hole for usage statistics.
required: false
type: string
default: None
{% endconfiguration %}
Full example
# Example configuration.yaml entry
pi_hole:
host: 'localhost:4865'
ssl: false
verify_ssl: false
Services
The platform provides the following services to interact with your Pi-hole.
Service pi_hole.disable
Disable your Pi-hole for the specified amount of time.
| Service data attribute | Required | Type | Description |
|---|---|---|---|
duration |
True |
timedelta | Time for which Pi-hole should be disabled |
Note: This service requires api_key to be specified in the configuration.
Service pi_hole.enable
Enable your Pi-hole.
Note: This service requires api_key to be specified in the configuration.
This integration was not made by Pi-hole LLC or the Pi-hole community. They did not provide support, feedback, testing, or any other help during its creation. This is a third party platform which may break if Pi-hole changes their API in a later release. It is not official, not developed, not supported, and not endorsed Pi-hole LLC or the Pi-hole community. The trademark Pi-hole and the logo is used here to describe the platform. Pi-hole is a registered trademark of Pi-hole LLC.