Mathematica - Analog Out Bricklet

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

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 Analog Out Bricklet*)

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

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

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

BrickletAnalogOut[uid, ipcon] → analogOut
Parameters:
  • uid – Type: String
  • ipcon – Type: NETObject[IPConnection]
Returns:
  • analogOut – Type: NETObject[BrickletAnalogOut]

Creates an object with the unique device ID uid:

analogOut=NETNew["Tinkerforge.BrickletAnalogOut","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.

BrickletAnalogOut@SetVoltage[voltage] → Null
Parameters:
  • voltage – Type: Integer, Range: [0 to 216 - 1]

Sets the voltage in mV. The possible range is 0V to 5V (0-5000). Calling this function will set the mode to 0 (see SetMode[]).

The default value is 0 (with mode 1).

BrickletAnalogOut@GetVoltage[] → voltage
Returns:
  • voltage – Type: Integer, Range: [0 to 216 - 1]

Returns the voltage as set by SetVoltage[].

BrickletAnalogOut@SetMode[mode] → Null
Parameters:
  • mode – Type: Integer, Range: See constants

Sets the mode of the analog value. Possible modes:

  • 0: Normal Mode (Analog value as set by SetVoltage[] is applied)
  • 1: 1k Ohm resistor to ground
  • 2: 100k Ohm resistor to ground
  • 3: 500k Ohm resistor to ground

Setting the mode to 0 will result in an output voltage of 0. You can jump to a higher output voltage directly by calling SetVoltage[].

The default mode is 1.

The following constants are available for this function:

For mode:

  • BrickletAnalogOut`MODEUANALOGUVALUE = 0
  • BrickletAnalogOut`MODEU1KUTOUGROUND = 1
  • BrickletAnalogOut`MODEU100KUTOUGROUND = 2
  • BrickletAnalogOut`MODEU500KUTOUGROUND = 3
BrickletAnalogOut@GetMode[] → mode
Returns:
  • mode – Type: Integer, Range: See constants

Returns the mode as set by SetMode[].

The following constants are available for this function:

For mode:

  • BrickletAnalogOut`MODEUANALOGUVALUE = 0
  • BrickletAnalogOut`MODEU1KUTOUGROUND = 1
  • BrickletAnalogOut`MODEU100KUTOUGROUND = 2
  • BrickletAnalogOut`MODEU500KUTOUGROUND = 3

Advanced Functions

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

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

  • BrickletAnalogOut`FUNCTIONUSETUVOLTAGE = 1
  • BrickletAnalogOut`FUNCTIONUSETUMODE = 3
BrickletAnalogOut@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:

  • BrickletAnalogOut`FUNCTIONUSETUVOLTAGE = 1
  • BrickletAnalogOut`FUNCTIONUSETUMODE = 3
BrickletAnalogOut@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.

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

Constants

BrickletAnalogOut`DEVICEUIDENTIFIER

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

BrickletAnalogOut`DEVICEDISPLAYNAME

This constant represents the human readable name of a Analog Out Bricklet.