ha pi hole v6

🛡️ This custom integration restores compatibility between Home Assistant and Pi-hole, which is no longer supported by the native integration due to API changes.

bastgau

145

Python

Pi-hole V6 Integration for Home Assistant

Original component : Pi-hole

The Pi-hole integration allows you to retrieve statistics and interact with a Pi-hole system.

Description

Due to major changes in the Pi-hole API, the native Home Assistant integration was no longer functional.

The “Pi-hole V6 Integration” adds compatibility with the new API in Home Assistant. This integration aims to restore compatibility and provide Pi-hole management directly from Home Assistant.

Features

Monitor Pi-hole status.
Enable/Disable Pi-hole via Home Assistant.
Retrieve filtering statistics.
Compatibility with the Pi-hole V6 API.

The following sensors are currently implemented :

Note : To perform the flush/arp, flush/logs and restartdns actions, the ‘Permit destructive actions via API’ option must be enabled in the Pi-hole options.

Translation

The integration is currently translated in few langages :

Czech (thanks @kukulich)
Dutch (thanks @jverlaan)
English
French
German (thanks Christian)
Norwegian (thanks @emigrating)
Polish (thanks @jacksonafide)
Russian (thanks @ProFiLeR4100)
Portuguese (Brazil) (thanks @tangobones)
Slovak (thanks @milandzuris)
Spanish (thanks @dmbuil)
Swedish (thanks @aleexolsson)
Turkish (thanks @habil)
Ukrainian (thanks @ProFiLeR4100)

Installation

Installation via HACS

Add this repository as a custom repository to HACS:

Use HACS to install the integration.
Restart Home Assistant.
Set up the integration using the UI:

Manual Installation

Download the integration files from the GitHub repository.
Place the integration folder in the custom_components directory of Home Assistant.
Restart Home Assistant.
Set up the integration using the UI:

Debugging

It is possible to show the info and debug logs for the Pi-hole V6 integration, to do this you need to enable logging in the configuration.yaml, example below:

logger:
  default: warning
  logs:
    # Log for Pi-hole V6 integation
    custom_components.pi_hole_v6: debug

Logs do not remove sensitive information so careful what you share, check what you are about to share and blank identifying information.

Frequently Asked Questions

How do I configure the refresh frequency?

By default, the data is updated every 5 minutes. You can configure a different frequency as explained on the following page.

Support & Contributions

If you encounter any issues or wish to contribute to improving this integration, feel free to open an issue or a pull request on the GitHub repository.

Enjoy!