Struct tinkerforge::piezo_speaker_v2_bricklet::PiezoSpeakerV2Bricklet

pub struct PiezoSpeakerV2Bricklet { /* fields omitted */ }

Creates beep and alarm with configurable volume and frequency

Methods

impl PiezoSpeakerV2Bricklet

pub const DEVICE_IDENTIFIER: u16

pub const DEVICE_DISPLAY_NAME: &'static str

pub fn new<T: GetRequestSender>(
    uid: &str,
    req_sender: T
) -> PiezoSpeakerV2Bricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

pub fn get_response_expected(
    &mut self,
    fun: PiezoSpeakerV2BrickletFunction
) -> Result<bool, GetResponseExpectedError>

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See set_response_expected for the list of function ID constants available for this function.

pub fn set_response_expected(
    &mut self,
    fun: PiezoSpeakerV2BrickletFunction,
    response_expected: bool
) -> Result<(), SetResponseExpectedError>

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

pub fn set_response_expected_all(&mut self, response_expected: bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

pub fn get_api_version(&self) -> [u8; 3]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

pub fn get_beep_finished_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<()>

This receiver is triggered if a beep set by set_beep is finished

pub fn get_alarm_finished_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<()>

This receiver is triggered if a alarm set by set_alarm is finished

pub fn set_beep(
    &self,
    frequency: u16,
    volume: u8,
    duration: u32
) -> ConvertingReceiver<()>

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

Associated constants:

• PIEZO_SPEAKER_V2_BRICKLET_BEEP_DURATION_OFF
• PIEZO_SPEAKER_V2_BRICKLET_BEEP_DURATION_INFINITE

pub fn get_beep(&self) -> ConvertingReceiver<Beep>

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 in ms.

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

Associated constants:

• PIEZO_SPEAKER_V2_BRICKLET_BEEP_DURATION_OFF
• PIEZO_SPEAKER_V2_BRICKLET_BEEP_DURATION_INFINITE

pub fn set_alarm(
    &self,
    start_frequency: u16,
    end_frequency: u16,
    step_size: u16,
    step_delay: u16,
    volume: u8,
    duration: u32
) -> ConvertingReceiver<()>

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

The ranges are:

• 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

Associated constants:

• PIEZO_SPEAKER_V2_BRICKLET_ALARM_DURATION_OFF
• PIEZO_SPEAKER_V2_BRICKLET_ALARM_DURATION_INFINITE

pub fn get_alarm(&self) -> ConvertingReceiver<Alarm>

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 in ms as well as the current frequency of the alarm in Hz.

If the volume is updated during a beep (with update_volume) this function returns the updated value.

Associated constants:

• PIEZO_SPEAKER_V2_BRICKLET_ALARM_DURATION_OFF
• PIEZO_SPEAKER_V2_BRICKLET_ALARM_DURATION_INFINITE

pub fn update_volume(&self, volume: u8) -> ConvertingReceiver<()>

Updates the volume of an ongoing beep or alarm. The range of the volume is 0 to 10.

pub fn update_frequency(&self, frequency: u16) -> ConvertingReceiver<()>

Updates the frequency of an ongoing beep. The range of the frequency is 50Hz to 15000Hz.

pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>

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.

pub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>

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.

Associated constants:

• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_STATUS_OK
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>

Returns the current bootloader mode, see set_bootloader_mode.

Associated constants:

• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• PIEZO_SPEAKER_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>

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.

pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>

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.

pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>

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.

Associated constants:

• PIEZO_SPEAKER_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• PIEZO_SPEAKER_V2_BRICKLET_STATUS_LED_CONFIG_ON
• PIEZO_SPEAKER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• PIEZO_SPEAKER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by set_status_led_config

Associated constants:

• PIEZO_SPEAKER_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• PIEZO_SPEAKER_V2_BRICKLET_STATUS_LED_CONFIG_ON
• PIEZO_SPEAKER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• PIEZO_SPEAKER_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>

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.

pub fn reset(&self) -> ConvertingReceiver<()>

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!

pub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>

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.

pub fn read_uid(&self) -> ConvertingReceiver<u32>

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

pub fn get_identity(&self) -> ConvertingReceiver<Identity>

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 here. |device_identifier_constant|

Trait Implementations

impl Clone for PiezoSpeakerV2Bricklet

fn clone(&self) -> PiezoSpeakerV2Bricklet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.