Skip to content

Commit a62c603

Browse files
committed
typos and add sound effect descriptions to example header comments
1 parent fbaac5b commit a62c603

File tree

2 files changed

+45
-2
lines changed

2 files changed

+45
-2
lines changed

examples/Example_08_Sound_Effects/Example_08_Sound_Effects.ino

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,49 @@
33
44
This example demos the sound effects included in this library.
55
6+
This includes the following sound effects:
7+
0 (aka "Siren")
8+
Intended to sound like a siren, starting at a low frequency, and then
9+
increasing rapidly up and then back down. This sound effect does a
10+
single "up and down" cycle.
11+
12+
1 (aka "3 Fast Sirens")
13+
Similar to the "Siren" sound effect, only faster and goes three times.
14+
15+
2 (aka "robot saying 'Yes'")
16+
Intended to sound like a robot saying the word "yes".
17+
It starts at a low frequency and quickly ramps up to a high frequency,
18+
then stops. This can be interpreted by most to be an affirmative
19+
sound to any question you may ask your buzzing robot.
20+
21+
3 (aka "robot yelling 'YES!'" - faster)
22+
Same as the "Yes" sound effect, only faster.
23+
When done more quickly, it can add enthusiasm to the buzzing sound.
24+
25+
4 (aka "robot saying 'No'")
26+
Intended to sound like a robot saying the word "no".
27+
It starts at a high frequency and quickly ramps down to a low frequency,
28+
then stops. This can be interpreted by most to be an negative
29+
sound to any question you may ask your buzzing robot.
30+
31+
5 (aka "robot yelling 'NO!'" - faster)
32+
Same as the "No" sound effect, only faster.
33+
When done more quickly, it can add enthusiasm to the buzzing sound.
34+
35+
6 (aka "Laughing Robot")
36+
Intended to sound like your robot is laughing at you.
37+
38+
7 (aka "Laughing Robot Faster")
39+
Same as the "Laugh" sound effect, only faster.
40+
When done more quickly, it can add enthusiasm to the buzzing sound.
41+
42+
8 (aka "Crying Robot")
43+
Intended to sound like a robot is crying and sad.
44+
45+
9 (aka "Crying Robot Faster")
46+
Same as the "Cry" sound effect, only faster.
47+
When done more quickly, it can add enthusiasm to the buzzing sound.
48+
649
By Pete Lewis @ SparkFun Electronics
750
December 2023
851

src/sfeQwiicBuzzer.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ class sfeQwiicBuzzer
132132
/// @return 0 for succuss, negative for errors, positive for warnings
133133
sfeTkError_t soundEffect2(const uint8_t &volume);
134134

135-
/// @brief Plays sound effect (aka "robot yelling 'YES!'" - faster)
135+
/// @brief Plays sound effect 3 (aka "robot yelling 'YES!'" - faster)
136136
/// Intended to sound like a robot saying the word "yes".
137137
/// It starts at a low frequency and quickly ramps up to a high frequency,
138138
/// then stops. This can be interpreted by most to be an affirmative
@@ -142,7 +142,7 @@ class sfeQwiicBuzzer
142142
/// @return 0 for succuss, negative for errors, positive for warnings
143143
sfeTkError_t soundEffect3(const uint8_t &volume);
144144

145-
/// @brief Plays sound effect (aka "robot saying 'No'")
145+
/// @brief Plays sound effect 4 (aka "robot saying 'No'")
146146
/// Intended to sound like a robot saying the word "no".
147147
/// It starts at a high frequency and quickly ramps down to a low frequency,
148148
/// then stops. This can be interpreted by most to be an negative

0 commit comments

Comments
 (0)