TCP/IP - Piezo Speaker Bricklet 2.0

This is the description of the TCP/IP protocol 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.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletPiezoSpeakerV2.set_beep
Function ID:

1

Request:
  • frequency -- uint16
  • volume -- uint8
  • duration -- uint32
Response:

no response

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

The following meanings are defined for the parameters of this function:

  • 0: off, for duration
  • 4294967295: infinite, for duration
BrickletPiezoSpeakerV2.get_beep
Function ID:

2

Request:

empty payload

Response:
  • frequency -- uint16
  • volume -- uint8
  • duration -- uint32
  • duration_remaining -- uint32

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.

The following meanings are defined for the parameters of this function:

  • 0: off, for duration
  • 4294967295: infinite, for duration
BrickletPiezoSpeakerV2.set_alarm
Function ID:

3

Request:
  • start_frequency -- uint16
  • end_frequency -- uint16
  • step_size -- uint16
  • step_delay -- uint16
  • volume -- uint8
  • duration -- uint32
Response:

no response

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

The following meanings are defined for the parameters of this function:

  • 0: off, for duration
  • 4294967295: infinite, for duration
BrickletPiezoSpeakerV2.get_alarm
Function ID:

4

Request:

empty payload

Response:
  • start_frequency -- uint16
  • end_frequency -- uint16
  • step_size -- uint16
  • step_delay -- uint16
  • volume -- uint8
  • duration -- uint32
  • duration_remaining -- uint32
  • current_frequency -- uint16

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.

The following meanings are defined for the parameters of this function:

  • 0: off, for duration
  • 4294967295: infinite, for duration
BrickletPiezoSpeakerV2.update_volume
Function ID:

5

Request:
  • volume -- uint8
Response:

no response

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

BrickletPiezoSpeakerV2.update_frequency
Function ID:

6

Request:
  • frequency -- uint16
Response:

no response

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

Advanced Functions

BrickletPiezoSpeakerV2.get_spitfp_error_count
Function ID:

234

Request:

empty payload

Response:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.

BrickletPiezoSpeakerV2.set_bootloader_mode
Function ID:

235

Request:
  • mode -- uint8
Response:
  • status -- uint8

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 meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
  • 0: ok, for status
  • 1: invalid mode, for status
  • 2: no change, for status
  • 3: entry function not present, for status
  • 4: device identifier incorrect, for status
  • 5: crc mismatch, for status
BrickletPiezoSpeakerV2.get_bootloader_mode
Function ID:

236

Request:

empty payload

Response:
  • mode -- uint8

Returns the current bootloader mode, see set_bootloader_mode.

The following meanings are defined for the parameters of this function:

  • 0: bootloader, for mode
  • 1: firmware, for mode
  • 2: bootloader wait for reboot, for mode
  • 3: firmware wait for reboot, for mode
  • 4: firmware wait for erase and reboot, for mode
BrickletPiezoSpeakerV2.set_write_firmware_pointer
Function ID:

237

Request:
  • pointer -- uint32
Response:

no response

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.

BrickletPiezoSpeakerV2.write_firmware
Function ID:

238

Request:
  • data -- uint8[64]
Response:
  • status -- uint8

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.

BrickletPiezoSpeakerV2.set_status_led_config
Function ID:

239

Request:
  • config -- uint8
Response:

no response

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 meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletPiezoSpeakerV2.get_status_led_config
Function ID:

240

Request:

empty payload

Response:
  • config -- uint8

Returns the configuration as set by set_status_led_config

The following meanings are defined for the parameters of this function:

  • 0: off, for config
  • 1: on, for config
  • 2: show heartbeat, for config
  • 3: show status, for config
BrickletPiezoSpeakerV2.get_chip_temperature
Function ID:

242

Request:

empty payload

Response:
  • temperature -- int16

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.

BrickletPiezoSpeakerV2.reset
Function ID:243
Request:empty payload
Response:no response

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!

BrickletPiezoSpeakerV2.write_uid
Function ID:

248

Request:
  • uid -- uint32
Response:

no response

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.

BrickletPiezoSpeakerV2.read_uid
Function ID:

249

Request:

empty payload

Response:
  • uid -- uint32

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

BrickletPiezoSpeakerV2.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

Callbacks

BrickletPiezoSpeakerV2.CALLBACK_BEEP_FINISHED
Function ID:7
Response:empty payload

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

BrickletPiezoSpeakerV2.CALLBACK_ALARM_FINISHED
Function ID:8
Response:empty payload

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