Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,7 @@ omit =
homeassistant/components/sensor/dovado.py
homeassistant/components/sensor/dte_energy_bridge.py
homeassistant/components/sensor/dublin_bus_transport.py
homeassistant/components/sensor/dwdwarnapp.py
homeassistant/components/sensor/ebox.py
homeassistant/components/sensor/eddystone_temperature.py
homeassistant/components/sensor/eliqonline.py
Expand Down
245 changes: 245 additions & 0 deletions homeassistant/components/sensor/dwd_warnapp.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,245 @@
"""
Support for getting statistical data from a DWD-Warnapp system.
For more details about this platform, please refer to the documentation at
https://home-assistant.io/components/sensor.dwd_warnapp/

Data is fetched from DWD:
https://rcccm.dwd.de/DE/wetter/warnungen_aktuell/objekt_einbindung/objekteinbindung.html

Warnungen vor extremem Unwetter (Stufe 4)
Unwetterwarnungen (Stufe 3)
Warnungen vor markantem Wetter (Stufe 2)
Wetterwarnungen (Stufe 1)
"""
import logging
import json
import time

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'time' imported but unused

import datetime

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'datetime' imported but unused

from datetime import timedelta

import voluptuous as vol

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

CONF_NAME, CONF_HOST, CONF_SSL, CONF_VERIFY_SSL, CONF_MONITORED_CONDITIONS)
import homeassistant.util.dt as dt_util

_LOGGER = logging.getLogger(__name__)
_ENDPOINT = '/DWD/warnungen/warnapp_landkreise/json/warnings.json?jsonp=loadWarnings'

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line too long (85 > 79 characters)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


DEFAULT_HOST = 'www.dwd.de'

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


CONF_REGION_NAME = 'region_name'
DEFAULT_REGION_NAME = 'Hansestadt Hamburg'

SCAN_INTERVAL = timedelta(minutes=15)

MONITORED_CONDITIONS = {
'current_warning_level': ['Current Warning Level',
None, 'mdi:close-octagon-outline'],
'advance_warning_level': ['Advance Warning Level',
None, 'mdi:close-octagon-outline'],
}

PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Optional(CONF_REGION_NAME, default=DEFAULT_REGION_NAME): cv.string,
vol.Optional(CONF_HOST, default=DEFAULT_HOST): cv.string,
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_SSL, default=DEFAULT_SSL): cv.boolean,
vol.Optional(CONF_VERIFY_SSL, default=DEFAULT_VERIFY_SSL): cv.boolean,
vol.Optional(CONF_MONITORED_CONDITIONS, default=MONITORED_CONDITIONS):
vol.All(cv.ensure_list, [vol.In(MONITORED_CONDITIONS)]),
})


def setup_platform(hass, config, add_devices, discovery_info=None):
"""Set up the DWD-Warnapp sensor."""
name = config.get(CONF_NAME)
host = config.get(CONF_HOST)
use_ssl = config.get(CONF_SSL)
verify_ssl = config.get(CONF_VERIFY_SSL)
region_name = config.get(CONF_REGION_NAME)

api = DwdWarnappAPI(host, use_ssl, verify_ssl, region_name)

sensors = [DwdWarnappSensor(hass, api, name, condition)
for condition in config[CONF_MONITORED_CONDITIONS]]

add_devices(sensors, True)


class DwdWarnappSensor(Entity):
"""Representation of a DWD-Warnapp sensor."""

def __init__(self, hass, api, name, variable):
"""Initialize a DWD-Warnapp sensor."""
self._hass = hass
self._api = api
self._name = name
self._var_id = variable

variable_info = MONITORED_CONDITIONS[variable]
self._var_name = variable_info[0]
self._var_units = variable_info[1]
self._var_icon = variable_info[2]

@property
def name(self):
"""Return the name of the sensor."""
return "{} {}".format(self._name, self._var_name)

@property
def icon(self):
"""Icon to use in the frontend, if any."""
return self._var_icon

@property
def unit_of_measurement(self):
"""Return the unit the value is expressed in."""
return self._var_units

# pylint: disable=no-member
@property
def state(self):
"""Return the state of the device."""
try:
return round(self._api.data[self._var_id], 2)
except TypeError:
return self._api.data[self._var_id]

# pylint: disable=no-member
@property
def device_state_attributes(self):
"""Return the state attributes of the DWD-Warnapp."""

data = {}
data['region_name'] = self._api.region_name

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

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'

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line too long (165 > 79 characters)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line too long (165 > 79 characters)


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))

if self._var_id == 'current_warning_level':
prefix = 'current'
elif self._var_id == 'advance_warning_level':
prefix = 'advance'

data['warning_count'] = self._api.data[prefix + '_warning_count']
i = 0
for event in self._api.data[prefix + '_warnings']:
i = i + 1

data['warning_{}_name'.format(i)] = event['event']
data['warning_{}_level'.format(i)] = event['level']
data['warning_{}_type'.format(i)] = event['type']
if len(event['headline']) > 0:
data['warning_{}_headline'.format(i)] = event['headline']
if len(event['description']) > 0:
data['warning_{}_description'.format(i)] = event['description']
if len(event['instruction']) > 0:
data['warning_{}_instruction'.format(i)] = event['instruction']

if event['start'] is not None:
data['warning_{}_start'.format(i)] = dt_util.as_local(
dt_util.utc_from_timestamp(event['start'] / 1000))

if event['end'] is not None:
data['warning_{}_end'.format(i)] = dt_util.as_local(
dt_util.utc_from_timestamp(event['end'] / 1000))

return data

@property
def available(self):
"""Could the device be accessed during the last update call."""
return self._api.available

def update(self):
"""Get the latest data from the DWD-Warnapp API."""
self._api.update()


class DwdWarnappAPI(object):
"""Get the latest data and update the states."""

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

uri_scheme = 'https://' if use_ssl else 'http://'

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

resource = "{}{}{}".format(uri_scheme, host, _ENDPOINT)

self._rest = RestData('GET', resource, None, None, None, verify_ssl)
self.region_name = region_name
self.region_id = None
self.region_state = None
self.data = None
self.available = True
self.update()

#@Throttle(SCAN_INTERVAL)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

block comment should start with '# '

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

def update(self):
"""Get the latest data from the DWD-Warnapp."""
try:
self._rest.update()

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

data = {}

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

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line too long (97 > 79 characters)


_LOGGER.debug("Found {} {} global DWD warnings".format(
len(json_obj[myvalue]), mykey))

data['{}_warning_level'.format(mykey)] = 0
my_warnings = []

if self.region_id is not None:
# get a specific region_id
if self.region_id in json_obj[myvalue]:
my_warnings = json_obj[myvalue][self.region_id]

else:
# loop through all items to find warnings, region_id and region_state for region_name

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line too long (105 > 79 characters)

for key in json_obj[myvalue]:
if json_obj[myvalue][key][0]['regionName'] != self.region_name:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line too long (87 > 79 characters)

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line too long (83 > 79 characters)

break

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

line too long (81 > 79 characters)

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

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))

self.data = data
self.available = True
except TypeError:
_LOGGER.error("Unable to fetch data from DWD-Warnapp")
self.available = False