| Heinrich Schuchardt | ce2f0c6 | 2022-12-04 16:16:12 +0100 | [diff] [blame] | 1 | .. SPDX-License-Identifier: GPL-2.0+ |
| 2 | .. Copyright 2022, Heinrich Schuchardt <xypron.glpk@gmx.de> |
| 3 | |
| 4 | sound command |
| 5 | ============= |
| 6 | |
| 7 | Synopsis |
| 8 | -------- |
| 9 | |
| 10 | :: |
| 11 | |
| 12 | sound init |
| 13 | sound play [len [freq]] |
| 14 | |
| 15 | Description |
| 16 | ----------- |
| 17 | |
| 18 | The *sound* command is used to play a beep sound. |
| 19 | |
| 20 | sound init |
| 21 | initializes the sound driver. |
| 22 | |
| 23 | sound play |
| 24 | plays a square wave sound. It does not depend on previously calling |
| 25 | *sound init*. |
| 26 | |
| 27 | len |
| 28 | duration of the sound in ms, defaults to 1000 ms |
| 29 | |
| 30 | freq |
| 31 | frequency of the sound in Hz, defaults to 400 Hz |
| 32 | |
| 33 | Configuration |
| 34 | ------------- |
| 35 | |
| 36 | The sound command is enabled by CONFIG_CMD_SOUND=y. |
| 37 | |
| 38 | Return value |
| 39 | ------------ |
| 40 | |
| 41 | The return value $? is 0 (true) if the command succeeds, 1 (false) otherwise. |