Mathematica - Dual Button Bricklet¶

Callback¶

Download (ExampleCallback.nb)

 1Needs["NETLink`"]
 2LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]
 3
 4host="localhost"
 5port=4223
 6uid="XYZ"(*Change XYZ to the UID of your Dual Button Bricklet*)
 7
 8(*Create IPConnection and device object*)
 9ipcon=NETNew["Tinkerforge.IPConnection"]
10db=NETNew["Tinkerforge.BrickletDualButton",uid,ipcon]
11ipcon@Connect[host,port]
12
13(*Callback function for state changed callback*)
14StateChangedCB[sender_,buttonL_,buttonR_,ledL_,ledR_]:=
15 Module[{},
16  If[buttonL==Tinkerforge`BrickletDualButton`BUTTONUSTATEUPRESSED,Print["Left Button: Pressed"]];
17  If[buttonL==Tinkerforge`BrickletDualButton`BUTTONUSTATEURELEASED,Print["Left Button: Released"]];
18  If[buttonR==Tinkerforge`BrickletDualButton`BUTTONUSTATEUPRESSED,Print["Right Button: Pressed"]];
19  If[buttonR==Tinkerforge`BrickletDualButton`BUTTONUSTATEURELEASED,Print["Right Button: Released"]]
20 ]
21
22AddEventHandler[db@StateChangedCallback,StateChangedCB]
23
24Input["Click OK to exit"]
25
26(*Clean up*)
27ipcon@Disconnect[]
28ReleaseNETObject[db]
29ReleaseNETObject[ipcon]

Basic Functions¶

BrickletDualButton[uid, ipcon] → dualButton¶

Parameters:	uid – Type: String ipcon – Type: NETObject[IPConnection]
Returns:	dualButton – Type: NETObject[BrickletDualButton]

Creates an object with the unique device ID uid:

dualButton=NETNew["Tinkerforge.BrickletDualButton","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.

BrickletDualButton@SetLEDState[ledL, ledR] → Null¶

Parameters:	ledL – Type: Integer, Range: See constants, Default: 1 ledR – Type: Integer, Range: See constants, Default: 1

Sets the state of the LEDs. Possible states are:

• 0 = AutoToggleOn: Enables auto toggle with initially enabled LED.

• 1 = AutoToggleOff: Activates auto toggle with initially disabled LED.

• 2 = On: Enables LED (auto toggle is disabled).

• 3 = Off: Disables LED (auto toggle is disabled).

In auto toggle mode the LED is toggled automatically at each press of a button.

If you just want to set one of the LEDs and don't know the current state of the other LED, you can get the state with GetLEDState[] or you can use SetSelectedLEDState[].

The following constants are available for this function:

For ledL:

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1

• BrickletDualButton`LEDUSTATEUON = 2

• BrickletDualButton`LEDUSTATEUOFF = 3

For ledR:

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1

• BrickletDualButton`LEDUSTATEUON = 2

• BrickletDualButton`LEDUSTATEUOFF = 3

BrickletDualButton@GetLEDState[out ledL, out ledR] → Null¶

Output Parameters:	ledL – Type: Integer, Range: See constants, Default: 1 ledR – Type: Integer, Range: See constants, Default: 1

Returns the current state of the LEDs, as set by SetLEDState[].

The following constants are available for this function:

For ledL:

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1

• BrickletDualButton`LEDUSTATEUON = 2

• BrickletDualButton`LEDUSTATEUOFF = 3

For ledR:

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1

• BrickletDualButton`LEDUSTATEUON = 2

• BrickletDualButton`LEDUSTATEUOFF = 3

BrickletDualButton@GetButtonState[out buttonL, out buttonR] → Null¶

Output Parameters:	buttonL – Type: Integer, Range: See constants buttonR – Type: Integer, Range: See constants

Returns the current state for both buttons. Possible states are:

• 0 = pressed

• 1 = released

The following constants are available for this function:

For buttonL:

• BrickletDualButton`BUTTONUSTATEUPRESSED = 0

• BrickletDualButton`BUTTONUSTATEURELEASED = 1

For buttonR:

• BrickletDualButton`BUTTONUSTATEUPRESSED = 0

• BrickletDualButton`BUTTONUSTATEURELEASED = 1

Advanced Functions¶

BrickletDualButton@SetSelectedLEDState[led, state] → Null¶

Parameters:	led – Type: Integer, Range: See constants state – Type: Integer, Range: See constants

Sets the state of the selected LED (0 or 1).

The other LED remains untouched.

The following constants are available for this function:

For led:

• BrickletDualButton`LEDULEFT = 0

• BrickletDualButton`LEDURIGHT = 1

For state:

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1

• BrickletDualButton`LEDUSTATEUON = 2

• BrickletDualButton`LEDUSTATEUOFF = 3

BrickletDualButton@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.

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[dualButton@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 BrickletDualButton@StateChangedCallback[sender, buttonL, buttonR, ledL, ledR]¶

Callback Parameters:	sender – Type: NETObject[BrickletDualButton] buttonL – Type: Integer, Range: See constants buttonR – Type: Integer, Range: See constants ledL – Type: Integer, Range: See constants ledR – Type: Integer, Range: See constants

This callback is called whenever a button is pressed.

Possible states for buttons are:

• 0 = pressed

• 1 = released

Possible states for LEDs are:

• 0 = AutoToggleOn: Auto toggle enabled and LED on.

• 1 = AutoToggleOff: Auto toggle enabled and LED off.

• 2 = On: LED on (auto toggle is disabled).

• 3 = Off: LED off (auto toggle is disabled).

The following constants are available for this function:

For buttonL:

• BrickletDualButton`BUTTONUSTATEUPRESSED = 0

• BrickletDualButton`BUTTONUSTATEURELEASED = 1

For buttonR:

• BrickletDualButton`BUTTONUSTATEUPRESSED = 0

• BrickletDualButton`BUTTONUSTATEURELEASED = 1

For ledL:

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1

• BrickletDualButton`LEDUSTATEUON = 2

• BrickletDualButton`LEDUSTATEUOFF = 3

For ledR:

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0

• BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1

• BrickletDualButton`LEDUSTATEUON = 2

• BrickletDualButton`LEDUSTATEUOFF = 3

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.

BrickletDualButton@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.

BrickletDualButton@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:

• BrickletDualButton`FUNCTIONUSETULEDUSTATE = 1

• BrickletDualButton`FUNCTIONUSETUSELECTEDULEDUSTATE = 5

BrickletDualButton@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:

• BrickletDualButton`FUNCTIONUSETULEDUSTATE = 1

• BrickletDualButton`FUNCTIONUSETUSELECTEDULEDUSTATE = 5

BrickletDualButton@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¶

BrickletDualButton`DEVICEUIDENTIFIER¶

This constant is used to identify a Dual Button 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.

BrickletDualButton`DEVICEDISPLAYNAME¶

This constant represents the human readable name of a Dual Button Bricklet.