Deutsch
English
Menu
Software / API Bindings / JavaScript / API Reference and Examples / Bricklets / Hall Effect Bricklet 2.0

JavaScript - Hall Effect Bricklet 2.0

This is the description of the JavaScript 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 JavaScript API bindings is part of their general description.

Examples

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

Counter (Node.js)

Download (ExampleCounter.js)

 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
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Hall Effect Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var he = new Tinkerforge.BrickletHallEffectV2(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Get current count without counter reset
        he.getCounter(false,
            function (count) {
                console.log('Count: ' + count);
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Magnetic Flux Density (Node.js)

Download (ExampleMagneticFluxDensity.js)

 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
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Hall Effect Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var he = new Tinkerforge.BrickletHallEffectV2(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Get current Magnetic Flux Density
        he.getMagneticFluxDensity(
            function (magneticFluxDensity) {
                console.log('Magnetic Flux Density: ' + magneticFluxDensity + ' µT');
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Counter Callback (Node.js)

Download (ExampleCounterCallback.js)

 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
var Tinkerforge = require('tinkerforge');

var HOST = 'localhost';
var PORT = 4223;
var UID = 'XYZ'; // Change XYZ to the UID of your Hall Effect Bricklet 2.0

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var he = new Tinkerforge.BrickletHallEffectV2(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Configure counter with ±3000µT threshold and 10ms debounce
        he.setCounterConfig(3000, -3000, 10000);

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

// Register counter callback
he.on(Tinkerforge.BrickletHallEffectV2.CALLBACK_COUNTER,
    // Callback function for counter callback
    function (counter) {
        console.log('Counter: ' + counter);
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Counter (HTML)

Download (ExampleCounter.html), Test (ExampleCounter.html)

 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
51
52
53
54
55
56
57
58
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Hall Effect Bricklet 2.0 Counter Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var he = new Tinkerforge.BrickletHallEffectV2(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Get current count without counter reset
                        he.getCounter(false,
                            function (count) {
                                textArea.value += 'Count: ' + count + '\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

Magnetic Flux Density (HTML)

Download (ExampleMagneticFluxDensity.html), Test (ExampleMagneticFluxDensity.html)

 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
51
52
53
54
55
56
57
58
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Hall Effect Bricklet 2.0 Magnetic Flux Density Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var he = new Tinkerforge.BrickletHallEffectV2(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Get current Magnetic Flux Density
                        he.getMagneticFluxDensity(
                            function (magneticFluxDensity) {
                                textArea.value += 'Magnetic Flux Density: ' + magneticFluxDensity + ' µT\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

Counter Callback (HTML)

Download (ExampleCounterCallback.html), Test (ExampleCounterCallback.html)

 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
51
52
53
54
55
56
57
58
59
60
61
62
63
<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>Hall Effect Bricklet 2.0 Counter Callback Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var he = new Tinkerforge.BrickletHallEffectV2(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Configure counter with ±3000µT threshold and 10ms debounce
                        he.setCounterConfig(3000, -3000, 10000);

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

                // Register counter callback
                he.on(Tinkerforge.BrickletHallEffectV2.CALLBACK_COUNTER,
                    // Callback function for counter callback
                    function (counter) {
                        textArea.value += 'Counter: ' + counter + '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

API

Generally, every function of the JavaScript bindings can take two optional parameters, returnCallback and errorCallback. These are two user defined callback functions. The returnCallback function is called with the results as arguments, if the function returns its results asynchronously. 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
  • IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
  • IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71
  • IPConnection.ERROR_WRONG_DEVICE_TYPE = 81
  • IPConnection.ERROR_DEVICE_REPLACED = 82
  • IPConnection.ERROR_WRONG_RESPONSE_LENGTH = 83
  • IPConnection.ERROR_INT64_NOT_SUPPORTED = 91

The namespace for the JavaScript bindings is Tinkerforge.*.

Basic Functions

new BrickletHallEffectV2(uid, ipcon)
Parameters:
  • uid – Type: string
  • ipcon – Type: IPConnection
Returns:
  • hallEffectV2 – Type: BrickletHallEffectV2

Creates an object with the unique device ID uid:

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

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

BrickletHallEffectV2.getMagneticFluxDensity([returnCallback][, errorCallback])
Callback Parameters:
  • magneticFluxDensity – Type: int, Unit: 1 µT, Range: [-7000 to 7000]
Returns:
  • undefined

Returns the magnetic flux density (magnetic induction).

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

BrickletHallEffectV2.getCounter(resetCounter[, returnCallback][, errorCallback])
Parameters:
  • resetCounter – Type: boolean
Callback Parameters:
  • count – Type: int, Range: [0 to 232 - 1]
Returns:
  • undefined

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

BrickletHallEffectV2.setCounterConfig(highThreshold, lowThreshold, debounce[, returnCallback][, errorCallback])
Parameters:
  • highThreshold – Type: int, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 2000
  • lowThreshold – Type: int, Unit: 1 µT, Range: [-215 to 215 - 1], Default: -2000
  • debounce – Type: int, Unit: 1 µs, Range: [0 to 1000000], Default: 100000
Callback Parameters:
  • undefined
Returns:
  • undefined

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.

BrickletHallEffectV2.getCounterConfig([returnCallback][, errorCallback])
Callback Parameters:
  • highThreshold – Type: int, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 2000
  • lowThreshold – Type: int, Unit: 1 µT, Range: [-215 to 215 - 1], Default: -2000
  • debounce – Type: int, Unit: 1 µs, Range: [0 to 1000000], Default: 100000
Returns:
  • undefined

Returns the counter config as set by setCounterConfig().

Advanced Functions

BrickletHallEffectV2.getSPITFPErrorCount([returnCallback][, errorCallback])
Callback Parameters:
  • errorCountAckChecksum – Type: int, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: int, Range: [0 to 232 - 1]
  • errorCountFrame – Type: int, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: int, Range: [0 to 232 - 1]
Returns:
  • undefined

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.

BrickletHallEffectV2.setStatusLEDConfig(config[, returnCallback][, errorCallback])
Parameters:
  • config – Type: int, Range: See constants, Default: 3
Callback Parameters:
  • undefined
Returns:
  • undefined

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
BrickletHallEffectV2.getStatusLEDConfig([returnCallback][, errorCallback])
Callback Parameters:
  • config – Type: int, Range: See constants, Default: 3
Returns:
  • undefined

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
BrickletHallEffectV2.getChipTemperature([returnCallback][, errorCallback])
Callback Parameters:
  • temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]
Returns:
  • undefined

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.

BrickletHallEffectV2.reset([returnCallback][, errorCallback])
Callback Parameters:
  • undefined
Returns:
  • undefined

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!

BrickletHallEffectV2.getIdentity([returnCallback][, errorCallback])
Callback 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: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]
  • firmwareVersion – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, Range: [0 to 255]
  • deviceIdentifier – Type: int, Range: [0 to 216 - 1]
Returns:
  • undefined

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

BrickletHallEffectV2.on(callback_id, function[, errorCallback])
Parameters:
  • callback_id – Type: int
  • function – Type: function
Returns:
  • undefined

Registers the given function with the given callback_id.

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

BrickletHallEffectV2.setMagneticFluxDensityCallbackConfiguration(period, valueHasToChange, option, min, max[, returnCallback][, errorCallback])
Parameters:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 0
  • max – Type: int, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 0
Callback Parameters:
  • undefined
Returns:
  • undefined

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

  • BrickletHallEffectV2.THRESHOLD_OPTION_OFF = 'x'
  • BrickletHallEffectV2.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletHallEffectV2.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletHallEffectV2.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletHallEffectV2.THRESHOLD_OPTION_GREATER = '>'
BrickletHallEffectV2.getMagneticFluxDensityCallbackConfiguration([returnCallback][, errorCallback])
Callback Parameters:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: int, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 0
  • max – Type: int, Unit: 1 µT, Range: [-215 to 215 - 1], Default: 0
Returns:
  • undefined

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 = '>'
BrickletHallEffectV2.setCounterCallbackConfiguration(period, valueHasToChange[, returnCallback][, errorCallback])
Parameters:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false
Callback Parameters:
  • undefined
Returns:
  • undefined

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

BrickletHallEffectV2.getCounterCallbackConfiguration([returnCallback][, errorCallback])
Callback Parameters:
  • period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: boolean, Default: false
Returns:
  • undefined

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 with the on() function of the device object. The first parameter is the callback ID and the second parameter the callback function:

hallEffectV2.on(BrickletHallEffectV2.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.

BrickletHallEffectV2.CALLBACK_MAGNETIC_FLUX_DENSITY
Callback Parameters:
  • magneticFluxDensity – Type: int, 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().

BrickletHallEffectV2.CALLBACK_COUNTER
Callback Parameters:
  • count – Type: int, 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.

BrickletHallEffectV2.getAPIVersion()
Returns:
  • apiVersion – Type: [int, ...], Length: 3
    • 0: major – Type: int, Range: [0 to 255]
    • 1: minor – Type: int, Range: [0 to 255]
    • 2: revision – Type: int, 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.

BrickletHallEffectV2.getResponseExpected(functionId[, errorCallback])
Parameters:
  • functionId – Type: int, Range: See constants
Returns:
  • responseExpected – 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • 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
BrickletHallEffectV2.setResponseExpected(functionId, responseExpected[, errorCallback])
Parameters:
  • functionId – Type: int, Range: See constants
  • responseExpected – Type: boolean
Returns:
  • undefined

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

  • 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
BrickletHallEffectV2.setResponseExpectedAll(responseExpected)
Parameters:
  • responseExpected – Type: boolean
Returns:
  • undefined

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.

BrickletHallEffectV2.setBootloaderMode(mode[, returnCallback][, errorCallback])
Parameters:
  • mode – Type: int, Range: See constants
Callback Parameters:
  • status – Type: int, Range: See constants
Returns:
  • undefined

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
BrickletHallEffectV2.getBootloaderMode([returnCallback][, errorCallback])
Callback Parameters:
  • mode – Type: int, Range: See constants
Returns:
  • undefined

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
BrickletHallEffectV2.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])
Parameters:
  • pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]
Callback Parameters:
  • undefined
Returns:
  • undefined

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.

BrickletHallEffectV2.writeFirmware(data[, returnCallback][, errorCallback])
Parameters:
  • data – Type: [int, ...], Length: 64, Range: [0 to 255]
Callback Parameters:
  • status – Type: int, Range: [0 to 255]
Returns:
  • undefined

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.

BrickletHallEffectV2.writeUID(uid[, returnCallback][, errorCallback])
Parameters:
  • uid – Type: int, Range: [0 to 232 - 1]
Callback Parameters:
  • undefined
Returns:
  • undefined

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.

BrickletHallEffectV2.readUID([returnCallback][, errorCallback])
Callback Parameters:
  • uid – Type: int, Range: [0 to 232 - 1]
Returns:
  • undefined

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

Constants

BrickletHallEffectV2.DEVICE_IDENTIFIER

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

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

BrickletHallEffectV2.DEVICE_DISPLAY_NAME

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