homeassistant.components.snmp.util Namespace Reference

Functions
SnmpEngine	_get_snmp_engine ()
CommandArgsType	async_create_command_cmd_args (HomeAssistant hass, UsmUserData|CommunityData auth_data, UdpTransportTarget|Udp6TransportTarget target)
RequestArgsType	async_create_request_cmd_args (HomeAssistant hass, UsmUserData|CommunityData auth_data, UdpTransportTarget|Udp6TransportTarget target, str object_id)
SnmpEngine	async_get_snmp_engine (HomeAssistant hass)

Variables
	_LOGGER = logging.getLogger(__name__)
	CommandArgsType
string	DATA_SNMP_ENGINE = "snmp_engine"
	RequestArgsType

Detailed Description

Support for displaying collected data over SNMP.

Function Documentation

_get_snmp_engine()

SnmpEngine homeassistant.components.snmp.util._get_snmp_engine ( )

private

Return a cached instance of SnmpEngine.

Definition at line 89 of file util.py.

async_create_command_cmd_args()

CommandArgsType homeassistant.components.snmp.util.async_create_command_cmd_args	(	HomeAssistant	hass,
		UsmUserData | CommunityData	auth_data,
		UdpTransportTarget | Udp6TransportTarget	target
	)

Create command arguments.

The ObjectType needs to be created dynamically by the caller.

Definition at line 45 of file util.py.

async_create_request_cmd_args()

RequestArgsType homeassistant.components.snmp.util.async_create_request_cmd_args	(	HomeAssistant	hass,
		UsmUserData | CommunityData	auth_data,
		UdpTransportTarget | Udp6TransportTarget	target,
		str	object_id
	)

Create request arguments.

The same ObjectType is used for all requests.

Definition at line 58 of file util.py.

async_get_snmp_engine()

SnmpEngine homeassistant.components.snmp.util.async_get_snmp_engine

(

HomeAssistant

hass

)

Get the SNMP engine.

Definition at line 76 of file util.py.

Variable Documentation

_LOGGER

homeassistant.components.snmp.util._LOGGER = logging.getLogger(__name__)

private

Definition at line 26 of file util.py.

CommandArgsType

homeassistant.components.snmp.util.CommandArgsType

Definition at line 28 of file util.py.

DATA_SNMP_ENGINE

string homeassistant.components.snmp.util.DATA_SNMP_ENGINE = "snmp_engine"

Definition at line 24 of file util.py.

RequestArgsType

homeassistant.components.snmp.util.RequestArgsType

Definition at line 36 of file util.py.