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.

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

Rename AirGradient Nitrogen and Total VOC Indexes to NOx and VOC Index #119111

Closed
MallocArray opened this issue Jun 8, 2024 · 3 comments · Fixed by #119152
Closed

Rename AirGradient Nitrogen and Total VOC Indexes to NOx and VOC Index #119111

MallocArray opened this issue Jun 8, 2024 · 3 comments · Fixed by #119152

Comments

@MallocArray
Copy link
Contributor

The problem

The sensors from the SPG41 sensor have names that do not match the manufacturer and may confuse end users.

"Nitrogen index" doesn't really represent what is being sensed, as the datasheets consistently call it NOx which means nitrogen oxides and not just Nitrogen. To be the most accurate, and consistent with the manufacturer, I believe renaming it to "NOx Index" is the most clear

"Total VOC index" is not necessarily incorrect, but the datasheets consistently call it "VOC Index" and if it is important to include the Total part, using the very commonly accepted TVOC acronym would be more familiar, although since the manufacturer calls it VOC Index and not TVOC Index

As a side issue I think capitalizing each unique word gives a more polished/professional look to the integrations, so "Carbon Dioxide" and "PM0.3 Count" would also improve the overall appearance.

I can put together a PR if you would like, but wanted to get feedback before blindly submitting these suggested changes.

Related links:
https://pediaa.com/what-is-the-difference-between-voc-and-tvoc/

https://sensirion.com/media/documents/5FE8673C/61E96F50/[Sensirion_Gas_Sensors_Datasheet_SGP41.pdf](https://sensirion.com/media/documents/5FE8673C/61E96F50/Sensirion_Gas_Sensors_Datasheet_SGP41.pdf)

What version of Home Assistant Core has the issue?

2024.6.0

What was the last working version of Home Assistant Core?

No response

What type of installation are you running?

Home Assistant OS

Integration causing the issue

airgradient

Link to integration documentation on our website

https://www.home-assistant.io/integrations/airgradient

Diagnostics information

No response

Example YAML snippet

No response

Anything in the logs that might be useful for us?

No response

Additional information

No response

@home-assistant
Copy link

home-assistant bot commented Jun 8, 2024

Hey there @airgradienthq, @joostlek, mind taking a look at this issue as it has been labeled with an integration (airgradient) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of airgradient can trigger bot actions by commenting:

  • @home-assistant close Closes the issue.
  • @home-assistant rename Awesome new title Renames the issue.
  • @home-assistant reopen Reopen the issue.
  • @home-assistant unassign airgradient Removes the current integration label and assignees on the issue, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

(message by CodeOwnersMention)


airgradient documentation
airgradient source
(message by IssueLinks)

@joostlek
Copy link
Member

joostlek commented Jun 8, 2024

Sounds good to me.

About the capitalization, we use sentence case everywhere within Home Assistant (or well, we strive to, so there probably are some old ones that do not comply)

@MallocArray
Copy link
Contributor Author

Submitted a PR, but not sure if only the display name section should be renamed, or if it would be better to rename the underlying structure as well.

I'm not familiar with the PR process here so much, so if this isn't done correctly, feel free to correct it, or reject it and do it the proper way.

@github-actions github-actions bot locked and limited conversation to collaborators Jul 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants