adafruit / Adafruit_CircuitPython_SCD30

Helper library for the SCD30 e-CO2 sensor
MIT License
15 stars 10 forks source link

eCO2 -> CO2 #5

Closed rpavlik closed 3 years ago

rpavlik commented 3 years ago

This is a real CO2 sensor, so the docs and API should reflect that - see recent equivalent change to the arduino library. I opted to lowercase the property name now that we don't need mixed case to distinguish "e" from "CO2", so scd30.eCO2 is now just scd30.co2.

I also fixed some typos I saw as I was going thru.

Fixes #4

tannewt commented 3 years ago

Would you mind adding co2 to the design guide listing too? https://github.com/adafruit/circuitpython/blob/main/docs/design_guide.rst#sensor-properties-and-units Thanks!

rpavlik commented 3 years ago

I see that TVOC is in all caps. Do we want CO2 in all caps too? or lowercase like most of the rest?

ladyada commented 3 years ago

CO2 is a technical spelling, i'd prefer its in all caps

rpavlik commented 3 years ago

OK, I'll revise this accordingly.

ladyada commented 3 years ago

thank you :)

rpavlik commented 3 years ago

OK, commits updated, and the docs PR is here: https://github.com/adafruit/circuitpython/pull/4070

ladyada commented 3 years ago

thanks, gonna wait till @tannewt is around and approves the new 'sensor type'