pm1006: add rx-only support #2038

Habbie · 2021-07-19T19:25:38Z

What does this implement/fix?

This adds ESPHome support for the IKEA VINDRIKTNING. Some inspiration taken from https://github.com/Hypfer/esp8266-vindriktning-particle-sensor

The implementation is heavily based on the existing SDS011 implementation - mostly the parser is different.

Types of changes

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Other

Related issue or feature (if applicable): none

Pull request in esphome-docs with documentation (if applicable): esphome/esphome-docs#1315

Test Environment

ESP32
ESP8266

Example entry for `config.yaml`:

uart:
  rx_pin: D2
  baud_rate: 9600

sensor:
  - platform: pm1006
    pm_2_5:
      name: "Particulate Matter <2.5µm"

Checklist:

The code change is tested and works locally.
Tests have been added to verify that the new code works (under tests/ folder).

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in esphome-docs.

oxan

This adds ESPHome support for the IKEA VINDRIKTNING.

Ikea keeps coming up with more and more unpronouncable names 😆

esphome/components/pm1006/pm1006.cpp

esphome/components/pm1006/pm1006.h

Habbie · 2021-07-19T20:15:53Z

Ikea keeps coming up with more and more unpronouncable names laughing

I was going to say that as a European I can mostly cope - but you and I live in the same country :D

Thank you for your comments - I believe I have addressed them all (except possibly CI complaining about formatting, but we'll see).

Habbie · 2021-07-19T21:08:58Z

I believe I have addressed them all

and now I actually pushed this.

oxan

check_byte_() has a somewhat peculiar convention for the return value, but it's fine I guess.

Habbie · 2021-07-20T16:52:39Z

check_byte_() has a somewhat peculiar convention for the return value, but it's fine I guess.

I was just answering a question about that from somebody else. I agree it's peculiar - as I said earlier, I stole most of the code from sds011. I'm now tempted to redo some things -less- in the style of sds011, as I suspect that will improve the code quality.

Habbie · 2021-07-20T18:49:01Z

I'm now tempted to redo some things -less- in the style of sds011, as I suspect that will improve the code quality.

I've pondered this some more, and I think it makes sense to me to merge this as-is (assuming a maintainer agrees), and then later I can go over this one, and SDS011, and any others with the same weird code patterns, in one go.

AbeltjeNL · 2021-07-20T20:48:28Z

Keep up the good work @Habbie!! Just bought one of these s*ckers today at IKEA and mounted it to my ESP8266. Would very much like to get this working. If I can help out testing, please mention me :)

Habbie · 2021-07-21T20:49:55Z

Keep up the good work @Habbie!! Just bought one of these s*ckers today at IKEA and mounted it to my ESP8266. Would very much like to get this working. If I can help out testing, please mention me :)

Hi Abeltje, testing would be very welcome, of course. Functionally, this PR is done. Perhaps the question is what I can do to help you test? I'm on the ESPHome Discord at https://discord.gg/KhAMKrd

GSzabados · 2021-07-22T07:58:58Z

Functionally, this PR is done.

The question is really, when is this PR going to be merged?! ;)

lassebm · 2021-07-22T16:16:24Z

I've tested this driver/component with an IKEA Vindriktning air quality monitor and ESP8266, works like a charm, thanks! 🎉 Fetched just the pm1006 component from the PR branch with external_components.

AbeltjeNL · 2021-07-22T17:46:52Z

Same here. Works like a charm! 👌🏻

lassebm · 2021-07-22T18:02:21Z

As inspiration for others considering this driver for the awesome IKEA Vindriktning hack. I used an old ESP8266 NodeMCU v2 from the drawer and connected it all up as listed below.

IKEA Vindriktning	NodeMCU pin	Note
PCB +5V pad	VIN	NodeMCU v2 support 5-10V
PCB GND pad	GND
PCB REST pad	D2	UART TX from PM1006 sensor
Fan +5V (red wire)	3V3	Fan will run constantly and quietly
Fan GND (black wire)	GND

Example YAML (ESPHome >= 2021.8.0 required):

uart:
  rx_pin: D2
  baud_rate: 9600

sensor:
  - platform: pm1006
    pm_2_5:
      name: "IKEA Vindriktning PM2.5 sensor"

A few potato photos taken just before final assembly:

GSzabados · 2021-07-22T18:05:49Z

@lassebm, thanks for sharing. I've just finished the soldering and realised that the possible 4 pin connector at the end of the board would make things far more easier, but unfortunately IKEA hasn't fitted that.

Habbie · 2021-07-22T19:29:16Z

I have now also tested this with ESP32, and it works there too.

AbeltjeNL · 2021-07-22T20:36:44Z

@lassebm, thanks for sharing. I've just finished the soldering and realised that the possible 4 pin connector at the end of the board would make things far more easier, but unfortunately IKEA hasn't fitted that.

I soldered my connections to these connector pins. Works fine 👌🏻

AbeltjeNL · 2021-07-22T20:38:15Z

I'll try to make some less potatoe pictures this weekend.

sermayoral · 2021-07-22T20:52:53Z

I have now also tested this with ESP32, and it works there too.

I wanted to test this, but you did first 😃.

Can you use any esp32 gpio, or it should be the rx esp32 gpio?

Thanks for everything

sermayoral · 2021-07-22T21:00:53Z

I wanna test if i can use the output fan of the Ikea pcb applying 2 resistors to reduce the 5V to 3.3V. In that way the fan wouldn't work all the time

https://i1.wp.com/randomnerdtutorials.com/wp-content/uploads/2015/09/voltage-divider-circuit.png?resize=408%2C151&quality=100&strip=all&ssl=1

AbeltjeNL · 2021-07-22T21:06:43Z

I wanna test if i can use the output fan applying 2 resistors to reduce the 5V to 3.3V. In that way the fan wouldn't work all the time

https://i1.wp.com/randomnerdtutorials.com/wp-content/uploads/2015/09/voltage-divider-circuit.png?resize=408%2C151&quality=100&strip=all&ssl=1

The fan @ 5V is hardly noticeable. It doesn't spin all day and frankly, i didn't modify it but I don't hear it either..

sermayoral · 2021-07-22T21:10:01Z

I wanna test if i can use the output fan applying 2 resistors to reduce the 5V to 3.3V. In that way the fan wouldn't work all the time
https://i1.wp.com/randomnerdtutorials.com/wp-content/uploads/2015/09/voltage-divider-circuit.png?resize=408%2C151&quality=100&strip=all&ssl=1

The fan @ 5V is hardly noticeable. It doesn't spin all day and frankly, i didn't modify it but I don't hear it either..

Mmm. Does it not disturb you? Its a bit annoying

GSzabados · 2021-07-22T21:14:16Z

Mmm. Does it not disturb you? Its a bit annoying

My notebook's fan louder than the one inside the device. Where are you using that you can notice the fan?

sermayoral · 2021-07-22T21:15:09Z

Mmm. Does it not disturb you? Its a bit annoying

My notebook's fan louder than the one inside the device. Where are you using that you can notice the fan?

In my bedroom 😭

GSzabados · 2021-07-22T21:19:10Z

In my bedroom

Sorry for that... I have an old winding clock which ticks quite loud (and hits half and full hours), during summer a fan type mosquito trap running all night as well, plus the air purifier. All just creates white noise... And that one is good for sleeping.

sermayoral · 2021-07-23T22:13:26Z

An ESP32 with a big antenna to read all the ble termometers in the house as well

I think i'm going to search for another white and smaller antenna 😅

oxan · 2021-07-23T23:29:06Z

Everybody, please take the show-off and discussion of your builds somewhere else (such as a discussion, Discord or the HA forums), so that we can keep this PR focused on the code. Having to scroll through 50 off-topic comments and lots of images doesn't help to get a quick review ;)

sermayoral · 2021-07-24T12:56:33Z

Is there a bug with the last icon uploaded? I have tried to compile a firmware using esphome release branch and the pm1006 as external component, but i get this error:

INFO Reading configuration /config/esphome/aire.yaml...
ERROR Unable to import component pm1006.sensor:
Traceback (most recent call last):
  File "/opt/esphome/esphome/loader.py", line 163, in _lookup_module
    module = importlib.import_module(f"esphome.components.{domain}")
  File "/usr/lib/python3.7/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1006, in _gcd_import
  File "<frozen importlib._bootstrap>", line 983, in _find_and_load
  File "<frozen importlib._bootstrap>", line 967, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 677, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 728, in exec_module
  File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
  File "/config/esphome/.esphome/external_components/d4f73862/esphome/components/pm1006/sensor.py", line 4, in <module>
    from esphome.const import (
ImportError: cannot import name 'ICON_BLUR' from 'esphome.const' (/opt/esphome/esphome/const.py)
Failed config

sensor.pm1006: [source /config/esphome/aire.yaml:44]
  
  Platform not found: 'sensor.pm1006'.
  platform: pm1006
  pm_2_5: 
    name: IKEA Vindriktning PM2.5 sensor

oxan · 2021-07-24T12:59:17Z

@sermayoral This happens because this PR also adds the icon to the ESPHome core, so the PR branch can't be used as an external component.

sermayoral · 2021-07-24T13:15:04Z

@sermayoral This happens because this PR also adds the icon to the ESPHome core, so the PR branch can't be used as an external component.

Thanks @oxan. I have forked the PR branch changing the missing icon in order to use the pm1006 component as external component until it can be merged:

external_components:
  - source: github://sermayoral/esphome@pm1006
    components: [ pm1006 ]

Habbie · 2021-07-24T13:24:23Z

Oops, sorry about that!

…

On Sat, Jul 24, 2021, at 14:59, Oxan van Leeuwen wrote: @sermayoral <https://github.com/sermayoral> This happens because this PR also adds the icon to the ESPHome core, so the PR branch can't be used as an external component. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2038 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAEAMDUS6UATYSHM2VGIYPTTZK2LBANCNFSM5AUKJPSA>.

-- Peter van Dijk ***@***.***

sermayoral · 2021-07-24T13:34:48Z

Oops, sorry about that!
…
On Sat, Jul 24, 2021, at 14:59, Oxan van Leeuwen wrote: @sermayoral https://github.com/sermayoral This happens because this PR also adds the icon to the ESPHome core, so the PR branch can't be used as an external component. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#2038 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAEAMDUS6UATYSHM2VGIYPTTZK2LBANCNFSM5AUKJPSA.
-- Peter van Dijk @.***

Don't worry, minor solved problem, and thanks for your work!!

GSzabados · 2021-07-25T12:34:05Z

or the HA forums

I've created a topic in the HA forum referencing this PR.

https://community.home-assistant.io/t/ikea-vindriktning-air-quality-sensor/324599

@Habbie - if you do have a HA forum account, can you please just post there a comment and I will update the tag?
@lassebm - the same for you as for Habbie, but can you please share your your pictures and instructions as well?
@sermayoral, @AbeltjeNL - can you share your project pictures in the topic please?

OttoWinter

LGTM 👍 I haven't read through the entire thread, but this integration is ready to go right?

sermayoral · 2021-07-26T09:03:27Z

LGTM 👍 I haven't read through the entire thread, but this integration is ready to go right?

Hi @OttoWinter, this PR ir ready to merge, but the Doc PR should change the IMG to avoid using the IKEA one due to copyrights

nohn · 2021-07-26T10:01:08Z

Hi @OttoWinter, this PR ir ready to merge, but the Doc PR should change the IMG to avoid using the IKEA one due to copyrights

Habbie/esphome-docs#1 should fix that issue.

Habbie · 2021-07-26T14:51:14Z

Habbie/esphome-docs#1 should fix that issue.

merged, thanks!

nohn · 2021-07-27T15:50:06Z

Anything else that needs to be done to get this merged?

nohn · 2021-07-27T17:27:33Z

Example YAML using the pm1006 driver from the PR feature branch until merged upstream:

ImportError: cannot import name 'ICON_BLUR' from 'esphome.const' (/opt/esphome/esphome/const.py)

I can confirm this.

sermayoral · 2021-07-27T18:32:26Z

@sermayoral This happens because this PR also adds the icon to the ESPHome core, so the PR branch can't be used as an external component.

Thanks @oxan. I have forked the PR branch changing the missing icon in order to use the pm1006 component as external component until it can be merged:
external_components:
  - source: github://sermayoral/esphome@pm1006
    components: [ pm1006 ]

@nohn use my branch until this PR is merged

marcos-acpc · 2021-08-01T05:02:51Z

Hi, quick question I seen online that this sensor can read more than 2.5 PM and can at least read 1PM and 10 PM. Are you guys integrating the later 2 readings or just staying with single 2.5 PM? Found this in case it helps for anything: https://github.com/bertrik/pm1006k.

GSzabados · 2021-08-01T06:42:41Z

Hi, quick question I seen online that this sensor can read more than 2.5 PM

It is a PM1006 sensor and NOT the PM1006K.

http://www.jdscompany.co.kr/download.asp?gubun=07&filename=PM1006_LED_PARTICLE_SENSOR_MODULE_SPECIFICATIONS.pdf

marcos-acpc · 2021-08-02T05:39:47Z

@GSzabados Hi I got it but on the pdf you sent it states sizes between 0.3μm to 10μm. But yeh.. I might look for a different and more complete. sensor. Thanks anyway.

juha63 · 2021-08-04T15:31:48Z

@Habbie I think you shouldn't name this hack PM1006. Your implementation only works if you connect the ESP to the VENDRIKTNING pcb. If you connect it to the PM1006 directly, which has RX/TX UART, you won't get any measurements without first sending the right command. See: http://www.jdscompany.co.kr/download.asp?gubun=07&filename=PM1006_LED_PARTICLE_SENSOR_MODULE_SPECIFICATIONS.pdf

Habbie · 2021-08-04T16:42:50Z

That's correct. I modeled it like the SDS011 driver, which can operate on RX/TX mode, or in RX-only mode. As I was unable to test RX/TX mode, I only implemented RX-only mode, and for now we don't have a flag to choose - as there is no code RX/TX mode. I fully trust that somebody, perhaps me, will contribute TX/RX support soon, to the same component. It seemed pointless to me to -not- call this one pm1006 if it's going to mostly have the same code as a full pm1006 component.

(Also, it's a bit late, it's already merged).

probot-esphome bot added new-component component: pm1006 labels Jul 19, 2021

Habbie mentioned this pull request Jul 19, 2021

docs for pm1006 component esphome/esphome-docs#1315

Merged

2 tasks

oxan requested changes Jul 19, 2021

View reviewed changes

Habbie mentioned this pull request Jul 19, 2021

reading calculation appears to be wrong Hypfer/esp8266-vindriktning-particle-sensor#3

Closed

oxan approved these changes Jul 20, 2021

View reviewed changes

oxan added the needs-tests label Jul 22, 2021

probot-esphome bot added the has-tests label Jul 22, 2021

oxan removed the needs-tests label Jul 22, 2021

Habbie force-pushed the pm1006 branch from 9f0cd4e to e52c5eb Compare July 23, 2021 17:45

probot-esphome bot added core and removed has-tests labels Jul 23, 2021

OttoWinter approved these changes Jul 26, 2021

View reviewed changes

OttoWinter merged commit f97cfe9 into esphome:dev Jul 28, 2021

Habbie deleted the pm1006 branch July 28, 2021 11:07

This was referenced Aug 11, 2021

1.21.0b1 #2144

Merged

1.21.0b1 esphome/esphome-docs#1383

Merged

matrob mentioned this pull request Aug 16, 2021

Temperature and Humidity Hypfer/esp8266-vindriktning-particle-sensor#1

Closed

jesserockz mentioned this pull request Aug 18, 2021

2021.8.0 #2176

Merged

github-actions bot locked and limited conversation to collaborators Sep 14, 2021

Uh oh!

pm1006: add rx-only support #2038

pm1006: add rx-only support #2038

Conversation

Habbie commented Jul 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this implement/fix?

Types of changes

Test Environment

Example entry for config.yaml:

Checklist:

Uh oh!

oxan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Habbie commented Jul 19, 2021

Uh oh!

Habbie commented Jul 19, 2021

Uh oh!

oxan left a comment

Choose a reason for hiding this comment

Uh oh!

Habbie commented Jul 20, 2021

Uh oh!

Habbie commented Jul 20, 2021

Uh oh!

AbeltjeNL commented Jul 20, 2021

Uh oh!

Habbie commented Jul 21, 2021

Uh oh!

GSzabados commented Jul 22, 2021

Uh oh!

lassebm commented Jul 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AbeltjeNL commented Jul 22, 2021

Uh oh!

lassebm commented Jul 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GSzabados commented Jul 22, 2021

Uh oh!

Habbie commented Jul 22, 2021

Uh oh!

AbeltjeNL commented Jul 22, 2021

Uh oh!

AbeltjeNL commented Jul 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sermayoral commented Jul 22, 2021

Uh oh!

sermayoral commented Jul 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AbeltjeNL commented Jul 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sermayoral commented Jul 22, 2021

Uh oh!

GSzabados commented Jul 22, 2021

Uh oh!

sermayoral commented Jul 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GSzabados commented Jul 22, 2021

Uh oh!

sermayoral commented Jul 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oxan commented Jul 23, 2021

Uh oh!

sermayoral commented Jul 24, 2021

Uh oh!

oxan commented Jul 24, 2021

Uh oh!

Habbie commented Jul 19, 2021 •

edited

Loading

Example entry for `config.yaml`:

lassebm commented Jul 22, 2021 •

edited

Loading

lassebm commented Jul 22, 2021 •

edited

Loading

AbeltjeNL commented Jul 22, 2021 •

edited

Loading

sermayoral commented Jul 22, 2021 •

edited

Loading

AbeltjeNL commented Jul 22, 2021 •

edited

Loading

sermayoral commented Jul 22, 2021 •

edited

Loading

sermayoral commented Jul 23, 2021 •

edited

Loading

sermayoral commented Jul 24, 2021 •

edited

Loading

sermayoral commented Jul 27, 2021 •

edited

Loading