Skip to content
/ ha-jq300 Public
forked from Limych/ha-jq300

JQ-300 Indoor Air Quality Meter Home Assistant Integration

License

Notifications You must be signed in to change notification settings

pgp69/ha-jq300

 
 

Repository files navigation

Please ⭐ this repo if you find it useful

!!! Be careful! This is a BETA-version only. !!!

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

GitHub Release GitHub Activity License: CC BY-NC-SA 4.0 Requires.io

hacs Project Maintenance

GitHub pull requests Bugs

Community Forum

This component allows you to integrate JQ-300 Indoor Air Quality Meter into Home Assistant. And receive values of it sensors: 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.

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

Note:
It was discovered that there is no difference between the JQ-200 and JQ-300 models. Although the JQ-200 does not show PM2.5 sensor data in the official app, in fact this data is collected and transmitted from the cloud. Our component sees and displays them correctly. So you have the opportunity to save some money if you wish when purchasing.

Known Limitations and Issues

  • In some cases, the component may stop working.
    This is due to the fact that the authors of JQ-300 have recently begun to actively block attempts to receive data from their cloud bypassing the official application.
    There is only one way to fix it so far — to change the public IP address of your computer.

  • 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. Configure using the configuration instructions below.
  5. 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 in this repository.
  5. Extract all files from this archive you downloaded in the directory (folder) jq300 you created.
  6. Configure using the configuration instructions below.
  7. 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

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)
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.
Default value: all available devices

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

receive_hcho_in_ppb:
(boolean) (Optional)
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.
Default value: False

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:
  logs:
    custom_components.jq300: debug

... then restart HA.

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines

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.

License

creative commons Attribution-NonCommercial-ShareAlike 4.0 International License

See separate license file for full text.

About

JQ-300 Indoor Air Quality Meter Home Assistant Integration

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 94.3%
  • Shell 5.7%