Software / API Bindings / Mathematica / API Reference and Examples / Bricklets (Discontinued) / Industrial Analog Out Bricklet

Mathematica - Industrial Analog Out Bricklet¶

This is the description of the Mathematica API bindings for the Industrial Analog Out Bricklet. General information and technical specifications for the Industrial Analog Out 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 Current¶

Download (ExampleSimpleCurrent.nb)

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

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Industrial Analog Out Bricklet*)

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

(*Set output current to 4.5mA*)
iao@SetCurrent[4500]
iao@Enable[]

Input["Click OK to exit"]

iao@Disable[]

ipcon@Disconnect[]
ReleaseNETObject[iao]
ReleaseNETObject[ipcon]

Simple Voltage¶

Download (ExampleSimpleVoltage.nb)

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

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Industrial Analog Out Bricklet*)

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

(*Set output voltage to 3.3V*)
iao@SetVoltage[3300]
iao@Enable[]

Input["Click OK to exit"]

iao@Disable[]

ipcon@Disconnect[]
ReleaseNETObject[iao]
ReleaseNETObject[ipcon]

API¶

Generally, every function 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 function. 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¶

BrickletIndustrialAnalogOut[uid, ipcon] → industrialAnalogOut¶

Parameters:	uid – Type: String ipcon – Type: NETObject[IPConnection]
Returns:	industrialAnalogOut – Type: NETObject[BrickletIndustrialAnalogOut]

Creates an object with the unique device ID uid:

industrialAnalogOut=NETNew["Tinkerforge.BrickletIndustrialAnalogOut","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.

BrickletIndustrialAnalogOut@Enable[] → Null¶

Enables the output of voltage and current.

The default is disabled.

BrickletIndustrialAnalogOut@Disable[] → Null¶

Disables the output of voltage and current.

The default is disabled.

BrickletIndustrialAnalogOut@IsEnabled[] → enabled¶

Returns:	enabled – Type: True/False, Default: False

Returns true if output of voltage and current is enabled, false otherwise.

BrickletIndustrialAnalogOut@SetVoltage[voltage] → Null¶

Parameters:	voltage – Type: Integer, Unit: 1 mV, Range: [0 to 10000]

Sets the output voltage.

The output voltage and output current are linked. Changing the output voltage also changes the output current.

BrickletIndustrialAnalogOut@GetVoltage[] → voltage¶

Returns:	voltage – Type: Integer, Unit: 1 mV, Range: [0 to 10000]

Returns the voltage as set by SetVoltage[].

BrickletIndustrialAnalogOut@SetCurrent[current] → Null¶

Parameters:	current – Type: Integer, Unit: 1 µA, Range: [0 to 24000]

Sets the output current.

The output current and output voltage are linked. Changing the output current also changes the output voltage.

BrickletIndustrialAnalogOut@GetCurrent[] → current¶

Returns:	current – Type: Integer, Unit: 1 µA, Range: [0 to 24000]

Returns the current as set by SetCurrent[].

Advanced Functions¶

BrickletIndustrialAnalogOut@SetConfiguration[voltageRange, currentRange] → Null¶

Parameters:	voltageRange – Type: Integer, Range: See constants, Default: 1 currentRange – Type: Integer, Range: See constants, Default: 0

Configures the voltage and current range.

Possible voltage ranges are:

0V to 5V
0V to 10V

Possible current ranges are:

4mA to 20mA
0mA to 20mA
0mA to 24mA

The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.

The following constants are available for this function:

For voltageRange:

BrickletIndustrialAnalogOut`VOLTAGEURANGEU0UTOU5V = 0
BrickletIndustrialAnalogOut`VOLTAGEURANGEU0UTOU10V = 1

For currentRange:

BrickletIndustrialAnalogOut`CURRENTURANGEU4UTOU20MA = 0
BrickletIndustrialAnalogOut`CURRENTURANGEU0UTOU20MA = 1
BrickletIndustrialAnalogOut`CURRENTURANGEU0UTOU24MA = 2

BrickletIndustrialAnalogOut@GetConfiguration[out voltageRange, out currentRange] → Null¶

Output Parameters:	voltageRange – Type: Integer, Range: See constants, Default: 1 currentRange – Type: Integer, Range: See constants, Default: 0

Returns the configuration as set by SetConfiguration[].

The following constants are available for this function:

For voltageRange:

BrickletIndustrialAnalogOut`VOLTAGEURANGEU0UTOU5V = 0
BrickletIndustrialAnalogOut`VOLTAGEURANGEU0UTOU10V = 1

For currentRange:

BrickletIndustrialAnalogOut`CURRENTURANGEU4UTOU20MA = 0
BrickletIndustrialAnalogOut`CURRENTURANGEU0UTOU20MA = 1
BrickletIndustrialAnalogOut`CURRENTURANGEU0UTOU24MA = 2

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

Output Parameters:

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 2¹⁶ - 1]

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 2¹⁶ - 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.

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.

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

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

BrickletIndustrialAnalogOut`FUNCTIONUENABLE = 1
BrickletIndustrialAnalogOut`FUNCTIONUDISABLE = 2
BrickletIndustrialAnalogOut`FUNCTIONUSETUVOLTAGE = 4
BrickletIndustrialAnalogOut`FUNCTIONUSETUCURRENT = 6
BrickletIndustrialAnalogOut`FUNCTIONUSETUCONFIGURATION = 8

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

The following constants are available for this function:

For functionId:

BrickletIndustrialAnalogOut`FUNCTIONUENABLE = 1
BrickletIndustrialAnalogOut`FUNCTIONUDISABLE = 2
BrickletIndustrialAnalogOut`FUNCTIONUSETUVOLTAGE = 4
BrickletIndustrialAnalogOut`FUNCTIONUSETUCURRENT = 6
BrickletIndustrialAnalogOut`FUNCTIONUSETUCONFIGURATION = 8

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

BrickletIndustrialAnalogOut`DEVICEUIDENTIFIER¶

This constant is used to identify a Industrial Analog Out 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.

BrickletIndustrialAnalogOut`DEVICEDISPLAYNAME¶: This constant represents the human readable name of a Industrial Analog Out Bricklet.