homeassistant.components.opnsense.device_tracker.OPNSenseDeviceScanner Class Reference

Inheritance diagram for homeassistant.components.opnsense.device_tracker.OPNSenseDeviceScanner:

Collaboration diagram for homeassistant.components.opnsense.device_tracker.OPNSenseDeviceScanner:

Public Member Functions
def	__init__ (self, client, interfaces)
def	get_device_name (self, device)
def	get_extra_attributes (self, device)
def	scan_devices (self)
def	update_info (self)

Public Attributes
	client
	interfaces
	last_results

Private Member Functions
def	_get_mac_addrs (self, devices)

Detailed Description

Class which queries a router running OPNsense.

Definition at line 22 of file device_tracker.py.

Constructor & Destructor Documentation

__init__()

def homeassistant.components.opnsense.device_tracker.OPNSenseDeviceScanner.__init__	(		self,
			client,
			interfaces
	)

Initialize the scanner.

Definition at line 25 of file device_tracker.py.

Member Function Documentation

_get_mac_addrs()

def homeassistant.components.opnsense.device_tracker.OPNSenseDeviceScanner._get_mac_addrs (   self,   devices  )

private

Create dict with mac address keys from list of devices.

Definition at line 31 of file device_tracker.py.

get_device_name()

def homeassistant.components.opnsense.device_tracker.OPNSenseDeviceScanner.get_device_name	(		self,
			device
	)

Return the name of the given device or None if we don't know.

Definition at line 44 of file device_tracker.py.

get_extra_attributes()

def homeassistant.components.opnsense.device_tracker.OPNSenseDeviceScanner.get_extra_attributes	(		self,
			device
	)

Return the extra attrs of the given device.

Definition at line 59 of file device_tracker.py.

scan_devices()

def homeassistant.components.opnsense.device_tracker.OPNSenseDeviceScanner.scan_devices

(

self

)

Scan for new devices and return a list with found device IDs.

Definition at line 39 of file device_tracker.py.

update_info()

def homeassistant.components.opnsense.device_tracker.OPNSenseDeviceScanner.update_info

(

self

)

Ensure the information from the OPNSense router is up to date.

Return boolean if scanning successful.

Definition at line 50 of file device_tracker.py.

Member Data Documentation

client

homeassistant.components.opnsense.device_tracker.OPNSenseDeviceScanner.client

Definition at line 28 of file device_tracker.py.

interfaces

homeassistant.components.opnsense.device_tracker.OPNSenseDeviceScanner.interfaces

Definition at line 29 of file device_tracker.py.

last_results

homeassistant.components.opnsense.device_tracker.OPNSenseDeviceScanner.last_results

Definition at line 27 of file device_tracker.py.

---

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

• core/homeassistant/components/opnsense/device_tracker.py