Added DWD WarnApp Sensor by runningman84 · Pull Request #8657 · home-assistant/core

runningman84 · 2017-07-26T19:23:18Z

Description:

This sensor adds support for current and advance weather warnings from DWD (Deutsche Wetter Dienst) for Germany. This sensor uses the same data as the WarnWetter Android/IOS App.

The warning level is between 0 (no danger) and 4:

Warnungen vor extremem Unwetter (Stufe 4)
Unwetterwarnungen (Stufe 3)
Warnungen vor markantem Wetter (Stufe 2)
Wetterwarnungen (Stufe 1)

It can be a bit tricky to find out the correct region name because the source json files only shows a region if a current or advance warning is there:
https://www.dwd.de/DWD/warnungen/warnapp_landkreise/json/warnings.json?jsonp=loadWarnings
The region_name should match the name of the regions listed on this page:
https://www.dwd.de/DE/wetter/warnungen_landkreise/warnWetter_node.html?ort=Hamburg

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

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

sensor:
  - platform: dwd_weather_warnings
    region_name: 'Hansestadt Hamburg'   # optional

Here is a screenshot:
https://community.home-assistant.io/t/dwd-warnapp-sensor-amtliche-warnungen-des-deutschen-wetterdienstes/22699/1

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.

If the code does not interact with devices:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
Tests have been added to verify that the new code works.

homeassistant · 2017-07-26T19:23:19Z

Hi @runningman84,

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-07-26T19:23:22Z

+                data['{}_warning_count'.format(mykey)] = len(my_warnings)
+                data['{}_warnings'.format(mykey)] = my_warnings
+
+                _LOGGER.debug("Found {} {} local DWD warnings".format(len(my_warnings), mykey))


line too long (95 > 79 characters)

houndci-bot · 2017-07-26T19:23:22Z

+
+                # Get max warning level
+                for event in my_warnings:
+                    if(event['level'] >= data['{}_warning_level'.format(mykey)]):


line too long (81 > 79 characters)

houndci-bot · 2017-07-26T19:23:22Z

+                            continue
+                        my_warnings = json_obj[myvalue][key]
+                        self.region_id = key
+                        self.region_state = json_obj[myvalue][key][0]['stateShort']


line too long (83 > 79 characters)

houndci-bot · 2017-07-26T19:23:23Z

+                else:
+                    # loop through all items to find warnings, region_id and region_state for region_name
+                    for key in json_obj[myvalue]:
+                        if json_obj[myvalue][key][0]['regionName'] != self.region_name:


line too long (87 > 79 characters)

houndci-bot · 2017-07-26T19:23:23Z

+                        my_warnings = json_obj[myvalue][self.region_id]
+
+                else:
+                    # loop through all items to find warnings, region_id and region_state for region_name


line too long (105 > 79 characters)

houndci-bot · 2017-07-26T19:23:23Z

+            # data['region_map_url'] = 'https://www.dwd.de/DWD/warnungen/warnapp_gemeinden/json/warnungen_gemeinde_map_' + str(data['region_state'].lower()) + '.png'
+
+        if self._api.data['time'] is not None:
+            data['last_update'] = dt_util.as_local(dt_util.utc_from_timestamp(self._api.data['time']  / 1000))


line too long (110 > 79 characters)
multiple spaces before operator

houndci-bot · 2017-07-26T19:23:23Z

+
+        if  self._api.region_state is not None:
+            data['region_state'] = self._api.region_state
+            # data['region_map_url'] = 'https://www.dwd.de/DWD/warnungen/warnapp_gemeinden/json/warnungen_gemeinde_map_' + str(data['region_state'].lower()) + '.png'


line too long (165 > 79 characters)

houndci-bot · 2017-07-26T19:23:23Z

+        if  self._api.region_id is not None:
+            data['region_id'] = self._api.region_id
+
+        if  self._api.region_state is not None:


multiple spaces after keyword

houndci-bot · 2017-07-26T19:23:23Z

+        data = {}
+        data['region_name'] = self._api.region_name
+
+        if  self._api.region_id is not None:


multiple spaces after keyword

houndci-bot · 2017-07-26T19:23:23Z

+    'current_warning_level': ['Current Warning Level',
+                          None, 'mdi:close-octagon-outline'],
+    'advance_warning_level': ['Advance Warning Level',
+                          None, 'mdi:close-octagon-outline'],


continuation line under-indented for visual indent

houndci-bot · 2017-07-26T19:27:33Z

+import homeassistant.util.dt as dt_util
+
+_LOGGER = logging.getLogger(__name__)
+_ENDPOINT = '/DWD/warnungen/warnapp_landkreise/json/warnings.json?jsonp=loadWarnings'


line too long (85 > 79 characters)

how ca we fix this one? I cannot change the corresponding url, splitting it into multiple lines seems odd to me.

Fix it by not hardcoding the url arguments in the endpoint.

houndci-bot · 2017-07-26T19:27:33Z

+import logging
+import json
+import time
+import datetime


'datetime' imported but unused

houndci-bot · 2017-07-26T19:27:33Z

+"""
+import logging
+import json
+import time


'time' imported but unused

houndci-bot · 2017-07-26T19:39:44Z

+
+        if self._api.region_state is not None:
+            data['region_state'] = self._api.region_state
+            # data['region_map_url'] = 'https://www.dwd.de/DWD/warnungen/warnapp_gemeinden/json/warnungen_gemeinde_map_' + str(data['region_state'].lower()) + '.png'


line too long (165 > 79 characters)

balloob

There are a lot of options in here that I don't really see why they would make sense for querying a web service (verify SSL, use SSL etc)

balloob · 2017-08-01T06:24:10Z

+DEFAULT_METHOD = 'GET'
+DEFAULT_NAME = 'DWD-Warnapp'
+DEFAULT_SSL = True
+DEFAULT_VERIFY_SSL = True


Why did you implement this option? Doesn't it default fetch dwd.de which I assume has SSL working?

balloob · 2017-08-01T06:25:23Z

+        self.available = True
+        self.update()
+
+    #@Throttle(SCAN_INTERVAL)


You will need to implement throttle or you're hammering their API

balloob · 2017-08-01T06:25:36Z

+        """Initialize the data object."""
+        from homeassistant.components.sensor.rest import RestData
+
+        uri_scheme = 'https://' if use_ssl else 'http://'


Why is this an option? Isn't the website always the same

houndci-bot · 2017-08-04T22:17:31Z

+        self.available = True
+        self.update()
+
+    @Throttle(SCAN_INTERVAL)


undefined name 'Throttle'

houndci-bot · 2017-08-04T22:17:31Z

+import homeassistant.helpers.config_validation as cv
+from homeassistant.helpers.entity import Entity
+from homeassistant.components.sensor import PLATFORM_SCHEMA
+from homeassistant.const import (


'homeassistant.const.CONF_HOST' imported but unused
'homeassistant.const.CONF_SSL' imported but unused
'homeassistant.const.CONF_VERIFY_SSL' imported but unused

houndci-bot · 2017-08-04T22:22:46Z

+
+                # Get max warning level
+                for event in my_warnings:
+                    if(event['level'] >= data['{}_warning_level'.format(mykey)]):


line too long (81 > 79 characters)

houndci-bot · 2017-08-04T22:22:47Z

+                            continue
+                        my_warnings = json_obj[myvalue][key]
+                        self.region_id = key
+                        self.region_state = json_obj[myvalue][key][0]['stateShort']


line too long (83 > 79 characters)

houndci-bot · 2017-08-04T22:22:47Z

+                else:
+                    # loop through all items to find warnings, region_id and region_state for region_name
+                    for key in json_obj[myvalue]:
+                        if json_obj[myvalue][key][0]['regionName'] != self.region_name:


line too long (87 > 79 characters)

houndci-bot · 2017-08-04T22:22:47Z

+                        my_warnings = json_obj[myvalue][self.region_id]
+
+                else:
+                    # loop through all items to find warnings, region_id and region_state for region_name


line too long (105 > 79 characters)

houndci-bot · 2017-08-04T22:22:47Z

+
+            data['time'] = json_obj['time']
+
+            for mykey, myvalue in {'current': 'warnings', 'advance': 'vorabInformation'}.items():


line too long (97 > 79 characters)

houndci-bot · 2017-08-04T22:22:47Z

+
+        if self._api.region_state is not None:
+            data['region_state'] = self._api.region_state
+            # data['region_map_url'] = 'https://www.dwd.de/DWD/warnungen/warnapp_gemeinden/json/warnungen_gemeinde_map_' + str(data['region_state'].lower()) + '.png'


line too long (165 > 79 characters)

runningman84 · 2017-08-04T22:25:50Z

@balloob I added the throttle function and renamed it to dwd weather warnings.
I do not have a good idea how to shorten the lines to be below 80 chars. Is that a hard limit? If yes please provide some advice how to do this...

balloob · 2017-08-06T18:11:03Z

 if (event['level'] >=
         data['{}_warning_level'.format(mykey)]):

balloob · 2017-08-06T18:11:10Z

Yes, it is a hard limit.

houndci-bot · 2017-08-06T19:47:51Z

+                    # loop through all items to find warnings, region_id
+                    # and region_state for region_name
+                    for key in json_obj[myvalue]:
+                        if json_obj[myvalue][key][0]['regionName'] != self.region_name:


line too long (87 > 79 characters)

fabaff · 2017-08-08T20:33:11Z

+
+_LOGGER = logging.getLogger(__name__)
+
+DEFAULT_NAME = 'DWD-Wetter-Warnungen'


Should be in English. If the user can set name: if he/she want it in German.

fabaff · 2017-08-08T20:33:16Z

+DEFAULT_NAME = 'DWD-Wetter-Warnungen'
+
+CONF_REGION_NAME = 'region_name'
+DEFAULT_REGION_NAME = 'Hansestadt Hamburg'


This default does only make sense for a small group of users.

I will remove the default region

fabaff · 2017-08-08T20:33:38Z

+
+    # pylint: disable=no-member
+    @property
+    def device_state_attributes(self):


Can you please add an attribution?

what do you mean?

fabaff · 2017-08-08T20:36:53Z

+
+    def __init__(self, hass, api, name, variable):
+        """Initialize a DWD-Weather-Warnings sensor."""
+        self._hass = hass


You doesn't seems to use self._hass.

I will remove it

fabaff · 2017-08-08T20:41:32Z

+
+    def __init__(self, region_name):
+        """Initialize the data object."""
+        from homeassistant.components.sensor.rest import RestData


Please place this in the file header.

houndci-bot · 2017-08-18T18:04:49Z

+            return self._api.data[self._var_id]
+
+    # pylint: disable=no-member
+    @property


redefinition of unused 'device_state_attributes' from line 96

runningman84 · 2017-08-18T18:26:24Z

@fabaff can you accept the pull request or is still something missing?

fabaff · 2017-08-21T13:44:48Z

There are still lint issues.

houndci-bot · 2017-09-02T20:13:50Z

+                data['{}_warnings'.format(mykey)] = my_warnings
+
+                _LOGGER.debug("Found %d %s local DWD warnings",
+                    len(my_warnings), mykey)


continuation line under-indented for visual indent

houndci-bot · 2017-09-02T20:13:50Z

+            }.items():
+
+                _LOGGER.debug("Found %d %s global DWD warnings",
+                    len(json_obj[myvalue]), mykey)


continuation line under-indented for visual indent

syssi · 2017-09-03T06:59:10Z

+        elif self._var_id == 'advance_warning_level':
+            prefix = 'advance'
+
+        data['warning_count'] = self._api.data[prefix + '_warning_count']


Local variable 'prefix' might be referenced before assignment. Compare L122, L124.

ok I will add a else path and throw an exception there...

syssi · 2017-09-03T07:02:47Z

+
+    def __init__(self, region_name):
+        """Initialize the data object."""
+


Just remove this blank line.

syssi · 2017-09-03T07:07:56Z

+            json_string = self._rest.data[24:len(self._rest.data) - 2]
+            json_obj = json.loads(json_string)
+
+            data = {}


You could save a line here. My IDE complains about. ;-)

- data = {} - - data['time'] = json_obj['time'] + data = {'time': json_obj['time']}

syssi · 2017-09-03T07:09:33Z

+    @property
+    def device_state_attributes(self):
+        """Return the state attributes of the DWD-Weather-Warnings."""
+        data = {}


Same here:

data = { ATTR_ATTRIBUTION: ATTRIBUTION, 'region_name': self._api.region_name, }

syssi · 2017-09-03T07:12:11Z

Good job! 👍

runningman84 · 2017-09-03T10:07:30Z

@fabaff and @balloob all checks have passed

balloob · 2017-09-05T15:40:40Z

Thanks! 🐬

Added DWD WarnApp Sensor

1af723f

homeassistant added new-platform platform: sensor.dwd_warnapp cla-needed labels Jul 26, 2017

houndci-bot reviewed Jul 26, 2017

View reviewed changes

homeassistant added cla-signed and removed cla-needed labels Jul 26, 2017

Fixed some idents and spaces

7cb7924

homeassistant added the cla-signed label Jul 26, 2017

houndci-bot reviewed Jul 26, 2017

View reviewed changes

Removed unused imports

17cc1a7

houndci-bot reviewed Jul 26, 2017

View reviewed changes

Removed comment

7b3e84c

runningman84 mentioned this pull request Jul 26, 2017

Added docs for DWD WarnApp Sensor home-assistant/home-assistant.io#3062

Merged

balloob requested changes Aug 1, 2017

View reviewed changes

Some fixes

a85e8d5

balloobbot added the platform label Aug 4, 2017

houndci-bot reviewed Aug 4, 2017

View reviewed changes

Added throttle

d9da925

homeassistant added the cla-signed label Aug 4, 2017

Renamed sensor to dwd weather warnings

d2f6676

houndci-bot reviewed Aug 4, 2017

View reviewed changes

Renamed test file

df60b1a

homeassistant added the cla-signed label Aug 4, 2017

shorten lines

deb31e7

houndci-bot reviewed Aug 6, 2017

View reviewed changes

shorten lines

5c270a4

fabaff requested changes Aug 8, 2017

View reviewed changes

runningman84 added 2 commits August 8, 2017 22:54

Implemented changes requested by fabaff

7426e3e

added ATTRIBUTION

43cc842

houndci-bot reviewed Aug 18, 2017

View reviewed changes

move ATTRIBUTION to existing method

8a510f7

fixed lint tests

339b097

homeassistant added the cla-signed label Aug 18, 2017

runningman84 added 2 commits September 2, 2017 22:09

Fix linter issues

8095761

Fix linter issues

0e0a9e9

houndci-bot reviewed Sep 2, 2017

View reviewed changes

Fix linter

70d0195

syssi reviewed Sep 3, 2017

View reviewed changes

Fixed linter

0940766

balloob merged commit 9ede0f5 into home-assistant:dev Sep 5, 2017

balloob mentioned this pull request Sep 7, 2017

0.53 #9327

Merged

runningman84 mentioned this pull request Sep 9, 2017

Renamed dwdwarnapp to dwd_weather_warnings home-assistant/home-assistant.io#3335

Merged

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

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


		data['time'] = json_obj['time']

		for mykey, myvalue in {'current': 'warnings', 'advance': 'vorabInformation'}.items():


		_LOGGER = logging.getLogger(__name__)

		DEFAULT_NAME = 'DWD-Wetter-Warnungen'


		def __init__(self, region_name):
		"""Initialize the data object."""

Uh oh!

Conversation

runningman84 commented Jul 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

homeassistant commented Jul 26, 2017

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!

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!

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!

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!

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!

Choose a reason for hiding this comment

Uh oh!

balloob left a comment

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!

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!

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!

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!

runningman84 commented Aug 4, 2017

Uh oh!

balloob commented Aug 6, 2017

Uh oh!

balloob commented Aug 6, 2017

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!

Choose a reason for hiding this comment

runningman84 commented Jul 26, 2017 •

edited

Loading

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