Mathematica - Hall Effect Bricklet¶

Simple¶

Download (ExampleSimple.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Hall Effect Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
he=NETNew["Tinkerforge.BrickletHallEffect",uid,ipcon]
ipcon@Connect[host,port]

(*Get current edge count without reset*)
Print["Count: "<>ToString[he@GetEdgeCount[False]]]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[he]
ReleaseNETObject[ipcon]

Callback¶

Download (ExampleCallback.nb)

 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

Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Hall Effect Bricklet*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
he=NETNew["Tinkerforge.BrickletHallEffect",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for edge count callback*)
EdgeCountCB[sender_,count_,value_]:=
 Print["Count: "<>ToString[count]]
AddEventHandler[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]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[he]
ReleaseNETObject[ipcon]

Basic Functions¶

BrickletHallEffect[uid, ipcon] → hallEffect¶

Parameters:	uid – Type: String ipcon – Type: NETObject[IPConnection]
Returns:	hallEffect – Type: NETObject[BrickletHallEffect]

Creates an object with the unique device ID uid:

hallEffect=NETNew["Tinkerforge.BrickletHallEffect","YOUR_DEVICE_UID",ipcon]

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

The .NET runtime has built-in garbage collection that frees objects that are no longer in use by a program. But because Mathematica can not automatically tell when a Mathematica "program" doesn't use a .NET object anymore, this has to be done by the program. For this the ReleaseNETObject[] function is used in the examples.

For further information about object management in .NET/Link see the corresponding Mathematica .NET/Link documentation.

BrickletHallEffect@GetValue[] → value¶

Returns:	value – Type: True/False

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

BrickletHallEffect@GetEdgeCount[resetCounter] → count¶

Parameters:	resetCounter – Type: True/False
Returns:	count – Type: Integer, 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¶

BrickletHallEffect@SetEdgeCountConfig[edgeType, debounce] → Null¶

Parameters:	edgeType – Type: Integer, Range: See constants, Default: 0 debounce – Type: Integer, 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`EDGEUTYPEURISING = 0
• BrickletHallEffect`EDGEUTYPEUFALLING = 1
• BrickletHallEffect`EDGEUTYPEUBOTH = 2

BrickletHallEffect@GetEdgeCountConfig[out edgeType, out debounce] → Null¶

Output Parameters:	edgeType – Type: Integer, Range: See constants, Default: 0 debounce – Type: Integer, 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`EDGEUTYPEURISING = 0
• BrickletHallEffect`EDGEUTYPEUFALLING = 1
• BrickletHallEffect`EDGEUTYPEUBOTH = 2

BrickletHallEffect@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null¶

Output Parameters:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Integer, Range: [ToCharacterCode["a"][[0]] to ToCharacterCode["h"][[0]], ToCharacterCode["z"][[0]]] hardwareVersioni – Type: Integer 1: major – Type: Integer, Range: [0 to 255] 2: minor – Type: Integer, Range: [0 to 255] 3: revision – Type: Integer, Range: [0 to 255] firmwareVersioni – Type: Integer 1: major – Type: Integer, Range: [0 to 255] 2: minor – Type: Integer, Range: [0 to 255] 3: revision – Type: Integer, Range: [0 to 255] deviceIdentifier – Type: Integer, 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¶

BrickletHallEffect@SetEdgeInterrupt[edges] → Null¶

Parameters:	edges – Type: Integer, 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.

BrickletHallEffect@GetEdgeInterrupt[] → edges¶

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

Returns the edges as set by SetEdgeInterrupt[].

BrickletHallEffect@SetEdgeCountCallbackPeriod[period] → Null¶

Parameters:	period – Type: Integer, 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.

BrickletHallEffect@GetEdgeCountCallbackPeriod[] → period¶

Returns:	period – Type: Integer, 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 assigning a function to a callback property of the device object:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[hallEffect@ExampleCallback,MyCallback]

For further information about event handling using .NET/Link see the corresponding Mathematica .NET/Link documentation.

The available callback property and their type of parameters are described below.

event BrickletHallEffect@EdgeCountCallback[sender, count, value]¶

Callback Parameters:	sender – Type: NETObject[BrickletHallEffect] count – Type: Integer, Range: [0 to 232 - 1] value – Type: True/False

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.

BrickletHallEffect@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}¶

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

BrickletHallEffect@GetResponseExpected[functionId] → responseExpected¶

Parameters:	functionId – Type: Integer, Range: See constants
Returns:	responseExpected – Type: True/False

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`FUNCTIONUSETUEDGEUCOUNTUCONFIG = 3
• BrickletHallEffect`FUNCTIONUSETUEDGEUINTERRUPT = 5
• BrickletHallEffect`FUNCTIONUSETUEDGEUCOUNTUCALLBACKUPERIOD = 7

BrickletHallEffect@SetResponseExpected[functionId, responseExpected] → Null¶

Parameters:	functionId – Type: Integer, Range: See constants responseExpected – Type: True/False

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`FUNCTIONUSETUEDGEUCOUNTUCONFIG = 3
• BrickletHallEffect`FUNCTIONUSETUEDGEUINTERRUPT = 5
• BrickletHallEffect`FUNCTIONUSETUEDGEUCOUNTUCALLBACKUPERIOD = 7

BrickletHallEffect@SetResponseExpectedAll[responseExpected] → Null¶

Parameters:	responseExpected – Type: True/False

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

Constants¶

BrickletHallEffect`DEVICEUIDENTIFIER¶

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.

BrickletHallEffect`DEVICEDISPLAYNAME¶

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