JavaScript - Piezo Buzzer Bricklet

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

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

Examples

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

API

Generally, every method of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback is called with the return values as parameters, if the method returns something. The errorCallback is called with an error code in case of an error. The error code can be one of the following values:

  • IPConnection.ERROR_ALREADY_CONNECTED = 11
  • IPConnection.ERROR_NOT_CONNECTED = 12
  • IPConnection.ERROR_CONNECT_FAILED = 13
  • IPConnection.ERROR_INVALID_FUNCTION_ID = 21
  • IPConnection.ERROR_TIMEOUT = 31
  • IPConnection.ERROR_INVALID_PARAMETER = 41
  • IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
  • IPConnection.ERROR_UNKNOWN_ERROR = 43

The namespace for the JavaScript bindings is Tinkerforge.*.

Basic Functions

new BrickletPiezoBuzzer(uid, ipcon)
Parameters:
  • uid -- string
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

var piezoBuzzer = new BrickletPiezoBuzzer("YOUR_DEVICE_UID", ipcon);

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

BrickletPiezoBuzzer.beep(duration[, returnCallback][, errorCallback])
Parameters:
  • duration -- int
Callback:

undefined

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

BrickletPiezoBuzzer.morseCode(morse[, returnCallback][, errorCallback])
Parameters:
  • morse -- string
Callback:

undefined

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

BrickletPiezoBuzzer.getAPIVersion()
Return type:[int, int, int]

Returns the version of the API definition (major, minor, revision) 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.

BrickletPiezoBuzzer.getResponseExpected(functionId[, errorCallback])
Parameters:
  • functionId -- int
Return 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 send and errors are silently ignored, because they cannot be detected.

See setResponseExpected() for the list of function ID constants available for this function.

BrickletPiezoBuzzer.setResponseExpected(functionId, responseExpected[, errorCallback])
Parameters:
  • functionId -- int
  • responseExpected -- 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 and callbacks it is always disabled.

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

  • BrickletPiezoBuzzer.FUNCTION_BEEP = 1
  • BrickletPiezoBuzzer.FUNCTION_MORSE_CODE = 2
BrickletPiezoBuzzer.setResponseExpectedAll(responseExpected)
Parameters:
  • responseExpected -- boolean

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

BrickletPiezoBuzzer.getIdentity([returnCallback][, errorCallback])
Callback:
  • uid -- string
  • connectedUid -- string
  • position -- char
  • hardwareVersion -- [int, int, int]
  • firmwareVersion -- [int, int, int]
  • deviceIdentifier -- 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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletPiezoBuzzer.on(id, callback)
Parameters:
  • id -- int
  • callback -- function

Registers a callback with ID id to the function callback. The available IDs with corresponding function signatures are listed below.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the on() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

piezoBuzzer.on(BrickletPiezoBuzzer.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

The available constants with inherent number and 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.

BrickletPiezoBuzzer.CALLBACK_BEEP_FINISHED

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

BrickletPiezoBuzzer.CALLBACK_MORSE_CODE_FINISHED

This callback is triggered if the playback of the morse code set by morseCode() is finished.

Constants

BrickletPiezoBuzzer.DEVICE_IDENTIFIER

This constant is used to identify a Piezo Buzzer Bricklet.

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

Creative Commons Licence The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.