Mathematica - Dual Button Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
      - Requirements
      - Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
          - Current12 Bricklet
          - Current25 Bricklet
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
            - Examples
              - Callback
            - API
              - Basic Functions
              - Advanced Functions
              - Callbacks
              - Constants
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
    - Visual Basic .NET
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# Mathematica - Dual Button Bricklet

This is the description of the Mathematica API bindings for the Dual Button Bricklet. General information and technical specifications for the Dual Button Bricklet are summarized in its hardware description.

An installation guide for the Mathematica API bindings is part of their general description.

## Examples

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

### 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
    29
    30
    31
    32
    33
    34

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

    host="localhost"
    port=4223
    uid="zgh"(* Change to your UID *)

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

    (* Callback function for state changed callback *)
    StateChangedCB[sender_,buttonL_,buttonR_,ledL_,ledR_]:=
     Module[{},
      If[buttonL==Tinkerforge`BrickletDualButton`BUTTONUSTATEUPRESSED,
       Print["Left button pressed"],
       Print["Left button released"]
      ];
      If[buttonR==Tinkerforge`BrickletDualButton`BUTTONUSTATEUPRESSED,
       Print["Right button pressed"],
       Print["Right button released"]
      ];
      Print[""]
     ]

    AddEventHandler[db@StateChanged,StateChangedCB]

    Input["Click OK to exit"]

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

## API

Generally, every method of the Mathematica bindings that returns a value can throw a `Tinkerforge.TimeoutException`. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since .NET/Link does not support multiple return values directly, we use the `out` keyword to return multiple values from a method. For further information about the `out` keyword in .NET/Link see the corresponding Mathematica .NET/Link documentation.

The namespace for all Brick/Bricklet bindings and the IPConnection is `Tinkerforge.*`.

### Basic Functions

`BrickletDualButton`[uid, ipcon] → dualButton

  Parameters:

  - uid -- String
  - ipcon -- NETObject[IPConnection]

  Returns:

  - dualButton -- 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 (see examples above).

  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 -- Integer
  - ledR -- Integer

  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 default value is (1, 1).

  The following constants are available for this function:

  - BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0
  - BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1
  - BrickletDualButton`LEDUSTATEUON = 2
  - BrickletDualButton`LEDUSTATEUOFF = 3

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

  Parameters:

  - ledL -- Integer
  - ledR -- Integer

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

  The following constants are available for this function:

  - BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0
  - BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1
  - BrickletDualButton`LEDUSTATEUON = 2
  - BrickletDualButton`LEDUSTATEUOFF = 3

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

  Parameters:

  - buttonL -- Integer
  - buttonR -- Integer

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

  - 0 = pressed
  - 1 = released

  The following constants are available for this function:

  - BrickletDualButton`BUTTONUSTATEUPRESSED = 0
  - BrickletDualButton`BUTTONUSTATEURELEASED = 1

### Advanced Functions

`BrickletDualButton``@``SetSelectedLEDState`[led, state] → Null

  Parameters:

  - led -- Integer
  - state -- Integer

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

  The other LED remains untouched.

  The following constants are available for this function:

  - BrickletDualButton`LEDULEFT = 0
  - BrickletDualButton`LEDURIGHT = 1
  - BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0
  - BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1
  - BrickletDualButton`LEDUSTATEUON = 2
  - BrickletDualButton`LEDUSTATEUOFF = 3

`BrickletDualButton``@``GetAPIVersion`[] → {apiVersion1, apiVersion2, apiVersion3}

  Returns:

  - apiVersioni -- Integer

  Returns the version of the API definition (major, minor, revision) 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 -- Integer

  Returns:

  - responseExpected -- 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 send and errors are silently ignored, because they cannot be detected.

  See `SetResponseExpected[]` for the list of function ID constants available for this function.

`BrickletDualButton``@``SetResponseExpected`[functionId, responseExpected] → Null

  Parameters:

  - functionId -- Integer
  - responseExpected -- 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 and callbacks it is always disabled.

  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 function ID constants are available for this function:

  - BrickletDualButton`FUNCTIONUSETULEDUSTATE = 1
  - BrickletDualButton`FUNCTIONUSETUSELECTEDULEDUSTATE = 5

`BrickletDualButton``@``SetResponseExpectedAll`[responseExpected] → Null

  Parameters:

  - responseExpected -- True/False

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

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

  Parameters:

  - uid -- String
  - connectedUid -- String
  - position -- Integer
  - hardwareVersioni -- Integer
  - firmwareVersioni -- Integer
  - deviceIdentifier -- Integer

  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' or 'd'.

  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:

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

>     AddEventHandler[dualButton@Example,Callback]

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.

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.

event `BrickletDualButton``@``StateChanged`[sender, buttonL, buttonR, ledL, ledR]

  Parameters:

  - sender -- NETObject[BrickletDualButton]
  - buttonL -- Integer
  - buttonR -- Integer
  - ledL -- Integer
  - ledR -- Integer

  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:

  - BrickletDualButton`BUTTONUSTATEUPRESSED = 0
  - BrickletDualButton`BUTTONUSTATEURELEASED = 1
  - BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUON = 0
  - BrickletDualButton`LEDUSTATEUAUTOUTOGGLEUOFF = 1
  - BrickletDualButton`LEDUSTATEUON = 2
  - BrickletDualButton`LEDUSTATEUOFF = 3

### Constants

`BrickletDualButton`````DEVICEUIDENTIFIER`

  This constant is used to identify a Dual Button Bricklet.

  The `GetIdentity[]` function and the `EnumerateCallback` callback of the IP Connection have a `deviceIdentifier` parameter to specify the Brick's or Bricklet's type.

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.