Added continue-on-errors, added value template #8971

iamjackg · 2017-08-13T19:50:55Z

Description:

Annoyed by the fact that my printer had to be on when I started Home Assistant, I added functionality to

allow the sensor to start and keep working even if the remote host becomes unreachable
specify an optional default value in case the remote host is unreachable
process the value with a template

The new configuration options are:

value_template (Optional): Defines a template to parse the value.
accept_errors (Optional): Determines whether the sensor should start and keep working even if the SNMP host is unreachable or not responding. This allows the sensor to be initialized properly even if, for example, your printer is not on when you start Home Assistant. Defaults to false.
default_value (Optional): Determines what value the sensor should take if accept_errors is set and the host is unreachable or not responding. If not set, the sensor will have value unknown in case of errors.

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

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

# Example configuration.yaml entry
sensor:
  - platform: snmp
    name: 'Printer uptime'
    host: 192.168.2.21
    baseoid: 1.3.6.1.2.1.1.3.0
    accept_errors: true
    unit_of_measurement: 'minutes'
    value_template: '{{((value | int) / 6000) | int}}'

Checklist:

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

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

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable (example).
New dependencies are only imported inside functions that use them (example).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

mention-bot · 2017-08-13T19:50:56Z

@iamjackg, thanks for your PR! By analyzing the history of the files in this pull request, we identified @fabaff, @jhemzal and @bgehrich to be potential reviewers.

homeassistant · 2017-08-13T19:50:56Z

Hello @iamjackg,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

8ed8e0935e76a97905db077c705c63cfce01157c - This commit has something that looks like an email address (jack.gaino@indexexchange.com). Maybe try linking that to GitHub?.

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.
If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.
- If you only made a single commit you should be able to run
```
git commit --amend --author="Author Name <email@address.com>"
```
  (substituting Author Name and email@address.com for your actual information) to set the authorship information.
- If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
  1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
  2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
- Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

houndci-bot · 2017-08-13T19:51:00Z

homeassistant/components/sensor/snmp.py

        else:
            for resrow in restable:
-                self.value = resrow[-1]
+                self.value = str(resrow[-1])
+              


            


blank line at end of file

houndci-bot · 2017-08-13T19:51:00Z

homeassistant/components/sensor/snmp.py



 class SnmpData(object):
    """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):


line too long (94 > 79 characters)

houndci-bot · 2017-08-13T19:51:00Z

homeassistant/components/sensor/snmp.py

        _LOGGER.error("Please check the details in the configuration file")
        return False
    else:
-        data = SnmpData(host, port, community, baseoid, version)
-        add_devices([SnmpSensor(data, name, unit)], True)
+        data = SnmpData(host, port, community, baseoid, version, accept_errors, default_value)


line too long (94 > 79 characters)

homeassistant · 2017-08-13T19:58:52Z

Hi @iamjackg,

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!

homeassistant · 2017-08-13T20:04:49Z

Hi @iamjackg,

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-08-13T20:04:55Z

homeassistant/components/sensor/snmp.py

-        data = SnmpData(host, port, community, baseoid, version)
-        add_devices([SnmpSensor(data, name, unit)], True)
+        data = SnmpData(
+            host, port, community, baseoid,version, accept_errors,


missing whitespace after ','

homeassistant · 2017-08-13T20:06:37Z

Hi @iamjackg,

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!

fanaticDavid · 2017-08-13T21:18:32Z

I am looking forward to this! Support for value_template will allow me to get rid of a few template sensors I had to create just to make the output of snmp sensors more readable.

pvizeli · 2017-08-14T07:36:41Z

homeassistant/components/sensor/snmp.py

+        if value is None:
+            value = STATE_UNKNOWN
+        elif self._value_template is not None:
+            value = self._value_template.render_with_possible_json_value(


Can we have json inside a snmp value?

It's possible and entirely device-dependent, as SNMP can return string values. Any manufacturer can decide that one of their OIDs is going to return a JSON representation of some data. I'd rather leave the opportunity and cover the odd edge case.

* Added continue-on-errors, added value template * Refactored long lines * Fixed whitespace issues

homeassistant added platform: sensor.snmp cla-error labels Aug 13, 2017

balloobbot added the platform label Aug 13, 2017

houndci-bot reviewed Aug 13, 2017

View reviewed changes

iamjackg mentioned this pull request Aug 13, 2017

Updated SNMP documentation home-assistant/home-assistant.io#3175

Merged

Added continue-on-errors, added value template

1ea215e

iamjackg force-pushed the snmp-improvements branch from 8ed8e09 to 1ea215e Compare August 13, 2017 19:58

homeassistant added the cla-needed label Aug 13, 2017

Refactored long lines

2d9b130

homeassistant added the cla-needed label Aug 13, 2017

houndci-bot reviewed Aug 13, 2017

View reviewed changes

Fixed whitespace issues

8946cfb

homeassistant added cla-needed cla-signed and removed cla-needed labels Aug 13, 2017

pvizeli reviewed Aug 14, 2017

View reviewed changes

pvizeli approved these changes Aug 14, 2017

View reviewed changes

pvizeli merged commit 5309006 into home-assistant:dev Aug 14, 2017

dethpickle pushed a commit to dethpickle/home-assistant that referenced this pull request Aug 18, 2017

Added continue-on-errors, added value template (home-assistant#8971)

51e6c94

* Added continue-on-errors, added value template * Refactored long lines * Fixed whitespace issues

balloob mentioned this pull request Aug 25, 2017

0.52 #9131

Merged

home-assistant locked and limited conversation to collaborators Dec 11, 2017

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Added continue-on-errors, added value template #8971

Added continue-on-errors, added value template #8971

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Added continue-on-errors, added value template #8971

Added continue-on-errors, added value template #8971

Uh oh!

Conversation

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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