Skip to content
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

Compute US AQI and EPA AQI for PMS5003x sensors #22294

Closed
wants to merge 3 commits into from
Closed

Compute US AQI and EPA AQI for PMS5003x sensors #22294

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff1cf18
Compute US AQI and EPA AQI for PMS5003x sensors
thomashargrove Oct 14, 2024
5ee616a
respond to pr comments
thomashargrove Oct 14, 2024
a676102
Add european AQI
thomashargrove Oct 14, 2024
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
3 changes: 3 additions & 0 deletions tasmota/include/i18n.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1007,6 +1007,9 @@ const char HTTP_SNS_ENVIRONMENTAL_CONCENTRATION[] PROGMEM = "{s}%s " D_ENVIRON
const char HTTP_SNS_F_ENVIRONMENTAL_CONCENTRATION[] PROGMEM = "{s}%s " D_ENVIRONMENTAL_CONCENTRATION " %s " D_UNIT_MICROMETER "{m}%1_f " D_UNIT_MICROGRAM_PER_CUBIC_METER "{e}";
const char HTTP_SNS_PARTICALS_BEYOND[] PROGMEM = "{s}%s " D_PARTICALS_BEYOND " %s " D_UNIT_MICROMETER "{m}%d " D_UNIT_PARTS_PER_DECILITER "{e}";
const char HTTP_SNS_AVG_RAD_DOSE[] PROGMEM = "{s}%s " D_AVG_RAD_DOSE " %s " D_UNIT_MINUTE "{m}%d.%02d " D_UNIT_US_H "{e}";
const char HTTP_SNS_US_AQI[] PROGMEM = "{s}%s US AQI {m}%d{e}";
const char HTTP_SNS_US_EPA_AQI[] PROGMEM = "{s}%s US EPA AQI {m}%d{e}";
const char HTTP_SNS_EUROPEAN_AQI[] PROGMEM = "{s}%s European AQI {m}%s{e}";

const char HTTP_SNS_VOLTAGE[] PROGMEM = "{s}" D_VOLTAGE "{m}%s " D_UNIT_VOLT "{e}";
const char HTTP_SNS_CURRENT[] PROGMEM = "{s}" D_CURRENT "{m}%s " D_UNIT_AMPERE "{e}";
Expand Down
105 changes: 103 additions & 2 deletions tasmota/tasmota_xsns_sensor/xsns_18_pms5003.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,77 @@ void PmsInit(void) {
}
}

// This gives more accurate data for forest fire smoke. PurpleAir gives you this conversion option labeled "US EPA"
// https://cfpub.epa.gov/si/si_public_record_report.cfm?dirEntryId=353088&Lab=CEMM
/*
Copy-paste from the PDF Slide 26
y={0 ≤ x <30: 0.524*x - 0.0862*RH + 5.75}
y={30≤ x <50: (0.786*(x/20 - 3/2) + 0.524*(1 - (x/20 - 3/2)))*x -0.0862*RH + 5.75}
y={50 ≤ x <210: 0.786*x - 0.0862*RH + 5.75}
y={210 ≤ x <260: (0.69*(x/50 – 21/5) + 0.786*(1 - (x/50 – 21/5)))*x - 0.0862*RH*(1 - (x/50 – 21/5)) + 2.966*(x/50 – 21/5) + 5.75*(1 - (x/50 – 21/5)) + 8.84*(10^{-4})*x^{2}*(x/50 – 21/5)}
y={260 ≤ x: 2.966 + 0.69*x + 8.84*10^{-4}*x^2}

y= corrected PM2.5 µg/m3
x= PM2.5 cf_atm (lower)
RH= Relative humidity as measured by the PurpleAir
*/
int usaEpaStandardPm2d5Adjustment(int pm25_standard, int relative_humidity)
{
// Rename to use the same variables from the paper
float x = pm25_standard;
float RH = relative_humidity;
if (x<30) {
return 0.524f * x - 0.0862f * RH + 5.75f;
} else if(x<50) {
return (0.786f * (x/20.0f - 3.0f/2.0f) + 0.524f * (1.0f - (x/20.0f - 3.0f/2.0f))) * x - 0.0862f * RH + 5.75f;
} else if(x<210) {
return 0.786f * x - 0.0862f * RH + 5.75f;
} else if(x<260) {
return (0.69f * (x/50.0f - 21.0f/5.0f) + 0.786f * (1.0f - (x/50.0f - 21.0f/5.0f))) * x - 0.0862f * RH * (1.0f - (x/50.0f - 21.0f/5.0f)) + 2.966f * (x/50.0f - 21.0f/5.0f) + 5.75f * (1.0f - (x/50.0f - 21.0f/5.0f)) + 8.84f * FastPrecisePowf(10.0f, -4.0f) * FastPrecisePowf(x,2.0f) * (x/50.0f - 21.0f/5.0f);
} else {
return 2.966f + 0.69f * x + 8.84f * FastPrecisePowf(10.0f, -4.0f) * FastPrecisePowf(x, 2.0f);
}
}

// Compute US AQI using the 2024+ table
// https://forum.airnowtech.org/t/the-aqi-equation-2024-valid-beginning-may-6th-2024/453
int compute_us_aqi(int pm25_standard)
{
if (pm25_standard <= 9) {
return map_double(pm25_standard, 0, 9, 0, 50);
} else if (pm25_standard <= 35) {
return map_double(pm25_standard, 9.1f, 35.4f, 51, 100);
} else if (pm25_standard <= 55) {
return map_double(pm25_standard, 35.5f, 55.4f, 101, 150);
} else if (pm25_standard <= 125) {
return map_double(pm25_standard, 55.5f, 125.4f, 151, 200);
} else if (pm25_standard <= 225) {
return map_double(pm25_standard, 125.5f, 225.4f, 201, 300);
} else if (pm25_standard <= 325) {
return map_double(pm25_standard, 225.5f, 325.4f, 301, 500);
} else {
return 500;
}
}

// From https://www.eea.europa.eu/en/analysis/maps-and-charts/index
const char* compute_european_aqi(int pm25_standard)
{
if (pm25_standard <= 10) {
return "Good";
} else if (pm25_standard <= 20) {
return "Fair";
} else if (pm25_standard <= 25) {
return "Moderate";
} else if (pm25_standard <= 50) {
return "Poor";
} else if (pm25_standard <= 75) {
return "Very Poor";
} else {
return "Extremely Poor";
}
}

void PmsShow(bool json) {
if (Pms.valid) {
char types[10];
Expand All @@ -370,20 +441,42 @@ void PmsShow(bool json) {
#ifdef PMS_MODEL_PMS5003T
float temperature = ConvertTemp(pms_data.temperature10x/10.0);
float humidity = ConvertHumidity(pms_data.humidity10x/10.0);
int epa_us_aqi;
// When in Fahrenheit include US AQI
if (Settings->flag.temperature_conversion) {
epa_us_aqi = compute_us_aqi(usaEpaStandardPm2d5Adjustment(pms_data.pm25_standard, humidity));
}
#endif // PMS_MODEL_PMS5003T
int us_aqi;
const char* european_aqi;
// Use US AQI for Fahrenheit, EAQI (European Air Quality Index) for Celsius
if (Settings->flag.temperature_conversion) {
us_aqi = compute_us_aqi(pms_data.pm25_standard);
} else {
european_aqi = compute_european_aqi(pms_data.pm25_standard);
}

if (json) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This section of code was inconsistent with trailing commas. I changed it so each new json string we append starts with a comma and does not have a trailing comma

ResponseAppend_P(PSTR(",\"%s\":{\"CF1\":%d,\"CF2.5\":%d,\"CF10\":%d,\"PM1\":%d,\"PM2.5\":%d,\"PM10\":%d"),
types,
pms_data.pm10_standard, pms_data.pm25_standard, pms_data.pm100_standard,
pms_data.pm10_env, pms_data.pm25_env, pms_data.pm100_env);
if (Settings->flag.temperature_conversion) {
ResponseAppend_P(PSTR(",\"US_AQI\":%d"), us_aqi);
} else {
ResponseAppend_P(PSTR(",\"EAQI\":\"%s\""), european_aqi);
}
#if !(defined(PMS_MODEL_PMS3003) || defined(PMS_MODEL_ZH03X))
ResponseAppend_P(PSTR(",\"PB0.3\":%d,\"PB0.5\":%d,\"PB1\":%d,\"PB2.5\":%d,"),
ResponseAppend_P(PSTR(",\"PB0.3\":%d,\"PB0.5\":%d,\"PB1\":%d,\"PB2.5\":%d"),
pms_data.particles_03um, pms_data.particles_05um, pms_data.particles_10um, pms_data.particles_25um);
#ifdef PMS_MODEL_PMS5003T
ResponseAppend_P(PSTR(","));
ResponseAppendTHD(temperature, humidity);
if (Settings->flag.temperature_conversion) {
ResponseAppend_P(PSTR(",\"US_EPA_AQI\":%d"), epa_us_aqi);
}
#else
ResponseAppend_P(PSTR("\"PB5\":%d,\"PB10\":%d"),
ResponseAppend_P(PSTR(",\"PB5\":%d,\"PB10\":%d"),
pms_data.particles_50um, pms_data.particles_100um);
#endif // PMS_MODEL_PMS5003T
#endif // No PMS_MODEL_PMS3003
Expand All @@ -409,8 +502,16 @@ void PmsShow(bool json) {
WSContentSend_PD(HTTP_SNS_PARTICALS_BEYOND, types, "0.5", pms_data.particles_05um);
WSContentSend_PD(HTTP_SNS_PARTICALS_BEYOND, types, "1", pms_data.particles_10um);
WSContentSend_PD(HTTP_SNS_PARTICALS_BEYOND, types, "2.5", pms_data.particles_25um);
if (Settings->flag.temperature_conversion) {
WSContentSend_PD(HTTP_SNS_US_AQI, types, us_aqi);
} else {
WSContentSend_PD(HTTP_SNS_EUROPEAN_AQI, types, european_aqi);
}
#ifdef PMS_MODEL_PMS5003T
WSContentSend_THD(types, temperature, humidity);
if (Settings->flag.temperature_conversion) {
WSContentSend_PD(HTTP_SNS_US_EPA_AQI, types, epa_us_aqi);
}
#else
WSContentSend_PD(HTTP_SNS_PARTICALS_BEYOND, types, "5", pms_data.particles_50um);
WSContentSend_PD(HTTP_SNS_PARTICALS_BEYOND, types, "10", pms_data.particles_100um);
Expand Down