C# - Hall Effect 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 Hall Effect Bricklet

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

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

        // Get current edge count without reset
        long count = he.GetEdgeCount(false);
        Console.WriteLine("Count: " + count);

        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 Hall Effect Bricklet

    // Callback function for edge count callback
    static void EdgeCountCB(BrickletHallEffect sender, long count, bool value)
    {
        Console.WriteLine("Count: " + count);
    }

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

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

        // Register edge count callback to function EdgeCountCB
        he.EdgeCountCallback += EdgeCountCB;

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

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

Basic Functions¶

class BrickletHallEffect(string uid, IPConnection ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	hallEffect – Type: BrickletHallEffect

Creates an object with the unique device ID uid:

BrickletHallEffect hallEffect = new BrickletHallEffect("YOUR_DEVICE_UID", ipcon);

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

bool BrickletHallEffect.GetValue()¶

Returns:	value – Type: bool

Returns true if a magnetic field of 3.5 millitesla or greater is detected.

long BrickletHallEffect.GetEdgeCount(bool resetCounter)¶

Parameters:	resetCounter – Type: bool
Returns:	count – Type: long, Range: [0 to 232 - 1]

Returns the current value of the edge counter. You can configure edge type (rising, falling, both) that is counted with SetEdgeCountConfig().

If you set the reset counter to true, the count is set back to 0 directly after it is read.

Advanced Functions¶

void BrickletHallEffect.SetEdgeCountConfig(byte edgeType, byte debounce)¶

Parameters:	edgeType – Type: byte, Range: See constants, Default: 0 debounce – Type: byte, Unit: 1 ms, Range: [0 to 255], Default: 100

The edge type parameter configures if rising edges, falling edges or both are counted. Possible edge types are:

• 0 = rising
• 1 = falling
• 2 = both

A magnetic field of 3.5 millitesla or greater causes a falling edge and a magnetic field of 2.5 millitesla or smaller causes a rising edge.

If a magnet comes near the Bricklet the signal goes low (falling edge), if a magnet is removed from the vicinity the signal goes high (rising edge).

Configuring an edge counter resets its value to 0.

If you don't know what any of this means, just leave it at default. The default configuration is very likely OK for you.

The following constants are available for this function:

For edgeType:

• BrickletHallEffect.EDGE_TYPE_RISING = 0
• BrickletHallEffect.EDGE_TYPE_FALLING = 1
• BrickletHallEffect.EDGE_TYPE_BOTH = 2

void BrickletHallEffect.GetEdgeCountConfig(out byte edgeType, out byte debounce)¶

Output Parameters:	edgeType – Type: byte, Range: See constants, Default: 0 debounce – Type: byte, Unit: 1 ms, Range: [0 to 255], Default: 100

Returns the edge type and debounce time as set by SetEdgeCountConfig().

The following constants are available for this function:

For edgeType:

• BrickletHallEffect.EDGE_TYPE_RISING = 0
• BrickletHallEffect.EDGE_TYPE_FALLING = 1
• BrickletHallEffect.EDGE_TYPE_BOTH = 2

void BrickletHallEffect.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 BrickletHallEffect.SetEdgeInterrupt(long edges)¶

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

Sets the number of edges until an interrupt is invoked.

If edges is set to n, an interrupt is invoked for every n-th detected edge.

If edges is set to 0, the interrupt is disabled.

long BrickletHallEffect.GetEdgeInterrupt()¶

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

Returns the edges as set by SetEdgeInterrupt().

void BrickletHallEffect.SetEdgeCountCallbackPeriod(long period)¶

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

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

The EdgeCountCallback callback is only triggered if the edge count has changed since the last triggering.

long BrickletHallEffect.GetEdgeCountCallbackPeriod()¶

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

Returns the period as set by SetEdgeCountCallbackPeriod().

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(BrickletHallEffect sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

hallEffect.ExampleCallback += MyCallback;

The available events are described below.

event BrickletHallEffect.EdgeCountCallback(BrickletHallEffect sender, long count, bool value)¶

Callback Parameters:	sender – Type: BrickletHallEffect count – Type: long, Range: [0 to 232 - 1] value – Type: bool

This callback is triggered periodically with the period that is set by SetEdgeCountCallbackPeriod(). The parameters are the current count and the current value (see GetValue() and GetEdgeCount()).

The EdgeCountCallback callback is only triggered if the count or value changed since the last triggering.

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[] BrickletHallEffect.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 BrickletHallEffect.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:

• BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CONFIG = 3
• BrickletHallEffect.FUNCTION_SET_EDGE_INTERRUPT = 5
• BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7

void BrickletHallEffect.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:

• BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CONFIG = 3
• BrickletHallEffect.FUNCTION_SET_EDGE_INTERRUPT = 5
• BrickletHallEffect.FUNCTION_SET_EDGE_COUNT_CALLBACK_PERIOD = 7

void BrickletHallEffect.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 BrickletHallEffect.DEVICE_IDENTIFIER¶

This constant is used to identify a Hall Effect 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 BrickletHallEffect.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Hall Effect Bricklet.