File tree Expand file tree Collapse file tree 1 file changed +7
-3
lines changed Expand file tree Collapse file tree 1 file changed +7
-3
lines changed Original file line number Diff line number Diff line change @@ -95,12 +95,13 @@ class VL6180X:
95
95
"""Create an instance of the VL6180X distance sensor. You must pass in
96
96
the following parameters:
97
97
98
- :param i2c: An instance of the I2C bus connected to the sensor.
98
+ :param ~I2C i2c: An instance of the I2C bus connected to the sensor.
99
99
100
100
Optionally you can specify:
101
101
102
- :param address: The I2C address of the sensor. If not specified the sensor's
102
+ :param int address: The I2C address of the sensor. If not specified the sensor's
103
103
default value will be assumed.
104
+ :param int offset: The offset to be applied to measurements, in mm
104
105
"""
105
106
106
107
def __init__ (
@@ -168,7 +169,8 @@ def range_history_enabled(self) -> bool:
168
169
169
170
def start_range_continuous (self , period : int = 100 ) -> None :
170
171
"""Start continuous range mode
171
- :param period: Time delay between measurements in ms
172
+
173
+ :param int period: Time delay between measurements, in milliseconds
172
174
"""
173
175
# Set range between measurements
174
176
period_reg : int = 0
@@ -238,6 +240,8 @@ def read_lux(self, gain: int) -> float:
238
240
- ALS_GAIN_10 = 10x
239
241
- ALS_GAIN_20 = 20x
240
242
- ALS_GAIN_40 = 40x
243
+
244
+ :param int gain: The gain value to use
241
245
"""
242
246
reg = self ._read_8 (_VL6180X_REG_SYSTEM_INTERRUPT_CONFIG )
243
247
reg &= ~ 0x38
You can’t perform that action at this time.
0 commit comments