C# - Sound Intensity Bricklet¶

Simple¶

Download (ExampleSimple.cs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Sound Intensity Bricklet

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletSoundIntensity si = new BrickletSoundIntensity(UID, ipcon); // Create device object

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

        // Get current intensity
        int intensity = si.GetIntensity();
        Console.WriteLine("Intensity: " + intensity);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Callback¶

Download (ExampleCallback.cs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Sound Intensity Bricklet

    // Callback function for intensity callback
    static void IntensityCB(BrickletSoundIntensity sender, int intensity)
    {
        Console.WriteLine("Intensity: " + intensity);
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletSoundIntensity si = new BrickletSoundIntensity(UID, ipcon); // Create device object

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

        // Register intensity callback to function IntensityCB
        si.IntensityCallback += IntensityCB;

        // Set period for intensity callback to 0.05s (50ms)
        // Note: The intensity callback is only called every 0.05 seconds
        //       if the intensity has changed since the last call!
        si.SetIntensityCallbackPeriod(50);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Threshold¶

Download (ExampleThreshold.cs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Sound Intensity Bricklet

    // Callback function for intensity reached callback
    static void IntensityReachedCB(BrickletSoundIntensity sender, int intensity)
    {
        Console.WriteLine("Intensity: " + intensity);
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletSoundIntensity si = new BrickletSoundIntensity(UID, ipcon); // Create device object

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

        // Get threshold callbacks with a debounce time of 1 second (1000ms)
        si.SetDebouncePeriod(1000);

        // Register intensity reached callback to function IntensityReachedCB
        si.IntensityReachedCallback += IntensityReachedCB;

        // Configure threshold for intensity "greater than 2000"
        si.SetIntensityCallbackThreshold('>', 2000, 0);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Basic Functions¶

class BrickletSoundIntensity(string uid, IPConnection ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	soundIntensity – Type: BrickletSoundIntensity

Creates an object with the unique device ID uid:

BrickletSoundIntensity soundIntensity = new BrickletSoundIntensity("YOUR_DEVICE_UID", ipcon);

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

int BrickletSoundIntensity.GetIntensity()¶

Returns:	intensity – Type: int, Range: [0 to 212 - 1]

Returns the current sound intensity.

The value corresponds to the upper envelop of the signal of the microphone capsule.

If you want to get the intensity periodically, it is recommended to use the IntensityCallback callback and set the period with SetIntensityCallbackPeriod().

Advanced Functions¶

void BrickletSoundIntensity.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶

Output Parameters:

uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: byte[], Length: 3 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] firmwareVersion – Type: byte[], Length: 3 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, 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.

Callback Configuration Functions¶

void BrickletSoundIntensity.SetIntensityCallbackPeriod(long period)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the IntensityCallback callback is triggered periodically. A value of 0 turns the callback off.

The IntensityCallback callback is only triggered if the intensity has changed since the last triggering.

long BrickletSoundIntensity.GetIntensityCallbackPeriod()¶

Returns:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetIntensityCallbackPeriod().

void BrickletSoundIntensity.SetIntensityCallbackThreshold(char option, int min, int max)¶

Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Range: [0 to 216 - 1], Default: 0 max – Type: int, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the IntensityReachedCallback callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the intensity is outside the min and max values
'i'	Callback is triggered when the intensity is inside the min and max values
'<'	Callback is triggered when the intensity is smaller than the min value (max is ignored)
'>'	Callback is triggered when the intensity is greater than the min value (max is ignored)

The following constants are available for this function:

For option:

• BrickletSoundIntensity.THRESHOLD_OPTION_OFF = 'x'
• BrickletSoundIntensity.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletSoundIntensity.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletSoundIntensity.THRESHOLD_OPTION_SMALLER = '<'
• BrickletSoundIntensity.THRESHOLD_OPTION_GREATER = '>'

void BrickletSoundIntensity.GetIntensityCallbackThreshold(out char option, out int min, out int max)¶

Output Parameters:	option – Type: char, Range: See constants, Default: 'x' min – Type: int, Range: [0 to 216 - 1], Default: 0 max – Type: int, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by SetIntensityCallbackThreshold().

The following constants are available for this function:

For option:

• BrickletSoundIntensity.THRESHOLD_OPTION_OFF = 'x'
• BrickletSoundIntensity.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletSoundIntensity.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletSoundIntensity.THRESHOLD_OPTION_SMALLER = '<'
• BrickletSoundIntensity.THRESHOLD_OPTION_GREATER = '>'

void BrickletSoundIntensity.SetDebouncePeriod(long debounce)¶

Parameters:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callback

• IntensityReachedCallback

is triggered, if the thresholds

• SetIntensityCallbackThreshold()

keeps being reached.

long BrickletSoundIntensity.GetDebouncePeriod()¶

Returns:	debounce – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by SetDebouncePeriod().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by appending your callback handler to the corresponding event:

void MyCallback(BrickletSoundIntensity sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

soundIntensity.ExampleCallback += MyCallback;

The available events are described below.

event BrickletSoundIntensity.IntensityCallback(BrickletSoundIntensity sender, int intensity)¶

Callback Parameters:	sender – Type: BrickletSoundIntensity intensity – Type: int, Range: [0 to 212 - 1]

This callback is triggered periodically with the period that is set by SetIntensityCallbackPeriod(). The parameter is the intensity of the sensor.

The IntensityCallback callback is only triggered if the intensity has changed since the last triggering.

event BrickletSoundIntensity.IntensityReachedCallback(BrickletSoundIntensity sender, int intensity)¶

Callback Parameters:	sender – Type: BrickletSoundIntensity intensity – Type: int, Range: [0 to 212 - 1]

This callback is triggered when the threshold as set by SetIntensityCallbackThreshold() is reached. The parameter is the intensity of the encoder.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().

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.

byte[] BrickletSoundIntensity.GetAPIVersion()¶

Output Parameters:	apiVersion – Type: byte[], Length: 3 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, 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.

bool BrickletSoundIntensity.GetResponseExpected(byte functionId)¶

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

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:

• BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_PERIOD = 2
• BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD = 4
• BrickletSoundIntensity.FUNCTION_SET_DEBOUNCE_PERIOD = 6

void BrickletSoundIntensity.SetResponseExpected(byte functionId, bool responseExpected)¶

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

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:

• BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_PERIOD = 2
• BrickletSoundIntensity.FUNCTION_SET_INTENSITY_CALLBACK_THRESHOLD = 4
• BrickletSoundIntensity.FUNCTION_SET_DEBOUNCE_PERIOD = 6

void BrickletSoundIntensity.SetResponseExpectedAll(bool responseExpected)¶

Parameters:	responseExpected – Type: bool

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

Constants¶

int BrickletSoundIntensity.DEVICE_IDENTIFIER¶

This constant is used to identify a Sound Intensity 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.

string BrickletSoundIntensity.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Sound Intensity Bricklet.