Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.snmp.device_tracker.SnmpScanner Class Reference
Inheritance diagram for homeassistant.components.snmp.device_tracker.SnmpScanner:
[legend]
Collaboration diagram for homeassistant.components.snmp.device_tracker.SnmpScanner:
[legend]

Public Member Functions

def __init__ (self, config)
 
str|None async_get_device_name (self, str device)
 
def async_get_snmp_data (self)
 
None async_init (self, HomeAssistant hass)
 
def async_scan_devices (self)
 

Public Attributes

 baseoid
 
 last_results
 
 request_args
 
 success_init
 

Private Member Functions

def _async_update_info (self)
 

Private Attributes

 _auth_data
 
 _target
 

Detailed Description

Queries any SNMP capable Access Point for connected devices.

Definition at line 68 of file device_tracker.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.snmp.device_tracker.SnmpScanner.__init__ (   self,
  config 
)
Initialize the scanner and test the target device.

Definition at line 71 of file device_tracker.py.

Member Function Documentation

◆ _async_update_info()

def homeassistant.components.snmp.device_tracker.SnmpScanner._async_update_info (   self)
private
Ensure the information from the device is up to date.

Return boolean if scanning successful.

Definition at line 136 of file device_tracker.py.

◆ async_get_device_name()

str | None homeassistant.components.snmp.device_tracker.SnmpScanner.async_get_device_name (   self,
str  device 
)
Return the name of the given device or None if we don't know.

Definition at line 131 of file device_tracker.py.

◆ async_get_snmp_data()

def homeassistant.components.snmp.device_tracker.SnmpScanner.async_get_snmp_data (   self)
Fetch MAC addresses from access point via SNMP.

Definition at line 150 of file device_tracker.py.

◆ async_init()

None homeassistant.components.snmp.device_tracker.SnmpScanner.async_init (   self,
HomeAssistant  hass 
)
Make a one-off read to check if the target device is reachable and readable.

Definition at line 118 of file device_tracker.py.

◆ async_scan_devices()

def homeassistant.components.snmp.device_tracker.SnmpScanner.async_scan_devices (   self)
Scan for new devices and return a list with found device IDs.

Definition at line 126 of file device_tracker.py.

Member Data Documentation

◆ _auth_data

homeassistant.components.snmp.device_tracker.SnmpScanner._auth_data
private

Definition at line 100 of file device_tracker.py.

◆ _target

homeassistant.components.snmp.device_tracker.SnmpScanner._target
private

Definition at line 112 of file device_tracker.py.

◆ baseoid

homeassistant.components.snmp.device_tracker.SnmpScanner.baseoid

Definition at line 114 of file device_tracker.py.

◆ last_results

homeassistant.components.snmp.device_tracker.SnmpScanner.last_results

Definition at line 115 of file device_tracker.py.

◆ request_args

homeassistant.components.snmp.device_tracker.SnmpScanner.request_args

Definition at line 120 of file device_tracker.py.

◆ success_init

homeassistant.components.snmp.device_tracker.SnmpScanner.success_init

Definition at line 116 of file device_tracker.py.


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