Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.broadlink.device.BroadlinkDevice Class Reference
Inheritance diagram for homeassistant.components.broadlink.device.BroadlinkDevice:
[legend]
Collaboration diagram for homeassistant.components.broadlink.device.BroadlinkDevice:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, ConfigEntry config)
 
bool async_auth (self)
 
def async_request (self, function, *args, **kwargs)
 
bool async_setup (self)
 
bool async_unload (self)
 
bool|None available (self)
 
str mac_address (self)
 
str name (self)
 
str|None unique_id (self)
 

Static Public Member Functions

None async_update (HomeAssistant hass, ConfigEntry entry)
 

Public Attributes

 api
 
 authorized
 
 config
 
 fw_version
 
 hass
 
 update_manager
 

Private Member Functions

None _async_handle_auth_error (self)
 
int|None _get_firmware_version (self)
 

Detailed Description

Manages a Broadlink device.

Definition at line 44 of file device.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.broadlink.device.BroadlinkDevice.__init__ (   self,
HomeAssistant  hass,
ConfigEntry  config 
)
Initialize the device.

Definition at line 49 of file device.py.

Member Function Documentation

◆ _async_handle_auth_error()

None homeassistant.components.broadlink.device.BroadlinkDevice._async_handle_auth_error (   self)
private
Handle an authentication error.

Definition at line 185 of file device.py.

◆ _get_firmware_version()

int | None homeassistant.components.broadlink.device.BroadlinkDevice._get_firmware_version (   self)
private
Get firmware version.

Definition at line 95 of file device.py.

◆ async_auth()

bool homeassistant.components.broadlink.device.BroadlinkDevice.async_auth (   self)
Authenticate to the device.

Definition at line 162 of file device.py.

◆ async_request()

def homeassistant.components.broadlink.device.BroadlinkDevice.async_request (   self,
  function,
args,
**  kwargs 
)
Send a request to the device.

Definition at line 175 of file device.py.

◆ async_setup()

bool homeassistant.components.broadlink.device.BroadlinkDevice.async_setup (   self)
Set up the device and related entities.

Definition at line 102 of file device.py.

◆ async_unload()

bool homeassistant.components.broadlink.device.BroadlinkDevice.async_unload (   self)
Unload the device and related entities.

Definition at line 150 of file device.py.

◆ async_update()

None homeassistant.components.broadlink.device.BroadlinkDevice.async_update ( HomeAssistant  hass,
ConfigEntry  entry 
)
static
Update the device and related entities.

Triggered when the device is renamed on the frontend.

Definition at line 81 of file device.py.

◆ available()

bool | None homeassistant.components.broadlink.device.BroadlinkDevice.available (   self)
Return True if the device is available.

Definition at line 74 of file device.py.

◆ mac_address()

str homeassistant.components.broadlink.device.BroadlinkDevice.mac_address (   self)
Return the mac address of the device.

Definition at line 69 of file device.py.

◆ name()

str homeassistant.components.broadlink.device.BroadlinkDevice.name (   self)
Return the name of the device.

Definition at line 59 of file device.py.

◆ unique_id()

str | None homeassistant.components.broadlink.device.BroadlinkDevice.unique_id (   self)
Return the unique id of the device.

Definition at line 64 of file device.py.

Member Data Documentation

◆ api

homeassistant.components.broadlink.device.BroadlinkDevice.api

Definition at line 113 of file device.py.

◆ authorized

homeassistant.components.broadlink.device.BroadlinkDevice.authorized

Definition at line 133 of file device.py.

◆ config

homeassistant.components.broadlink.device.BroadlinkDevice.config

Definition at line 52 of file device.py.

◆ fw_version

homeassistant.components.broadlink.device.BroadlinkDevice.fw_version

Definition at line 116 of file device.py.

◆ hass

homeassistant.components.broadlink.device.BroadlinkDevice.hass

Definition at line 51 of file device.py.

◆ update_manager

homeassistant.components.broadlink.device.BroadlinkDevice.update_manager

Definition at line 139 of file device.py.


The documentation for this class was generated from the following file: