Mathematica - Piezo Speaker Bricklet

This is the description of the Mathematica API bindings for the Piezo Speaker Bricklet. General information and technical specifications for the Piezo Speaker Bricklet are summarized in its hardware description.

An installation guide for the Mathematica API bindings is part of their general description.

Examples

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

Beep

Download (ExampleBeep.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Piezo Speaker Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
ps=NETNew["Tinkerforge.BrickletPiezoSpeaker",uid,ipcon]
ipcon@Connect[host,port]

(*Make 2 second beep with a frequency of 1kHz*)
ps@Beep[2000,1000]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[ps]
ReleaseNETObject[ipcon]

Morse Code

Download (ExampleMorseCode.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Piezo Speaker Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
ps=NETNew["Tinkerforge.BrickletPiezoSpeaker",uid,ipcon]
ipcon@Connect[host,port]

(*Morse SOS with a frequency of 2kHz*)
ps@MorseCode["... --- ...",2000]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[ps]
ReleaseNETObject[ipcon]

API

Generally, every function of the Mathematica bindings that returns a value can throw a Tinkerforge.TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since .NET/Link does not support multiple return values directly, we use the out keyword to return multiple values from a function. For further information about the out keyword in .NET/Link see the corresponding Mathematica .NET/Link documentation.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletPiezoSpeaker[uid, ipcon] → piezoSpeaker
Parameters:
  • uid – Type: String
  • ipcon – Type: NETObject[IPConnection]
Returns:
  • piezoSpeaker – Type: NETObject[BrickletPiezoSpeaker]

Creates an object with the unique device ID uid:

piezoSpeaker=NETNew["Tinkerforge.BrickletPiezoSpeaker","YOUR_DEVICE_UID",ipcon]

This object can then be used after the IP Connection is connected (see examples above).

The .NET runtime has built-in garbage collection that frees objects that are no longer in use by a program. But because Mathematica can not automatically tell when a Mathematica "program" doesn't use a .NET object anymore, this has to be done by the program. For this the ReleaseNETObject[] function is used in the examples.

For further information about object management in .NET/Link see the corresponding Mathematica .NET/Link documentation.

BrickletPiezoSpeaker@Beep[duration, frequency] → Null
Parameters:
  • duration – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1] with constants
  • frequency – Type: Integer, Unit: 1 Hz, Range: [585 to 7100]

Beeps with the given frequency for the given duration.

Changed in version 2.0.2 (Plugin): A duration of 0 stops the current beep if any, the frequency parameter is ignored. A duration of 4294967295 results in an infinite beep.

The Piezo Speaker Bricklet can only approximate the frequency, it will play the best possible match by applying the calibration (see Calibrate[]).

The following constants are available for this function:

For duration:

  • BrickletPiezoSpeaker`BEEPUDURATIONUOFF = 0
  • BrickletPiezoSpeaker`BEEPUDURATIONUINFINITE = 4294967295
BrickletPiezoSpeaker@MorseCode[morse, frequency] → Null
Parameters:
  • morse – Type: String, Length: up to 60
  • frequency – Type: Integer, Unit: 1 Hz, Range: [585 to 7100]

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

Advanced Functions

BrickletPiezoSpeaker@Calibrate[] → calibration
Returns:
  • calibration – Type: True/False

The Piezo Speaker Bricklet can play 512 different tones. This function plays each tone and measures the exact frequency back. The result is a mapping between setting value and frequency. This mapping is stored in the EEPROM and loaded on startup.

The Bricklet should come calibrated, you only need to call this function (once) every time you reflash the Bricklet plugin.

Returns true after the calibration finishes.

BrickletPiezoSpeaker@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Output Parameters:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: Integer, Range: [ToCharacterCode["a"][[0]] to ToCharacterCode["h"][[0]], ToCharacterCode["i"][[0]], ToCharacterCode["z"][[0]]]
  • hardwareVersioni – Type: Integer
    • 1: major – Type: Integer, Range: [0 to 255]
    • 2: minor – Type: Integer, Range: [0 to 255]
    • 3: revision – Type: Integer, Range: [0 to 255]
  • firmwareVersioni – Type: Integer
    • 1: major – Type: Integer, Range: [0 to 255]
    • 2: minor – Type: Integer, Range: [0 to 255]
    • 3: revision – Type: Integer, Range: [0 to 255]
  • deviceIdentifier – Type: Integer, 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as 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 by assigning a function to a callback property of the device object:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[piezoSpeaker@ExampleCallback,MyCallback]

For further information about event handling using .NET/Link see the corresponding Mathematica .NET/Link documentation.

The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

event BrickletPiezoSpeaker@BeepFinishedCallback[sender]
Callback Parameters:
  • sender – Type: NETObject[BrickletPiezoSpeaker]

This callback is triggered if a beep set by Beep[] is finished

event BrickletPiezoSpeaker@MorseCodeFinishedCallback[sender]
Callback Parameters:
  • sender – Type: NETObject[BrickletPiezoSpeaker]

This callback is triggered if the playback of the morse code set by MorseCode[] is finished.

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.

BrickletPiezoSpeaker@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Output Parameters:
  • apiVersioni – Type: Integer
    • 1: major – Type: Integer, Range: [0 to 255]
    • 2: minor – Type: Integer, Range: [0 to 255]
    • 3: revision – Type: Integer, 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.

BrickletPiezoSpeaker@GetResponseExpected[functionId] → responseExpected
Parameters:
  • functionId – Type: Integer, Range: See constants
Returns:
  • responseExpected – Type: True/False

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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletPiezoSpeaker`FUNCTIONUBEEP = 1
  • BrickletPiezoSpeaker`FUNCTIONUMORSEUCODE = 2
BrickletPiezoSpeaker@SetResponseExpected[functionId, responseExpected] → Null
Parameters:
  • functionId – Type: Integer, Range: See constants
  • responseExpected – Type: True/False

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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletPiezoSpeaker`FUNCTIONUBEEP = 1
  • BrickletPiezoSpeaker`FUNCTIONUMORSEUCODE = 2
BrickletPiezoSpeaker@SetResponseExpectedAll[responseExpected] → Null
Parameters:
  • responseExpected – Type: True/False

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

Constants

BrickletPiezoSpeaker`DEVICEUIDENTIFIER

This constant is used to identify a Piezo Speaker Bricklet.

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.

BrickletPiezoSpeaker`DEVICEDISPLAYNAME

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