homeassistant.components.nmap_tracker.NmapDeviceScanner Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass, ConfigEntry entry, NmapTrackedDevices devices)
def	async_setup (self)
str	signal_device_missing (self)
str	signal_device_new (self)

Public Attributes
	consider_home
	devices
	home_interval

Private Member Functions
None	_async_device_offline (self, str ipv4, str reason, datetime now)
def	_async_mark_missing_devices_as_not_home (self)
def	_async_run_nmap_scan (self)
def	_async_scan_devices (self, *_)
def	_async_start_scanner (self, *_)
def	_async_stop (self)
def	_build_options (self)
def	_run_nmap_scan (self)

Private Attributes
	_entry
	_entry_id
	_exclude
	_finished_first_scan
	_hass
	_hosts
	_known_mac_addresses
	_last_results
	_options
	_scan_interval
	_scan_lock
	_scanner
	_stopping

Detailed Description

Scanner for devices using nmap.

Definition at line 133 of file __init__.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.nmap_tracker.NmapDeviceScanner.__init__	(		self,
		HomeAssistant	hass,
		ConfigEntry	entry,
		NmapTrackedDevices	devices
	)

Initialize the scanner.

Definition at line 136 of file __init__.py.

Member Function Documentation

_async_device_offline()

None homeassistant.components.nmap_tracker.NmapDeviceScanner._async_device_offline (   self, str  ipv4, str  reason, datetime  now  )

private

Mark an IP offline.

Definition at line 321 of file __init__.py.

_async_mark_missing_devices_as_not_home()

def homeassistant.components.nmap_tracker.NmapDeviceScanner._async_mark_missing_devices_as_not_home (   self )

private

Definition at line 271 of file __init__.py.

_async_run_nmap_scan()

def homeassistant.components.nmap_tracker.NmapDeviceScanner._async_run_nmap_scan (   self )

private

Scan the network for devices and dispatch events.

Definition at line 360 of file __init__.py.

_async_scan_devices()

def homeassistant.components.nmap_tracker.NmapDeviceScanner._async_scan_devices (   self, *  _  )

private

Scan devices and dispatch.

Definition at line 252 of file __init__.py.

_async_start_scanner()

def homeassistant.components.nmap_tracker.NmapDeviceScanner._async_start_scanner (   self, *  _  )

private

Start the scanner.

Definition at line 212 of file __init__.py.

_async_stop()

def homeassistant.components.nmap_tracker.NmapDeviceScanner._async_stop (   self )

private

Stop the scanner.

Definition at line 208 of file __init__.py.

_build_options()

def homeassistant.components.nmap_tracker.NmapDeviceScanner._build_options (   self )

private

Build the command line and strip out last results that do not need to be updated.

Definition at line 226 of file __init__.py.

_run_nmap_scan()

def homeassistant.components.nmap_tracker.NmapDeviceScanner._run_nmap_scan (   self )

private

Run nmap and return the result.

Definition at line 292 of file __init__.py.

async_setup()

def homeassistant.components.nmap_tracker.NmapDeviceScanner.async_setup

(

self

)

Set up the tracker.

Definition at line 161 of file __init__.py.

signal_device_missing()

str homeassistant.components.nmap_tracker.NmapDeviceScanner.signal_device_missing

(

self

)

Signal specific per nmap tracker entry to signal a missing device.

Definition at line 203 of file __init__.py.

signal_device_new()

str homeassistant.components.nmap_tracker.NmapDeviceScanner.signal_device_new

(

self

)

Signal specific per nmap tracker entry to signal new device.

Definition at line 198 of file __init__.py.

Member Data Documentation

_entry

homeassistant.components.nmap_tracker.NmapDeviceScanner._entry

private

Definition at line 145 of file __init__.py.

_entry_id

homeassistant.components.nmap_tracker.NmapDeviceScanner._entry_id

private

Definition at line 151 of file __init__.py.

_exclude

homeassistant.components.nmap_tracker.NmapDeviceScanner._exclude

private

Definition at line 154 of file __init__.py.

_finished_first_scan

homeassistant.components.nmap_tracker.NmapDeviceScanner._finished_first_scan

private

Definition at line 158 of file __init__.py.

_hass

homeassistant.components.nmap_tracker.NmapDeviceScanner._hass

private

Definition at line 144 of file __init__.py.

_hosts

homeassistant.components.nmap_tracker.NmapDeviceScanner._hosts

private

Definition at line 152 of file __init__.py.

_known_mac_addresses

homeassistant.components.nmap_tracker.NmapDeviceScanner._known_mac_addresses

private

Definition at line 190 of file __init__.py.

_last_results

homeassistant.components.nmap_tracker.NmapDeviceScanner._last_results

private

Definition at line 249 of file __init__.py.

_options

homeassistant.components.nmap_tracker.NmapDeviceScanner._options

private

Definition at line 153 of file __init__.py.

_scan_interval

homeassistant.components.nmap_tracker.NmapDeviceScanner._scan_interval

private

Definition at line 155 of file __init__.py.

_scan_lock

homeassistant.components.nmap_tracker.NmapDeviceScanner._scan_lock

private

Definition at line 147 of file __init__.py.

_scanner

homeassistant.components.nmap_tracker.NmapDeviceScanner._scanner

private

Definition at line 149 of file __init__.py.

_stopping

homeassistant.components.nmap_tracker.NmapDeviceScanner._stopping

private

Definition at line 148 of file __init__.py.

consider_home

homeassistant.components.nmap_tracker.NmapDeviceScanner.consider_home

Definition at line 142 of file __init__.py.

devices

homeassistant.components.nmap_tracker.NmapDeviceScanner.devices

Definition at line 140 of file __init__.py.

home_interval

homeassistant.components.nmap_tracker.NmapDeviceScanner.home_interval

Definition at line 141 of file __init__.py.

---

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

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