homeassistant.components.snmp.sensor Namespace Reference

Classes
class	SnmpData
class	SnmpSensor

Functions
None	async_setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback async_add_entities, DiscoveryInfoType|None discovery_info=None)

Variables
	_LOGGER = logging.getLogger(__name__)
	PLATFORM_SCHEMA
	SCAN_INTERVAL = timedelta(seconds=10)
tuple	TRIGGER_ENTITY_OPTIONS

Detailed Description

Support for displaying collected data over SNMP.

Function Documentation

async_setup_platform()

None homeassistant.components.snmp.sensor.async_setup_platform	(	HomeAssistant	hass,
		ConfigType	config,
		AddEntitiesCallback	async_add_entities,
		DiscoveryInfoType | None	discovery_info = None
	)

Set up the SNMP sensor.

Definition at line 112 of file sensor.py.

Variable Documentation

_LOGGER

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

private

Definition at line 75 of file sensor.py.

PLATFORM_SCHEMA

homeassistant.components.snmp.sensor.PLATFORM_SCHEMA

Initial value:

=  SENSOR_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_BASEOID): cv.string,
        vol.Optional(CONF_ACCEPT_ERRORS, default=False): cv.boolean,
        vol.Optional(CONF_COMMUNITY, default=DEFAULT_COMMUNITY): cv.string,
        vol.Optional(CONF_DEFAULT_VALUE): cv.string,
        vol.Optional(CONF_HOST, default=DEFAULT_HOST): cv.string,
        vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
        vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
        vol.Optional(CONF_VERSION, default=DEFAULT_VERSION): vol.In(SNMP_VERSIONS),
        vol.Optional(CONF_USERNAME): cv.string,
        vol.Optional(CONF_AUTH_KEY): cv.string,
        vol.Optional(CONF_AUTH_PROTOCOL, default=DEFAULT_AUTH_PROTOCOL): vol.In(
            MAP_AUTH_PROTOCOLS
        ),
        vol.Optional(CONF_PRIV_KEY): cv.string,
        vol.Optional(CONF_PRIV_PROTOCOL, default=DEFAULT_PRIV_PROTOCOL): vol.In(
            MAP_PRIV_PROTOCOLS
        ),
    }
).extend(TEMPLATE_SENSOR_BASE_SCHEMA.schema)

Definition at line 89 of file sensor.py.

SCAN_INTERVAL

homeassistant.components.snmp.sensor.SCAN_INTERVAL = timedelta(seconds=10)

Definition at line 77 of file sensor.py.

TRIGGER_ENTITY_OPTIONS

tuple homeassistant.components.snmp.sensor.TRIGGER_ENTITY_OPTIONS

Initial value:

=  (
    CONF_AVAILABILITY,
    CONF_DEVICE_CLASS,
    CONF_ICON,
    CONF_PICTURE,
    CONF_UNIQUE_ID,
    CONF_STATE_CLASS,
    CONF_UNIT_OF_MEASUREMENT,
)

Definition at line 79 of file sensor.py.