Skip to content

Commit 2fff705

Browse files
authored
Revise README for features and configuration updates
Updated features and configuration details in README.
1 parent 65f5b93 commit 2fff705

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ This custom component integrates the Qingping Air Quality Monitors [CGS1/CGS2/CG
1616

1717
- Automatic discovery of Qingping CGS1/CGS2/CGDN1 devices
1818
- Real-time updates of air quality data
19-
- Configurable temperature and humidity offsets
19+
- Configurable offsets
20+
- Configuration entites
2021
- Adjustable update interval
2122
- Automatic unit conversion for temperature
2223
- Device status monitoring
@@ -39,15 +40,15 @@ This custom component integrates the Qingping Air Quality Monitors [CGS1/CGS2/CG
3940
5. Search for "Qingping Pro AQM" and follow the configuration steps
4041

4142
## Configuration
42-
<img src="https://github.com/user-attachments/assets/3cc92957-3460-4ba4-b78f-17afab455f40" alt="Device Discovery" width="250" align="left">
43+
<img src="https://github.com/user-attachments/assets/a123e039-7ada-4062-a5aa-f2c7b2d20085" alt="Device Discovery" width="250" align="left">
4344
The integration supports automatic discovery of Qingping CGS1/CGS2/CGDN1 devices.
4445
<br />If your device is not discovered automatically, you can add it manually by providing the MAC address.
4546
<br />⚠️ Do not include : in your MAC address. example: 532D38701E1F
4647
<br /><br /><br /><br /><br /><br /><br /><br /><br /><br /><br />
4748

4849

4950
## How it Works
50-
<img src="https://github.com/user-attachments/assets/46567747-a8cb-443e-be23-78a87e741a42" alt="Device Discovery" width="275" align="right">
51+
<img src="https://github.com/user-attachments/assets/55a42477-59a7-48b6-b70b-f743c5e2a69a" alt="Device Discovery" width="275" align="right">
5152

5253
1. **Device Discovery**: The integration uses MQTT to discover Qingping CGS1/CGS2/CGDN1 devices on your network. It listens for messages on the MQTT topic `qingping/#` to identify available devices.
5354

@@ -62,6 +63,19 @@ The integration supports automatic discovery of Qingping CGS1/CGS2/CGDN1 devices
6263
- TVOC (ppb, ppm and mg/m³) `Only on CGS1`
6364
- eTVOC (ppb, VOC index and mg/m³) `Only on CGS2`
6465
- Noise level `Only on CGS2`
66+
- Temp & Humidity Offsets
67+
- PM2.5 Offsets
68+
- PM10 Offsets
69+
- TVOC Offsets `Only on CGS1`
70+
- eTVOC Offsets `Only on CGS2`
71+
- CO2 Offsets
72+
- Auto Sliding `Only on CGDN1`
73+
- Auto CO2 Calibration `Only on CGDN1`
74+
- Manual Calibration `Only on CGDN1`
75+
- Night Mode `Only on CGDN1`
76+
- Power Off Time `Only on CGDN1`
77+
- Screensaver `Only on CGDN1`
78+
- Timezone `Only on CGDN1`
6579
- Battery level
6680
- Device status (online/offline)
6781
- Firmware version
@@ -70,15 +84,15 @@ The integration supports automatic discovery of Qingping CGS1/CGS2/CGDN1 devices
7084

7185
4. **TVOC Sensor**: The sensor can be set to 3 different measurement units, by default it is ppb. The component converts from ppb to get ppm and mg/m³.
7286
- ppm = ppb/1000
73-
- mg/m³ = ppb/1000 * 0.0409 * 111.1 (concentration (ppm) x 0.0409 x molecular weight)<br />
87+
- mg/m³ = ppb/218.77<br />
7488

7589
**eTVOC Sensor**: The sensor can be set to 3 different measurement units, by default it is VOC index. The component converts from voc index to get ppb and mg/m³.
76-
- ppb = (index * 5) + 35
77-
- mg/m³ = (index * 0.023) + 0.124
90+
- ppb = (math.log(501-voc_index) - 6.24) * -2215.4
91+
- mg/m³ = (ppb*4.5*10 + 5) / 10 / 1000
7892

7993
5. **Data Updates**: The component subscribes to MQTT messages from the device. When new data is received, it updates the relevant sensors in Home Assistant.
8094

81-
6. **Offset Adjustments**: The integration allows you to set offset values for temperature and humidity readings. These offsets are applied to the raw sensor data before it's displayed in Home Assistant.
95+
6. **Offset Adjustments**: The integration allows you to set offset values for sesor readings. These offsets are applied to the device before it's displayed in Home Assistant.
8296

8397
7. **Update Interval**: You can configure how often the device should report new data. This is done through a number entity that allows you to set the update interval in seconds.
8498

0 commit comments

Comments
 (0)