19
19
# CircuitPython Library Author: Michael Schroeder(sommersoft). No
20
20
# affiliation to Adafruit is implied.
21
21
"""
22
- `adafruit_VEML6070 ` - VEML6070 UV Sensor
22
+ `adafruit_veml6070 ` - VEML6070 UV Sensor
23
23
====================================================
24
24
25
25
CircuitPython library to support VEML6070 UV Index sensor.
@@ -89,9 +89,9 @@ class VEML6070:
89
89
Defaults to `VEML6070_1_T` if parameter not passed. To change
90
90
setting after intialization, use
91
91
`[veml6070].set_integration_time(new_it)`.
92
- :param bool ack: The inital setting of `ACKnowledge` on alert. Defaults to `False`
92
+ :param bool ack: The inital setting of `` ACKnowledge` ` on alert. Defaults to `False`
93
93
if parameter not passed. To change setting after intialization,
94
- use `[veml6070].set_ack(new_ack)`.
94
+ use `` [veml6070].set_ack(new_ack)` `.
95
95
96
96
Example:
97
97
@@ -165,7 +165,7 @@ def set_ack(self, new_ack=False):
165
165
"""
166
166
Turns on or off the ACKnowledge function of the sensor. The ACK function will send
167
167
a signal to the host when the value of the sensed UV light changes beyond the
168
- programmed threshold. Use `[veml6070].set_ack_threshold` to change between the two
168
+ programmed threshold. Use `` [veml6070].set_ack_threshold` ` to change between the two
169
169
available threshold settings.
170
170
"""
171
171
if new_ack not in (True , False ):
@@ -179,8 +179,8 @@ def set_ack(self, new_ack=False):
179
179
def set_ack_threshold (self , new_ack_thd = 0 ):
180
180
"""
181
181
Sets the ACKnowledge Threshold, which alerts the host controller to value changes
182
- greater than the threshold. Available settings are: `0` = 102 steps; `1 ` = 145 steps.
183
- `0 ` is the default setting.
182
+ greater than the threshold. Available settings are: ``0`` = 102 steps; ``1` ` = 145 steps.
183
+ ``0` ` is the default setting.
184
184
"""
185
185
if new_ack_thd not in (0 , 1 ):
186
186
raise ValueError ("ACK Threshold must be '0' or '1'." )
@@ -219,7 +219,7 @@ def sleep(self):
219
219
220
220
def wake (self ):
221
221
"""
222
- Wakes the VEML6070 from sleep. `[veml6070].read` will also wake from sleep.
222
+ Wakes the VEML6070 from sleep. `` [veml6070].read` ` will also wake from sleep.
223
223
"""
224
224
self .buf [0 ] = (self ._ack << 5 | self ._ack_thd << 4 |
225
225
_VEML6070_INTEGRATION_TIME [self ._it ][0 ] << 2 | 0x02 )
@@ -229,7 +229,7 @@ def wake(self):
229
229
def get_index (self , _raw ):
230
230
"""
231
231
Calculates the UV Risk Level based on the captured UV reading. Requres the `_raw`
232
- argument (from `veml6070.read`). Risk level is available for Integration Times (IT)
232
+ argument (from `` veml6070.read` `). Risk level is available for Integration Times (IT)
233
233
1, 2, & 4. The result is automatically scaled to the current IT setting.
234
234
235
235
LEVEL* UV Index
0 commit comments