TCP/IP - Piezo Buzzer Bricklet

This is the API description for the TCP/IP protocol of the Piezo Buzzer Bricklet. General information on what this device does and the technical specifications can be found here.

A tutorial on how to test the Piezo Buzzer Bricklet and get the first examples running can be found here.

API

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

Basic Functions

PiezoBuzzer.beep

Function ID:

1

Request:

• duration – uint32

Response:

no response

Beeps with the duration in ms. For example: If you set a value of 1000, the piezo buzzer will beep for one second.

PiezoBuzzer.morse_code

Function ID:

2

Request:

• morse – char[60]

Response:

no response

Sets morse code that will be played by the piezo buzzer. The morse code is given as a string consisting of ”.” (dot), “-” (minus) and ” ” (space) for dits, dahs and pauses. Every other character is ignored.

For example: If you set the string ”...—...”, the piezo buzzer will beep nine times with the durations “short short short long long long short short short”.

The maximum string size is 60.

Advanced Functions

PiezoBuzzer.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 identifiers can be found here.

New in version 2.0.0 (Plugin).

Callbacks

PiezoBuzzer.CALLBACK_BEEP_FINISHED

Function ID:3 Response:empty payload

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

PiezoBuzzer.CALLBACK_MORSE_CODE_FINISHED

Function ID:4 Response:empty payload

This callback is triggered if the playback of the morse code set by morse_code is finished.

Constants

PiezoBuzzer.DEVICE_IDENTIFIER

Value:214

This constant is used to identify a PiezoBuzzer Bricklet.

The get_identity function and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick’s or Bricklet’s type.