This is the description of the Shell API bindings for the Piezo Buzzer Bricklet. General information and technical specifications for the Piezo Buzzer Bricklet are summarized in its hardware description.
An installation guide for the Shell API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
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 Buzzer Bricklet # Make 2 second beep tinkerforge call piezo-buzzer-bricklet $uid beep 2000
Possible exit codes for all tinkerforge commands are:
The common options of the call and dispatch commands are documented here. The specific command structure is shown below.
The call command is used to call a function of the Piezo Buzzer Bricklet. It can take several options:
The dispatch command is used to dispatch a callback of the Piezo Buzzer Bricklet. It can take several options:
The <function> to be called can take different options depending of its kind. All functions can take the following options:
Getter functions can take the following options:
Setter functions can take the following options:
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.
The <callback> to be dispatched can take several options:
Beeps for the given duration.
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".
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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.
The device identifier numbers can be found here.
Callbacks can be used to receive time critical or recurring data from the device:
tinkerforge dispatch piezo-buzzer-bricklet <uid> example
The available callbacks are described below.
Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.
This callback is triggered if a beep set by beep is finished