Tinkerforge::BrickletPiezoSpeakerV2 - Creates beep and alarm with configurable volume and frequency
This constant is used to identify a Piezo Speaker Bricklet 2.0.
The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.
This constant represents the display name of a Piezo Speaker Bricklet 2.0.
This constant is used with the register_callback() subroutine to specify the CALLBACK_BEEP_FINISHED callback.
This constant is used with the register_callback() subroutine to specify the CALLBACK_ALARM_FINISHED callback.
This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.
Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.
Beeps with the given frequency and volume for the duration in ms.
For example: If you set a duration of 1000, with a volume of 10 and a frequency value of 2000 the piezo buzzer will beep with maximum loudness for one second with a frequency of 2 kHz.
A duration of 0 stops the current beep if any is ongoing. A duration of 4294967295 results in an infinite beep.
The ranges are:
* Frequency: 50Hz - 15000Hz * Volume: 0 - 10 * Duration: 0ms - 4294967295ms
Returns the last beep settings as set by :func:`Set Beep`. If a beep is currently running it also returns the remaining duration of the beep in ms.
If the frequency or volume is updated during a beep (with :func:`Update Frequency` or :func:`Update Volume`) this function returns the updated value.
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 in Hz. * End Frequency: End frequency of the alarm in Hz. * Step Size: Size of one step of the sweep between the start/end frequencies in Hz. * Step Delay: Delay between two steps (duration of time that one tone is used in a sweep) in ms. * Duration: Duration of the alarm in ms.
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
* Start Frequency: 50Hz - 14999Hz (has to be smaller than end frequency) * End Frequency: 51Hz - 15000Hz (has to be bigger than start frequency) * Step Size: 1Hz - 65535Hz (has to be small enough to fit into the frequency range) * Step Delay: 1ms - 65535ms (has to be small enough to fit into the duration) * Volume: 0 - 10 * Duration: 0ms - 4294967295ms
Returns the last alarm settings as set by :func:`Set Alarm`. If an alarm is currently running it also returns the remaining duration of the alarm in ms as well as the current frequency of the alarm in Hz.
If the volume is updated during a beep (with :func:`Update Volume`) this function returns the updated value.
Updates the volume of an ongoing beep or alarm. The range of the volume is 0 to 10.
Updates the frequency of an ongoing beep. The range of the frequency is 50Hz to 15000Hz.
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.
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.
Returns the current bootloader mode, see :func:`Set Bootloader Mode`.
Sets the firmware pointer for :func:`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).
Writes 64 Bytes of firmware at the position as written by :func:`Set Write Firmware Pointer` before. The firmware is written to flash every 4 chunks.
You can only write firmware in bootloader mode.
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.
Returns the configuration as set by :func:`Set Status LED Config`
Returns the temperature in °C 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.
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!
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.
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
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' or 'd'.
The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|
To install Tinkerforge, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tinkerforge
CPAN shell
perl -MCPAN -e shell install Tinkerforge
For more information on module installation, please visit the detailed CPAN module installation guide.