Mathematica - Industrial Digital In 4 Bricklet

This is the description of the Mathematica API bindings for the Industrial Digital In 4 Bricklet. General information and technical specifications for the Industrial Digital In 4 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).

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 Industrial Digital In 4 Bricklet*)

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

(*Get current value as bitmask*)
Print["Value Mask: "<>StringJoin[Map[ToString,IntegerDigits[idi4@GetValue[],2,4]]]]

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

Interrupt

Download (ExampleInterrupt.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
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Industrial Digital In 4 Bricklet*)

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

(*Callback function for interrupt callback*)
InterruptCB[sender_,interruptMask_,valueMask_]:=
 Module[{},
  Print["Interrupt Mask: "<>StringJoin[Map[ToString,IntegerDigits[interruptMask,2,4]]]];
  Print["Value Mask: "<>StringJoin[Map[ToString,IntegerDigits[valueMask,2,4]]]]
 ]

AddEventHandler[idi4@InterruptCallback,InterruptCB]

(*Enable interrupt on pin 0*)
idi4@SetInterrupt[FromDigits[{0,0,0,1},2]]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[idi4]
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

BrickletIndustrialDigitalIn4[uid, ipcon] → industrialDigitalIn4
Parameters:
  • uid – Type: String
  • ipcon – Type: NETObject[IPConnection]
Returns:
  • industrialDigitalIn4 – Type: NETObject[BrickletIndustrialDigitalIn4]

Creates an object with the unique device ID uid:

industrialDigitalIn4=NETNew["Tinkerforge.BrickletIndustrialDigitalIn4","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.

BrickletIndustrialDigitalIn4@GetValue[] → valueMask
Returns:
  • valueMask – Type: Integer, Range: [0 to 216 - 1]

Returns the input value with a bitmask. The bitmask is 16bit long, true refers to high and false refers to low.

For example: The value 3 or 0b0011 means that pins 0-1 are high and the other pins are low.

If no groups are used (see SetGroup[]), the pins correspond to the markings on the IndustrialDigital In 4 Bricklet.

If groups are used, the pins correspond to the element in the group. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

BrickletIndustrialDigitalIn4@GetEdgeCount[pin, resetCounter] → count
Parameters:
  • pin – Type: Integer, Range: [0 to 255]
  • resetCounter – Type: True/False
Returns:
  • count – Type: Integer, Range: [0 to 232 - 1]

Returns the current value of the edge counter for the selected pin. You can configure the edges that are counted with SetEdgeCountConfig[].

If you set the reset counter to true, the count is set back to 0 directly after it is read.

New in version 2.0.1 (Plugin).

Advanced Functions

BrickletIndustrialDigitalIn4@SetGroup[{group1, group2, group3, group4}] → Null
Parameters:
  • groupi – Type: Integer

Sets a group of Digital In 4 Bricklets that should work together. You can find Bricklets that can be grouped together with GetAvailableForGroup[].

The group consists of 4 elements. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

Each element can either be one of the ports ('a' to 'd') or 'n' if it should not be used.

For example: If you have two Digital In 4 Bricklets connected to port A and port B respectively, you could call with ['a', 'b', 'n', 'n'].

Now the pins on the Digital In 4 on port A are assigned to 0-3 and the pins on the Digital In 4 on port B are assigned to 4-7. It is now possible to call GetValue[] and read out two Bricklets at the same time.

Changing the group configuration resets all edge counter configurations and values.

BrickletIndustrialDigitalIn4@GetGroup[] → {group1, group2, group3, group4}
Returns:
  • groupi – Type: Integer

Returns the group as set by SetGroup[]

BrickletIndustrialDigitalIn4@GetAvailableForGroup[] → available
Returns:
  • available – Type: Integer, Range: [0 to 255]

Returns a bitmask of ports that are available for grouping. For example the value 5 or 0b0101 means: Port A and port C are connected to Bricklets that can be grouped together.

BrickletIndustrialDigitalIn4@SetEdgeCountConfig[selectionMask, edgeType, debounce] → Null
Parameters:
  • selectionMask – Type: Integer, Range: [0 to 216 - 1]
  • edgeType – Type: Integer, Range: See constants
  • debounce – Type: Integer, Range: [0 to 255]

Configures the edge counter for the selected pins. A bitmask of 9 or 0b1001 will enable the edge counter for pins 0 and 3.

The edge type parameter configures if rising edges, falling edges or both are counted if the pin is configured for input. Possible edge types are:

  • 0 = rising (default)
  • 1 = falling
  • 2 = both

The debounce time is given in ms.

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.

Default values: 0 (edge type) and 100ms (debounce time)

The following constants are available for this function:

For edgeType:

  • BrickletIndustrialDigitalIn4`EDGEUTYPEURISING = 0
  • BrickletIndustrialDigitalIn4`EDGEUTYPEUFALLING = 1
  • BrickletIndustrialDigitalIn4`EDGEUTYPEUBOTH = 2

New in version 2.0.1 (Plugin).

BrickletIndustrialDigitalIn4@GetEdgeCountConfig[pin, out edgeType, out debounce] → Null
Parameters:
  • pin – Type: Integer, Range: [0 to 255]
Output Parameters:
  • edgeType – Type: Integer, Range: See constants
  • debounce – Type: Integer, Range: [0 to 255]

Returns the edge type and debounce time for the selected pin as set by SetEdgeCountConfig[].

The following constants are available for this function:

For edgeType:

  • BrickletIndustrialDigitalIn4`EDGEUTYPEURISING = 0
  • BrickletIndustrialDigitalIn4`EDGEUTYPEUFALLING = 1
  • BrickletIndustrialDigitalIn4`EDGEUTYPEUBOTH = 2

New in version 2.0.1 (Plugin).

BrickletIndustrialDigitalIn4@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Returns:
  • apiVersioni – Type: Integer, Range: [0 to 255]

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.

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

The following constants are available for this function:

For functionId:

  • BrickletIndustrialDigitalIn4`FUNCTIONUSETUGROUP = 2
  • BrickletIndustrialDigitalIn4`FUNCTIONUSETUDEBOUNCEUPERIOD = 5
  • BrickletIndustrialDigitalIn4`FUNCTIONUSETUINTERRUPT = 7
  • BrickletIndustrialDigitalIn4`FUNCTIONUSETUEDGEUCOUNTUCONFIG = 11
BrickletIndustrialDigitalIn4@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 send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletIndustrialDigitalIn4`FUNCTIONUSETUGROUP = 2
  • BrickletIndustrialDigitalIn4`FUNCTIONUSETUDEBOUNCEUPERIOD = 5
  • BrickletIndustrialDigitalIn4`FUNCTIONUSETUINTERRUPT = 7
  • BrickletIndustrialDigitalIn4`FUNCTIONUSETUEDGEUCOUNTUCONFIG = 11
BrickletIndustrialDigitalIn4@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.

BrickletIndustrialDigitalIn4@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
  • hardwareVersioni – Type: Integer, Range: [0 to 255]
  • firmwareVersioni – 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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletIndustrialDigitalIn4@SetDebouncePeriod[debounce] → Null
Parameters:
  • debounce – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the debounce period of the InterruptCallback callback.

For example: If you set this value to 100, you will get the interrupt maximal every 100ms. This is necessary if something that bounces is connected to the Digital In 4 Bricklet, such as a button.

BrickletIndustrialDigitalIn4@GetDebouncePeriod[] → debounce
Returns:
  • debounce – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by SetDebouncePeriod[].

BrickletIndustrialDigitalIn4@SetInterrupt[interruptMask] → Null
Parameters:
  • interruptMask – Type: Integer, Range: [0 to 216 - 1]

Sets the pins on which an interrupt is activated with a bitmask. Interrupts are triggered on changes of the voltage level of the pin, i.e. changes from high to low and low to high.

For example: An interrupt bitmask of 9 or 0b1001 will enable the interrupt for pins 0 and 3.

The interrupts use the grouping as set by SetGroup[].

The interrupt is delivered with the InterruptCallback callback.

BrickletIndustrialDigitalIn4@GetInterrupt[] → interruptMask
Returns:
  • interruptMask – Type: Integer, Range: [0 to 216 - 1]

Returns the interrupt bitmask as set by SetInterrupt[].

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[industrialDigitalIn4@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.

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 BrickletIndustrialDigitalIn4@InterruptCallback[sender, interruptMask, valueMask]
Callback Parameters:
  • sender – Type: NETObject[BrickletIndustrialDigitalIn4]
  • interruptMask – Type: Integer, Range: [0 to 216 - 1]
  • valueMask – Type: Integer, Range: [0 to 216 - 1]

This callback is triggered whenever a change of the voltage level is detected on pins where the interrupt was activated with SetInterrupt[].

The values are a bitmask that specifies which interrupts occurred and the current value bitmask.

For example:

  • (1, 1) or (0b0001, 0b0001) means that an interrupt on pin 0 occurred and currently pin 0 is high and pins 1-3 are low.
  • (9, 14) or (0b1001, 0b1110) means that interrupts on pins 0 and 3 occurred and currently pin 0 is low and pins 1-3 are high.

Constants

BrickletIndustrialDigitalIn4`DEVICEUIDENTIFIER

This constant is used to identify a Industrial Digital In 4 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.

BrickletIndustrialDigitalIn4`DEVICEDISPLAYNAME

This constant represents the human readable name of a Industrial Digital In 4 Bricklet.