Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.unifi.services Namespace Reference

Functions

None async_reconnect_client (HomeAssistant hass, Mapping[str, Any] data)
 
None async_remove_clients (HomeAssistant hass, Mapping[str, Any] data)
 
None async_setup_services (HomeAssistant hass)
 

Variables

string SERVICE_RECONNECT_CLIENT = "reconnect_client"
 
 SERVICE_RECONNECT_CLIENT_SCHEMA
 
string SERVICE_REMOVE_CLIENTS = "remove_clients"
 
dictionary SERVICE_TO_SCHEMA
 
tuple SUPPORTED_SERVICES = (SERVICE_RECONNECT_CLIENT, SERVICE_REMOVE_CLIENTS)
 

Detailed Description

UniFi Network services.

Function Documentation

◆ async_reconnect_client()

None homeassistant.components.unifi.services.async_reconnect_client ( HomeAssistant  hass,
Mapping[str, Any]  data 
)
Try to get wireless client to reconnect to Wi-Fi.

Definition at line 53 of file services.py.

◆ async_remove_clients()

None homeassistant.components.unifi.services.async_remove_clients ( HomeAssistant  hass,
Mapping[str, Any]  data 
)
Remove select clients from UniFi Network.

Validates based on:
- Total time between first seen and last seen is less than 15 minutes.
- Neither IP, hostname nor name is configured.

Definition at line 82 of file services.py.

◆ async_setup_services()

None homeassistant.components.unifi.services.async_setup_services ( HomeAssistant  hass)
Set up services for UniFi integration.

Definition at line 32 of file services.py.

Variable Documentation

◆ SERVICE_RECONNECT_CLIENT

string homeassistant.components.unifi.services.SERVICE_RECONNECT_CLIENT = "reconnect_client"

Definition at line 17 of file services.py.

◆ SERVICE_RECONNECT_CLIENT_SCHEMA

homeassistant.components.unifi.services.SERVICE_RECONNECT_CLIENT_SCHEMA
Initial value:
1 = vol.All(
2  vol.Schema({vol.Required(ATTR_DEVICE_ID): str})
3 )

Definition at line 20 of file services.py.

◆ SERVICE_REMOVE_CLIENTS

string homeassistant.components.unifi.services.SERVICE_REMOVE_CLIENTS = "remove_clients"

Definition at line 18 of file services.py.

◆ SERVICE_TO_SCHEMA

dictionary homeassistant.components.unifi.services.SERVICE_TO_SCHEMA
Initial value:
1 = {
2  SERVICE_RECONNECT_CLIENT: SERVICE_RECONNECT_CLIENT_SCHEMA,
3 }

Definition at line 26 of file services.py.

◆ SUPPORTED_SERVICES

tuple homeassistant.components.unifi.services.SUPPORTED_SERVICES = (SERVICE_RECONNECT_CLIENT, SERVICE_REMOVE_CLIENTS)

Definition at line 24 of file services.py.