Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Index your code
hub
/
github.com/bastgau/ha-pi-hole-v6
/ types & classes
Types & classes
32 in github.com/bastgau/ha-pi-hole-v6
⨍
Functions
133
◇
Types & classes
32
↓ 6 callers
Class
PiholeV6ButtonEntityDescription
Description of a Pi-hole V6 button entity used to trigger actions on the Pi-hole instance.
custom_components/pi_hole_v6/button.py:28
↓ 4 callers
Class
PiHoleV6UpdateEntityDescription
Describes PiHoleV6 update entity. Attributes: installed_version (Callable[[dict[str, Any]], str] | None): A callable that takes the versi
custom_components/pi_hole_v6/update.py:26
↓ 1 callers
Class
ClientConnectorError
The class `ClientConnectorError` is used to raise an exception when the Pi-hole V6 server is unreachable.
custom_components/pi_hole_v6/exceptions.py:54
↓ 1 callers
Class
OptionsFlowHandler
Options flow used to change configuration (options) of existing instance of integration.
custom_components/pi_hole_v6/config_flow.py:298
↓ 1 callers
Class
PiHoleV6BinarySensor
Representation of a Pi-hole V6 binary sensor.
custom_components/pi_hole_v6/binary_sensor.py:83
↓ 1 callers
Class
PiHoleV6BinarySensorEntityDescription
Describes PiHole binary sensor entity. Attributes: state_value (Callable[[PiholeAPI], Any]): A callable that takes the API client
custom_components/pi_hole_v6/binary_sensor.py:32
↓ 1 callers
Class
PiHoleV6Button
Representation of a Pi-hole V6 button.
custom_components/pi_hole_v6/button.py:95
↓ 1 callers
Class
PiHoleV6Data
Runtime data definition. Attributes: api (PiholeAPI): The Pi-hole API client instance. coordinator (DataUpdateCoordinator[Any]):
custom_components/pi_hole_v6/__init__.py:55
↓ 1 callers
Class
PiHoleV6DeviceTracker
Representation of a device tracked via Pi-hole network data. Each tracked device gets its own entry in the Home Assistant device registry, id
custom_components/pi_hole_v6/device_tracker.py:295
↓ 1 callers
Class
PiHoleV6Group
Representation of a Pi-hole V6 group. Attributes: group_name (str): The name of the Pi-hole group managed by this entity.
custom_components/pi_hole_v6/switch.py:284
↓ 1 callers
Class
PiHoleV6Sensor
Representation of a Pi-hole V6 sensor.
custom_components/pi_hole_v6/sensor.py:194
↓ 1 callers
Class
PiHoleV6Switch
Representation of a Pi-hole V6 switch.
custom_components/pi_hole_v6/switch.py:128
↓ 1 callers
Class
PiHoleV6UpdateEntity
Representation of a Pi-hole update entity.
custom_components/pi_hole_v6/update.py:114
Class
APIError
The class `APIError` is a parent exception related to Pi-hole API.
custom_components/pi_hole_v6/exceptions.py:8
Class
AbortLogoutError
The class `AbortLogoutError` represents an exception when a logout is not relevant and can be avoided.
custom_components/pi_hole_v6/exceptions.py:28
Class
ActionExecutionError
The class `ActionExecutionError` is used to raise an exception when an action cannot be executed.
custom_components/pi_hole_v6/exceptions.py:18
Class
Api
Pi-hole API Client. Attributes: url (str): The URL of the Pi-hole API endpoint. just_initialized (bool): Flag indicating the clie
custom_components/pi_hole_v6/api.py:27
Class
BadGatewayError
The class `BadGatewayError` represents an exception for receiving an invalid response from an upstream server.
custom_components/pi_hole_v6/exceptions.py:40
Class
BadRequestError
The class `BadRequestError` is defined for requests that are unacceptable.
custom_components/pi_hole_v6/exceptions.py:46
Class
ConfigFlowHandler
Handle a Pi-hole V6 config flow.
custom_components/pi_hole_v6/config_flow.py:82
Class
ContentTypeError
The class `ContentTypeError` is used to raise an exception when the content type provided by the API is incorrect.
custom_components/pi_hole_v6/exceptions.py:75
Class
DataStructureError
The class `DataStructureError` is used to raise an exception when the data structure returned by the API is incorrect.
custom_components/pi_hole_v6/exceptions.py:141
Class
ForbiddenError
The class `ForbiddenError` represents an exception for when an API key lacks the necessary permissions for a request.
custom_components/pi_hole_v6/exceptions.py:85
Class
GatewayTimeoutError
The class `GatewayTimeoutError` represents an exception that occurs when a server acting as a gateway times out waiting for another server.
custom_components/pi_hole_v6/exceptions.py:91
Class
MethodNotAllowedError
The class `MethodNotAllowedError` represents an exception that occurs when a request's HTTP method is not supported on the server.
custom_components/pi_hole_v6/exceptions.py:97
Class
NotFoundError
The class `NotFoundError` represents a situation where a requested resource does not exist.
custom_components/pi_hole_v6/exceptions.py:103
Class
PiHoleV6Entity
Representation of a Pi-hole V6 entity. Attributes: api (PiholeAPI): The Pi-hole API client instance.
custom_components/pi_hole_v6/entity.py:21
Class
RequestFailedError
The class `RequestFailedError` defines an exception for when a request fails.
custom_components/pi_hole_v6/exceptions.py:109
Class
ServerError
The class `ServerError` defines an exception for internal server errors.
custom_components/pi_hole_v6/exceptions.py:115
Class
ServiceUnavailableError
The class `ServiceUnavailableError` defines an exception for when the server is temporarily unavailable.
custom_components/pi_hole_v6/exceptions.py:121
Class
TooManyRequestsError
The class `TooManyRequestsError` represents hitting the API with too many requests too quickly.
custom_components/pi_hole_v6/exceptions.py:127
Class
UnauthorizedError
The class `UnauthorizedError` is used to raise an exception when no session identity is provided for an endpoint requiring authorization.
custom_components/pi_hole_v6/exceptions.py:133