Allow separate command and state OIDs and payloads in SNMP switch (#11075)

* Allow separate command and state OIDs and payloads in SNMP switch

Follow PEP8 style properly

More PEP8 style fixes

Fully PEP8 compliant

* Fix pylint errors

* Remove comment to satisfy pylint

* Style changes/refactoring
This commit is contained in:
Nash Kaminski 2018-01-26 00:48:21 -06:00 committed by Paulus Schoutsen
parent 9a71717047
commit 748fff7ebc

View File

@ -18,6 +18,9 @@ REQUIREMENTS = ['pysnmp==4.4.4']
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
CONF_BASEOID = 'baseoid' CONF_BASEOID = 'baseoid'
CONF_COMMAND_OID = 'command_oid'
CONF_COMMAND_PAYLOAD_ON = 'command_payload_on'
CONF_COMMAND_PAYLOAD_OFF = 'command_payload_off'
CONF_COMMUNITY = 'community' CONF_COMMUNITY = 'community'
CONF_VERSION = 'version' CONF_VERSION = 'version'
@ -36,6 +39,9 @@ SNMP_VERSIONS = {
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Required(CONF_BASEOID): cv.string, vol.Required(CONF_BASEOID): cv.string,
vol.Optional(CONF_COMMAND_OID): cv.string,
vol.Optional(CONF_COMMAND_PAYLOAD_ON): cv.string,
vol.Optional(CONF_COMMAND_PAYLOAD_OFF): cv.string,
vol.Optional(CONF_COMMUNITY, default=DEFAULT_COMMUNITY): cv.string, vol.Optional(CONF_COMMUNITY, default=DEFAULT_COMMUNITY): cv.string,
vol.Optional(CONF_HOST, default=DEFAULT_HOST): cv.string, vol.Optional(CONF_HOST, default=DEFAULT_HOST): cv.string,
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string, vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
@ -53,26 +59,37 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
port = config.get(CONF_PORT) port = config.get(CONF_PORT)
community = config.get(CONF_COMMUNITY) community = config.get(CONF_COMMUNITY)
baseoid = config.get(CONF_BASEOID) baseoid = config.get(CONF_BASEOID)
command_oid = config.get(CONF_COMMAND_OID)
command_payload_on = config.get(CONF_COMMAND_PAYLOAD_ON)
command_payload_off = config.get(CONF_COMMAND_PAYLOAD_OFF)
version = config.get(CONF_VERSION) version = config.get(CONF_VERSION)
payload_on = config.get(CONF_PAYLOAD_ON) payload_on = config.get(CONF_PAYLOAD_ON)
payload_off = config.get(CONF_PAYLOAD_OFF) payload_off = config.get(CONF_PAYLOAD_OFF)
add_devices( add_devices(
[SnmpSwitch(name, host, port, community, baseoid, version, payload_on, [SnmpSwitch(name, host, port, community, baseoid, command_oid, version,
payload_off)], True) payload_on, payload_off,
command_payload_on, command_payload_off)], True)
class SnmpSwitch(SwitchDevice): class SnmpSwitch(SwitchDevice):
"""Represents a SNMP switch.""" """Represents a SNMP switch."""
def __init__(self, name, host, port, community, def __init__(self, name, host, port, community,
baseoid, version, payload_on, payload_off): baseoid, commandoid, version, payload_on, payload_off,
command_payload_on, command_payload_off):
"""Initialize the switch.""" """Initialize the switch."""
self._name = name self._name = name
self._host = host self._host = host
self._port = port self._port = port
self._community = community self._community = community
self._baseoid = baseoid self._baseoid = baseoid
"""Set the command OID to the base OID if command OID is unset"""
self._commandoid = commandoid or baseoid
self._command_payload_on = command_payload_on or payload_on
self._command_payload_off = command_payload_off or payload_off
self._version = SNMP_VERSIONS[version] self._version = SNMP_VERSIONS[version]
self._state = None self._state = None
self._payload_on = payload_on self._payload_on = payload_on
@ -82,13 +99,13 @@ class SnmpSwitch(SwitchDevice):
"""Turn on the switch.""" """Turn on the switch."""
from pyasn1.type.univ import (Integer) from pyasn1.type.univ import (Integer)
self._set(Integer(self._payload_on)) self._set(Integer(self._command_payload_on))
def turn_off(self): def turn_off(self):
"""Turn off the switch.""" """Turn off the switch."""
from pyasn1.type.univ import (Integer) from pyasn1.type.univ import (Integer)
self._set(Integer(self._payload_off)) self._set(Integer(self._command_payload_off))
def update(self): def update(self):
"""Update the state.""" """Update the state."""
@ -142,7 +159,7 @@ class SnmpSwitch(SwitchDevice):
CommunityData(self._community, mpModel=self._version), CommunityData(self._community, mpModel=self._version),
UdpTransportTarget((self._host, self._port)), UdpTransportTarget((self._host, self._port)),
ContextData(), ContextData(),
ObjectType(ObjectIdentity(self._baseoid), value) ObjectType(ObjectIdentity(self._commandoid), value)
) )
next(request) next(request)