beeper

The beeper commands module.

These commands are used in the following models: SS3706A

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Attributes and Functions
- beeper.beep()
- beeper.enable

Beeper

Bases: BaseTSPCmd

The beeper command tree.

Properties and methods
  • .beep(): The beeper.beep() function.
  • .enable: The beeper.enable attribute.

enable property writable

enable: str

Access the beeper.enable attribute.

Description
  • This command allows you to turn the beeper on or off.
Usage
  • Accessing this property will send the print(beeper.enable) query.
  • Setting this property to a value will send the beeper.enable = value command.
TSP Syntax
- beeper.enable = value
- print(beeper.enable)
Raises:

beep

beep(duration: float, frequency: float) -> None

Run the beeper.beep() function.

Description
  • This function generates an audible tone.
TSP Syntax
- beeper.beep()
Parameters:
  • duration (float) –

    The amount of time to play the tone (0.001 s to 100 s).

  • frequency (float) –

    The frequency of the beep (20 Hz to 8000 Hz).

Raises: