Fix Piezo.prototype.note() #1328
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `note()` method was passing a frequency (Hz) to the `tone()` method, which is expecting to receive a duty cycle (μs), leading to the wrong note being played. The solution is for `note()` to call `frequency()` instead, which will do the appropriate conversion. Since it took me a while to understand the relationships between `tone`, `frequency` and `note` I've added some documentation to those methods to clear things up for the next person. I've also made some unit tests more aggressive about checking that values are converted appropriately as they're passed around, and commented note-frequency-duty equivalencies to help the test read nicer.
- Test that `note()` is case-insensitive - Better description of default octave - One-line Piezo.prototype.note - s/frequncy/frequency - Note tests demonstrate the difference between note letter and octave number better
|
Note: I'm not sure what's up with the failure in this test run and I'm unable to re-run tests on your repo, but I'm pretty sure it's flaky. Here's a passing Travis run at 050489e. I've proposed some changes to help with test flakiness over here. |
|
@lyzadanger is this good to go? @islemaster addressed the test breakage in a different patch |
|
LGTM 👍 |
|
I will do a release asap. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Re-opening #1324, which automatically closed when I merged code-dot-org#3; see that PR for discussion. Sorry about that! FYI @rwaldron @lyzadanger
The
note()method was passing a frequency (Hz) to thetone()method, which is expecting to receive a duty cycle (μs), leading to the wrong note being played. The solution is fornote()to callfrequency()instead, which will do the appropriate conversion.Since it took me a while to understand the relationships between
tone,frequencyandnoteI've added some documentation to those methods to clear things up for the next person. I've also made some unit tests more aggressive about checking that values are converted appropriately as they're passed around, and commented note-frequency-duty equivalencies to help the test read nicer.