DDF for IKEA VINDSTYRKA #7246

ebaauw · 2023-09-17T10:45:06Z

Note: this PR depends on #7252.

This updated DDF for the IKEA VINDSTYRKA sensor introduces the new state/measured_value and corresponding capabilities items. Unfortunately, the sensor reports temperature and humidity at a coarse resolution, so we cannot see the floating point values in action.

ZHATemperature

Add state/measured_value, as float value in °C. Unfortunately, the sensor's granularity is limited to integer values;
Add corresponding cap/measured_value items. min and max are reported by the sensor; quantity, substance, and unit are defined in the DDF;
Deprecate state/temperature (integer value in 0.01 °C);
Not sure what to do with config/offset (also integer value in 0.01 °C). I do apply it to state/measured_value, but ultimately, we want this as a float values as well. Maybe introduce config/measured_value/offset and deprecate config/offset?

{
  "capabilities": {
    "measured_value": {
      "max": 50,
      "min": -10,
      "quantity": "temperature",
      "substance": "air",
      "unit": "degC"
    }
  },
  "config": {
    "offset": 0,
    "on": true,
    "reachable": true
  },
  "ep": 1,
  "etag": "89dc3816a6ddd73d103a8e2cc4b61caa",
  "lastannounced": null,
  "lastseen": "2023-09-23T14:05Z",
  "manufacturername": "IKEA of Sweden",
  "modelid": "VINDSTYRKA",
  "name": "Vindstyrka",
  "productid": "E2112",
  "state": {
    "lastupdated": "2023-09-23T14:02:06.470",
    "measured_value": 23,
    "temperature": 2300
  },
  "swversion": "1.0.11",
  "type": "ZHATemperature",
  "uniqueid": "94:34:69:ff:fe:bb:f4:92-01-0402"
}

ZHAHumidity

Add state/measured_value, as float value in %. Unfortunately, the sensor's granularity is limited to integer values;
Add corresponding cap/measured_value items. min and max are reported by the sensor; quantity, substance, and unit are defined in the DDF;
Deprecate state/temperature (integer value in 0.01%);
Not sure what to do with config/offset (also integer value in 0.01%). I do apply it to state/measured_value, but ultimately, we want this as a float values as well. Maybe introduce config/measured_value/offset and deprecate config/offset?

{
  "capabilities": {
    "measured_value": {
      "max": 100,
      "min": 0,
      "quantity": "level",
      "substance": "relative humidity",
      "unit": "%"
    }
  },
  "config": {
    "offset": 0,
    "on": true,
    "reachable": true
  },
  "ep": 1,
  "etag": "4a8285863f1847c8f96f1a6e6dc98a4a",
  "lastannounced": null,
  "lastseen": "2023-09-23T14:01Z",
  "manufacturername": "IKEA of Sweden",
  "modelid": "VINDSTYRKA",
  "name": "Vindstyrka",
  "productid": "E2112",
  "state": {
    "humidity": 5800,
    "lastupdated": "2023-09-23T14:00:08.432",
    "measured_value": 58
  },
  "swversion": "1.0.11",
  "type": "ZHAHumidity",
  "uniqueid": "94:34:69:ff:fe:bb:f4:92-01-0405"
}

ZHAParticulateMatter

The sensor uses the standard 0x042A to report PM2.5 density.

Change type to ZHAParticulateMatter (was ZHAAirQuality);
Add state/measured_value, as float value in µg/m³. Unfortunately, the sensor's granularity is limited to integer values;
Add corresponding cap/measured_value items. min and max are reported by the sensor; quantity, substance, and unit are defined in the DDF;
Derive state/airquality from state/measured_value. The validator error for this is being fixed by @Zehir;
Deprecate state/pm2_5.

{
  "capabilities": {
    "measured_value": {
      "max": 999,
      "min": 0,
      "quantity": "density",
      "substance": "PM2.5",
      "unit": "ug/m^3"
    }
  },
  "config": {
    "on": true,
    "reachable": true
  },
  "ep": 1,
  "etag": "5ab00c1628d670a2eeda5bff81463897",
  "lastannounced": null,
  "lastseen": "2023-09-23T14:02Z",
  "manufacturername": "IKEA of Sweden",
  "modelid": "VINDSTYRKA",
  "name": "Vindstyrka",
  "productid": "E2112",
  "state": {
    "airquality": "excellent",
    "lastupdated": "2023-09-23T14:01:32.533",
    "measured_value": 1,
    "pm2_5": 1
  },
  "swversion": "1.0.11",
  "type": "ZHAParticulateMatter",
  "uniqueid": "94:34:69:ff:fe:bb:f4:92-01-042a"
}

ZHAAirQuality

The sensor uses IKEA-specific cluster to report the tVOC level.

Add state/measured_value, as float value in ppb. Unfortunately, the sensor's granularity is limited to integer values;
Add corresponding cap/measured_value items. min and max are reported by the sensor; quantity, substance, and unit are defined in the DDF;
Derive state/airquality from state/measured_value. The validator error for this is being fixed by @Zehir;
Deprecate state/airqualityppb.

{
  "capabilities": {
    "measured_value": {
      "max": 500,
      "min": 0,
      "quantity": "level",
      "substance": "tVOC",
      "unit": "ppb"
    }
  },
  "config": {
    "on": true,
    "reachable": true
  },
  "ep": 1,
  "etag": "036255a18e94d3760a13e8ceb66abb52",
  "lastannounced": null,
  "lastseen": "2023-09-23T14:02Z",
  "manufacturername": "IKEA of Sweden",
  "modelid": "VINDSTYRKA",
  "name": "Vindstyrka",
  "productid": "E2112",
  "state": {
    "airquality": "good",
    "airqualityppb": 75,
    "lastupdated": "2023-09-23T13:59:56.439",
    "measured_value": 75
  },
  "swversion": "1.0.11",
  "type": "ZHAAirQuality",
  "uniqueid": "94:34:69:ff:fe:bb:f4:92-01-fc7e"
}

Add `state/measured_value` and `cap/measured_value/*`.

Expose `cap/measured_value` as map.

- Change PM2.5 sensor to ZHAParticulateMatter; - Add `state/measured_value` and associated `cap/measured_value` items to all sensors.

Zehir · 2023-09-17T12:08:58Z

@ebaauw I have updated the github action to 1.8.1 with lastest changes of the validator, you can re-run the validator from the Checks tab.

Add support for `DataTypeReal`.

This reverts commit 1609614.

This reverts commit e83b218.

This reverts commit 70bf453.

This reverts commit 543a1e1.

This reverts commit 8b495b5.

This reverts commit 8e5a475.

This reverts commit 8afb06a.

Express units in ASCII.

Support `measured_value`, see dresden-elektronik/deconz-rest-plugin#7246 and dresden-elektronik/deconz-rest-plugin#7248

manup · 2023-09-25T09:28:44Z

I don't have the device for testing, PR looks fine to me except the state/temperature deprecation :)

Remove deprecated mark on `state/temperature`.

ebaauw · 2023-09-25T09:53:59Z

Updated.

LeoeLeoeL · 2023-10-10T16:12:41Z

I think unit of measure for TVOC should be changed from PPB to a "general" INDEX.
TVOC PPB scale goes from 0 to 5500 but this entity stops to 500.

BabaIsYou · 2023-10-10T16:44:21Z

Already reported #7121 (comment) and #6673 (comment) but may be lost into larger discussions.

ebaauw · 2023-10-10T19:24:17Z

I think unit of measure for TVOC should be changed from PPB to a "general" INDEX.

An index is dimension-less, so unit should be null in this case. Also, quantity should be "index" instead of "level".

Already reported #7121 (comment) and #6673 (comment) but may be lost into larger discussions.

Indeed, you have, and that did slip my mind. Thanks for reminding us.

TVOC PPB scale goes from 0 to 5500 but this entity stops to 500.

According to its spec sheet (link in above-mentioned comments), the SEN54 measures 1 to 1,000 ppm of ethanol equivalents. So that would imply a ppb scale of 1,000 to 1,000,000. Also, the spec sheet mentions "VOC", not "tVOC". The VINDSTYRKA display shows "tVOC", though.

The referenced conversion table only shows ranges. This is enough to conclude the index value has no linear relationship to the TVOC level, but not enough to derive a conversion formula. We could do linear extrapolation in each range, but I'd rather see a proper formula, @BabaIsYou would you have that?

Both unit and quantity are defined as static values in the DDF, so it would be easy enough to change them. Using different quantity values, I don't think we would need to normalise the measured_value for all ZHAAirQuality sensors, but this might be lost in translation / documentation very easily.

I think I would rather have the API report tVOC level, and normalise measured_value (and max and min) for ZHAAirQuality, by converting the reported index value to equivalent tVOC level. In that case, unit and quantity can remain unchanged.

LeoeLeoeL · 2023-10-10T19:31:51Z

I wrote INDEX because also PM 2.5 often uses a scale (called AQI) that goes from 0 to 500.

BabaIsYou · 2023-10-11T12:23:09Z

We could do linear extrapolation in each range, but I'd rather see a proper formula, @BabaIsYou would you have that?

Unfortunately I don't ! But I think that this kind of transformation won't reflect what this index is in reality. It's not a measure of a concentration but the reflect of an empiric variation on the last 24 hours. Then I think that I could be better to change unit and quantity in the device specific DDF for devices that are based on SEN54 sensor like the VindStyrka.

BabaIsYou · 2023-10-11T12:50:55Z

I wrote INDEX because also PM 2.5 often uses a scale (called AQI) that goes from 0 to 500.

AFAIK AQI is not limited to PM 2.5, iit's a kind of tVOC as it combines several substances to get an index : https://www.airnow.gov/sites/default/files/2020-05/aqi-technical-assistance-document-sept2018.pdf

LeoeLeoeL · 2023-10-11T16:05:22Z

I have 3 of them (PM 2.5 sensors):

They can show PM 2.5 in AQI index or ug/m3.
They are "faster" than Vindstyrka but they arent "smart".

BabaIsYou · 2023-10-11T16:37:10Z

You're right, my misunderstanding of how it is calculated. The AQI is calculated from the upper pollutant (only one in youre case) based on the calculation chart and formula in pages 9-10 of the referenced pdf.

ebaauw · 2023-10-11T20:38:10Z

Please stay on topic.

BabaIsYou · 2023-10-11T20:58:34Z

May be we are if AQI and VOC index share the same formula and charts ;-)

ebaauw · 2023-10-13T13:53:20Z

Fixed in #7297.

ebaauw added 5 commits September 17, 2023 12:18

Create cap_measured_value_quantity.json

8afb06a

Update resource.cpp

8e5a475

Add `state/measured_value` and `cap/measured_value/*`.

Update resource.h

8b495b5

Add `state/measured_value` and `cap/measured_value/*`.

Update rest_sensors.cpp

543a1e1

Expose `cap/measured_value` as map.

Update vindstyrka_air_quality_sensor.json

8d6934a

- Change PM2.5 sensor to ZHAParticulateMatter; - Add `state/measured_value` and associated `cap/measured_value` items to all sensors.

ebaauw requested review from manup, SwoopX and Smanar September 17, 2023 10:45

ebaauw added the Device Improvement Additional tag to attach to a existing issue. label Sep 17, 2023

ebaauw added this to the v2.24.1-beta milestone Sep 17, 2023

ebaauw marked this pull request as ready for review September 17, 2023 10:46

Update vindstyrka_air_quality_sensor.json

b7537f6

ebaauw added 3 commits September 17, 2023 14:16

Update resource.h

70bf453

Add support for `DataTypeReal`.

Update resource.cpp

e83b218

Add support for `DataTypeReal`.

Update resource.cpp

1609614

ebaauw marked this pull request as draft September 18, 2023 10:56

ebaauw added 7 commits September 18, 2023 19:36

Revert "Update resource.cpp"

7d05d3f

This reverts commit 1609614.

Revert "Update resource.cpp"

37dc72e

This reverts commit e83b218.

Revert "Update resource.h"

19affed

This reverts commit 70bf453.

Revert "Update rest_sensors.cpp"

a5d8e62

This reverts commit 543a1e1.

Revert "Update resource.h"

5e2f0f4

This reverts commit 8b495b5.

Revert "Update resource.cpp"

e4ac9d1

This reverts commit 8e5a475.

Revert "Create cap_measured_value_quantity.json"

e7ce3e2

This reverts commit 8afb06a.

ebaauw marked this pull request as ready for review September 18, 2023 17:38

ebaauw added 2 commits September 21, 2023 22:04

Update vindstyrka_air_quality_sensor.json

8115d0b

Express units in ASCII.

Update vindstyrka_air_quality_sensor.json

1ae9837

ebaauw added a commit to ebaauw/homebridge-deconz that referenced this pull request Sep 23, 2023

Update AirQuality.js

4fd85b1

Support `measured_value`, see dresden-elektronik/deconz-rest-plugin#7246 and dresden-elektronik/deconz-rest-plugin#7248

Update vindstyrka_air_quality_sensor.json

0e42029

Remove deprecated mark on `state/temperature`.

manup merged commit 06dba02 into dresden-elektronik:master Sep 26, 2023
1 check failed

ebaauw deleted the vindstyrka branch September 26, 2023 22:20

ebaauw mentioned this pull request Oct 8, 2023

Ikea VindStyrka values of PM 2.5 no more provided #7284

Closed

2 tasks

dresden-elektronik locked as off-topic and limited conversation to collaborators Oct 11, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DDF for IKEA VINDSTYRKA #7246

DDF for IKEA VINDSTYRKA #7246

ebaauw commented Sep 17, 2023 •

edited

Loading

Zehir commented Sep 17, 2023

manup commented Sep 25, 2023

ebaauw commented Sep 25, 2023

LeoeLeoeL commented Oct 10, 2023

BabaIsYou commented Oct 10, 2023

ebaauw commented Oct 10, 2023

LeoeLeoeL commented Oct 10, 2023

BabaIsYou commented Oct 11, 2023

BabaIsYou commented Oct 11, 2023 •

edited

Loading

LeoeLeoeL commented Oct 11, 2023

BabaIsYou commented Oct 11, 2023

ebaauw commented Oct 11, 2023

BabaIsYou commented Oct 11, 2023 •

edited

Loading

ebaauw commented Oct 13, 2023

DDF for IKEA VINDSTYRKA #7246

DDF for IKEA VINDSTYRKA #7246

Conversation

ebaauw commented Sep 17, 2023 • edited Loading

ZHATemperature

ZHAHumidity

ZHAParticulateMatter

ZHAAirQuality

Zehir commented Sep 17, 2023

manup commented Sep 25, 2023

ebaauw commented Sep 25, 2023

LeoeLeoeL commented Oct 10, 2023

BabaIsYou commented Oct 10, 2023

ebaauw commented Oct 10, 2023

LeoeLeoeL commented Oct 10, 2023

BabaIsYou commented Oct 11, 2023

BabaIsYou commented Oct 11, 2023 • edited Loading

LeoeLeoeL commented Oct 11, 2023

BabaIsYou commented Oct 11, 2023

ebaauw commented Oct 11, 2023

BabaIsYou commented Oct 11, 2023 • edited Loading

ebaauw commented Oct 13, 2023

ebaauw commented Sep 17, 2023 •

edited

Loading

BabaIsYou commented Oct 11, 2023 •

edited

Loading

BabaIsYou commented Oct 11, 2023 •

edited

Loading