mirror of
https://github.com/home-assistant/core.git
synced 2025-07-23 21:27:38 +00:00
Added continue-on-errors, added value template (#8971)
* Added continue-on-errors, added value template * Refactored long lines * Fixed whitespace issues
This commit is contained in:
parent
e2920ce5e5
commit
5309006494
@ -13,7 +13,8 @@ import homeassistant.helpers.config_validation as cv
|
|||||||
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
||||||
from homeassistant.helpers.entity import Entity
|
from homeassistant.helpers.entity import Entity
|
||||||
from homeassistant.const import (
|
from homeassistant.const import (
|
||||||
CONF_HOST, CONF_NAME, CONF_PORT, CONF_UNIT_OF_MEASUREMENT)
|
CONF_HOST, CONF_NAME, CONF_PORT, CONF_UNIT_OF_MEASUREMENT, STATE_UNKNOWN,
|
||||||
|
CONF_VALUE_TEMPLATE)
|
||||||
|
|
||||||
REQUIREMENTS = ['pysnmp==4.3.9']
|
REQUIREMENTS = ['pysnmp==4.3.9']
|
||||||
|
|
||||||
@ -22,6 +23,8 @@ _LOGGER = logging.getLogger(__name__)
|
|||||||
CONF_BASEOID = 'baseoid'
|
CONF_BASEOID = 'baseoid'
|
||||||
CONF_COMMUNITY = 'community'
|
CONF_COMMUNITY = 'community'
|
||||||
CONF_VERSION = 'version'
|
CONF_VERSION = 'version'
|
||||||
|
CONF_ACCEPT_ERRORS = 'accept_errors'
|
||||||
|
CONF_DEFAULT_VALUE = 'default_value'
|
||||||
|
|
||||||
DEFAULT_COMMUNITY = 'public'
|
DEFAULT_COMMUNITY = 'public'
|
||||||
DEFAULT_HOST = 'localhost'
|
DEFAULT_HOST = 'localhost'
|
||||||
@ -45,6 +48,9 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|||||||
vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
|
vol.Optional(CONF_UNIT_OF_MEASUREMENT): cv.string,
|
||||||
vol.Optional(CONF_VERSION, default=DEFAULT_VERSION):
|
vol.Optional(CONF_VERSION, default=DEFAULT_VERSION):
|
||||||
vol.In(SNMP_VERSIONS),
|
vol.In(SNMP_VERSIONS),
|
||||||
|
vol.Optional(CONF_ACCEPT_ERRORS, default=False): cv.boolean,
|
||||||
|
vol.Optional(CONF_DEFAULT_VALUE): cv.string,
|
||||||
|
vol.Optional(CONF_VALUE_TEMPLATE): cv.template
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|
||||||
@ -61,6 +67,12 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
|
|||||||
baseoid = config.get(CONF_BASEOID)
|
baseoid = config.get(CONF_BASEOID)
|
||||||
unit = config.get(CONF_UNIT_OF_MEASUREMENT)
|
unit = config.get(CONF_UNIT_OF_MEASUREMENT)
|
||||||
version = config.get(CONF_VERSION)
|
version = config.get(CONF_VERSION)
|
||||||
|
accept_errors = config.get(CONF_ACCEPT_ERRORS)
|
||||||
|
default_value = config.get(CONF_DEFAULT_VALUE)
|
||||||
|
value_template = config.get(CONF_VALUE_TEMPLATE)
|
||||||
|
|
||||||
|
if value_template is not None:
|
||||||
|
value_template.hass = hass
|
||||||
|
|
||||||
errindication, _, _, _ = next(
|
errindication, _, _, _ = next(
|
||||||
getCmd(SnmpEngine(),
|
getCmd(SnmpEngine(),
|
||||||
@ -69,23 +81,27 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
|
|||||||
ContextData(),
|
ContextData(),
|
||||||
ObjectType(ObjectIdentity(baseoid))))
|
ObjectType(ObjectIdentity(baseoid))))
|
||||||
|
|
||||||
if errindication:
|
if errindication and not accept_errors:
|
||||||
_LOGGER.error("Please check the details in the configuration file")
|
_LOGGER.error("Please check the details in the configuration file")
|
||||||
return False
|
return False
|
||||||
else:
|
else:
|
||||||
data = SnmpData(host, port, community, baseoid, version)
|
data = SnmpData(
|
||||||
add_devices([SnmpSensor(data, name, unit)], True)
|
host, port, community, baseoid, version, accept_errors,
|
||||||
|
default_value)
|
||||||
|
add_devices([SnmpSensor(data, name, unit, value_template)], True)
|
||||||
|
|
||||||
|
|
||||||
class SnmpSensor(Entity):
|
class SnmpSensor(Entity):
|
||||||
"""Representation of a SNMP sensor."""
|
"""Representation of a SNMP sensor."""
|
||||||
|
|
||||||
def __init__(self, data, name, unit_of_measurement):
|
def __init__(self, data, name, unit_of_measurement,
|
||||||
|
value_template):
|
||||||
"""Initialize the sensor."""
|
"""Initialize the sensor."""
|
||||||
self.data = data
|
self.data = data
|
||||||
self._name = name
|
self._name = name
|
||||||
self._state = None
|
self._state = None
|
||||||
self._unit_of_measurement = unit_of_measurement
|
self._unit_of_measurement = unit_of_measurement
|
||||||
|
self._value_template = value_template
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def name(self):
|
def name(self):
|
||||||
@ -105,19 +121,30 @@ class SnmpSensor(Entity):
|
|||||||
def update(self):
|
def update(self):
|
||||||
"""Get the latest data and updates the states."""
|
"""Get the latest data and updates the states."""
|
||||||
self.data.update()
|
self.data.update()
|
||||||
self._state = self.data.value
|
value = self.data.value
|
||||||
|
|
||||||
|
if value is None:
|
||||||
|
value = STATE_UNKNOWN
|
||||||
|
elif self._value_template is not None:
|
||||||
|
value = self._value_template.render_with_possible_json_value(
|
||||||
|
value, STATE_UNKNOWN)
|
||||||
|
|
||||||
|
self._state = value
|
||||||
|
|
||||||
|
|
||||||
class SnmpData(object):
|
class SnmpData(object):
|
||||||
"""Get the latest data and update the states."""
|
"""Get the latest data and update the states."""
|
||||||
|
|
||||||
def __init__(self, host, port, community, baseoid, version):
|
def __init__(self, host, port, community, baseoid, version, accept_errors,
|
||||||
|
default_value):
|
||||||
"""Initialize the data object."""
|
"""Initialize the data object."""
|
||||||
self._host = host
|
self._host = host
|
||||||
self._port = port
|
self._port = port
|
||||||
self._community = community
|
self._community = community
|
||||||
self._baseoid = baseoid
|
self._baseoid = baseoid
|
||||||
self._version = SNMP_VERSIONS[version]
|
self._version = SNMP_VERSIONS[version]
|
||||||
|
self._accept_errors = accept_errors
|
||||||
|
self._default_value = default_value
|
||||||
self.value = None
|
self.value = None
|
||||||
|
|
||||||
def update(self):
|
def update(self):
|
||||||
@ -133,11 +160,13 @@ class SnmpData(object):
|
|||||||
ObjectType(ObjectIdentity(self._baseoid)))
|
ObjectType(ObjectIdentity(self._baseoid)))
|
||||||
)
|
)
|
||||||
|
|
||||||
if errindication:
|
if errindication and not self._accept_errors:
|
||||||
_LOGGER.error("SNMP error: %s", errindication)
|
_LOGGER.error("SNMP error: %s", errindication)
|
||||||
elif errstatus:
|
elif errstatus and not self._accept_errors:
|
||||||
_LOGGER.error("SNMP error: %s at %s", errstatus.prettyPrint(),
|
_LOGGER.error("SNMP error: %s at %s", errstatus.prettyPrint(),
|
||||||
errindex and restable[-1][int(errindex) - 1] or '?')
|
errindex and restable[-1][int(errindex) - 1] or '?')
|
||||||
|
elif (errindication or errstatus) and self._accept_errors:
|
||||||
|
self.value = self._default_value
|
||||||
else:
|
else:
|
||||||
for resrow in restable:
|
for resrow in restable:
|
||||||
self.value = resrow[-1]
|
self.value = str(resrow[-1])
|
||||||
|
Loading…
x
Reference in New Issue
Block a user