Add offset setting, add type hints #22
Conversation
Datasheet says it doesn't keep between resets
adafruit_vl6180x.py
Outdated
| if not -128 <= offset <= 127: | ||
| raise ValueError("Offset out of range (-128 ... 127)") | ||
| if offset < 0: | ||
| offset = ~(abs(offset) - 1) | ||
| self._write_8(_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET, offset) |
There was a problem hiding this comment.
Please use struct.pack here. Can also let it do the range checking. For example, all this could be:
self._write_8(_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET, struct.pack("b", offset)[0])From AN4545:
There was a problem hiding this comment.
Ah, that looks much simpler and cleaner, thanks!
|
This PR also appears to be adding type checking to address #19? |
Yeah, looks like I branched from my other PR, so I guess this would supersede it. I can close the other one in that case. |
|
The new example looks like it's only different from the existing example by the one line: sensor = adafruit_vl6180x.VL6180X(i2c, offset=10)What do you think about adding that as a commented out line to the existing example? |
Definitely a better idea, good one! |
|
Should I also add code showing how to use the offset to effectively calibrate? |
|
That's a good question. Actually - a second example might be good. And have it be what one could use to come up with the offset. Mention the app note in code comments, etc. How about that? Actual usage of offset is pretty easy - so could cover that with a simple mod of existing example, i.e. with a commented out line. |
|
Sounds like a plan! I'll get on this tonight. |
|
@caternuson Alright, added an example of the AN4545 procedure as |
examples/vl6180x_simpletest.py
Outdated
| @@ -17,6 +17,7 @@ | |||
|
|
|||
| # Create sensor instance. | |||
| sensor = adafruit_vl6180x.VL6180X(i2c) | |||
| # sensor = adafruit_vl6180x.VL6180X(i2c) # This would add a +10 millimeter offset to measurements: | |||
There was a problem hiding this comment.
Needs offset parameter.
There was a problem hiding this comment.
Ah, thank you for catching this, will add ASAP
|
Ah, the things you can do remote with a tablet. Ready, @caternuson ! |
|
Thanks! Looks good. |
Updating https://github.com/adafruit/Adafruit_CircuitPython_VL6180X to 1.3.0 from 1.2.8: > Merge pull request adafruit/Adafruit_CircuitPython_VL6180X#22 from tekktrik/feature/add-manual-offset > update rtd py version Updating https://github.com/adafruit/Adafruit_CircuitPython_Display_Shapes to 2.4.0 from 2.3.2: > Merge pull request adafruit/Adafruit_CircuitPython_Display_Shapes#44 from FoamyGuy/size_properties > update rtd py version
Address Issue #18 by allowing an offset to be set through a property. Initialization now also includes a parameter to set the offset as well.
Tested with the sensor and an FT232H with Blinka.