Skip to content

Commit 684ef87

Browse files
authored
Clarify documentation of set_realtime_value()
1 parent 5a0eb1e commit 684ef87

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

adafruit_drv2605.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,10 @@ def sequence(self) -> "_DRV2605_Sequence":
209209
return self._sequence
210210

211211
def set_realtime_value(self, val: int) -> None:
212-
"""Set the output value (amplitude) used for Real-Time Playback"""
212+
"""Set the output value used for Real-Time Playback. By default, the device
213+
interprets the value as SIGNED (2s complement), and its effect depends on
214+
other operating parameters. Consult the datasheet for more information!
215+
"""
213216
if not 0 <= val <= 255:
214217
raise ValueError("Real-Time Playback value must be a value within 0-255!")
215218
self._write_u8(_DRV2605_REG_RTPIN, val)

0 commit comments

Comments
 (0)