C/C++ - Hall Effect Bricklet 2.0

This is the description of the C/C++ API bindings for the Hall Effect Bricklet 2.0. General information and technical specifications for the Hall Effect Bricklet 2.0 are summarized in its hardware description.

An installation guide for the C/C++ API bindings is part of their general description.

Examples

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

Counter

Download (example_counter.c)

 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
38
39
40
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_hall_effect_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Hall Effect Bricklet 2.0

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    HallEffectV2 he;
    hall_effect_v2_create(&he, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get current count without counter reset
    uint32_t count;
    if(hall_effect_v2_get_counter(&he, false, &count) < 0) {
        fprintf(stderr, "Could not get count without counter reset, probably timeout\n");
        return 1;
    }

    printf("Count: %u\n", count);

    printf("Press key to exit\n");
    getchar();
    hall_effect_v2_destroy(&he);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Magnetic Flux Density

Download (example_magnetic_flux_density.c)

 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
38
39
40
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_hall_effect_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Hall Effect Bricklet 2.0

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    HallEffectV2 he;
    hall_effect_v2_create(&he, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get current Magnetic Flux Density
    int16_t magnetic_flux_density;
    if(hall_effect_v2_get_magnetic_flux_density(&he, &magnetic_flux_density) < 0) {
        fprintf(stderr, "Could not get Magnetic Flux Density, probably timeout\n");
        return 1;
    }

    printf("Magnetic Flux Density: %d µT\n", magnetic_flux_density);

    printf("Press key to exit\n");
    getchar();
    hall_effect_v2_destroy(&he);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Counter Callback

Download (example_counter_callback.c)

 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
38
39
40
41
42
43
44
45
46
47
48
49
50
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_hall_effect_v2.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Hall Effect Bricklet 2.0

// Callback function for counter callback
void cb_counter(uint32_t counter, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Counter: %u\n", counter);
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    HallEffectV2 he;
    hall_effect_v2_create(&he, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

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

    // Register counter callback to function cb_counter
    hall_effect_v2_register_callback(&he,
                                     HALL_EFFECT_V2_CALLBACK_COUNTER,
                                     (void (*)(void))cb_counter,
                                     NULL);

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

    printf("Press key to exit\n");
    getchar();
    hall_effect_v2_destroy(&he);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Every function of the C/C++ bindings returns an integer which describes an error code. Data returned from the device, when a getter is called, is handled via output parameters. These parameters are labeled with the ret_ prefix.

Possible error codes are:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (unused since C/C++ bindings version 2.0.0)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14

as defined in ip_connection.h.

All functions listed below are thread-safe.

Basic Functions

void hall_effect_v2_create(HallEffectV2 *hall_effect_v2, const char *uid, IPConnection *ipcon)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • uid – Type: const char *
  • ipcon – Type: IPConnection *

Creates the device object hall_effect_v2 with the unique device ID uid and adds it to the IPConnection ipcon:

HallEffectV2 hall_effect_v2;
hall_effect_v2_create(&hall_effect_v2, "YOUR_DEVICE_UID", &ipcon);

This device object can be used after the IP connection has been connected (see examples above).

void hall_effect_v2_destroy(HallEffectV2 *hall_effect_v2)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *

Removes the device object hall_effect_v2 from its IPConnection and destroys it. The device object cannot be used anymore afterwards.

int hall_effect_v2_get_magnetic_flux_density(HallEffectV2 *hall_effect_v2, int16_t *ret_magnetic_flux_density)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
Output Parameters:
  • ret_magnetic_flux_density – Type: int16_t, Unit: 1 µT, Range: [-7000 to 7000]
Returns:
  • error_code – Type: int

Returns the magnetic flux density (magnetic induction).

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

int hall_effect_v2_get_counter(HallEffectV2 *hall_effect_v2, bool reset_counter, uint32_t *ret_count)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • reset_counter – Type: bool
Output Parameters:
  • ret_count – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

Returns the current value of the counter.

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

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 HALL_EFFECT_V2_CALLBACK_COUNTER callback. You can set the callback configuration with hall_effect_v2_set_counter_callback_configuration().

int hall_effect_v2_set_counter_config(HallEffectV2 *hall_effect_v2, int16_t high_threshold, int16_t low_threshold, uint32_t debounce)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • high_threshold – Type: int16_t, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 2000
  • low_threshold – Type: int16_t, Unit: 1 µT, Range: [-215 to 215 - 1], Default: -2000
  • debounce – Type: uint32_t, Unit: 1 µs, Range: [0 to 1000000], Default: 100000
Returns:
  • error_code – Type: int

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.

int hall_effect_v2_get_counter_config(HallEffectV2 *hall_effect_v2, int16_t *ret_high_threshold, int16_t *ret_low_threshold, uint32_t *ret_debounce)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
Output Parameters:
  • ret_high_threshold – Type: int16_t, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 2000
  • ret_low_threshold – Type: int16_t, Unit: 1 µT, Range: [-215 to 215 - 1], Default: -2000
  • ret_debounce – Type: uint32_t, Unit: 1 µs, Range: [0 to 1000000], Default: 100000
Returns:
  • error_code – Type: int

Returns the counter config as set by hall_effect_v2_set_counter_config().

Advanced Functions

int hall_effect_v2_get_spitfp_error_count(HallEffectV2 *hall_effect_v2, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
Output Parameters:
  • ret_error_count_ack_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_message_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_frame – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_overflow – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

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.

int hall_effect_v2_set_bootloader_mode(HallEffectV2 *hall_effect_v2, uint8_t mode, uint8_t *ret_status)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • mode – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_status – Type: uint8_t, Range: See constants
Returns:
  • error_code – Type: int

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:

  • HALL_EFFECT_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • HALL_EFFECT_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • HALL_EFFECT_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • HALL_EFFECT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • HALL_EFFECT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

  • HALL_EFFECT_V2_BOOTLOADER_STATUS_OK = 0
  • HALL_EFFECT_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • HALL_EFFECT_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • HALL_EFFECT_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • HALL_EFFECT_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • HALL_EFFECT_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int hall_effect_v2_get_bootloader_mode(HallEffectV2 *hall_effect_v2, uint8_t *ret_mode)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
Output Parameters:
  • ret_mode – Type: uint8_t, Range: See constants
Returns:
  • error_code – Type: int

Returns the current bootloader mode, see hall_effect_v2_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

  • HALL_EFFECT_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • HALL_EFFECT_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • HALL_EFFECT_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • HALL_EFFECT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • HALL_EFFECT_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int hall_effect_v2_set_write_firmware_pointer(HallEffectV2 *hall_effect_v2, uint32_t pointer)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • pointer – Type: uint32_t, Unit: 1 B, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

Sets the firmware pointer for hall_effect_v2_write_firmware(). 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.

int hall_effect_v2_write_firmware(HallEffectV2 *hall_effect_v2, uint8_t data[64], uint8_t *ret_status)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • data – Type: uint8_t[64], Range: [0 to 255]
Output Parameters:
  • ret_status – Type: uint8_t, Range: [0 to 255]
Returns:
  • error_code – Type: int

Writes 64 Bytes of firmware at the position as written by hall_effect_v2_set_write_firmware_pointer() 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.

int hall_effect_v2_set_status_led_config(HallEffectV2 *hall_effect_v2, uint8_t config)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • error_code – Type: int

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:

  • HALL_EFFECT_V2_STATUS_LED_CONFIG_OFF = 0
  • HALL_EFFECT_V2_STATUS_LED_CONFIG_ON = 1
  • HALL_EFFECT_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • HALL_EFFECT_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int hall_effect_v2_get_status_led_config(HallEffectV2 *hall_effect_v2, uint8_t *ret_config)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
Output Parameters:
  • ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • error_code – Type: int

Returns the configuration as set by hall_effect_v2_set_status_led_config()

The following constants are available for this function:

For ret_config:

  • HALL_EFFECT_V2_STATUS_LED_CONFIG_OFF = 0
  • HALL_EFFECT_V2_STATUS_LED_CONFIG_ON = 1
  • HALL_EFFECT_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • HALL_EFFECT_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int hall_effect_v2_get_chip_temperature(HallEffectV2 *hall_effect_v2, int16_t *ret_temperature)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
Output Parameters:
  • ret_temperature – Type: int16_t, Unit: 1 °C, Range: [-215 to 215 - 1]
Returns:
  • error_code – Type: int

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.

int hall_effect_v2_reset(HallEffectV2 *hall_effect_v2)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
Returns:
  • error_code – Type: int

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!

int hall_effect_v2_write_uid(HallEffectV2 *hall_effect_v2, uint32_t uid)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

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.

int hall_effect_v2_read_uid(HallEffectV2 *hall_effect_v2, uint32_t *ret_uid)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
Output Parameters:
  • ret_uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • error_code – Type: int

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

int hall_effect_v2_get_identity(HallEffectV2 *hall_effect_v2, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
Output Parameters:
  • ret_uid – Type: char[8]
  • ret_connected_uid – Type: char[8]
  • ret_position – Type: char, Range: ['a' to 'h', 'i', 'z']
  • ret_hardware_version – Type: uint8_t[3]
    • 0: major – Type: uint8_t, Range: [0 to 255]
    • 1: minor – Type: uint8_t, Range: [0 to 255]
    • 2: revision – Type: uint8_t, Range: [0 to 255]
  • ret_firmware_version – Type: uint8_t[3]
    • 0: major – Type: uint8_t, Range: [0 to 255]
    • 1: minor – Type: uint8_t, Range: [0 to 255]
    • 2: revision – Type: uint8_t, Range: [0 to 255]
  • ret_device_identifier – Type: uint16_t, Range: [0 to 216 - 1]
Returns:
  • error_code – Type: 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', '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.

Callback Configuration Functions

void hall_effect_v2_register_callback(HallEffectV2 *hall_effect_v2, int16_t callback_id, void (*function)(void), void *user_data)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • callback_id – Type: int16_t
  • function – Type: void (*)(void)
  • user_data – Type: void *

Registers the given function with the given callback_id. The user_data will be passed as the last parameter to the function.

The available callback IDs with corresponding function signatures are listed below.

int hall_effect_v2_set_magnetic_flux_density_callback_configuration(HallEffectV2 *hall_effect_v2, uint32_t period, bool value_has_to_change, char option, int16_t min, int16_t max)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int16_t, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 0
  • max – Type: int16_t, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 0
Returns:
  • error_code – Type: int

The period is the period with which the HALL_EFFECT_V2_CALLBACK_MAGNETIC_FLUX_DENSITY 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 HALL_EFFECT_V2_CALLBACK_MAGNETIC_FLUX_DENSITY 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:

  • HALL_EFFECT_V2_THRESHOLD_OPTION_OFF = 'x'
  • HALL_EFFECT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • HALL_EFFECT_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • HALL_EFFECT_V2_THRESHOLD_OPTION_SMALLER = '<'
  • HALL_EFFECT_V2_THRESHOLD_OPTION_GREATER = '>'
int hall_effect_v2_get_magnetic_flux_density_callback_configuration(HallEffectV2 *hall_effect_v2, uint32_t *ret_period, bool *ret_value_has_to_change, char *ret_option, int16_t *ret_min, int16_t *ret_max)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • ret_value_has_to_change – Type: bool, Default: false
  • ret_option – Type: char, Range: See constants, Default: 'x'
  • ret_min – Type: int16_t, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 0
  • ret_max – Type: int16_t, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 0
Returns:
  • error_code – Type: int

Returns the callback configuration as set by hall_effect_v2_set_magnetic_flux_density_callback_configuration().

The following constants are available for this function:

For ret_option:

  • HALL_EFFECT_V2_THRESHOLD_OPTION_OFF = 'x'
  • HALL_EFFECT_V2_THRESHOLD_OPTION_OUTSIDE = 'o'
  • HALL_EFFECT_V2_THRESHOLD_OPTION_INSIDE = 'i'
  • HALL_EFFECT_V2_THRESHOLD_OPTION_SMALLER = '<'
  • HALL_EFFECT_V2_THRESHOLD_OPTION_GREATER = '>'
int hall_effect_v2_set_counter_callback_configuration(HallEffectV2 *hall_effect_v2, uint32_t period, bool value_has_to_change)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • value_has_to_change – Type: bool, Default: false
Returns:
  • error_code – Type: int

The period is the period with which the HALL_EFFECT_V2_CALLBACK_COUNTER 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.

int hall_effect_v2_get_counter_callback_configuration(HallEffectV2 *hall_effect_v2, uint32_t *ret_period, bool *ret_value_has_to_change)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
Output Parameters:
  • ret_period – Type: uint32_t, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • ret_value_has_to_change – Type: bool, Default: false
Returns:
  • error_code – Type: int

Returns the callback configuration as set by hall_effect_v2_set_counter_callback_configuration().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the hall_effect_v2_register_callback() function:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

hall_effect_v2_register_callback(&hall_effect_v2,
                                 HALL_EFFECT_V2_CALLBACK_EXAMPLE,
                                 (void (*)(void))my_callback,
                                 NULL);

The available constants with corresponding function signatures 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.

HALL_EFFECT_V2_CALLBACK_MAGNETIC_FLUX_DENSITY
void callback(int16_t magnetic_flux_density, void *user_data)
Callback Parameters:
  • magnetic_flux_density – Type: int16_t, Unit: 1 µT, Range: [-7000 to 7000]
  • user_data – Type: void *

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

The parameter is the same as hall_effect_v2_get_magnetic_flux_density().

HALL_EFFECT_V2_CALLBACK_COUNTER
void callback(uint32_t count, void *user_data)
Callback Parameters:
  • count – Type: uint32_t, Range: [0 to 232 - 1]
  • user_data – Type: void *

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

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

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.

int hall_effect_v2_get_api_version(HallEffectV2 *hall_effect_v2, uint8_t ret_api_version[3])
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
Output Parameters:
  • ret_api_version – Type: uint8_t[3]
    • 0: major – Type: uint8_t, Range: [0 to 255]
    • 1: minor – Type: uint8_t, Range: [0 to 255]
    • 2: revision – Type: uint8_t, Range: [0 to 255]
Returns:
  • error_code – Type: int

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.

int hall_effect_v2_get_response_expected(HallEffectV2 *hall_effect_v2, uint8_t function_id, bool *ret_response_expected)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • function_id – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_response_expected – Type: bool
Returns:
  • error_code – Type: int

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 hall_effect_v2_set_response_expected(). 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 function_id:

  • HALL_EFFECT_V2_FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 2
  • HALL_EFFECT_V2_FUNCTION_SET_COUNTER_CONFIG = 6
  • HALL_EFFECT_V2_FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION = 8
  • HALL_EFFECT_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • HALL_EFFECT_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • HALL_EFFECT_V2_FUNCTION_RESET = 243
  • HALL_EFFECT_V2_FUNCTION_WRITE_UID = 248
int hall_effect_v2_set_response_expected(HallEffectV2 *hall_effect_v2, uint8_t function_id, bool response_expected)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • function_id – Type: uint8_t, Range: See constants
  • response_expected – Type: bool
Returns:
  • error_code – Type: int

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 function_id:

  • HALL_EFFECT_V2_FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 2
  • HALL_EFFECT_V2_FUNCTION_SET_COUNTER_CONFIG = 6
  • HALL_EFFECT_V2_FUNCTION_SET_COUNTER_CALLBACK_CONFIGURATION = 8
  • HALL_EFFECT_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • HALL_EFFECT_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • HALL_EFFECT_V2_FUNCTION_RESET = 243
  • HALL_EFFECT_V2_FUNCTION_WRITE_UID = 248
int hall_effect_v2_set_response_expected_all(HallEffectV2 *hall_effect_v2, bool response_expected)
Parameters:
  • hall_effect_v2 – Type: HallEffectV2 *
  • response_expected – Type: bool
Returns:
  • error_code – Type: int

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

Constants

HALL_EFFECT_V2_DEVICE_IDENTIFIER

This constant is used to identify a Hall Effect Bricklet 2.0.

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

HALL_EFFECT_V2_DEVICE_DISPLAY_NAME

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