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

nkaminski · 2017-12-11T03:20:57Z

Description:

It is evident that some switch devices, such as the PDU/CDU units made by Server Technology, use different OIDs and payloads for reading vs. writing the on/off state of power outlets. Therefore, I have expanded the SNMP switch component in a fully backwards-compatible manner to allow for these devices which use separate command and state OIDs and variable mappings to be used with HA.

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#4190

Example entry for `configuration.yaml` (if applicable):

switch:
  - platform: snmp
    name: Server Technology PDU Outlet 16
    host: 192.168.1.1
    community: private
    version: 2c
    baseoid: .1.3.6.1.4.1.1718.3.2.3.1.10.1.1.16
    command_oid: .1.3.6.1.4.1.1718.3.2.3.1.11.1.1.16
    payload_on: 5
    payload_off: 4
    command_payload_on: 1
    command_payload_off: 2

Checklist:

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

homeassistant · 2017-12-11T03:20:58Z

Hi @nkaminski,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

houndci-bot · 2017-12-11T03:21:03Z

homeassistant/components/switch/snmp.py

-        [SnmpSwitch(name, host, port, community, baseoid, version, payload_on,
-                    payload_off)], True)
+        [SnmpSwitch(name, host, port, community, baseoid, command_oid, version, payload_on,
+                    payload_off, command_payload_on, command_payload_off)], True)


line too long (81 > 79 characters)

houndci-bot · 2017-12-11T03:21:03Z

homeassistant/components/switch/snmp.py

    version = config.get(CONF_VERSION)
    payload_on = config.get(CONF_PAYLOAD_ON)
    payload_off = config.get(CONF_PAYLOAD_OFF)

    add_devices(
-        [SnmpSwitch(name, host, port, community, baseoid, version, payload_on,
-                    payload_off)], True)
+        [SnmpSwitch(name, host, port, community, baseoid, command_oid, version, payload_on,


line too long (91 > 79 characters)

houndci-bot · 2017-12-11T03:21:03Z

homeassistant/components/switch/snmp.py

@@ -36,6 +39,9 @@

 PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
    vol.Required(CONF_BASEOID): cv.string,
+    vol.Optional(CONF_COMMAND_OID, default=None): vol.Any(cv.string, None),
+    vol.Optional(CONF_COMMAND_PAYLOAD_ON, default=None): vol.Any(cv.string, None),
+    vol.Optional(CONF_COMMAND_PAYLOAD_OFF, default=None): vol.Any(cv.string, None),


line too long (83 > 79 characters)

houndci-bot · 2017-12-11T03:21:03Z

homeassistant/components/switch/snmp.py

@@ -36,6 +39,9 @@

 PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
    vol.Required(CONF_BASEOID): cv.string,
+    vol.Optional(CONF_COMMAND_OID, default=None): vol.Any(cv.string, None),
+    vol.Optional(CONF_COMMAND_PAYLOAD_ON, default=None): vol.Any(cv.string, None),


line too long (82 > 79 characters)

homeassistant · 2017-12-11T03:37:18Z

Hi @nkaminski,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

houndci-bot · 2017-12-11T03:37:26Z

homeassistant/components/switch/snmp.py

-                    payload_off)], True)
+        [SnmpSwitch(name, host, port, community, baseoid, command_oid, version,
+            payload_on, payload_off,
+            command_payload_on, command_payload_off)], True)


continuation line under-indented for visual indent

houndci-bot · 2017-12-11T03:37:27Z

homeassistant/components/switch/snmp.py

-        [SnmpSwitch(name, host, port, community, baseoid, version, payload_on,
-                    payload_off)], True)
+        [SnmpSwitch(name, host, port, community, baseoid, command_oid, version,
+            payload_on, payload_off,


continuation line under-indented for visual indent

houndci-bot · 2017-12-11T03:37:27Z

homeassistant/components/switch/snmp.py

+    vol.Optional(CONF_COMMAND_PAYLOAD_ON, default=None):
+            vol.Any(cv.string, None),
+    vol.Optional(CONF_COMMAND_PAYLOAD_OFF, default=None):
+            vol.Any(cv.string, None),


continuation line unaligned for hanging indent

houndci-bot · 2017-12-11T03:37:27Z

homeassistant/components/switch/snmp.py

+    vol.Optional(CONF_COMMAND_OID, default=None):
+            vol.Any(cv.string, None),
+    vol.Optional(CONF_COMMAND_PAYLOAD_ON, default=None):
+            vol.Any(cv.string, None),


continuation line unaligned for hanging indent

houndci-bot · 2017-12-11T03:37:27Z

homeassistant/components/switch/snmp.py

@@ -36,6 +39,12 @@

 PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
    vol.Required(CONF_BASEOID): cv.string,
+    vol.Optional(CONF_COMMAND_OID, default=None):
+            vol.Any(cv.string, None),


continuation line unaligned for hanging indent

pvizeli · 2017-12-17T11:51:01Z

homeassistant/components/switch/snmp.py

+    vol.Optional(CONF_COMMAND_PAYLOAD_OFF, default=None):
+        vol.Any(
+            cv.string,
+            None),


Don't set it default None and do not allow set None as payload like others. Please use the same style

pvizeli · 2017-12-17T11:51:54Z

homeassistant/components/switch/snmp.py

+        if commandoid:
+            self._commandoid = commandoid
+        else:
+            self._commandoid = baseoid


use style: ... = commandiod or baseoid

pvizeli · 2017-12-17T11:52:05Z

homeassistant/components/switch/snmp.py

+        if command_payload_on:
+            self._command_payload_on = command_payload_on
+        else:
+            self._command_payload_on = payload_on


pvizeli · 2017-12-17T11:52:12Z

homeassistant/components/switch/snmp.py

+        if command_payload_off:
+            self._command_payload_off = command_payload_off
+        else:
+            self._command_payload_off = payload_off


Changes made as requested

Follow PEP8 style properly More PEP8 style fixes Fully PEP8 compliant

nkaminski · 2018-01-19T05:06:39Z

@pvizeli Changes made as requested. Ready for review.

balloob · 2018-01-26T06:48:37Z

Awesome! Congrats on your first contribution! 🎉 🌮 🐬

* upstream/master: (465 commits) Update pyhomematic to 0.1.38 (home-assistant#11936) Implement Alexa temperature sensors (home-assistant#11930) Fixed rfxtrx binary_sensor KeyError on missing optional device_class (home-assistant#11925) Allow setting climate devices to AUTO mode via Google Assistant (home-assistant#11923) fixes home-assistant#11848 (home-assistant#11915) Add "write" service to system_log (home-assistant#11901) Update frontend to 20180126.0 Version 0.62 Allow separate command and state OIDs and payloads in SNMP switch (home-assistant#11075) Add ERC20 tokens to etherscan.io sensor (home-assistant#11916) Report scripts and groups as scenes to Alexa (home-assistant#11900) Minor fix to configuration validation and related log line. (home-assistant#11898) Multi-Room Support for Greenwave Reality (home-assistant#11364) Added Xeoma camera platform (home-assistant#11619) Improve foscam library exception support (home-assistant#11701) Iota wallet (home-assistant#11398) New venstar climate component (home-assistant#11639) Update python-wink version and multiple wink fixes/updates. (home-assistant#11833) Use API to discover Hue if no bridges specified (home-assistant#11909) Clarify emulated hue warning (home-assistant#11910) ...

homeassistant added cla-needed platform: switch.snmp labels Dec 11, 2017

houndci-bot reviewed Dec 11, 2017

View reviewed changes

This was referenced Dec 11, 2017

Document separate command and state OIDs and payloads in SNMP switch home-assistant/home-assistant.io#4189

Closed

Update documentation for SNMP switch component to reflect changes. home-assistant/home-assistant.io#4190

Merged

homeassistant added the cla-needed label Dec 11, 2017

houndci-bot reviewed Dec 11, 2017

View reviewed changes

homeassistant added cla-signed and removed cla-needed labels Dec 11, 2017

balloobbot added the platform label Dec 11, 2017

nkaminski force-pushed the dev branch from e79e5bb to 1cb355d Compare December 11, 2017 03:56

homeassistant added the cla-signed label Dec 11, 2017

pvizeli requested changes Dec 17, 2017

View reviewed changes

nkaminski force-pushed the dev branch from 20113eb to 20a9fcb Compare December 21, 2017 08:41

homeassistant added the cla-signed label Dec 21, 2017

nkaminski force-pushed the dev branch from 20a9fcb to 3bf840a Compare December 25, 2017 07:30

homeassistant added the cla-signed label Dec 25, 2017

nkaminski force-pushed the dev branch from 687dd86 to d7c7d2f Compare January 4, 2018 04:37

homeassistant added the cla-signed label Jan 4, 2018

nkaminski added 4 commits January 17, 2018 20:48

Allow separate command and state OIDs and payloads in SNMP switch

708cfb2

Follow PEP8 style properly More PEP8 style fixes Fully PEP8 compliant

Fix pylint errors

0900d4d

Remove comment to satisfy pylint

cf10c6d

Style changes/refactoring

26be523

nkaminski force-pushed the dev branch from d7c7d2f to 26be523 Compare January 18, 2018 02:48

homeassistant added the cla-signed label Jan 18, 2018

balloob approved these changes Jan 26, 2018

View reviewed changes

balloob merged commit 748fff7 into home-assistant:dev Jan 26, 2018

balloob mentioned this pull request Jan 26, 2018

0.62 #11921

Merged

home-assistant locked and limited conversation to collaborators May 29, 2018

ghost added integration: snmp and removed platform: switch.snmp labels Mar 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

nkaminski commented Dec 11, 2017 •

edited

homeassistant commented Dec 11, 2017

houndci-bot Dec 11, 2017

houndci-bot Dec 11, 2017

houndci-bot Dec 11, 2017

houndci-bot Dec 11, 2017

homeassistant commented Dec 11, 2017

houndci-bot Dec 11, 2017

houndci-bot Dec 11, 2017

houndci-bot Dec 11, 2017

houndci-bot Dec 11, 2017

houndci-bot Dec 11, 2017

pvizeli Dec 17, 2017

pvizeli Dec 17, 2017

pvizeli Dec 17, 2017

pvizeli Dec 17, 2017

nkaminski Dec 25, 2017

nkaminski commented Jan 19, 2018

balloob commented Jan 26, 2018

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

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

Conversation

nkaminski commented Dec 11, 2017 • edited

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

homeassistant commented Dec 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

homeassistant commented Dec 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nkaminski commented Jan 19, 2018

balloob commented Jan 26, 2018

nkaminski commented Dec 11, 2017 •

edited

Example entry for `configuration.yaml` (if applicable):