Skip to content

Commit da16715

Browse files
lewispg228lewispg228
committed
moving back to all caps and underscore style for some things
1 parent fd5955f commit da16715

File tree

6 files changed

+287
-290
lines changed

6 files changed

+287
-290
lines changed

‎examples/Example_05_ChangeI2CAddress/Example_05_ChangeI2CAddress.ino‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
QwiicBuzzer buzzer;
2020

2121
// The default address is 0x34, change this if your buzzer currently has a different address!
22-
uint8_t initialAddress = kSfeQwiicBuzzerDefaultAddress;
22+
uint8_t initialAddress = SFE_QWIIC_BUZZER_DEFAULT_ADDRESS;
2323

2424
void setup() {
2525
Serial.begin(115200);

‎examples/Example_07_Melody/Example_07_Melody.ino‎

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,24 +27,21 @@ QwiicBuzzer buzzer;
2727

2828
// notes in the melody:
2929
int melody[] = {
30-
kSfeQwiicBuzzerNoteC4,
31-
kSfeQwiicBuzzerNoteG3,
32-
kSfeQwiicBuzzerNoteG3,
33-
kSfeQwiicBuzzerNoteA3,
34-
kSfeQwiicBuzzerNoteG3,
35-
0,
36-
kSfeQwiicBuzzerNoteB3,
37-
kSfeQwiicBuzzerNoteC4
30+
SFE_QWIIC_BUZZER_NOTE_C4,
31+
SFE_QWIIC_BUZZER_NOTE_G3,
32+
SFE_QWIIC_BUZZER_NOTE_G3,
33+
SFE_QWIIC_BUZZER_NOTE_A3,
34+
SFE_QWIIC_BUZZER_NOTE_G3,
35+
0, // silence (aka "rest")
36+
SFE_QWIIC_BUZZER_NOTE_B3,
37+
SFE_QWIIC_BUZZER_NOTE_C4
3838
};
3939

4040
// note durations: 4 = quarter note, 8 = eighth note, etc.:
4141
int noteDurations[] = {
4242
4, 8, 8, 4, 4, 4, 4, 4
4343
};
4444

45-
#define kBuzzerVolume 4 // loudest!!
46-
//#define kBuzzerVolume 3 // pretty good volume for most things
47-
4845
void setup() {
4946
Serial.begin(115200);
5047
Serial.println("Qwiic Buzzer Example_07_Buzz_Melody");
@@ -74,7 +71,7 @@ void play_melody()
7471
// to calculate the note duration, take one second divided by the note type.
7572
//e.g. quarter note = 1000 / 4, eighth note = 1000/8, etc.
7673
int noteDuration = 1000 / noteDurations[thisNote];
77-
buzzer.on(melody[thisNote], noteDuration, kBuzzerVolume);
74+
buzzer.on(melody[thisNote], noteDuration, SFE_QWIIC_BUZZER_VOLUME_MAX);
7875

7976
// to distinguish the notes, set a minimum time between them.
8077
// the note's duration + 30% seems to work well:

‎keywords.txt‎

Lines changed: 90 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ playSoundEffect KEYWORD2
2828
# Constants
2929
#########################################################
3030

31-
kSfeQwiicBuzzerDefaultAddress LITERAL1
31+
SFE_QWIIC_BUZZER_DEFAULT_ADDRESS LITERAL1
3232
kSfeQwiicBuzzerRegId LITERAL1
3333
kSfeQwiicBuzzerRegFirmwareMinor LITERAL1
3434
kSfeQwiicBuzzerRegFirmwareMajor LITERAL1
@@ -46,92 +46,92 @@ SFE_QWIIC_BUZZER_VOLUME_LOW LITERAL1
4646
SFE_QWIIC_BUZZER_VOLUME_MID LITERAL1
4747
SFE_QWIIC_BUZZER_VOLUME_MAX LITERAL1
4848

49-
kSfeQwiicBuzzerNoteB0 LITERAL1
50-
kSfeQwiicBuzzerNoteC1 LITERAL1
51-
kSfeQwiicBuzzerNoteCS1 LITERAL1
52-
kSfeQwiicBuzzerNoteD1 LITERAL1
53-
kSfeQwiicBuzzerNoteDS1 LITERAL1
54-
kSfeQwiicBuzzerNoteE1 LITERAL1
55-
kSfeQwiicBuzzerNoteF1 LITERAL1
56-
kSfeQwiicBuzzerNoteFS1 LITERAL1
57-
kSfeQwiicBuzzerNoteG1 LITERAL1
58-
kSfeQwiicBuzzerNoteGS1 LITERAL1
59-
kSfeQwiicBuzzerNoteA1 LITERAL1
60-
kSfeQwiicBuzzerNoteAS1 LITERAL1
61-
kSfeQwiicBuzzerNoteB1 LITERAL1
62-
kSfeQwiicBuzzerNoteC2 LITERAL1
63-
kSfeQwiicBuzzerNoteCS2 LITERAL1
64-
kSfeQwiicBuzzerNoteD2 LITERAL1
65-
kSfeQwiicBuzzerNoteDS2 LITERAL1
66-
kSfeQwiicBuzzerNoteE2 LITERAL1
67-
kSfeQwiicBuzzerNoteF2 LITERAL1
68-
kSfeQwiicBuzzerNoteFS2 LITERAL1
69-
kSfeQwiicBuzzerNoteG2 LITERAL1
70-
kSfeQwiicBuzzerNoteGS2 LITERAL1
71-
kSfeQwiicBuzzerNoteA2 LITERAL1
72-
kSfeQwiicBuzzerNoteAS2 LITERAL1
73-
kSfeQwiicBuzzerNoteB2 LITERAL1
74-
kSfeQwiicBuzzerNoteC3 LITERAL1
75-
kSfeQwiicBuzzerNoteCS3 LITERAL1
76-
kSfeQwiicBuzzerNoteD3 LITERAL1
77-
kSfeQwiicBuzzerNoteDS3 LITERAL1
78-
kSfeQwiicBuzzerNoteE3 LITERAL1
79-
kSfeQwiicBuzzerNoteF3 LITERAL1
80-
kSfeQwiicBuzzerNoteFS3 LITERAL1
81-
kSfeQwiicBuzzerNoteG3 LITERAL1
82-
kSfeQwiicBuzzerNoteGS3 LITERAL1
83-
kSfeQwiicBuzzerNoteA3 LITERAL1
84-
kSfeQwiicBuzzerNoteAS3 LITERAL1
85-
kSfeQwiicBuzzerNoteB3 LITERAL1
86-
kSfeQwiicBuzzerNoteC4 LITERAL1
87-
kSfeQwiicBuzzerNoteCS4 LITERAL1
88-
kSfeQwiicBuzzerNoteD4 LITERAL1
89-
kSfeQwiicBuzzerNoteDS4 LITERAL1
90-
kSfeQwiicBuzzerNoteE4 LITERAL1
91-
kSfeQwiicBuzzerNoteF4 LITERAL1
92-
kSfeQwiicBuzzerNoteFS4 LITERAL1
93-
kSfeQwiicBuzzerNoteG4 LITERAL1
94-
kSfeQwiicBuzzerNoteGS4 LITERAL1
95-
kSfeQwiicBuzzerNoteA4 LITERAL1
96-
kSfeQwiicBuzzerNoteAS4 LITERAL1
97-
kSfeQwiicBuzzerNoteB4 LITERAL1
98-
kSfeQwiicBuzzerNoteC5 LITERAL1
99-
kSfeQwiicBuzzerNoteCS5 LITERAL1
100-
kSfeQwiicBuzzerNoteD5 LITERAL1
101-
kSfeQwiicBuzzerNoteDS5 LITERAL1
102-
kSfeQwiicBuzzerNoteE5 LITERAL1
103-
kSfeQwiicBuzzerNoteF5 LITERAL1
104-
kSfeQwiicBuzzerNoteFS5 LITERAL1
105-
kSfeQwiicBuzzerNoteG5 LITERAL1
106-
kSfeQwiicBuzzerNoteGS5 LITERAL1
107-
kSfeQwiicBuzzerNoteA5 LITERAL1
108-
kSfeQwiicBuzzerNoteAS5 LITERAL1
109-
kSfeQwiicBuzzerNoteB5 LITERAL1
110-
kSfeQwiicBuzzerNoteC6 LITERAL1
111-
kSfeQwiicBuzzerNoteCS6 LITERAL1
112-
kSfeQwiicBuzzerNoteD6 LITERAL1
113-
kSfeQwiicBuzzerNoteDS6 LITERAL1
114-
kSfeQwiicBuzzerNoteE6 LITERAL1
115-
kSfeQwiicBuzzerNoteF6 LITERAL1
116-
kSfeQwiicBuzzerNoteFS6 LITERAL1
117-
kSfeQwiicBuzzerNoteG6 LITERAL1
118-
kSfeQwiicBuzzerNoteGS6 LITERAL1
119-
kSfeQwiicBuzzerNoteA6 LITERAL1
120-
kSfeQwiicBuzzerNoteAS6 LITERAL1
121-
kSfeQwiicBuzzerNoteB6 LITERAL1
122-
kSfeQwiicBuzzerNoteC7 LITERAL1
123-
kSfeQwiicBuzzerNoteCS7 LITERAL1
124-
kSfeQwiicBuzzerNoteD7 LITERAL1
125-
kSfeQwiicBuzzerNoteDS7 LITERAL1
126-
kSfeQwiicBuzzerNoteE7 LITERAL1
127-
kSfeQwiicBuzzerNoteF7 LITERAL1
128-
kSfeQwiicBuzzerNoteFS7 LITERAL1
129-
kSfeQwiicBuzzerNoteG7 LITERAL1
130-
kSfeQwiicBuzzerNoteGS7 LITERAL1
131-
kSfeQwiicBuzzerNoteA7 LITERAL1
132-
kSfeQwiicBuzzerNoteAS7 LITERAL1
133-
kSfeQwiicBuzzerNoteB7 LITERAL1
134-
kSfeQwiicBuzzerNoteC8 LITERAL1
135-
kSfeQwiicBuzzerNoteCS8 LITERAL1
136-
kSfeQwiicBuzzerNoteD8 LITERAL1
137-
kSfeQwiicBuzzerNoteDS8 LITERAL1
49+
SFE_QWIIC_BUZZER_NOTE_B0 LITERAL1
50+
SFE_QWIIC_BUZZER_NOTE_C1 LITERAL1
51+
SFE_QWIIC_BUZZER_NOTE_CS1 LITERAL1
52+
SFE_QWIIC_BUZZER_NOTE_D1 LITERAL1
53+
SFE_QWIIC_BUZZER_NOTE_DS1 LITERAL1
54+
SFE_QWIIC_BUZZER_NOTE_E1 LITERAL1
55+
SFE_QWIIC_BUZZER_NOTE_F1 LITERAL1
56+
SFE_QWIIC_BUZZER_NOTE_FS1 LITERAL1
57+
SFE_QWIIC_BUZZER_NOTE_G1 LITERAL1
58+
SFE_QWIIC_BUZZER_NOTE_GS1 LITERAL1
59+
SFE_QWIIC_BUZZER_NOTE_A1 LITERAL1
60+
SFE_QWIIC_BUZZER_NOTE_AS1 LITERAL1
61+
SFE_QWIIC_BUZZER_NOTE_B1 LITERAL1
62+
SFE_QWIIC_BUZZER_NOTE_C2 LITERAL1
63+
SFE_QWIIC_BUZZER_NOTE_CS2 LITERAL1
64+
SFE_QWIIC_BUZZER_NOTE_D2 LITERAL1
65+
SFE_QWIIC_BUZZER_NOTE_DS2 LITERAL1
66+
SFE_QWIIC_BUZZER_NOTE_E2 LITERAL1
67+
SFE_QWIIC_BUZZER_NOTE_F2 LITERAL1
68+
SFE_QWIIC_BUZZER_NOTE_FS2 LITERAL1
69+
SFE_QWIIC_BUZZER_NOTE_G2 LITERAL1
70+
SFE_QWIIC_BUZZER_NOTE_GS2 LITERAL1
71+
SFE_QWIIC_BUZZER_NOTE_A2 LITERAL1
72+
SFE_QWIIC_BUZZER_NOTE_AS2 LITERAL1
73+
SFE_QWIIC_BUZZER_NOTE_B2 LITERAL1
74+
SFE_QWIIC_BUZZER_NOTE_C3 LITERAL1
75+
SFE_QWIIC_BUZZER_NOTE_CS3 LITERAL1
76+
SFE_QWIIC_BUZZER_NOTE_D3 LITERAL1
77+
SFE_QWIIC_BUZZER_NOTE_DS3 LITERAL1
78+
SFE_QWIIC_BUZZER_NOTE_E3 LITERAL1
79+
SFE_QWIIC_BUZZER_NOTE_F3 LITERAL1
80+
SFE_QWIIC_BUZZER_NOTE_FS3 LITERAL1
81+
SFE_QWIIC_BUZZER_NOTE_G3 LITERAL1
82+
SFE_QWIIC_BUZZER_NOTE_GS3 LITERAL1
83+
SFE_QWIIC_BUZZER_NOTE_A3 LITERAL1
84+
SFE_QWIIC_BUZZER_NOTE_AS3 LITERAL1
85+
SFE_QWIIC_BUZZER_NOTE_B3 LITERAL1
86+
SFE_QWIIC_BUZZER_NOTE_C4 LITERAL1
87+
SFE_QWIIC_BUZZER_NOTE_CS4 LITERAL1
88+
SFE_QWIIC_BUZZER_NOTE_D4 LITERAL1
89+
SFE_QWIIC_BUZZER_NOTE_DS4 LITERAL1
90+
SFE_QWIIC_BUZZER_NOTE_E4 LITERAL1
91+
SFE_QWIIC_BUZZER_NOTE_F4 LITERAL1
92+
SFE_QWIIC_BUZZER_NOTE_FS4 LITERAL1
93+
SFE_QWIIC_BUZZER_NOTE_G4 LITERAL1
94+
SFE_QWIIC_BUZZER_NOTE_GS4 LITERAL1
95+
SFE_QWIIC_BUZZER_NOTE_A4 LITERAL1
96+
SFE_QWIIC_BUZZER_NOTE_AS4 LITERAL1
97+
SFE_QWIIC_BUZZER_NOTE_B4 LITERAL1
98+
SFE_QWIIC_BUZZER_NOTE_C5 LITERAL1
99+
SFE_QWIIC_BUZZER_NOTE_CS5 LITERAL1
100+
SFE_QWIIC_BUZZER_NOTE_D5 LITERAL1
101+
SFE_QWIIC_BUZZER_NOTE_DS5 LITERAL1
102+
SFE_QWIIC_BUZZER_NOTE_E5 LITERAL1
103+
SFE_QWIIC_BUZZER_NOTE_F5 LITERAL1
104+
SFE_QWIIC_BUZZER_NOTE_FS5 LITERAL1
105+
SFE_QWIIC_BUZZER_NOTE_G5 LITERAL1
106+
SFE_QWIIC_BUZZER_NOTE_GS5 LITERAL1
107+
SFE_QWIIC_BUZZER_NOTE_A5 LITERAL1
108+
SFE_QWIIC_BUZZER_NOTE_AS5 LITERAL1
109+
SFE_QWIIC_BUZZER_NOTE_B5 LITERAL1
110+
SFE_QWIIC_BUZZER_NOTE_C6 LITERAL1
111+
SFE_QWIIC_BUZZER_NOTE_CS6 LITERAL1
112+
SFE_QWIIC_BUZZER_NOTE_D6 LITERAL1
113+
SFE_QWIIC_BUZZER_NOTE_DS6 LITERAL1
114+
SFE_QWIIC_BUZZER_NOTE_E6 LITERAL1
115+
SFE_QWIIC_BUZZER_NOTE_F6 LITERAL1
116+
SFE_QWIIC_BUZZER_NOTE_FS6 LITERAL1
117+
SFE_QWIIC_BUZZER_NOTE_G6 LITERAL1
118+
SFE_QWIIC_BUZZER_NOTE_GS6 LITERAL1
119+
SFE_QWIIC_BUZZER_NOTE_A6 LITERAL1
120+
SFE_QWIIC_BUZZER_NOTE_AS6 LITERAL1
121+
SFE_QWIIC_BUZZER_NOTE_B6 LITERAL1
122+
SFE_QWIIC_BUZZER_NOTE_C7 LITERAL1
123+
SFE_QWIIC_BUZZER_NOTE_CS7 LITERAL1
124+
SFE_QWIIC_BUZZER_NOTE_D7 LITERAL1
125+
SFE_QWIIC_BUZZER_NOTE_DS7 LITERAL1
126+
SFE_QWIIC_BUZZER_NOTE_E7 LITERAL1
127+
SFE_QWIIC_BUZZER_NOTE_F7 LITERAL1
128+
SFE_QWIIC_BUZZER_NOTE_FS7 LITERAL1
129+
SFE_QWIIC_BUZZER_NOTE_G7 LITERAL1
130+
SFE_QWIIC_BUZZER_NOTE_GS7 LITERAL1
131+
SFE_QWIIC_BUZZER_NOTE_A7 LITERAL1
132+
SFE_QWIIC_BUZZER_NOTE_AS7 LITERAL1
133+
SFE_QWIIC_BUZZER_NOTE_B7 LITERAL1
134+
SFE_QWIIC_BUZZER_NOTE_C8 LITERAL1
135+
SFE_QWIIC_BUZZER_NOTE_CS8 LITERAL1
136+
SFE_QWIIC_BUZZER_NOTE_D8 LITERAL1
137+
SFE_QWIIC_BUZZER_NOTE_DS8 LITERAL1

‎src/SparkFun_Qwiic_Buzzer_Arduino_Library.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ class QwiicBuzzer : public sfeQwiicBuzzer
3535
/// @param address I2C device address to use for the sensor
3636
/// @param wirePort Wire port to use for I2C communication
3737
/// @return True if successful, false otherwise
38-
bool begin(uint8_t address = kSfeQwiicBuzzerDefaultAddress, TwoWire &wirePort = Wire)
38+
bool begin(uint8_t address = SFE_QWIIC_BUZZER_DEFAULT_ADDRESS, TwoWire &wirePort = Wire)
3939
{
4040
// Setup Arudino I2C bus
4141
_theI2CBus.init(wirePort, address);

‎src/sfeQwiicBuzzer.h‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@
3131
#include "sfeQwiicBuzzerRegisters.h"
3232
#include "sfeQwiicBuzzerPitches.h"
3333

34-
const uint8_t kSfeQwiicBuzzerDefaultAddress = 0x34;
35-
const uint16_t kSfeQwiicBuzzerResonantFrequency = 2730;
36-
#define SFE_QWIIC_BUZZER_VOLUME_OFF = 0;
37-
#define SFE_QWIIC_BUZZER_VOLUME_MIN = 1;
38-
#define SFE_QWIIC_BUZZER_VOLUME_LOW = 2;
39-
#define SFE_QWIIC_BUZZER_VOLUME_MID = 3;
40-
#define SFE_QWIIC_BUZZER_VOLUME_MAX = 4;
34+
#define SFE_QWIIC_BUZZER_DEFAULT_ADDRESS 0x34
35+
#define SFE_QWIIC_BUZZER_RESONANT_FREQUENCY 2730
36+
#define SFE_QWIIC_BUZZER_VOLUME_OFF 0
37+
#define SFE_QWIIC_BUZZER_VOLUME_MIN 1
38+
#define SFE_QWIIC_BUZZER_VOLUME_LOW 2
39+
#define SFE_QWIIC_BUZZER_VOLUME_MID 3
40+
#define SFE_QWIIC_BUZZER_VOLUME_MAX 4
4141

4242
class sfeQwiicBuzzer
4343
{
@@ -73,7 +73,7 @@ class sfeQwiicBuzzer
7373
/// @param duration Duration in milliseconds
7474
/// @param volume Volume (4 settings; 0=off, 1=quiet... 4=loudest)
7575
/// @return 0 for succuss, negative for errors, positive for warnings
76-
sfeTkError_t on(const uint16_t toneFrequency = kSfeQwiicBuzzerResonantFrequency, const uint16_t duration = 0, const uint8_t volume = 4);
76+
sfeTkError_t on(const uint16_t toneFrequency = SFE_QWIIC_BUZZER_RESONANT_FREQUENCY, const uint16_t duration = 0, const uint8_t volume = 4);
7777

7878
/// @brief Turns off buzzer
7979
/// @return 0 for succuss, negative for errors, positive for warnings

0 commit comments

Comments
 (0)