Skip to content

Latest commit

 

History

History
187 lines (141 loc) · 7.92 KB

README.md

File metadata and controls

187 lines (141 loc) · 7.92 KB
Raw

Please ⭐ this repo if you find it useful

Home Assistant Integration of JQ-300/200/100 Indoor Air Quality Meter

GitHub Release GitHub Activity License

hacs Project Maintenance Support me on Patreon

Community Forum

Integration JQ-300 Indoor Air Quality Meter into Home Assistant. From this device you can receive values of TVOC (volatile organic compounds), eCO2 (carbon dioxide), HCHO (formaldehyde), humidity and PM 2.5 (ultrafine particles).

I also suggest you visit the support topic on the community forum.

logo

Thanks to tomaae for the financial support in purchasing the device for creating this project.

Known Limitations and Issues

  • Only one application can be logged into an cloud account at a time.
    Therefore, each time restarted HA, authorization from the official application on your phone will be lost. Authorization is restored when you restart the official application.

Installation

HACS - Recommended

  1. Have HACS installed, this will allow you to easily manage and track updates.
  2. Search for "JQ-300/200/100 Indoor Air Quality Meter".
  3. Click Install below the found integration.
  4. (Not implemented for now, sorry) If you want to configure component via Home Assistant UI...
    in the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Jq300".
  5. If you want to configure component via configuration.yaml...
    follow instructions below, then restart Home Assistant.

Manual

  1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called jq300.
  4. Download file jq300.zip from the [latest release section][latest-release] in this repository.
  5. Extract all files from this archive you downloaded in the directory (folder) jq300 you created.
  6. (Not implemented for now, sorry) If you want to configure component via Home Assistant UI...
    in the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Jq300".
  7. If you want to configure component via configuration.yaml...
    follow instructions below, then restart Home Assistant.

* * *

I put a lot of work into making this repo and component available and updated to inspire and help others! I will be glad to receive thanks from you — it will give me new strength and add enthusiasm:


Patreon
or support via Bitcoin or Etherium:
Bitcoin
16yfCfz9dZ8y8yuSwBFVfiAa3CNYdMh7Ts

Usage

To use this component in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
jq300:
  username: YOUR_EMAIL
  password: YOUR_PASSWORD

example

Note:
Before using the devices you need to connect them to your account through the official app.

Only one application can be logged into an account at a time. Therefore, each time restarted this integration, authorization from the official application on your phone will be lost. Authorization is restored when you restart the official application.

We recommend using the IAQ UK sensor to evaluate overall air quality. Example configuration:

# Example configuration.yaml entry
jq300:
  username: YOUR_EMAIL
  password: YOUR_PASSWORD
  devices:
    - Kitchen
iaquk:
  Kitchen:
    sources:
      humidity: sensor.kitchen_humidity
      co2: sensor.kitchen_eco2
      tvoc: sensor.kitchen_tvoc
      hcho: sensor.kitchen_hcho
      pm: sensor.kitchen_pm25

Configuration variables

username:
(string) (Required)
The username for accessing your account.

password:
(string) (Required)
The password for accessing your account.

devices:
(list) (Optional) (Default value: all available devices)
List of names of devices to add to Home Assistant.
For each device, all sensors are created, which are possible:
for all devices: TVOC, HCHO (Formaldehyde) and eCO2;
for JQ-200 and JQ-300 only: internal temperature and humidity;
for JQ-300 only: PM 2.5.

receive_tvoc_in_ppb:
(boolean) (Optional) (Default value: False)
By default, the cloud returns the TVOC value in mg/m³ units. Setting this parameter to True allows to receive data in ppb units.

receive_hcho_in_ppb:
(boolean) (Optional) (Default value: False)
By default, the cloud returns the HCHO (formaldehyde) value in mg/m³ units. Setting this parameter to True allows to receive data in ppb units.

Track updates

You can automatically track new versions of this component and update it by HACS.

Troubleshooting

To enable debug logs use this configuration:

# Example configuration.yaml entry
logger:
  default: info
  logs:
    custom_components.jq300: debug

... then restart HA.

Contributions are welcome!

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

The original setup of this component is by Andrey "Limych" Khrolenok.

For a full list of all authors and contributors, check the contributor's page.

This Home Assistant custom component was created and is updated using the HA-Blueprint template. You can use this template to maintain your own Home Assistant custom components.

License

creative commons Attribution-NonCommercial-ShareAlike 4.0 International License

See separate license file for full text.