Shell - Piezo Speaker Bricklet 2.0¶

Alarm¶

Download (example-alarm.sh)

1#!/bin/sh
2# Connects to localhost:4223 by default, use --host and --port to change this
3
4uid=XYZ # Change XYZ to the UID of your Piezo Speaker Bricklet 2.0
5
6# 10 seconds of loud annoying fast alarm
7tinkerforge call piezo-speaker-v2-bricklet $uid set-alarm 800 2000 10 1 10 10000

Beep¶

Download (example-beep.sh)

1#!/bin/sh
2# Connects to localhost:4223 by default, use --host and --port to change this
3
4uid=XYZ # Change XYZ to the UID of your Piezo Speaker Bricklet 2.0
5
6# Make 2 second beep with a frequency of 1kHz
7tinkerforge call piezo-speaker-v2-bricklet $uid set-beep 1000 0 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-v2-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 2.0. 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 2.0 and exits

tinkerforge dispatch piezo-speaker-v2-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 2.0. 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 2.0 and exits

tinkerforge call piezo-speaker-v2-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-v2-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-v2-bricklet <uid> set-beep <frequency> <volume> <duration>¶

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

Beeps with the given frequency and volume for the duration.

A duration of 0 stops the current beep if any is ongoing. A duration of 4294967295 results in an infinite beep.

The following symbols are available for this function:

For <duration>:

• beep-duration-off = 0

• beep-duration-infinite = 4294967295

tinkerforge call piezo-speaker-v2-bricklet <uid> get-beep¶

Output:	frequency – Type: Int, Unit: 1 Hz, Range: [50 to 15000] volume – Type: Int, Range: [0 to 10] duration – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1] with symbols duration-remaining – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1]

Returns the last beep settings as set by set-beep. If a beep is currently running it also returns the remaining duration of the beep.

If the frequency or volume is updated during a beep (with update-frequency or update-volume) this function returns the updated value.

The following symbols are available for this function:

For duration:

• beep-duration-off = 0

• beep-duration-infinite = 4294967295

tinkerforge call piezo-speaker-v2-bricklet <uid> set-alarm <start-frequency> <end-frequency> <step-size> <step-delay> <volume> <duration>¶

Parameters:	<start-frequency> – Type: Int, Unit: 1 Hz, Range: [50 to 14999] <end-frequency> – Type: Int, Unit: 1 Hz, Range: [51 to 15000] <step-size> – Type: Int, Unit: 1 Hz, Range: [0 to 14950] <step-delay> – Type: Int, Unit: 1 ms, Range: [0 to 216 - 1] <volume> – Type: Int, Range: [0 to 10] <duration> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1] with symbols
Output:	no output

Creates an alarm (a tone that goes back and force between two specified frequencies).

The following parameters can be set:

• Start Frequency: Start frequency of the alarm.

• End Frequency: End frequency of the alarm.

• Step Size: Size of one step of the sweep between the start/end frequencies.

• Step Delay: Delay between two steps (duration of time that one tone is used in a sweep).

• Duration: Duration of the alarm.

A duration of 0 stops the current alarm if any is ongoing. A duration of 4294967295 results in an infinite alarm.

Below you can find two sets of example settings that you can try out. You can use these as a starting point to find an alarm signal that suits your application.

Example 1: 10 seconds of loud annoying fast alarm

• Start Frequency = 800

• End Frequency = 2000

• Step Size = 10

• Step Delay = 1

• Volume = 10

• Duration = 10000

Example 2: 10 seconds of soft siren sound with slow build-up

• Start Frequency = 250

• End Frequency = 750

• Step Size = 1

• Step Delay = 5

• Volume = 0

• Duration = 10000

The following conditions must be met:

• Start Frequency: has to be smaller than end frequency

• End Frequency: has to be bigger than start frequency

• Step Size: has to be small enough to fit into the frequency range

• Step Delay: has to be small enough to fit into the duration

The following symbols are available for this function:

For <duration>:

• alarm-duration-off = 0

• alarm-duration-infinite = 4294967295

tinkerforge call piezo-speaker-v2-bricklet <uid> get-alarm¶

Output:

start-frequency – Type: Int, Unit: 1 Hz, Range: [50 to 14999] end-frequency – Type: Int, Unit: 1 Hz, Range: [51 to 15000] step-size – Type: Int, Unit: 1 Hz, Range: [50 to 14950] step-delay – Type: Int, Unit: 1 ms, Range: [0 to 216 - 1] volume – Type: Int, Range: [0 to 10] duration – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1] with symbols duration-remaining – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1] with symbols current-frequency – Type: Int, Unit: 1 Hz, Range: [50 to 15000]

Returns the last alarm settings as set by set-alarm. If an alarm is currently running it also returns the remaining duration of the alarm as well as the current frequency of the alarm.

If the volume is updated during an alarm (with update-volume) this function returns the updated value.

The following symbols are available for this function:

For duration:

• alarm-duration-off = 0

• alarm-duration-infinite = 4294967295

For duration-remaining:

• alarm-duration-off = 0

• alarm-duration-infinite = 4294967295

tinkerforge call piezo-speaker-v2-bricklet <uid> update-volume <volume>¶

Parameters:	<volume> – Type: Int, Range: [0 to 10]
Output:	no output

Updates the volume of an ongoing beep or alarm.

tinkerforge call piezo-speaker-v2-bricklet <uid> update-frequency <frequency>¶

Parameters:	<frequency> – Type: Int, Unit: 1 Hz, Range: [50 to 15000]
Output:	no output

Updates the frequency of an ongoing beep.

Advanced Functions¶

tinkerforge call piezo-speaker-v2-bricklet <uid> get-spitfp-error-count¶

Output:	error-count-ack-checksum – Type: Int, Range: [0 to 232 - 1] error-count-message-checksum – Type: Int, Range: [0 to 232 - 1] error-count-frame – Type: Int, Range: [0 to 232 - 1] error-count-overflow – Type: Int, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

• ACK checksum errors,

• message checksum errors,

• framing errors and

• overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

tinkerforge call piezo-speaker-v2-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following symbols are available for this function:

For <config>:

• status-led-config-off = 0

• status-led-config-on = 1

• status-led-config-show-heartbeat = 2

• status-led-config-show-status = 3

tinkerforge call piezo-speaker-v2-bricklet <uid> get-status-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

For config:

• status-led-config-off = 0

• status-led-config-on = 1

• status-led-config-show-heartbeat = 2

• status-led-config-show-status = 3

tinkerforge call piezo-speaker-v2-bricklet <uid> get-chip-temperature¶

Output:	temperature – Type: Int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

tinkerforge call piezo-speaker-v2-bricklet <uid> reset¶

Output:	no output

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

tinkerforge call piezo-speaker-v2-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-v2-bricklet <uid> example

The available callbacks are described below.

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

Output:	no output

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

tinkerforge dispatch piezo-speaker-v2-bricklet <uid> alarm-finished¶

Output:	no output

This callback is triggered if a alarm set by set-alarm is finished

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

tinkerforge call piezo-speaker-v2-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols
Output:	status – Type: Int, Range: See symbols

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following symbols are available for this function:

For <mode>:

• bootloader-mode-bootloader = 0

• bootloader-mode-firmware = 1

• bootloader-mode-bootloader-wait-for-reboot = 2

• bootloader-mode-firmware-wait-for-reboot = 3

• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

For status:

• bootloader-status-ok = 0

• bootloader-status-invalid-mode = 1

• bootloader-status-no-change = 2

• bootloader-status-entry-function-not-present = 3

• bootloader-status-device-identifier-incorrect = 4

• bootloader-status-crc-mismatch = 5

tinkerforge call piezo-speaker-v2-bricklet <uid> get-bootloader-mode¶

Output:	mode – Type: Int, Range: See symbols

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

For mode:

• bootloader-mode-bootloader = 0

• bootloader-mode-firmware = 1

• bootloader-mode-bootloader-wait-for-reboot = 2

• bootloader-mode-firmware-wait-for-reboot = 3

• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call piezo-speaker-v2-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameters:	<pointer> – Type: Int, Unit: 1 B, Range: [0 to 232 - 1]
Output:	no output

Sets the firmware pointer for write-firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call piezo-speaker-v2-bricklet <uid> write-firmware <data>¶

Parameters:	<data> – Type: Int Array, Length: 64, Range: [0 to 255]
Output:	status – Type: Int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by set-write-firmware-pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call piezo-speaker-v2-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> – Type: Int, Range: [0 to 232 - 1]
Output:	no output

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

tinkerforge call piezo-speaker-v2-bricklet <uid> read-uid¶

Output:	uid – Type: Int, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.