homeassistant.components.usb.USBDiscovery Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass, list[USBMatcher] usb)
CALLBACK_TYPE	async_register_initial_scan_callback (self, CALLBACK_TYPE callback)
CALLBACK_TYPE	async_register_scan_request_callback (self, CALLBACK_TYPE _callback)
None	async_request_scan (self)
None	async_setup (self)
None	async_start (self, Event event)
None	async_stop (self, Event event)

Public Attributes
	hass
	initial_scan_done
	observer_active
	usb

Private Member Functions
None	_async_process_discovered_usb_device (self, USBDevice device)
None	_async_process_ports (self, list[ListPortInfo] ports)
None	_async_scan (self)
None	_async_scan_serial (self)
None	_async_start_monitor (self)
None	_device_discovered (self, Device device)
MonitorObserver|None	_get_monitor_observer (self)

Private Attributes
	_request_debouncer

Detailed Description

Manage USB Discovery.

Definition at line 189 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.usb.USBDiscovery.__init__	(		self,
		HomeAssistant	hass,
		list[USBMatcher]	usb
	)

Init USB Discovery.

Definition at line 192 of file __init__.py.

Member Function Documentation

_async_process_discovered_usb_device()

None homeassistant.components.usb.USBDiscovery._async_process_discovered_usb_device (   self, USBDevice  device  )

private

Process a USB discovery.

Definition at line 321 of file __init__.py.

_async_process_ports()

None homeassistant.components.usb.USBDiscovery._async_process_ports (   self, list[ListPortInfo]  ports  )

private

Process each discovered port.

Definition at line 363 of file __init__.py.

_async_scan()

None homeassistant.components.usb.USBDiscovery._async_scan (   self )

private

Scan for USB devices and notify callbacks to scan as well.

Definition at line 405 of file __init__.py.

_async_scan_serial()

None homeassistant.components.usb.USBDiscovery._async_scan_serial (   self )

private

Scan serial ports.

Definition at line 393 of file __init__.py.

_async_start_monitor()

None homeassistant.components.usb.USBDiscovery._async_start_monitor (   self )

private

Start monitoring hardware with pyudev.

Definition at line 223 of file __init__.py.

_device_discovered()

None homeassistant.components.usb.USBDiscovery._device_discovered (   self, Device  device  )

private

Call when the observer discovers a new usb tty device.

Definition at line 277 of file __init__.py.

_get_monitor_observer()

MonitorObserver | None homeassistant.components.usb.USBDiscovery._get_monitor_observer (   self )

private

Get the monitor observer.

This runs in the executor because the import
does blocking I/O.

Definition at line 244 of file __init__.py.

async_register_initial_scan_callback()

CALLBACK_TYPE homeassistant.components.usb.USBDiscovery.async_register_initial_scan_callback	(		self,
		CALLBACK_TYPE	callback
	)

Register an initial scan callback.

Definition at line 302 of file __init__.py.

async_register_scan_request_callback()

CALLBACK_TYPE homeassistant.components.usb.USBDiscovery.async_register_scan_request_callback	(		self,
		CALLBACK_TYPE	_callback
	)

Register a scan request callback.

Definition at line 288 of file __init__.py.

async_request_scan()

None homeassistant.components.usb.USBDiscovery.async_request_scan

(

self

)

Request a serial scan.

Definition at line 411 of file __init__.py.

async_setup()

None homeassistant.components.usb.USBDiscovery.async_setup

(

self

)

Set up USB Discovery.

Definition at line 207 of file __init__.py.

async_start()

None homeassistant.components.usb.USBDiscovery.async_start	(		self,
		Event	event
	)

Start USB Discovery and run a manual scan.

Definition at line 213 of file __init__.py.

async_stop()

None homeassistant.components.usb.USBDiscovery.async_stop	(		self,
		Event	event
	)

Stop USB Discovery.

Definition at line 218 of file __init__.py.

Member Data Documentation

_request_debouncer

homeassistant.components.usb.USBDiscovery._request_debouncer

private

Definition at line 414 of file __init__.py.

hass

homeassistant.components.usb.USBDiscovery.hass

Definition at line 198 of file __init__.py.

initial_scan_done

homeassistant.components.usb.USBDiscovery.initial_scan_done

Definition at line 204 of file __init__.py.

observer_active

homeassistant.components.usb.USBDiscovery.observer_active

Definition at line 201 of file __init__.py.

usb

homeassistant.components.usb.USBDiscovery.usb

Definition at line 199 of file __init__.py.

---

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

• core/homeassistant/components/usb/__init__.py