Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.yeelight.scanner.YeelightScanner Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass)
 
ValuesView[CaseInsensitiveDict] async_discover (self)
 
YeelightScanner async_get (cls, HomeAssistant hass)
 
CaseInsensitiveDict|None async_get_capabilities (self, str host)
 
None async_scan (self, datetime|None _=None)
 
None async_setup (self)
 

Static Public Attributes

 None
 

Private Member Functions

set[IPv4Address] _async_build_source_set (self)
 
None _async_discovered_by_ssdp (self, CaseInsensitiveDict response)
 
None _async_process_entry (self, CaseInsensitiveDict headers)
 

Private Attributes

 _hass
 
 _scanner
 
 _setup_future
 
 _track_interval
 

Detailed Description

Scan for Yeelight devices.

Definition at line 44 of file scanner.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.yeelight.scanner.YeelightScanner.__init__ (   self,
HomeAssistant  hass 
)
Initialize class.

Definition at line 57 of file scanner.py.

Member Function Documentation

◆ _async_build_source_set()

set[IPv4Address] homeassistant.components.yeelight.scanner.YeelightScanner._async_build_source_set (   self)
private
Build the list of ssdp sources.

Definition at line 118 of file scanner.py.

◆ _async_discovered_by_ssdp()

None homeassistant.components.yeelight.scanner.YeelightScanner._async_discovered_by_ssdp (   self,
CaseInsensitiveDict  response 
)
private

Definition at line 167 of file scanner.py.

◆ _async_process_entry()

None homeassistant.components.yeelight.scanner.YeelightScanner._async_process_entry (   self,
CaseInsensitiveDict  headers 
)
private
Process a discovery.

Definition at line 189 of file scanner.py.

◆ async_discover()

ValuesView[CaseInsensitiveDict] homeassistant.components.yeelight.scanner.YeelightScanner.async_discover (   self)
Discover bulbs.

Definition at line 132 of file scanner.py.

◆ async_get()

YeelightScanner homeassistant.components.yeelight.scanner.YeelightScanner.async_get (   cls,
HomeAssistant  hass 
)
Get scanner instance.

Definition at line 51 of file scanner.py.

◆ async_get_capabilities()

CaseInsensitiveDict | None homeassistant.components.yeelight.scanner.YeelightScanner.async_get_capabilities (   self,
str  host 
)
Get capabilities via SSDP.

Definition at line 148 of file scanner.py.

◆ async_scan()

None homeassistant.components.yeelight.scanner.YeelightScanner.async_scan (   self,
datetime | None   _ = None 
)
Send discovery packets.

Definition at line 142 of file scanner.py.

◆ async_setup()

None homeassistant.components.yeelight.scanner.YeelightScanner.async_setup (   self)
Set up the scanner.

Definition at line 67 of file scanner.py.

Member Data Documentation

◆ _hass

homeassistant.components.yeelight.scanner.YeelightScanner._hass
private

Definition at line 59 of file scanner.py.

◆ _scanner

homeassistant.components.yeelight.scanner.YeelightScanner._scanner
private

Definition at line 54 of file scanner.py.

◆ _setup_future

homeassistant.components.yeelight.scanner.YeelightScanner._setup_future
private

Definition at line 73 of file scanner.py.

◆ _track_interval

homeassistant.components.yeelight.scanner.YeelightScanner._track_interval
private

Definition at line 112 of file scanner.py.

◆ None

homeassistant.components.yeelight.scanner.YeelightScanner.None
static

Definition at line 47 of file scanner.py.


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