Skip to content

Add index parameter to scrape sensor #21084

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fabaff merged 2 commits into from
Feb 16, 2019
Merged

Add index parameter to scrape sensor #21084

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
efae0cb
Add index parameter to scrape sensor
davidbb Feb 4, 2019
85c35bc
Set default value for index to avoid later checks
davidbb Feb 15, 2019
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
13 changes: 9 additions & 4 deletions homeassistant/components/sensor/scrape.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@

CONF_ATTR = 'attribute'
CONF_SELECT = 'select'
CONF_INDEX = 'index'

DEFAULT_NAME = 'Web scrape'
DEFAULT_VERIFY_SSL = True
Expand All @@ -34,6 +35,7 @@
vol.Required(CONF_RESOURCE): cv.string,
vol.Required(CONF_SELECT): cv.string,
vol.Optional(CONF_ATTR): cv.string,
vol.Optional(CONF_INDEX, default=0): cv.positive_int,
vol.Optional(CONF_AUTHENTICATION):
vol.In([HTTP_BASIC_AUTHENTICATION, HTTP_DIGEST_AUTHENTICATION]),
vol.Optional(CONF_HEADERS): vol.Schema({cv.string: cv.string}),
Expand All @@ -56,6 +58,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
verify_ssl = config.get(CONF_VERIFY_SSL)
select = config.get(CONF_SELECT)
attr = config.get(CONF_ATTR)
index = config.get(CONF_INDEX)
unit = config.get(CONF_UNIT_OF_MEASUREMENT)
username = config.get(CONF_USERNAME)
password = config.get(CONF_PASSWORD)
Expand All @@ -77,19 +80,21 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
raise PlatformNotReady

add_entities([
ScrapeSensor(rest, name, select, attr, value_template, unit)], True)
ScrapeSensor(rest, name, select, attr, index, value_template, unit)],
True)


class ScrapeSensor(Entity):
"""Representation of a web scrape sensor."""

def __init__(self, rest, name, select, attr, value_template, unit):
def __init__(self, rest, name, select, attr, index, value_template, unit):
"""Initialize a web scrape sensor."""
self.rest = rest
self._name = name
self._state = None
self._select = select
self._attr = attr
self._index = index
self._value_template = value_template
self._unit_of_measurement = unit

Expand Down Expand Up @@ -119,9 +124,9 @@ def update(self):

try:
if self._attr is not None:
value = raw_data.select(self._select)[0][self._attr]
value = raw_data.select(self._select)[self._index][self._attr]
else:
value = raw_data.select(self._select)[0].text
value = raw_data.select(self._select)[self._index].text
_LOGGER.debug(value)
except IndexError:
_LOGGER.error("Unable to extract data from HTML")
Expand Down