Skip to content

Commit 3169dd5

Browse files
authored
Update docs to say 44.1kHz instead of 22kHz (#3)
Hello! I just got this module (it's fantastic!), and uploaded to it the latest release, but as I was trying to load my own samples onto it, I found two things which seem to have drifted from these docs: 1. The sample that comes with it is called `honk.wav` and not `sample.wav` -- was an earlier version called `sample.wav`? 2. The `honk.wav` audio file is 16-bit signed mono WAV at _44.1kHz_ and not 22kHz... I found this out the hard way because I kept loading my own samples at 22kHz and wondering why they were playing back at a higher pitch than I expected. 😅 When I transcoded my audio files to 44.1kHz 16-bit signed mono WAVs, they suddenly worked! Hence this PR. Lemme know if maybe I got something else wrong and my workaround isn't actually correct. Thanks!
1 parent e9ae59b commit 3169dd5

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

user_guide/docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ With the default code, it will trigger the sample and play it through the audio
4141

4242
You can change the sample on Big Honking Button by connecting it to your computer via a micro USB cable. The USB port is located on the module's main circuit board, located under the panel. Please note that you do have to power the module in order for the USB connection to work (the module itself can **not** be powered over USB alone).
4343

44-
Samples must be in mono, 16-bit, 22kHz, signed `wav` files. Adafruit has an [excellent guide on how to convert sound files](https://learn.adafruit.com/adafruit-wave-shield-audio-shield-for-arduino/convert-files).
44+
Samples must be in mono, 16-bit, 44.1kHz, signed `wav` files. Adafruit has an [excellent guide on how to convert sound files](https://learn.adafruit.com/adafruit-wave-shield-audio-shield-for-arduino/convert-files), though your sample can be 44.1kHz and not 22kHz.
4545

4646
To modify the sample that plays:
4747

4848
1. Connect the Big Honking Button to your computer using a micro USB cable. It should show up as a small external drive named `CIRCUITPY`
4949
1. Navigate to the `samples` folder in the drive
50-
1. Rename or delete the existing `sample.wav` file
51-
1. Copy your sample over and rename it to `sample.wav`
50+
1. Rename or delete the existing `honk.wav` file
51+
1. Copy your sample over and rename it to `honk.wav`
5252

5353
Your Big Honking Button will reboot and then it should play the new sample! If you run into trouble, please [reach out](#getting-support-and-help).
5454

@@ -145,4 +145,4 @@ Got a question not answered here? [Reach out](#getting-support-and-help), we'll
145145
Big Honking Button would not be possible without the help of the CircuitPython community and Adafruit Industries.
146146

147147

148-
[discord]: https://discord.gg/UpfqghQ
148+
[discord]: https://discord.gg/UpfqghQ

0 commit comments

Comments
 (0)