aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHeinrich Schuchardt2022-12-15 16:50:39 -0800
committerHeinrich Schuchardt2022-12-20 16:06:48 +0100
commitea58b9a404d4cf39a3bb314804f42b213eb6d896 (patch)
treeb374c20a3bedb6366168eb94efec1f9d8f5f8cb0 /doc
parent2243922edca9f56a9d5519b9d6e36f5d7a18434d (diff)
cmd: allow sound command to play multiple sounds
Currently the sound command accepts only one value each for duration and frequency. Allowing more duration and frequency arguments enables playing a tune. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/usage/cmd/sound.rst23
1 files changed, 21 insertions, 2 deletions
diff --git a/doc/usage/cmd/sound.rst b/doc/usage/cmd/sound.rst
index d3fac243b13..2cfe9b7ad15 100644
--- a/doc/usage/cmd/sound.rst
+++ b/doc/usage/cmd/sound.rst
@@ -10,12 +10,12 @@ Synopsis
::
sound init
- sound play [len [freq]]
+ sound play [[len freq] ...] [len [freq]]
Description
-----------
-The *sound* command is used to play a beep sound.
+The *sound* command is used to play one or multiple beep sounds.
sound init
initializes the sound driver.
@@ -30,6 +30,25 @@ len
freq
frequency of the sound in Hz, defaults to 400 Hz
+Examples
+--------
+
+Beep at 400 Hz for 1000 ms::
+
+ sound play
+
+Beep at 400 Hz for 600 ms::
+
+ sound play 600
+
+Beep at 500 Hz for 600 ms::
+
+ sound play 600 500
+
+Play melody::
+
+ sound play 500 1047 500 880 500 0 500 1047 500 880 500 0 500 784 500 698 500 784 1000 698
+
Configuration
-------------