Skip to content

Commit 1e46c0c

Browse files
committed
more description for configureBuzzer()
1 parent 5c7721c commit 1e46c0c

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/sfeQwiicBuzzer.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,12 @@ class sfeQwiicBuzzer
5050
/// @return 0 for succuss, negative for errors, positive for warnings
5151
sfeTkError_t isConnected();
5252

53-
/// @brief Configures the Qwiic Buzzer
53+
/// @brief Configures the Qwiic Buzzer without causing the buzzer to buzz.
54+
/// This allows configuration in silence (before you may want to buzz).
55+
/// It is also useful in combination with saveSettings(), and then later
56+
/// causing buzzing by using the physical TRIGGER pin.
57+
/// To start buzzing (via Qwiic) with your desired configuration, use this
58+
/// function, then call setBuzzerActiveReg().
5459
/// @param toneFrequency Frequency of buzzer tone
5560
/// @param duration Duration in milliseconds
5661
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)

0 commit comments

Comments
 (0)