MATLAB/Octave - Piezo Speaker Bricklet 2.0¶

Alarm (MATLAB)¶

Download (matlab_example_alarm.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

function matlab_example_alarm()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletPiezoSpeakerV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Piezo Speaker Bricklet 2.0

    ipcon = IPConnection(); % Create IP connection
    ps = handle(BrickletPiezoSpeakerV2(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % 10 seconds of loud annoying fast alarm
    ps.setAlarm(800, 2000, 10, 1, 10, 10000);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Beep (MATLAB)¶

Download (matlab_example_beep.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

function matlab_example_beep()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletPiezoSpeakerV2;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Piezo Speaker Bricklet 2.0

    ipcon = IPConnection(); % Create IP connection
    ps = handle(BrickletPiezoSpeakerV2(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Make 2 second beep with a frequency of 1kHz
    ps.setBeep(1000, 0, 2000);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Alarm (Octave)¶

Download (octave_example_alarm.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

function octave_example_alarm()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Piezo Speaker Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    ps = javaObject("com.tinkerforge.BrickletPiezoSpeakerV2", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % 10 seconds of loud annoying fast alarm
    ps.setAlarm(800, 2000, 10, 1, 10, 10000);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Beep (Octave)¶

Download (octave_example_beep.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

function octave_example_beep()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Piezo Speaker Bricklet 2.0

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    ps = javaObject("com.tinkerforge.BrickletPiezoSpeakerV2", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Make 2 second beep with a frequency of 1kHz
    ps.setBeep(1000, 0, 2000);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Basic Functions¶

class BrickletPiezoSpeakerV2(String uid, IPConnection ipcon)¶

Parameters:	uid – Type: String ipcon – Type: IPConnection
Returns:	piezoSpeakerV2 – Type: BrickletPiezoSpeakerV2

Creates an object with the unique device ID uid.

In MATLAB:

import com.tinkerforge.BrickletPiezoSpeakerV2;

piezoSpeakerV2 = BrickletPiezoSpeakerV2('YOUR_DEVICE_UID', ipcon);

In Octave:

piezoSpeakerV2 = java_new("com.tinkerforge.BrickletPiezoSpeakerV2", "YOUR_DEVICE_UID", ipcon);

This object can then be used after the IP Connection is connected.

void BrickletPiezoSpeakerV2.setBeep(int frequency, int volume, long duration)¶

Parameters:	frequency – Type: int, Unit: 1 Hz, Range: [50 to 15000] volume – Type: int, Range: [0 to 10] duration – Type: long, Unit: 1 ms, Range: [0 to 232 - 1] with constants

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:

• BrickletPiezoSpeakerV2.BEEP_DURATION_OFF = 0
• BrickletPiezoSpeakerV2.BEEP_DURATION_INFINITE = 4294967295

BrickletPiezoSpeakerV2.Beep BrickletPiezoSpeakerV2.getBeep()¶

Return Object:	frequency – Type: int, Unit: 1 Hz, Range: [50 to 15000] volume – Type: int, Range: [0 to 10] duration – Type: long, Unit: 1 ms, Range: [0 to 232 - 1] with constants durationRemaining – Type: long, Unit: 1 ms, Range: [0 to 232 - 1]

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

The following constants are available for this function:

For duration:

• BrickletPiezoSpeakerV2.BEEP_DURATION_OFF = 0
• BrickletPiezoSpeakerV2.BEEP_DURATION_INFINITE = 4294967295

void BrickletPiezoSpeakerV2.setAlarm(int startFrequency, int endFrequency, int stepSize, int stepDelay, int volume, long duration)¶

Parameters:	startFrequency – Type: int, Unit: 1 Hz, Range: [50 to 14999] endFrequency – Type: int, Unit: 1 Hz, Range: [51 to 15000] stepSize – Type: int, Unit: 1 Hz, Range: [0 to 14950] stepDelay – Type: int, Unit: 1 ms, Range: [0 to 216 - 1] volume – Type: int, Range: [0 to 10] duration – Type: long, Unit: 1 ms, Range: [0 to 232 - 1] with constants

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:

• BrickletPiezoSpeakerV2.ALARM_DURATION_OFF = 0
• BrickletPiezoSpeakerV2.ALARM_DURATION_INFINITE = 4294967295

BrickletPiezoSpeakerV2.Alarm BrickletPiezoSpeakerV2.getAlarm()¶

Return Object:

startFrequency – Type: int, Unit: 1 Hz, Range: [50 to 14999] endFrequency – Type: int, Unit: 1 Hz, Range: [51 to 15000] stepSize – Type: int, Unit: 1 Hz, Range: [50 to 14950] stepDelay – Type: int, Unit: 1 ms, Range: [0 to 216 - 1] volume – Type: int, Range: [0 to 10] duration – Type: long, Unit: 1 ms, Range: [0 to 232 - 1] with constants durationRemaining – Type: long, Unit: 1 ms, Range: [0 to 232 - 1] with constants currentFrequency – Type: int, Unit: 1 Hz, Range: [50 to 15000]

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

The following constants are available for this function:

For duration:

• BrickletPiezoSpeakerV2.ALARM_DURATION_OFF = 0
• BrickletPiezoSpeakerV2.ALARM_DURATION_INFINITE = 4294967295

For durationRemaining:

• BrickletPiezoSpeakerV2.ALARM_DURATION_OFF = 0
• BrickletPiezoSpeakerV2.ALARM_DURATION_INFINITE = 4294967295

void BrickletPiezoSpeakerV2.updateVolume(int volume)¶

Parameters:	volume – Type: int, Range: [0 to 10]

Updates the volume of an ongoing beep or alarm.

void BrickletPiezoSpeakerV2.updateFrequency(int frequency)¶

Parameters:	frequency – Type: int, Unit: 1 Hz, Range: [50 to 15000]

Updates the frequency of an ongoing beep.

Advanced Functions¶

BrickletPiezoSpeakerV2.SPITFPErrorCount BrickletPiezoSpeakerV2.getSPITFPErrorCount()¶

Return Object:	errorCountAckChecksum – Type: long, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1] errorCountFrame – Type: long, Range: [0 to 232 - 1] errorCountOverflow – Type: long, Range: [0 to 232 - 1]

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.

void BrickletPiezoSpeakerV2.setStatusLEDConfig(int config)¶

Parameters:	config – Type: int, Range: See constants, Default: 3

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:

• BrickletPiezoSpeakerV2.STATUS_LED_CONFIG_OFF = 0
• BrickletPiezoSpeakerV2.STATUS_LED_CONFIG_ON = 1
• BrickletPiezoSpeakerV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletPiezoSpeakerV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletPiezoSpeakerV2.getStatusLEDConfig()¶

Returns:	config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by setStatusLEDConfig()

The following constants are available for this function:

For config:

• BrickletPiezoSpeakerV2.STATUS_LED_CONFIG_OFF = 0
• BrickletPiezoSpeakerV2.STATUS_LED_CONFIG_ON = 1
• BrickletPiezoSpeakerV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletPiezoSpeakerV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletPiezoSpeakerV2.getChipTemperature()¶

Returns:	temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

void BrickletPiezoSpeakerV2.reset()¶

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.Identity BrickletPiezoSpeakerV2.getIdentity()¶

Return Object:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] firmwareVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255] deviceIdentifier – Type: int, Range: [0 to 216 - 1]

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.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with "set" function of MATLAB. The parameters consist of the IP Connection object, the callback name and the callback function. For example, it looks like this in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Due to a difference in the Octave Java support the "set" function cannot be used in Octave. The registration is done with "add*Callback" functions of the device object. It looks like this in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

It is possible to add several callbacks and to remove them with the corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of the structure e, which is derived from the java.util.EventObject class. The available callback names with corresponding structure fields are described below.

callback BrickletPiezoSpeakerV2.BeepFinishedCallback¶

Event Object:	empty object

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

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addBeepFinishedCallback() function. An added callback function can be removed with the removeBeepFinishedCallback() function.

callback BrickletPiezoSpeakerV2.AlarmFinishedCallback¶

Event Object:	empty object

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

In MATLAB the set() function can be used to register a callback function to this callback.

In Octave a callback function can be added to this callback using the addAlarmFinishedCallback() function. An added callback function can be removed with the removeAlarmFinishedCallback() function.

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

short[] BrickletPiezoSpeakerV2.getAPIVersion()¶

Return Object:	apiVersion – Type: short[], Length: 3 1: major – Type: short, Range: [0 to 255] 2: minor – Type: short, Range: [0 to 255] 3: revision – Type: short, Range: [0 to 255]

Returns the version of the API definition 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.

boolean BrickletPiezoSpeakerV2.getResponseExpected(byte functionId)¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: boolean

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 setResponseExpected(). 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 functionId:

• BrickletPiezoSpeakerV2.FUNCTION_SET_BEEP = 1
• BrickletPiezoSpeakerV2.FUNCTION_SET_ALARM = 3
• BrickletPiezoSpeakerV2.FUNCTION_UPDATE_VOLUME = 5
• BrickletPiezoSpeakerV2.FUNCTION_UPDATE_FREQUENCY = 6
• BrickletPiezoSpeakerV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletPiezoSpeakerV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletPiezoSpeakerV2.FUNCTION_RESET = 243
• BrickletPiezoSpeakerV2.FUNCTION_WRITE_UID = 248

void BrickletPiezoSpeakerV2.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: boolean

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 functionId:

• BrickletPiezoSpeakerV2.FUNCTION_SET_BEEP = 1
• BrickletPiezoSpeakerV2.FUNCTION_SET_ALARM = 3
• BrickletPiezoSpeakerV2.FUNCTION_UPDATE_VOLUME = 5
• BrickletPiezoSpeakerV2.FUNCTION_UPDATE_FREQUENCY = 6
• BrickletPiezoSpeakerV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletPiezoSpeakerV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletPiezoSpeakerV2.FUNCTION_RESET = 243
• BrickletPiezoSpeakerV2.FUNCTION_WRITE_UID = 248

void BrickletPiezoSpeakerV2.setResponseExpectedAll(boolean responseExpected)¶

Parameters:	responseExpected – Type: boolean

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 BrickletPiezoSpeakerV2.setBootloaderMode(int mode)¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, Range: See constants

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:

• BrickletPiezoSpeakerV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletPiezoSpeakerV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletPiezoSpeakerV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletPiezoSpeakerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletPiezoSpeakerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BrickletPiezoSpeakerV2.BOOTLOADER_STATUS_OK = 0
• BrickletPiezoSpeakerV2.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletPiezoSpeakerV2.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletPiezoSpeakerV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletPiezoSpeakerV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletPiezoSpeakerV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletPiezoSpeakerV2.getBootloaderMode()¶

Returns:	mode – Type: int, Range: See constants

Returns the current bootloader mode, see setBootloaderMode().

The following constants are available for this function:

For mode:

• BrickletPiezoSpeakerV2.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletPiezoSpeakerV2.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletPiezoSpeakerV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletPiezoSpeakerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletPiezoSpeakerV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletPiezoSpeakerV2.setWriteFirmwarePointer(long pointer)¶

Parameters:	pointer – Type: long, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for writeFirmware(). 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 BrickletPiezoSpeakerV2.writeFirmware(int[] data)¶

Parameters:	data – Type: int[], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

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

void BrickletPiezoSpeakerV2.writeUID(long uid)¶

Parameters:	uid – Type: long, Range: [0 to 232 - 1]

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.

long BrickletPiezoSpeakerV2.readUID()¶

Returns:	uid – Type: long, Range: [0 to 232 - 1]

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

Constants¶

int BrickletPiezoSpeakerV2.DEVICE_IDENTIFIER¶

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

The getIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

String BrickletPiezoSpeakerV2.DEVICE_DISPLAY_NAME¶

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