Struct PiezoSpeakerV2Bricklet

pub struct PiezoSpeakerV2Bricklet { /* private fields */ }

Creates beep and alarm with configurable volume and frequency

Implementations

impl PiezoSpeakerV2Bricklet

pub const DEVICE_IDENTIFIER: u16 = 2_145u16

pub const DEVICE_DISPLAY_NAME: &'static str = "Piezo Speaker Bricklet 2.0"

pub fn new(uid: Uid, connection: AsyncIpConnection) -> 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 sent 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 sent 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 async fn get_beep_finished_callback_receiver( &mut self, ) -> impl Stream<Item = ()>

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

pub async fn get_alarm_finished_callback_receiver( &mut self, ) -> impl Stream<Item = ()>

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

pub async fn set_beep( &mut self, frequency: u16, volume: u8, duration: u32, ) -> Result<(), TinkerforgeError>

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.

Associated constants:

• PIEZO_SPEAKER_V2_BRICKLET_BEEP_DURATION_OFF
• PIEZO_SPEAKER_V2_BRICKLET_BEEP_DURATION_INFINITE

pub async fn get_beep(&mut self) -> Result<Beep, TinkerforgeError>

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.

Associated constants:

• PIEZO_SPEAKER_V2_BRICKLET_BEEP_DURATION_OFF
• PIEZO_SPEAKER_V2_BRICKLET_BEEP_DURATION_INFINITE

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

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

Associated constants:

• PIEZO_SPEAKER_V2_BRICKLET_ALARM_DURATION_OFF
• PIEZO_SPEAKER_V2_BRICKLET_ALARM_DURATION_INFINITE

pub async fn get_alarm(&mut self) -> Result<Alarm, TinkerforgeError>

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.

Associated constants:

• PIEZO_SPEAKER_V2_BRICKLET_ALARM_DURATION_OFF
• PIEZO_SPEAKER_V2_BRICKLET_ALARM_DURATION_INFINITE

pub async fn update_volume( &mut self, volume: u8, ) -> Result<(), TinkerforgeError>

Updates the volume of an ongoing beep or alarm.

pub async fn update_frequency( &mut self, frequency: u16, ) -> Result<(), TinkerforgeError>

Updates the frequency of an ongoing beep.

pub async fn get_spitfp_error_count( &mut self, ) -> Result<SpitfpErrorCount, TinkerforgeError>

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 async fn set_bootloader_mode( &mut self, mode: u8, ) -> Result<u8, TinkerforgeError>

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 async fn get_bootloader_mode(&mut self) -> Result<u8, TinkerforgeError>

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 async fn set_write_firmware_pointer( &mut self, pointer: u32, ) -> Result<(), TinkerforgeError>

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 async fn write_firmware( &mut self, data: &[u8; 64], ) -> Result<u8, TinkerforgeError>

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 async fn set_status_led_config( &mut self, config: u8, ) -> Result<(), TinkerforgeError>

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 async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>

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 async fn get_chip_temperature(&mut self) -> Result<i16, TinkerforgeError>

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.

pub async fn reset(&mut self) -> Result<(), TinkerforgeError>

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 async fn write_uid(&mut self, uid: u32) -> Result<(), TinkerforgeError>

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 async fn read_uid(&mut self) -> Result<u32, TinkerforgeError>

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

pub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>

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

Trait Implementations

impl Clone for PiezoSpeakerV2Bricklet

fn clone(&self) -> PiezoSpeakerV2Bricklet

Returns a duplicate of the value.

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

Performs copy-assignment from source.