C# - Hall Effect Bricklet 2.0¶

Counter¶

Download (ExampleCounter.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 2.0

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

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

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

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

Magnetic Flux Density¶

Download (ExampleMagneticFluxDensity.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 2.0

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

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

        // Get current Magnetic Flux Density
        short magneticFluxDensity = he.GetMagneticFluxDensity();
        Console.WriteLine("Magnetic Flux Density: " + magneticFluxDensity + " µT");

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

Counter Callback¶

Download (ExampleCounterCallback.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 Hall Effect Bricklet 2.0

    // Callback function for counter callback
    static void CounterCB(BrickletHallEffectV2 sender, long counter)
    {
        Console.WriteLine("Counter: " + counter);
    }

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

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

        // Configure counter with ±3000µT threshold and 10ms debounce
        he.SetCounterConfig(3000, -3000, 10000);

        // Register counter callback to function CounterCB
        he.CounterCallback += CounterCB;

        // Set period for counter callback to 0.1s (100ms)
        he.SetCounterCallbackConfiguration(100, true);

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

Basic Functions¶

class BrickletHallEffectV2(string uid, IPConnection ipcon)¶

Parameters:	uid – Type: string ipcon – Type: IPConnection
Returns:	hallEffectV2 – Type: BrickletHallEffectV2

Creates an object with the unique device ID uid:

BrickletHallEffectV2 hallEffectV2 = new BrickletHallEffectV2("YOUR_DEVICE_UID", ipcon);

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

short BrickletHallEffectV2.GetMagneticFluxDensity()¶

Returns:	magneticFluxDensity – Type: short, Unit: 1 µT, Range: [-7000 to 7000]

Returns the magnetic flux density (magnetic induction).

If you want to get the value periodically, it is recommended to use the MagneticFluxDensityCallback callback. You can set the callback configuration with SetMagneticFluxDensityCallbackConfiguration().

long BrickletHallEffectV2.GetCounter(bool resetCounter)¶

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

Returns the current value of the counter.

You can configure the low/high thresholds and the debounce time with SetCounterConfig().

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

If you want to get the count periodically, it is recommended to use the CounterCallback callback. You can set the callback configuration with SetCounterCallbackConfiguration().

void BrickletHallEffectV2.SetCounterConfig(short highThreshold, short lowThreshold, long debounce)¶

Parameters:	highThreshold – Type: short, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 2000 lowThreshold – Type: short, Unit: 1 µT, Range: [-215 to 215 - 1], Default: -2000 debounce – Type: long, Unit: 1 µs, Range: [0 to 1000000], Default: 100000

Sets a high and a low threshold as well as a debounce time.

If the measured magnetic flux density goes above the high threshold or below the low threshold, the count of the counter is increased by 1.

The debounce time is the minimum time between two count increments.

void BrickletHallEffectV2.GetCounterConfig(out short highThreshold, out short lowThreshold, out long debounce)¶

Output Parameters:	highThreshold – Type: short, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 2000 lowThreshold – Type: short, Unit: 1 µT, Range: [-215 to 215 - 1], Default: -2000 debounce – Type: long, Unit: 1 µs, Range: [0 to 1000000], Default: 100000

Returns the counter config as set by SetCounterConfig().

Advanced Functions¶

void BrickletHallEffectV2.GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)¶

Output Parameters:	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 BrickletHallEffectV2.SetStatusLEDConfig(byte config)¶

Parameters:	config – Type: byte, 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:

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

byte BrickletHallEffectV2.GetStatusLEDConfig()¶

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

Returns the configuration as set by SetStatusLEDConfig()

The following constants are available for this function:

For config:

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

short BrickletHallEffectV2.GetChipTemperature()¶

Returns:	temperature – Type: short, 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 BrickletHallEffectV2.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!

void BrickletHallEffectV2.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 BrickletHallEffectV2.SetMagneticFluxDensityCallbackConfiguration(long period, bool valueHasToChange, char option, short min, short max)¶

Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: short, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 0 max – Type: short, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 0

The period is the period with which the MagneticFluxDensityCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the MagneticFluxDensityCallback callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

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

void BrickletHallEffectV2.GetMagneticFluxDensityCallbackConfiguration(out long period, out bool valueHasToChange, out char option, out short min, out short max)¶

Output Parameters:	period – Type: long, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 valueHasToChange – Type: bool, Default: false option – Type: char, Range: See constants, Default: 'x' min – Type: short, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 0 max – Type: short, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 0

Returns the callback configuration as set by SetMagneticFluxDensityCallbackConfiguration().

The following constants are available for this function:

For option:

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

void BrickletHallEffectV2.SetCounterCallbackConfiguration(long period, bool valueHasToChange)¶

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

The period is the period with which the CounterCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after at least one of the values has changed. If the values didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

void BrickletHallEffectV2.GetCounterCallbackConfiguration(out long period, out bool valueHasToChange)¶

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

Returns the callback configuration as set by SetCounterCallbackConfiguration().

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

hallEffectV2.ExampleCallback += MyCallback;

The available events are described below.

event BrickletHallEffectV2.MagneticFluxDensityCallback(BrickletHallEffectV2 sender, short magneticFluxDensity)¶

Callback Parameters:	sender – Type: BrickletHallEffectV2 magneticFluxDensity – Type: short, Unit: 1 µT, Range: [-7000 to 7000]

This callback is triggered periodically according to the configuration set by SetMagneticFluxDensityCallbackConfiguration().

The parameter is the same as GetMagneticFluxDensity().

event BrickletHallEffectV2.CounterCallback(BrickletHallEffectV2 sender, long count)¶

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

This callback is triggered periodically according to the configuration set by SetCounterCallbackConfiguration().

The count is the same as you would get with GetCounter().

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

• BrickletHallEffectV2.FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 2
• BrickletHallEffectV2.FUNCTION_SET_COUNTER_CONFIG = 6
• BrickletHallEffectV2.FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION = 8
• BrickletHallEffectV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletHallEffectV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletHallEffectV2.FUNCTION_RESET = 243
• BrickletHallEffectV2.FUNCTION_WRITE_UID = 248

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

• BrickletHallEffectV2.FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 2
• BrickletHallEffectV2.FUNCTION_SET_COUNTER_CONFIG = 6
• BrickletHallEffectV2.FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION = 8
• BrickletHallEffectV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletHallEffectV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletHallEffectV2.FUNCTION_RESET = 243
• BrickletHallEffectV2.FUNCTION_WRITE_UID = 248

void BrickletHallEffectV2.SetResponseExpectedAll(bool responseExpected)¶

Parameters:	responseExpected – Type: bool

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.

byte BrickletHallEffectV2.SetBootloaderMode(byte mode)¶

Parameters:	mode – Type: byte, Range: See constants
Returns:	status – Type: byte, 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:

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

For status:

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

byte BrickletHallEffectV2.GetBootloaderMode()¶

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

Returns the current bootloader mode, see SetBootloaderMode().

The following constants are available for this function:

For mode:

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

void BrickletHallEffectV2.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.

byte BrickletHallEffectV2.WriteFirmware(byte[] data)¶

Parameters:	data – Type: byte[], Length: 64, Range: [0 to 255]
Returns:	status – Type: byte, 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 BrickletHallEffectV2.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 BrickletHallEffectV2.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 BrickletHallEffectV2.DEVICE_IDENTIFIER¶

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

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