Skip to content

[airq] Add support for mold and virus index #19446

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fwolter merged 13 commits into from
Oct 12, 2025
Merged

[airq] Add support for mold and virus index #19446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
2708aa8
Implemented collection of values for the virus and mold index (#19444)
nixoso Oct 5, 2025
dd6b5c9
Added new channel descriptions for mold and virus index (#19444)
nixoso Oct 5, 2025
f1a9a4b
Update documentation (#19444)
nixoso Oct 5, 2025
8361d99
Spotless check (#19444)
nixoso Oct 5, 2025
12a3087
Add translation for new properties (#19444)
nixoso Oct 5, 2025
80be499
[review] Changing channel names for better understanding. (#19444)
nixoso Oct 7, 2025
6c1fad8
[review] fix translation (#19444)
nixoso Oct 10, 2025
9ed881e
[fix] File does not end with a newline. (#19444)
nixoso Oct 10, 2025
7c4f353
[review] revert DE translation (#19444)
nixoso Oct 11, 2025
e1f4724
[review] Compound adjective should be capitalized (#19444)
nixoso Oct 11, 2025
e8758a0
[review] Description added for Virus-&Mold-Free MaxErr channel (#19444)
nixoso Oct 11, 2025
dfebdb7
[review] Spelling corrected in the README (#19444)
nixoso Oct 11, 2025
df7bdfd
[review] add translation for labels (#19444)
nixoso Oct 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions bundles/org.openhab.binding.airq/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ The rw column is empty if the channel is only readable, w if the channel can be
| temperature | Number:Temperature | | Temperature |
| timestamp | DateTime | | Timestamp of measurement |
| tvoc | Number:Dimensionless | | VOC concentration |
| virus-free | Number:Dimensionless | r | Virus-Free index in percent; the lower the index, the higher the potential virus risk. |
| mold-free | Number:Dimensionless | r | Mold-Free index in percent; the lower the index, the higher the potential mold risk. |
| uptime | Number:Time | | uptime in seconds |
| wifi | Switch | | WLAN on or off |
| ssid | String | | WLAN SSID |
Expand Down Expand Up @@ -168,6 +170,8 @@ Number:Temperature airQ_temperature "Temperature"
DateTime airQ_timestamp "TimeStamp [%1$td.%1$tm.%1$tY %1$tH:%1$tM]" {channel="airq:airq:1:timestamp"}
Number:Dimensionless airQ_voc "VOC concentration" {channel="airq:airq:1:tvoc"}
Number:Time airQ_uptime "Uptime" {channel="airq:airq:1:uptime"}
Number:Dimensionless airQ_Virus_free "Virus-Free index" {unit="%",channel="airq:airq:1:virus_free"}
Number:Dimensionless airQ_Mold_free "Mold-Free index" {unit="%",channel="airq:airq:1:mold_free"}

Number:Dimensionless airQ_cnt03_maxerr "Maximum error of Fine Dust >0,3 µm" {channel="airq:airq:1:cnt0_3_maxerr"}
Number:Dimensionless airQ_cnt05_maxerr "Maximum error of Fine Dust >0,5 µm" {channel="airq:airq:1:cnt0_5_maxerr"}
Expand All @@ -190,6 +194,8 @@ Number:Dimensionless airQ_so2_maxerr "Maximum error of SO2 concentrati
Number:Dimensionless airQ_sound_maxerr "Maximum error of Noise" {channel="airq:airq:1:sound_maxerr"}
Number:Dimensionless airQ_temperature_maxerr "Maximum error of Temperature" {channel="airq:airq:1:temperature_maxerr"}
Number:Dimensionless airQ_voc_maxerr "Maximum error of VOC concentration" {channel="airq:airq:1:tvoc_maxerr"}
Number:Dimensionless airQ_virus_free_maxerr "Maximum error of Virus-Free" {unit="%",channel="airq:airq:1:virus_free_maxerr"}
Number:Dimensionless airQ_mold_free_maxerr "Maximum error of Mold-Free" {unit="%",channel="airq:airq:1:mold_free_maxerr"}

Switch airQ_wifi "WLAN on or off" {channel="airq:airq:1:wifi"}
String airQ_SSID "WLAN SSID" {channel="airq:airq:1:ssid"}
Expand Down
2 changes: 2 additions & 0 deletions ...org.openhab.binding.airq/src/main/java/org/openhab/binding/airq/internal/AirqHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -496,6 +496,8 @@ public void pollData() {
processType(decObj, "timestamp", "timestamp", "datetime");
processType(decObj, "uptime", "uptime", "numberTimePeriod");
processType(decObj, "tvoc", "tvoc", "pairPPB");
processType(decObj, "virus", "virus_free", "pair");
processType(decObj, "mold", "mold_free", "pair");

updateStatus(ThingStatus.ONLINE);
} catch (JsonSyntaxException e) {
Expand Down
6 changes: 6 additions & 0 deletions bundles/org.openhab.binding.airq/src/main/resources/OH-INF/i18n/airq.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,9 @@ channel-type.airq.humidity.label = Humidity
channel-type.airq.humidity_abs.label = Absolute Humidity
channel-type.airq.humidity_abs_maxerr.label = Max. Error Abs. Humidity
channel-type.airq.humidity_maxerr.label = Max. Error Humidity
channel-type.airq.mold_free.label = Mold-Free Index
channel-type.airq.mold_free_maxerr.label = Max. Error Mold-Free
channel-type.airq.mold_free_maxerr.description = Maximum tolerated error in the Mold-Free Index measurement.
channel-type.airq.mtime.label = Time Needed for Measurement
channel-type.airq.nightmodeBrightnessDay.label = Day Brightness of LED
channel-type.airq.nightmodeBrightnessNight.label = Night Brightness of LED
Expand Down Expand Up @@ -113,3 +116,6 @@ channel-type.airq.tvoc_maxerr.label = Max. Error VOC Conc.
channel-type.airq.typps.label = Average Size of Fine Dust
channel-type.airq.uptime.label = Uptime
channel-type.airq.usercalib.label = Last Sensor Calibration
channel-type.airq.virus_free.label = Virus-Free Index
channel-type.airq.virus_free_maxerr.label = Max. Error Virus-Free
channel-type.airq.virus_free_maxerr.description = Maximum tolerated error in the Virus-Free Index measurement.
32 changes: 31 additions & 1 deletion bundles/org.openhab.binding.airq/src/main/resources/OH-INF/thing/thing-types.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@
<channel id="timestamp" typeId="timestamp"/>
<channel id="tvoc" typeId="tvoc"/>
<channel id="uptime" typeId="uptime"/>
<channel id="virus_free" typeId="virus_free"/>
<channel id="mold_free" typeId="mold_free"/>

<!-- Maximum error -->
<channel id="fineDustCnt00_3_maxerr" typeId="cnt0_3_maxerr"/>
Expand All @@ -71,6 +73,8 @@
<channel id="sound_maxerr" typeId="sound_maxerr"/>
<channel id="temperature_maxerr" typeId="temperature_maxerr"/>
<channel id="tvoc_maxerr" typeId="tvoc_maxerr"/>
<channel id="virus_free_maxerr" typeId="virus_free_maxerr"/>
<channel id="mold_free_maxerr" typeId="mold_free_maxerr"/>
Comment on lines +76 to +77
Copy link
Contributor

@lsiepel lsiepel Oct 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These two are not added to the readme, not needed?

Copy link
Contributor Author

@nixoso nixoso Oct 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Until now, the MaxErr channels were not explicitly listed.
@fwolter, should I add them?

Copy link
Member

@fwolter fwolter Oct 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not, PR welcome :) Right of the bat, I couldn't find any documentation what exactly the max error value means. I assume it is the tolerance to be expected under the current environmental conditions.


<!-- configuration data -->
<channel id="wifi" typeId="Wifi"/>
Expand Down Expand Up @@ -120,7 +124,7 @@
<property name="sensorList">Unknown sensor list</property>
<property name="sensorInfo">No info about sensors</property>
<property name="industry">No industry info</property>
<property name="thingTypeVersion">2</property>
<property name="thingTypeVersion">3</property>
</properties>

<config-description>
Expand Down Expand Up @@ -348,6 +352,18 @@
<state readOnly="true" pattern="%d %unit%"></state>
</channel-type>

<channel-type id="virus_free" advanced="false">
<item-type unitHint="%">Number:Dimensionless</item-type>
<label>Virus-Free Index</label>
<state readOnly="true" pattern="%.2f %unit%"></state>
</channel-type>

<channel-type id="mold_free" advanced="false">
<item-type unitHint="%">Number:Dimensionless</item-type>
<label>Mold-Free Index</label>
<state readOnly="true" pattern="%.2f %unit%"></state>
</channel-type>

<!-- Maximum error -->
<channel-type id="cnt0_3_maxerr" advanced="true">
<item-type>Number:Dimensionless</item-type>
Expand Down Expand Up @@ -487,6 +503,20 @@
<state readOnly="true" pattern="± %.2f %%"></state>
</channel-type>

<channel-type id="virus_free_maxerr" advanced="true">
<item-type unitHint="%">Number:Dimensionless</item-type>
<label>Max. Error Virus-Free</label>
<description>Maximum tolerated error in the Virus-Free Index measurement.</description>
<state readOnly="true" pattern="± %.2f %%"></state>
</channel-type>

<channel-type id="mold_free_maxerr" advanced="true">
<item-type unitHint="%">Number:Dimensionless</item-type>
<label>Max. Error Mold-Free</label>
<description>Maximum tolerated error in the Mold-Free Index measurement.</description>
<state readOnly="true" pattern="± %.2f %%"></state>
</channel-type>

<!-- settings -->

<channel-type id="Wifi" advanced="true">
Expand Down
20 changes: 20 additions & 0 deletions bundles/org.openhab.binding.airq/src/main/resources/OH-INF/update/update.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,26 @@
<label>Fine Dust Count 10μm</label>
</update-channel>
</instruction-set>
<instruction-set targetVersion="3">
<add-channel id="virus_free">
<type>airq:virus_free</type>
<label>Virus-Free Index</label>
</add-channel>
<add-channel id="virus_free_maxerr">
<type>airq:virus-free_maxerr</type>
<label>Max. Error Virus-Free</label>
<description>Maximum tolerated error in the Virus-Free Index measurement.</description>
</add-channel>
<add-channel id="mold_free">
<type>airq:mold_free</type>
<label>Mold-Free Index</label>
</add-channel>
<add-channel id="mold_free_maxerr">
<type>airq:mold_free_maxerr</type>
<label>Max. Error Mold-Free</label>
<description>Maximum tolerated error in the Mold-Free Index measurement.</description>
</add-channel>
</instruction-set>
</thing-type>

</update:update-descriptions>