alarm Command

Produces a tone on the speaker.

Scope: Global

Syntax

Parameters

Tone 
Frequency in hertz in the range 50 to 20000. The default is 440. Tone can also be set using the beeptone parameter.
Duration 
Duration in hundredths of a second in the range 0 to 1000. The default is 20. Duration can also be set using the beeplength parameter.

Description

The alarm command sounds a tone on the speaker, if sound has not been turned off using a system command or the set beep off command. Use the set alarm on command to produce the sound when the screen is next refreshed.

Note: If the system beep has been turned off using an system command, the beep on parameter cannot override it and the alarm will remain off.

Example

To change the alarm, type:

alarm 100 75 

API Return Code

-1 
A parameter issued with the command was not valid. Issue the command again with valid numeric values for Duration and Tone.

beep Parameter
beeptone Parameter
beeplength Parameter
alarm Parameter