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-05-02 17:18:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/pi_hole.markdown
Benoit Anastay 66958b77cd
Replace "Updates" category name with "Update" (#24090) 
The purpose of this change is to be consistent withothers categories names as suggested by @ludeeus
2022-09-11 21:13:18 +02:00

1.4 KiB
Raw Permalink Blame History

title, description, ha_category, ha_iot_class, ha_config_flow, ha_release, ha_codeowners, ha_domain, ha_platforms, ha_integration_type
title description ha_category ha_iot_class ha_config_flow ha_release ha_codeowners ha_domain ha_platforms ha_integration_type
Pi-hole Instructions on how to integrate Pi-hole with Home Assistant.
Sensor
Switch
System Monitor
Update
Local Polling true 0.28
@johnluetke
@shenxn
pi_hole
binary_sensor
sensor
switch
update
integration

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

{% include integrations/config_flow.md %}

Please note, that during the integration set up, an API key can be provided. Providing one, gives access to the Pi-Hole disable service and a switch to enable/disable Pi-Hole from Home Assistant.

Services

The platform provides the following services to interact with your Pi-hole. Use switch entities when calling the services.

Service pi_hole.disable

Disables configured Pi-hole(s) for the specified amount of time.

Service data attribute Required Type Description
entity_id False string Target switch entity. Use all to target all Pi-hole services
duration True timedelta Time for which Pi-hole should be disabled

Example service call:

# Example service call to disable Pi-Hole for 30 minutes
service: pi_hole.disable
data:
  duration: '00:30'
target:
  entity_id: all