Add Attributes to a sensor device #27

wcomartin · 2021-01-14T16:50:15Z

Would be really cool to have the ability to add attributes from the scrape to the sensor as well as have multiple sensors

for example if the webpage had a table of data, and you wanted other columns in the table to be attributes.

kongo09 · 2021-06-08T16:54:56Z

Maybe this could be implemented similar to the rest integration https://www.home-assistant.io/integrations/rest/

For example, instead of generating five separate sensor for the same printer

# Dell Printer
multiscrape:
  - resource: !secret printer_status
    scan_interval: 900
    sensor:
      - name: Printer Toner Level Cyan
        select: "body > table > tr > td > table:nth-child(6) > tr > td > table > tr:nth-child(2) > td:nth-child(1) > b"
        value_template: '{{ value|regex_findall_index(find="(\d+)\%", index=0, ignorecase=False) }}'
        unit_of_measurement: "%"
      - name: Printer Toner Level Magenta
        select: "body > table > tr > td > table:nth-child(6) > tr > td > table > tr:nth-child(4) > td:nth-child(1) > b"
        value_template: '{{ value|regex_findall_index(find="(\d+)\%", index=0, ignorecase=False) }}'
        unit_of_measurement: "%"
      - name: Printer Toner Level Yellow
        select: "body > table > tr > td > table:nth-child(6) > tr > td > table > tr:nth-child(6) > td:nth-child(1) > b"
        value_template: '{{ value|regex_findall_index(find="(\d+)\%", index=0, ignorecase=False) }}'
        unit_of_measurement: "%"
      - name: Printer Toner Level Black
        select: "body > table > tr > td > table:nth-child(6) > tr > td > table > tr:nth-child(8) > td:nth-child(1) > b"
        value_template: '{{ value|regex_findall_index(find="(\d+)\%", index=0, ignorecase=False) }}'
        unit_of_measurement: "%"
  - resource: !secret printer_volume
    scan_interval: 900
    sensor:
      - name: Printer Volume
        select: "body > table > tr > td > table:nth-child(4) > tr > td > table > tr > td:nth-child(2) > font"
        value_template: '{{ value }}'
        unit_of_measurement: "pages"

it could be one sensor with a state for the number of pages and four attributes for toner levels. Maybe similar to this:

# Dell Printer
multiscrape:
  - sensor:
      name: Dell Printer
      value:
      - resource: !secret printer_volume
        scan_interval: 900
        name: Printer Volume
        select: "body > table > tr > td > table:nth-child(4) > tr > td > table > tr > td:nth-child(2) > font"
        value_template: '{{ value }}'
        unit_of_measurement: "pages"
      attributes:
      - name: Toner Level Cyan
        resource: !secret printer_status
        scan_interval: 900
        select: "body > table > tr > td > table:nth-child(6) > tr > td > table > tr:nth-child(2) > td:nth-child(1) > b"
        value_template: '{{ value|regex_findall_index(find="(\d+)\%", index=0, ignorecase=False) }}'
      - name: Toner Level Magenta
        resource: !secret printer_status
        scan_interval: 900
        select: "body > table > tr > td > table:nth-child(6) > tr > td > table > tr:nth-child(4) > td:nth-child(1) > b"
        value_template: '{{ value|regex_findall_index(find="(\d+)\%", index=0, ignorecase=False) }}'
      - name: Toner Level Yellow
        resource: !secret printer_status
        scan_interval: 900
        select: "body > table > tr > td > table:nth-child(6) > tr > td > table > tr:nth-child(6) > td:nth-child(1) > b"
        value_template: '{{ value|regex_findall_index(find="(\d+)\%", index=0, ignorecase=False) }}'
      - name: Toner Level Black
        resource: !secret printer_status
        scan_interval: 900
        select: "body > table > tr > td > table:nth-child(6) > tr > td > table > tr:nth-child(8) > td:nth-child(1) > b"
        value_template: '{{ value|regex_findall_index(find="(\d+)\%", index=0, ignorecase=False) }}'

DimkaInc · 2021-06-08T17:52:13Z

how to release read attr paremeter?

multiscrape:
  - resource: !secret pwr_sw_address
    username: !secret pwr_sw_username
    password: !secret pwr_sw_password
    scan_interval: 5
    sensor:
      - name: relay_1
        select: "button[name=relayon1] ~ img"
        attribute: "src"
        value_template: '{{ value.split("light")[1].split(".jpg")[0] }}'

kongo09 · 2021-06-08T18:10:35Z

I realise that my example might be too complicated as it has several calls to different resources for one sensor. But in your example, how would you set state and more than one attribute to one sensor from the one resource?

kongo09 · 2021-06-10T08:51:50Z

What about this:

multiscrape:
  - resource: !secret pwr_sw_address
    username: !secret pwr_sw_username
    password: !secret pwr_sw_password
    scan_interval: 5
    sensor:
      - name: relay_1
        select: "button[name=relayon1] ~ img"
        value_template: '{{ value.split("light")[1].split(".jpg")[0] }}'
        attributes:
          - name: src
            select: "some selection"
            value_template: "some value template"
          - name: brand
            select: "some selection"
            value_template: "some value template"
          - name: model
            select: "some selection"
            value_template: "some value template"

So from one resource you get one or more sensors with states and each sensor can have several attributes with their own selections in addition to the state.

DimkaInc · 2021-06-10T09:30:33Z

And how do I get the sensor value then?
my config parsed structure like this:
<td><button name="relayon1" value="on">Open</button><button name="relayoff1" value="off">Close</button><button name="pulse1" value="pluse">Pulse</button> <img src="lightoff.jpg"></td>
and set the sensor value on or off depending on the image name. Do you propose to me to make several different values for one sensor?

kongo09 · 2021-06-10T09:41:19Z

Yes, that would be the idea. You have one main value representing the sensor. But then this sensor also has a number of additional attributes that come along with it.

DimkaInc · 2021-06-10T10:01:05Z

Today is not work.

danieldotnl · 2021-06-10T11:20:43Z

What about this:

multiscrape:
  - resource: !secret pwr_sw_address
    username: !secret pwr_sw_username
    password: !secret pwr_sw_password
    scan_interval: 5
    sensor:
      - name: relay_1
        select: "button[name=relayon1] ~ img"
        value_template: '{{ value.split("light")[1].split(".jpg")[0] }}'
        attributes:
          - name: src
            select: "some selection"
            value_template: "some value template"
          - name: brand
            select: "some selection"
            value_template: "some value template"
          - name: model
            select: "some selection"
            value_template: "some value template"

So from one resource you get one or more sensors with states and each sensor can have several attributes with their own selections in addition to the state.

Adding attributes in this way is indeed how I envision it.

danieldotnl · 2021-06-15T08:30:08Z

@wcomartin thank you for your patience! Please check pre-release v4.1.0!

PS: And thank you for initiating the Kia Uvo integration :)

kongo09 · 2021-06-15T08:55:46Z

ok, will check, thanks

currently, with the latest 2021.6.4 multiscrape is broken for me. The previously working sensors stopped working. I'll try the pre-release and will report back and if the problem still exists open a separate issue.

kongo09 · 2021-06-15T23:19:16Z

Hm, I'm not entirely sure how the attributes are supposed to work. I tried this:

multiscrape:
  - resource: !secret printer_status
    scan_interval: 900
    sensor:
      - name: Printer Toner Level
        value_template: '{{ value }}'
        select: "body > table > tr > td > table:nth-child(10) > tr > td > table > tr:nth-child(2) > td:nth-child(2) > b"
        attributes:
          - name: Cyan
            select: "body > table > tr > td > table:nth-child(6) > tr > td > table > tr:nth-child(2) > td:nth-child(1) > b"
            value_template: '{{ value|regex_findall_index(find="(\d+)\%", index=0, ignorecase=False) }}'
          - name: Magenta
            select: "body > table > tr > td > table:nth-child(6) > tr > td > table > tr:nth-child(4) > td:nth-child(1) > b"
            value_template: '{{ value|regex_findall_index(find="(\d+)\%", index=0, ignorecase=False) }}'
          - name: Yellow
            select: "body > table > tr > td > table:nth-child(6) > tr > td > table > tr:nth-child(6) > td:nth-child(1) > b"
            value_template: '{{ value|regex_findall_index(find="(\d+)\%", index=0, ignorecase=False) }}'
          - name: Black
            select: "body > table > tr > td > table:nth-child(6) > tr > td > table > tr:nth-child(8) > td:nth-child(1) > b"
            value_template: '{{ value|regex_findall_index(find="(\d+)\%", index=0, ignorecase=False) }}'

and I get the following error:

2021-06-16 01:15:59 ERROR (MainThread) [homeassistant.components.sensor] Error adding entities for domain sensor with platform multiscrape
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/helpers/entity_platform.py", line 383, in async_add_entities
    await asyncio.gather(*tasks)
  File "/usr/src/homeassistant/homeassistant/helpers/entity_platform.py", line 588, in _async_add_entity
    await entity.add_to_platform_finish()
  File "/usr/src/homeassistant/homeassistant/helpers/entity.py", line 614, in add_to_platform_finish
    await self.async_added_to_hass()
  File "/usr/src/homeassistant/homeassistant/components/rest/entity.py", line 64, in async_added_to_hass
    self._update_from_rest_data()
  File "/config/custom_components/multiscrape/sensor.py", line 178, in _update_from_rest_data
    attr_value = self._scrape(
  File "/config/custom_components/multiscrape/entity.py", line 67, in _scrape
    value = value_template.async_render_with_possible_json_value(value, None)
  File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 543, in async_render_with_possible_json_value
    self._ensure_compiled()
  File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 571, in _ensure_compiled
    assert self.hass is not None, "hass variable not set on template"
AssertionError: hass variable not set on template
2021-06-16 01:15:59 ERROR (MainThread) [homeassistant.components.sensor] Error while setting up multiscrape platform for sensor
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/helpers/entity_platform.py", line 258, in _async_setup_platform
    await asyncio.gather(*pending)
  File "/usr/src/homeassistant/homeassistant/helpers/entity_platform.py", line 383, in async_add_entities
    await asyncio.gather(*tasks)
  File "/usr/src/homeassistant/homeassistant/helpers/entity_platform.py", line 588, in _async_add_entity
    await entity.add_to_platform_finish()
  File "/usr/src/homeassistant/homeassistant/helpers/entity.py", line 614, in add_to_platform_finish
    await self.async_added_to_hass()
  File "/usr/src/homeassistant/homeassistant/components/rest/entity.py", line 64, in async_added_to_hass
    self._update_from_rest_data()
  File "/config/custom_components/multiscrape/sensor.py", line 178, in _update_from_rest_data
    attr_value = self._scrape(
  File "/config/custom_components/multiscrape/entity.py", line 67, in _scrape
    value = value_template.async_render_with_possible_json_value(value, None)
  File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 543, in async_render_with_possible_json_value
    self._ensure_compiled()
  File "/usr/src/homeassistant/homeassistant/helpers/template.py", line 571, in _ensure_compiled
    assert self.hass is not None, "hass variable not set on template"
AssertionError: hass variable not set on template

kongo09 · 2021-06-16T16:25:00Z

Thanks, data is arriving well now. But there is still a bug - I'll file a new issue...

danieldotnl · 2021-06-16T16:53:05Z

Thanks for testing!

wcomartin · 2021-06-22T02:19:41Z

You guys are awesome!! This is going to make my modem status scraping much simpler.

danieldotnl transferred this issue from danieldotnl/hass-multiscrape Jun 8, 2021

danieldotnl added the enhancement New feature or request label Jun 10, 2021

kongo09 mentioned this issue Jun 15, 2021

Multiscrape broken in newest update? #31

Closed

danieldotnl closed this as completed in 958dbde Jun 16, 2021

kongo09 mentioned this issue Jun 16, 2021

attribute names are not well-formed #33

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Attributes to a sensor device #27

Add Attributes to a sensor device #27

wcomartin commented Jan 14, 2021

kongo09 commented Jun 8, 2021

DimkaInc commented Jun 8, 2021 •

edited

Loading

kongo09 commented Jun 8, 2021

kongo09 commented Jun 10, 2021

DimkaInc commented Jun 10, 2021

kongo09 commented Jun 10, 2021

DimkaInc commented Jun 10, 2021

danieldotnl commented Jun 10, 2021

danieldotnl commented Jun 15, 2021

kongo09 commented Jun 15, 2021

kongo09 commented Jun 15, 2021

kongo09 commented Jun 16, 2021

danieldotnl commented Jun 16, 2021 via email •

edited

Loading

wcomartin commented Jun 22, 2021

Add Attributes to a sensor device #27

Add Attributes to a sensor device #27

Comments

wcomartin commented Jan 14, 2021

kongo09 commented Jun 8, 2021

DimkaInc commented Jun 8, 2021 • edited Loading

kongo09 commented Jun 8, 2021

kongo09 commented Jun 10, 2021

DimkaInc commented Jun 10, 2021

kongo09 commented Jun 10, 2021

DimkaInc commented Jun 10, 2021

danieldotnl commented Jun 10, 2021

danieldotnl commented Jun 15, 2021

kongo09 commented Jun 15, 2021

kongo09 commented Jun 15, 2021

kongo09 commented Jun 16, 2021

danieldotnl commented Jun 16, 2021 via email • edited Loading

wcomartin commented Jun 22, 2021

DimkaInc commented Jun 8, 2021 •

edited

Loading

danieldotnl commented Jun 16, 2021 via email •

edited

Loading