Consistency in unified sensor driver property naming

[tuupola]

To avoid hijacking an unrelated thread I move this here. Currently there is mixed capitalization in the design guide concerning unified sensor driver property naming.

Consistency is usually good thing. If everything is lowercased there is no need to remember whether one should use capital letters or not. For example lux might be confusing. Is it acronym or word? Should it be sensor.lux or sensor.LUX? Also when seeing sensor.TVOC one is not really sure if it is a constant or property.

I do not have strong feelings about this, but my choice would be lowercased acronyms sensor.tvoc and sensor.eco2.

[tannewt]

I've been silent on this because I haven't felt super strong about it. I thought about expanding them out (total_volatile_organic_compound for example) but then they get really long. Ultimately, I agree with you @tuupola. Switching to lowercase makes sense to me.

[tannewt]

@tuupola Would you like to switch them to the lower case version?

[brentru]

These two libs to be changed to reflect the move to lowercase (am I forgetting any others which use the TVOC/eCO2 property naming?):
https://github.com/adafruit/Adafruit_CircuitPython_SGP30
https://github.com/adafruit/Adafruit_CircuitPython_CCS811

[tuupola]

Had missed this. @tannewt sure, I will check them out.

[tannewt]

Thanks @tuupola! Let me know if you need any guidance on how to get it done.

…

On Sun, Mar 4, 2018 at 9:55 PM Mika Tuupola ***@***.***> wrote: Had missed this. @tannewt <https://github.com/tannewt> sure, I will check them out. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#622 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AADNqQYJud9mHyh63V3PfX01L_sIwcaDks5tbNNmgaJpZM4SDQdk> .

[evaherrada]

@tuupola I put in a pull request fixing those issues to the CCS811 library and it was accepted. I didn't see any problems with the SGP30 library.

[tannewt]

SGP30 is missing properties all together. They should be added.

[tannewt]

@mrmcwethy would you be interested in adding eco2 and tvoc properties to the SGP30 driver?

[mrmcwethy]

@tannewt I would be happy to add these properies. I will need to order a sgp30 board.

[tannewt]

Go ahead and order one (and other other sensors of interest). I think @brentru may have started the sgp30 work though.

[brentru]

Working through the SGP30 right now.

@tannewt Do we want properties for the baseline sensor readings (would be the same as the call in the example: https://github.com/brentru/Adafruit_CircuitPython_SGP30/blob/master/examples/sgp30_simpletest.py#L27) as well? Naming would be: tvoc, tvoc_base, co2eq, co2eq_Base

[tannewt]

Yes please. I'd name them baseline_tvoc and baseline_co2eq though. Thanks!

[tannewt]

The CCS guide needs to be updated: https://learn.adafruit.com/adafruit-ccs811-air-quality-sensor?view=all#circuitpython-wiring-test

[brentru]

@tannewt will do.

[brentru]

Modified the CCS and SGP30 guides to match the naming consistencies.

[tannewt]

Awesome! I think this is done then. Please reopen if not.