Shell - Piezo Speaker Bricklet¶

Beep¶

Download (example-beep.sh)

1
2
3
4
5
6
7

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Piezo Speaker Bricklet

# Make 2 second beep with a frequency of 1kHz
tinkerforge call piezo-speaker-bricklet $uid beep 2000 1000

Morse Code¶

Download (example-morse-code.sh)

1
2
3
4
5
6
7

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Piezo Speaker Bricklet

# Morse SOS with a frequency of 2kHz
tinkerforge call piezo-speaker-bricklet $uid morse-code "... --- ..." 2000

Command Structure¶

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call piezo-speaker-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The call command is used to call a function of the Piezo Speaker Bricklet. It can take several options:

• --help shows help for the specific call command and exits
• --list-functions shows a list of known functions of the Piezo Speaker Bricklet and exits

tinkerforge dispatch piezo-speaker-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

The dispatch command is used to dispatch a callback of the Piezo Speaker Bricklet. It can take several options:

• --help shows help for the specific dispatch command and exits
• --list-callbacks shows a list of known callbacks of the Piezo Speaker Bricklet and exits

tinkerforge call piezo-speaker-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The <function> to be called can take different options depending of its kind. All functions can take the following options:

• --help shows help for the specific function and exits

Getter functions can take the following options:

• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

• --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch piezo-speaker-bricklet <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: String

The <callback> to be dispatched can take several options:

• --help shows help for the specific callback and exits
• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions¶

tinkerforge call piezo-speaker-bricklet <uid> beep <duration> <frequency>¶

Parameters:	<duration> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1] with symbols <frequency> – Type: Int, Unit: 1 Hz, Range: [585 to 7100]
Output:	no output

Beeps with the given frequency for the given duration.

Changed in version 2.0.2 (Plugin): A duration of 0 stops the current beep if any, the frequency parameter is ignored. A duration of 4294967295 results in an infinite beep.

The Piezo Speaker Bricklet can only approximate the frequency, it will play the best possible match by applying the calibration (see calibrate).

The following symbols are available for this function:

For <duration>:

• beep-duration-off = 0
• beep-duration-infinite = 4294967295

tinkerforge call piezo-speaker-bricklet <uid> morse-code <morse> <frequency>¶

Parameters:	<morse> – Type: String, Length: up to 60 <frequency> – Type: Int, Unit: 1 Hz, Range: [585 to 7100]
Output:	no output

Sets morse code that will be played by the piezo buzzer. The morse code is given as a string consisting of "." (dot), "-" (minus) and " " (space) for dits, dahs and pauses. Every other character is ignored.

For example: If you set the string "...---...", the piezo buzzer will beep nine times with the durations "short short short long long long short short short".

Advanced Functions¶

tinkerforge call piezo-speaker-bricklet <uid> calibrate¶

Output:	calibration – Type: Bool

The Piezo Speaker Bricklet can play 512 different tones. This function plays each tone and measures the exact frequency back. The result is a mapping between setting value and frequency. This mapping is stored in the EEPROM and loaded on startup.

The Bricklet should come calibrated, you only need to call this function (once) every time you reflash the Bricklet plugin.

Returns true after the calibration finishes.

tinkerforge call piezo-speaker-bricklet <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [a to h, z] hardware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] firmware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] device-identifier – Type: Int, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. 

Callbacks¶

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch piezo-speaker-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch piezo-speaker-bricklet <uid> beep-finished¶

Output:	no output

This callback is triggered if a beep set by beep is finished

tinkerforge dispatch piezo-speaker-bricklet <uid> morse-code-finished¶

Output:	no output

This callback is triggered if the playback of the morse code set by morse-code is finished.