homeassistant.components.guardian.button Namespace Reference

Classes
class	GuardianButton
class	ValveControllerButtonDescription

Functions
None	_async_reboot (Client client)
None	_async_valve_reset (Client client)
None	async_setup_entry (HomeAssistant hass, ConfigEntry entry, AddEntitiesCallback async_add_entities)

Variables
tuple	BUTTON_DESCRIPTIONS
string	BUTTON_KIND_REBOOT = "reboot"
string	BUTTON_KIND_RESET_VALVE_DIAGNOSTICS = "reset_valve_diagnostics"

Detailed Description

Buttons for the Elexa Guardian integration.

Function Documentation

_async_reboot()

None homeassistant.components.guardian.button._async_reboot ( Client  client )

private

Reboot the Guardian.

Definition at line 40 of file button.py.

_async_valve_reset()

None homeassistant.components.guardian.button._async_valve_reset ( Client  client )

private

Reset the valve diagnostics on the Guardian.

Definition at line 45 of file button.py.

async_setup_entry()

None homeassistant.components.guardian.button.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	entry,
		AddEntitiesCallback	async_add_entities
	)

Set up Guardian buttons based on a config entry.

Definition at line 70 of file button.py.

Variable Documentation

BUTTON_DESCRIPTIONS

tuple homeassistant.components.guardian.button.BUTTON_DESCRIPTIONS

Initial value:

=  (
    ValveControllerButtonDescription(
        key=BUTTON_KIND_REBOOT,
        push_action=_async_reboot,
        device_class=ButtonDeviceClass.RESTART,
        # Buttons don't actually need a coordinator; we give them one so they can        # properly inherit from GuardianEntity:        api_category=API_SYSTEM_DIAGNOSTICS,    ),    ValveControllerButtonDescription(        key=BUTTON_KIND_RESET_VALVE_DIAGNOSTICS,        translation_key="reset_diagnostics",        push_action=_async_valve_reset,        # Buttons don't actually need a coordinator; we give them one so they can
        # properly inherit from GuardianEntity:
        api_category=API_SYSTEM_DIAGNOSTICS,
    ),
)

Definition at line 50 of file button.py.

BUTTON_KIND_REBOOT

string homeassistant.components.guardian.button.BUTTON_KIND_REBOOT = "reboot"

Definition at line 36 of file button.py.

BUTTON_KIND_RESET_VALVE_DIAGNOSTICS

string homeassistant.components.guardian.button.BUTTON_KIND_RESET_VALVE_DIAGNOSTICS = "reset_valve_diagnostics"

Definition at line 37 of file button.py.