Deutsch
English
Menu

C/C++ for Microcontrollers - Piezo Speaker Bricklet 2.0

This is the description of the C/C++ for Microcontrollers API bindings for the Piezo Speaker Bricklet 2.0. General information and technical specifications for the Piezo Speaker Bricklet 2.0 are summarized in its hardware description.

An installation guide for the C/C++ for Microcontrollers API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Beep

Download (example_beep.c)

 1// This example is not self-contained.
 2// It requires usage of the example driver specific to your platform.
 3// See the HAL documentation.
 4
 5#include "src/bindings/hal_common.h"
 6#include "src/bindings/bricklet_piezo_speaker_v2.h"
 7
 8void check(int rc, const char *msg);
 9void example_setup(TF_HAL *hal);
10void example_loop(TF_HAL *hal);
11
12static TF_PiezoSpeakerV2 ps;
13
14void example_setup(TF_HAL *hal) {
15    // Create device object
16    check(tf_piezo_speaker_v2_create(&ps, NULL, hal), "create device object");
17
18    // Make 2 second beep with a frequency of 1kHz
19    check(tf_piezo_speaker_v2_set_beep(&ps, 1000, 0, 2000), "call set_beep");
20}
21
22void example_loop(TF_HAL *hal) {
23    // Poll for callbacks
24    tf_hal_callback_tick(hal, 0);
25}

Alarm

Download (example_alarm.c)

 1// This example is not self-contained.
 2// It requires usage of the example driver specific to your platform.
 3// See the HAL documentation.
 4
 5#include "src/bindings/hal_common.h"
 6#include "src/bindings/bricklet_piezo_speaker_v2.h"
 7
 8void check(int rc, const char *msg);
 9void example_setup(TF_HAL *hal);
10void example_loop(TF_HAL *hal);
11
12static TF_PiezoSpeakerV2 ps;
13
14void example_setup(TF_HAL *hal) {
15    // Create device object
16    check(tf_piezo_speaker_v2_create(&ps, NULL, hal), "create device object");
17
18    // 10 seconds of loud annoying fast alarm
19    check(tf_piezo_speaker_v2_set_alarm(&ps, 800, 2000, 10, 1, 10,
20                                        10000), "call set_alarm");
21}
22
23void example_loop(TF_HAL *hal) {
24    // Poll for callbacks
25    tf_hal_callback_tick(hal, 0);
26}

API

Most functions of the C/C++ bindings for microcontrollers return an error code (e_code).

Possible error codes are:

  • TF_E\ _OK = 0

  • TF_E\ _TIMEOUT = -1

  • TF_E\ _INVALID_PARAMETER = -2

  • TF_E\ _NOT_SUPPORTED = -3

  • TF_E\ _UNKNOWN_ERROR_CODE = -4

  • TF_E\ _STREAM_OUT_OF_SYNC = -5

  • TF_E\ _INVALID_CHAR_IN_UID = -6

  • TF_E\ _UID_TOO_LONG = -7

  • TF_E\ _UID_OVERFLOW = -8

  • TF_E\ _TOO_MANY_DEVICES = -9

  • TF_E\ _DEVICE_NOT_FOUND = -10

  • TF_E\ _WRONG_DEVICE_TYPE = -11

  • TF_E\ _LOCKED = -12

  • TF_E\ _PORT_NOT_FOUND = -13

(as defined in errors.h) as well as the errors returned from the hardware abstraction layer (HAL) that is used.

Use :cpp:func`tf_hal_strerror` (defined in the HAL's header file) to get an error string for an error code.

Data returned from the device, when a getter is called, is handled via output parameters. These parameters are labeled with the ret_ prefix. The bindings will not write to an output parameter if NULL or nullptr is passed. This can be used to ignore outputs that you are not interested in.

None of the functions listed below are thread-safe. See the API bindings description for details.

Basic Functions

int tf_piezo_speaker_v2_create(TF_PiezoSpeakerV2 *piezo_speaker_v2, const char *uid_or_port_name, TF_HAL *hal)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • uid – Type: const char *
  • hal – Type: TF_HAL *
Returns:
  • e_code – Type: int

Creates the device object piezo_speaker_v2 with the optional unique device ID or port name uid_or_port_name and adds it to the HAL hal:

TF_PiezoSpeakerV2 piezo_speaker_v2;
tf_piezo_speaker_v2_create(&piezo_speaker_v2, NULL, &hal);

Normally uid_or_port_name can stay NULL. For more details about this see section UID or Port Name.

int tf_piezo_speaker_v2_destroy(TF_PiezoSpeakerV2 *piezo_speaker_v2)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
Returns:
  • e_code – Type: int

Removes the device object piezo_speaker_v2 from its HAL and destroys it. The device object cannot be used anymore afterwards.

int tf_piezo_speaker_v2_set_beep(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint16_t frequency, uint8_t volume, uint32_t duration)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • frequency – Type: uint16_t, Unit: 1 Hz, Range: [50 to 15000]
  • volume – Type: uint8_t, Range: [0 to 10]
  • duration – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1] with constants
Returns:
  • e_code – Type: int

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 constants are available for this function:

For duration:

  • TF_PIEZO_SPEAKER_V2_BEEP_DURATION_OFF = 0

  • TF_PIEZO_SPEAKER_V2_BEEP_DURATION_INFINITE = 4294967295

int tf_piezo_speaker_v2_get_beep(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint16_t *ret_frequency, uint8_t *ret_volume, uint32_t *ret_duration, uint32_t *ret_duration_remaining)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
Output Parameters:
  • ret_frequency – Type: uint16_t, Unit: 1 Hz, Range: [50 to 15000]
  • ret_volume – Type: uint8_t, Range: [0 to 10]
  • ret_duration – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1] with constants
  • ret_duration_remaining – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

Returns the last beep settings as set by tf_piezo_speaker_v2_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 tf_piezo_speaker_v2_update_frequency() or tf_piezo_speaker_v2_update_volume()) this function returns the updated value.

The following constants are available for this function:

For ret_duration:

  • TF_PIEZO_SPEAKER_V2_BEEP_DURATION_OFF = 0

  • TF_PIEZO_SPEAKER_V2_BEEP_DURATION_INFINITE = 4294967295

int tf_piezo_speaker_v2_set_alarm(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint16_t start_frequency, uint16_t end_frequency, uint16_t step_size, uint16_t step_delay, uint8_t volume, uint32_t duration)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • start_frequency – Type: uint16_t, Unit: 1 Hz, Range: [50 to 14999]
  • end_frequency – Type: uint16_t, Unit: 1 Hz, Range: [51 to 15000]
  • step_size – Type: uint16_t, Unit: 1 Hz, Range: [0 to 14950]
  • step_delay – Type: uint16_t, Unit: 1 ms, Range: [0 to 216 - 1]
  • volume – Type: uint8_t, Range: [0 to 10]
  • duration – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1] with constants
Returns:
  • e_code – Type: int

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 constants are available for this function:

For duration:

  • TF_PIEZO_SPEAKER_V2_ALARM_DURATION_OFF = 0

  • TF_PIEZO_SPEAKER_V2_ALARM_DURATION_INFINITE = 4294967295

int tf_piezo_speaker_v2_get_alarm(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint16_t *ret_start_frequency, uint16_t *ret_end_frequency, uint16_t *ret_step_size, uint16_t *ret_step_delay, uint8_t *ret_volume, uint32_t *ret_duration, uint32_t *ret_duration_remaining, uint16_t *ret_current_frequency)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
Output Parameters:
  • ret_start_frequency – Type: uint16_t, Unit: 1 Hz, Range: [50 to 14999]
  • ret_end_frequency – Type: uint16_t, Unit: 1 Hz, Range: [51 to 15000]
  • ret_step_size – Type: uint16_t, Unit: 1 Hz, Range: [50 to 14950]
  • ret_step_delay – Type: uint16_t, Unit: 1 ms, Range: [0 to 216 - 1]
  • ret_volume – Type: uint8_t, Range: [0 to 10]
  • ret_duration – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1] with constants
  • ret_duration_remaining – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1] with constants
  • ret_current_frequency – Type: uint16_t, Unit: 1 Hz, Range: [50 to 15000]
Returns:
  • e_code – Type: int

Returns the last alarm settings as set by tf_piezo_speaker_v2_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 tf_piezo_speaker_v2_update_volume()) this function returns the updated value.

The following constants are available for this function:

For ret_duration:

  • TF_PIEZO_SPEAKER_V2_ALARM_DURATION_OFF = 0

  • TF_PIEZO_SPEAKER_V2_ALARM_DURATION_INFINITE = 4294967295

For ret_duration_remaining:

  • TF_PIEZO_SPEAKER_V2_ALARM_DURATION_OFF = 0

  • TF_PIEZO_SPEAKER_V2_ALARM_DURATION_INFINITE = 4294967295

int tf_piezo_speaker_v2_update_volume(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint8_t volume)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • volume – Type: uint8_t, Range: [0 to 10]
Returns:
  • e_code – Type: int

Updates the volume of an ongoing beep or alarm.

int tf_piezo_speaker_v2_update_frequency(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint16_t frequency)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • frequency – Type: uint16_t, Unit: 1 Hz, Range: [50 to 15000]
Returns:
  • e_code – Type: int

Updates the frequency of an ongoing beep.

Advanced Functions

int tf_piezo_speaker_v2_get_spitfp_error_count(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
Output Parameters:
  • ret_error_count_ack_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_message_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_frame – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_overflow – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

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.

int tf_piezo_speaker_v2_set_status_led_config(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint8_t config)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • e_code – Type: int

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 constants are available for this function:

For config:

  • TF_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_OFF = 0

  • TF_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_ON = 1

  • TF_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

  • TF_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_piezo_speaker_v2_get_status_led_config(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint8_t *ret_config)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
Output Parameters:
  • ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • e_code – Type: int

Returns the configuration as set by tf_piezo_speaker_v2_set_status_led_config()

The following constants are available for this function:

For ret_config:

  • TF_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_OFF = 0

  • TF_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_ON = 1

  • TF_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

  • TF_PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_piezo_speaker_v2_get_chip_temperature(TF_PiezoSpeakerV2 *piezo_speaker_v2, int16_t *ret_temperature)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
Output Parameters:
  • ret_temperature – Type: int16_t, Unit: 1 °C, Range: [-215 to 215 - 1]
Returns:
  • e_code – Type: int

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.

int tf_piezo_speaker_v2_reset(TF_PiezoSpeakerV2 *piezo_speaker_v2)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
Returns:
  • e_code – Type: int

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!

int tf_piezo_speaker_v2_get_identity(TF_PiezoSpeakerV2 *piezo_speaker_v2, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
Output Parameters:
  • ret_uid – Type: char[8]
  • ret_connected_uid – Type: char[8]
  • ret_position – Type: char, Range: ['a' to 'h', 'z']
  • ret_hardware_version – Type: uint8_t[3]
    • 0: major – Type: uint8_t, Range: [0 to 255]
    • 1: minor – Type: uint8_t, Range: [0 to 255]
    • 2: revision – Type: uint8_t, Range: [0 to 255]
  • ret_firmware_version – Type: uint8_t[3]
    • 0: major – Type: uint8_t, Range: [0 to 255]
    • 1: minor – Type: uint8_t, Range: [0 to 255]
    • 2: revision – Type: uint8_t, Range: [0 to 255]
  • ret_device_identifier – Type: uint16_t, Range: [0 to 216 - 1]
Returns:
  • e_code – Type: int

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. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding tf_piezo_speaker_v2_register_*_callback function. The user_data passed to the registration function as well as the device that triggered the callback are passed to the registered callback handler.

Only one handler can be registered to a callback at the same time. To deregister a callback, call the tf_piezo_speaker_v2_register_*_callback function with NULL as handler.

Note

Using callbacks for recurring events is preferred compared to using getters. Polling for a callback requires writing one byte only. See here Optimizing Performance.

Warning

Calling bindings function from inside a callback handler is not allowed. See here Thread safety.

int tf_piezo_speaker_v2_register_beep_finished_callback(TF_PiezoSpeakerV2 *piezo_speaker_v2, TF_PiezoSpeakerV2_BeepFinishedHandler handler, void *user_data)
void handler(TF_PiezoSpeakerV2 *piezo_speaker_v2, void *user_data)
Callback Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • user_data – Type: void *

This callback is triggered if a beep set by tf_piezo_speaker_v2_set_beep() is finished

int tf_piezo_speaker_v2_register_alarm_finished_callback(TF_PiezoSpeakerV2 *piezo_speaker_v2, TF_PiezoSpeakerV2_AlarmFinishedHandler handler, void *user_data)
void handler(TF_PiezoSpeakerV2 *piezo_speaker_v2, void *user_data)
Callback Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • user_data – Type: void *

This callback is triggered if a alarm set by tf_piezo_speaker_v2_set_alarm() is finished

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object.

int tf_piezo_speaker_v2_get_response_expected(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint8_t function_id, bool *ret_response_expected)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • function_id – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_response_expected – Type: bool
Returns:
  • e_code – Type: int

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

The following constants are available for this function:

For function_id:

  • TF_PIEZO_SPEAKER_V2_FUNCTION_SET_BEEP = 1

  • TF_PIEZO_SPEAKER_V2_FUNCTION_SET_ALARM = 3

  • TF_PIEZO_SPEAKER_V2_FUNCTION_UPDATE_VOLUME = 5

  • TF_PIEZO_SPEAKER_V2_FUNCTION_UPDATE_FREQUENCY = 6

  • TF_PIEZO_SPEAKER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

  • TF_PIEZO_SPEAKER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239

  • TF_PIEZO_SPEAKER_V2_FUNCTION_RESET = 243

  • TF_PIEZO_SPEAKER_V2_FUNCTION_WRITE_UID = 248

int tf_piezo_speaker_v2_set_response_expected(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint8_t function_id, bool response_expected)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • function_id – Type: uint8_t, Range: See constants
  • response_expected – Type: bool
Returns:
  • e_code – Type: int

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.

The following constants are available for this function:

For function_id:

  • TF_PIEZO_SPEAKER_V2_FUNCTION_SET_BEEP = 1

  • TF_PIEZO_SPEAKER_V2_FUNCTION_SET_ALARM = 3

  • TF_PIEZO_SPEAKER_V2_FUNCTION_UPDATE_VOLUME = 5

  • TF_PIEZO_SPEAKER_V2_FUNCTION_UPDATE_FREQUENCY = 6

  • TF_PIEZO_SPEAKER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

  • TF_PIEZO_SPEAKER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239

  • TF_PIEZO_SPEAKER_V2_FUNCTION_RESET = 243

  • TF_PIEZO_SPEAKER_V2_FUNCTION_WRITE_UID = 248

int tf_piezo_speaker_v2_set_response_expected_all(TF_PiezoSpeakerV2 *piezo_speaker_v2, bool response_expected)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • response_expected – Type: bool
Returns:
  • e_code – Type: int

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

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.

int tf_piezo_speaker_v2_set_bootloader_mode(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint8_t mode, uint8_t *ret_status)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • mode – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_status – Type: uint8_t, Range: See constants
Returns:
  • e_code – Type: int

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 constants are available for this function:

For mode:

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_BOOTLOADER = 0

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE = 1

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_OK = 0

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_INVALID_MODE = 1

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_NO_CHANGE = 2

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_piezo_speaker_v2_get_bootloader_mode(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint8_t *ret_mode)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
Output Parameters:
  • ret_mode – Type: uint8_t, Range: See constants
Returns:
  • e_code – Type: int

Returns the current bootloader mode, see tf_piezo_speaker_v2_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_BOOTLOADER = 0

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE = 1

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

  • TF_PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_piezo_speaker_v2_set_write_firmware_pointer(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint32_t pointer)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • pointer – Type: uint32_t, Unit: 1 B, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

Sets the firmware pointer for tf_piezo_speaker_v2_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.

int tf_piezo_speaker_v2_write_firmware(TF_PiezoSpeakerV2 *piezo_speaker_v2, const uint8_t data[64], uint8_t *ret_status)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • data – Type: const uint8_t[64], Range: [0 to 255]
Output Parameters:
  • ret_status – Type: uint8_t, Range: [0 to 255]
Returns:
  • e_code – Type: int

Writes 64 Bytes of firmware at the position as written by tf_piezo_speaker_v2_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.

int tf_piezo_speaker_v2_write_uid(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint32_t uid)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
  • uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

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.

int tf_piezo_speaker_v2_read_uid(TF_PiezoSpeakerV2 *piezo_speaker_v2, uint32_t *ret_uid)
Parameters:
  • piezo_speaker_v2 – Type: TF_PiezoSpeakerV2 *
Output Parameters:
  • ret_uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

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

Constants

TF_PIEZO_SPEAKER_V2_DEVICE_IDENTIFIER

This constant is used to identify a Piezo Speaker Bricklet 2.0.

The functions tf_piezo_speaker_v2_get_identity() and tf_hal_get_device_info() have a device_identifier output parameter to specify the Brick's or Bricklet's type.

TF_PIEZO_SPEAKER_V2_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Piezo Speaker Bricklet 2.0.