Property-fy proximity, add distance?

[caternuson]

The proximity value is currently accessed via a function call:

apds.proximity()

It would be more inline with other libraries to make that a property.

apds.proximity

Also - not seeing any entry in the Design Guide for proximity sensor: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html#sensor-properties-and-units Closest is distance, which may be possible in an approximate way by curve fitting one or more of these (from datasheet):

[ladyada]

im ok with a proximity property - distance really means distance, which this is not guaranteed to be :)

[tannewt]

It's totally ok to add a new entry to the design guide. The source is here: https://github.com/adafruit/circuitpython/blob/master/docs/design_guide.rst#sensor-properties-and-units

We should add sound_level too.

[kevinjwalters]

Are you doing this for consistency reasons or because its "Pythonic?".

I was trying to work out the other day a rule for deciding on a method return value vs property. If there's no historical use of an attribute and no setter and no intention/possibility of a setter then I can't see the value in a property?

[caternuson]

For CircuitPython, it's part of the Design Guide: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html#getters-setters

[kevinjwalters]

BTW, what's the unit for this gyro property?

>>> from adafruit_clue import clue
>>> clue.gyro
(2.89625, -9.19625, -4.94375)

The design guide has units for gyro as x, y, z radians per second but my guess was this was degrees per second? I may be wrong there...

[kevinjwalters]

Perhaps everyone's already aware of this one but I see readPressure() in https://github.com/adafruit/Adafruit_Arcada/blob/master/examples/full_board_tests/arcada_clue_sensorplotter/arcada_clue_sensorplotter.ino#L119 being plotted as Pa (Pascals) and not hPa as per https://learn.adafruit.com/using-the-adafruit-unified-sensor-driver/how-does-it-work#standardised-si-units-for-sensor-data-2-2

[ladyada]

@kevinjwalters please open an issue in the arcada repo if you see a bug!

[ladyada]

gyros are radians per second

[caternuson]

For CircuitPython, property names and units are documented here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html#sensor-properties-and-units

[kevinjwalters]

I'll see if my 50s record player works later for an rpm test...

[kevinjwalters]

I get around 220 somethings per second at 45rpm from CP's gyro on an HMV record player which needs a service. I put in https://github.com/adafruit/Adafruit_CircuitPython_LSM6DS/issues/9 for this.

[kevinjwalters]

For C/Arduino library for BMP280 sensor, someone has already noted discrepancy based on a comment in code, i'd added detail to the closed issue for this one: https://github.com/adafruit/Adafruit_BMP280_Library/issues/35#issuecomment-596030828

[tannewt]

Are you doing this for consistency reasons or because its "Pythonic?".

I was trying to work out the other day a rule for deciding on a method return value vs property. If there's no historical use of an attribute and no setter and no intention/possibility of a setter then I can't see the value in a property?

Properties themselves are more Pythonic. They represent state that exists regardless of whether it is being read. Functions are sequences of actions.

The design guide includes specific attribute names and units so that drivers can be used interchangeably.

[caternuson]

So....we OK with making this a breaking change? Not sure if there is a way to support both syntaxes?

[kevinjwalters]

You'll need to do a synchronised update to any libraries using this, e.g. at least:

• https://github.com/adafruit/Adafruit_CircuitPython_CLUE/blob/master/adafruit_clue.py#L471

[tannewt]

@caternuson Ya, I'm ok breaking it. Just make sure to do a major version bump and ideally change all uses like clue close to the same time.

[caternuson]

Done with #19