Adding a paragraph about LavaBeats in the README file. - #430
Merged
Conversation
JuanSMartinez
requested review from
alabiaga,
ashnohe,
madebymozart and
yrezgui
as code owners
August 14, 2026 20:48
alabiaga
approved these changes
Aug 14, 2026
| The `WaveformEnvelopeBuilder` is used to construct various repetitions of these | ||
| two pulses separated by a fixed first-to-second pulse delay. The first pulse is | ||
| a chirp signal that starts at a low frequency and ends at a higher frequency | ||
| over a short duration. The second pulse is as a single period of a low frequency |
Member
There was a problem hiding this comment.
Should this be "The second pulse is as a .."
Contributor
Author
There was a problem hiding this comment.
Thank you for catching this. Fixed
| with delay in-between following a typical beats-per-minute (bpm) rate. The | ||
| result is a haptic effect that resembles a beating heart. | ||
|
|
||
| LavaBeats also allows to configure all the parameters of the effect to emulate |
Member
There was a problem hiding this comment.
"LavaBeats also allows users to" ?
Contributor
Author
There was a problem hiding this comment.
Thanks. This reads better
| represented with vibration pulses of varying amplitudes and frequencies. The | ||
| first pulse represents the QRS complex of the ECG, which shows as a sharp peak | ||
| of high amplitude and short duration. The second pulse is the T wave, which has | ||
| lower amplitude, longer duration and a smoother shape. |
Member
There was a problem hiding this comment.
"lower amplitude, longer duration, and a smoother shape"
Contributor
Author
There was a problem hiding this comment.
Added the third comma now. Thank you
This describes the sample to the users
JuanSMartinez
force-pushed
the
lavabeats-readme
branch
from
August 14, 2026 21:28
c1a9d1c to
714c206
Compare
yrezgui
approved these changes
Aug 17, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This describes what the sample is and how it works, giving the user more context if they haven't seen the public developer documentation webpage