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

Classes

class  UnifiButtonEntity
 
class  UnifiButtonEntityDescription
 

Functions

bool async_port_power_cycle_available_fn (UnifiHub hub, str obj_id)
 
None async_power_cycle_port_control_fn (aiounifi.Controller api, str obj_id)
 
None async_regenerate_password_control_fn (aiounifi.Controller api, str obj_id)
 
None async_restart_device_control_fn (aiounifi.Controller api, str obj_id)
 
None async_setup_entry (HomeAssistant hass, UnifiConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 

Detailed Description

Button platform for UniFi Network integration.

Support for restarting UniFi devices.

Function Documentation

◆ async_port_power_cycle_available_fn()

bool homeassistant.components.unifi.button.async_port_power_cycle_available_fn ( UnifiHub  hub,
str  obj_id 
)
Check if port allows power cycle action.

Definition at line 52 of file button.py.

◆ async_power_cycle_port_control_fn()

None homeassistant.components.unifi.button.async_power_cycle_port_control_fn ( aiounifi.Controller  api,
str   obj_id 
)
Restart device.

Definition at line 66 of file button.py.

◆ async_regenerate_password_control_fn()

None homeassistant.components.unifi.button.async_regenerate_password_control_fn ( aiounifi.Controller  api,
str   obj_id 
)
Regenerate WLAN password.

Definition at line 74 of file button.py.

◆ async_restart_device_control_fn()

None homeassistant.components.unifi.button.async_restart_device_control_fn ( aiounifi.Controller  api,
str   obj_id 
)
Restart device.

Definition at line 59 of file button.py.

◆ async_setup_entry()

None homeassistant.components.unifi.button.async_setup_entry ( HomeAssistant  hass,
UnifiConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
)
Set up button platform for UniFi Network integration.

Definition at line 135 of file button.py.