Mathematica - API Bindings

The Mathematica bindings allow you to control Bricks and Bricklets from your Mathematica notebooks. The ZIP file for the bindings contains:

  • Tinkerforge.dll, a precompiled .NET library

  • in source/ the source code of Tinkerforge.dll

  • in examples/ the examples for every Brick and Bricklet

The Mathematica bindings are based on the C# bindings. Since version 2.0.0 the C# bindings are CLS compliant. This allows to use them with all .NET compatible languages, such as Mathematica's .NET/Link support. It requires the .NET Framework on Windows and the Mono Framework on Linux and macOS.

Requirements

  • Mathematica 5.0 or newer on Windows, Linux or macOS with .NET/Link support

Installation

The installation of the Mathematica bindings is optional. You can install them as Mathematica AddOn or as Mathematica SystemFile, but you can also use them without installing them first.

As AddOn

To install the bindings as AddOn just create a new folder for Tinkerforge in the Mathematica AddOn-Applications folder and copy the Tinkerforge.dll file to it. On Windows the AddOn-Applications folder for Mathematica 9 is located here (for Mathematica 10 replace 9.0 by 10.0):

C:\Program Files\Wolfram Research\Mathematica\9.0\AddOns\Applications\

On Linux it's located here (for Mathematica 10 replace 9.0 by 10.0):

/usr/local/Wolfram/Mathematica/9.0/AddOns/Applications/

And on macOS it's located here:

/Applications/Mathematica.app/AddOns/Applications/

Create a Tinkerforge/ folder here, create an assembly/ folder in copy the Tinkerforge.dll file to it. Afterwards it should look like this on Windows:

C:\Program Files\Wolfram Research\Mathematica\9.0\AddOns\Applications\Tinkerforge\assembly\Tinkerforge.dll

Like this on Linux:

/usr/local/Wolfram/Mathematica/9.0/AddOns/Applications/Tinkerforge/assembly/Tinkerforge.dll

And like this on macOS:

/Applications/Mathematica.app/AddOns/Applications/Tinkerforge/assembly/Tinkerforge.dll

If you installed the bindings like this then you have to modify the LoadNETAssembly[] call in the examples like this:

LoadNETAssembly["Tinkerforge","Tinkerforge`"]

The section about testing an example has more details about this.

As SystemFile

To install the bindings as SystemFile copy the Tinkerforge.dll file to Mathematica's SystemFiles folder for .NET/Link. On Windows the SystemFiles folder for .NET/Link for Mathematica 9 is located here (for Mathematica 10 replace 9.0 by 10.0):

C:\Program Files\Wolfram Research\Mathematica\9.0\SystemFiles\Links\NETLink\

On Linux it's located here (for Mathematica 10 replace 9.0 by 10.0):

/usr/local/Wolfram/Mathematica/9.0/SystemFiles/Links/NETLink/

And on macOS it's located here:

/Applications/Mathematica.app/SystemFiles/Links/NETLink/

If you installed the bindings like this then you have to modify the LoadNETAssembly[] call in the examples like this:

LoadNETAssembly["Tinkerforge"]

The section about testing an example has more details about this.

Without Installation

You can use the Mathematica bindings without having to install them. Just give the folder that contains the Tinkerforge.dll file as parameter to the LoadNETAssembly[] call. The examples are set up in a ways that the LoadNETAssembly[] call already points correctly to the Tinkerforge.dll file if the bindings and the examples have been unpacked from the ZIP file. The section about testing an example has more details about this.

Testing an Example

To test a Mathematica example Brick Daemon and Brick Viewer have to be installed first. Brick Daemon acts as a proxy between the USB interface of the Bricks and the API bindings. Brick Viewer connects to Brick Daemon and helps to figure out basic information about the connected Bricks and Bricklets.

Stepper Brick

As an example we will run the Stepper Brick configuration example. To do this open the ExampleConfiguration.nb Notebook from the examples/Brick/Stepper/ folder in Mathematica.

Loading the Bindings

Depending on if and how you installed the Mathematica bindings you have to adapt the LoadNETAssembly[] call accordingly to make Mathematica find the Tinkerforge.dll file. Further details about handling .NET libraries in Mathematica documentation.

If the bindings are installed as AddOn then the LoadNETAssembly[] call has to look like this:

LoadNETAssembly["Tinkerforge","Tinkerforge`"]

If the bindings are installed as SystemFile then the LoadNETAssembly[] call has to look like this:

LoadNETAssembly["Tinkerforge"]

If you did not install the bindings then the LoadNETAssembly[] call can stay as it is, if you run the examples from the unpacked ZIP file for the bindings. The examples are set up in a ways that the LoadNETAssembly[] call already points correctly to the Tinkerforge.dll file if the bindings and the examples have been unpacked from the ZIP file.

You can also call LoadNETAssembly[] with an absolute path to the Tinkerforge.dll file. For example like this on Windows:

LoadNETAssembly["C:\\Absolute\\path\\to\\Tinkerforge.dll"]

Or like this on Linux and macOS:

LoadNETAssembly["/Absolute/path/to/Tinkerforge.dll"]

Configure Network Address and UID

In the example host and port specify at which network address the Stepper Brick can be found. If it is connected locally to USB then localhost and 4223 is correct. The uid value has to be changed to the UID of the connected Stepper Brick, which you can figure out using Brick Viewer:

host="localhost"
port=4223
uid="XXYYZZ"(*Change XXYYZZ to the UID of your Stepper Brick*)

Now you're ready to test this example. Evaluate all cells in top-down order to do this.

Temperature Bricklet

Here's an another example showing a dynamic plot of Temperature Bricklet measurements. The drop at sample 82 was created using a freezer spray.

Temprature Bricklet dynamic plot example

API Reference and Examples

Links to the API reference for the IP Connection, Bricks and Bricklets as well as the examples from the ZIP file of the bindings are listed in the following table. Further project descriptions can be found in the Kits section.

Name, API, Examples

Miscellaneous

IP Connection

API

Examples

Bricks

ESP32

API

ESP32 Ethernet

API

HAT

API

Examples

HAT Zero

API

Examples

IMU 2.0

API

Examples

Master

API

Examples

RED

API

Silent Stepper

API

Examples

Bricks (Discontinued)

DC

API

Examples

IMU

API

Examples

Servo

API

Examples

Stepper

API

Examples

Bricklets

Accelerometer 2.0

API

Examples

Air Quality

API

Examples

Ambient Light 3.0

API

Examples

Analog In 3.0

API

Examples

Analog Out 3.0

API

Examples

Barometer

API

Examples

Barometer 2.0

API

Examples

CAN

API

Examples

CAN 2.0

API

Examples

CO2 2.0

API

Examples

Color

API

Examples

Color 2.0

API

Examples

Compass

API

Examples

DC 2.0

API

Examples

Distance IR

API

Examples

Distance IR 2.0

API

Examples

Distance US 2.0

API

Examples

DMX

API

Examples

Dual Button 2.0

API

Examples

Dust Detector

API

Examples

E-Paper 296x128

API

Examples

Energy Monitor

API

Examples

GPS 2.0

API

Examples

GPS 3.0

API

Examples

Hall Effect

API

Examples

Hall Effect 2.0

API

Examples

Humidity 2.0

API

Examples

IMU 3.0

API

Examples

Industrial Analog Out 2.0

API

Examples

Industrial Counter

API

Examples

Industrial Digital In 4 2.0

API

Examples

Industrial Digital Out 4

API

Examples

Industrial Digital Out 4 2.0

API

Examples

Industrial Dual 0-20mA

API

Examples

Industrial Dual 0-20mA 2.0

API

Examples

Industrial Dual AC In

API

Industrial Dual AC Relay

API

Examples

Industrial Dual Analog In 2.0

API

Examples

Industrial Dual Relay

API

Examples

Industrial PTC

API

Examples

Industrial Quad Relay 2.0

API

Examples

IO-16

API

Examples

IO-16 2.0

API

Examples

IO-4 2.0

API

Examples

Isolator

API

Examples

Joystick

API

Examples

Joystick 2.0

API

Examples

Laser Range Finder 2.0

API

Examples

LCD 128x64

API

Examples

LCD 20x4

API

Examples

LED Strip 2.0

API

Examples

Line

API

Examples

Linear Poti

API

Examples

Linear Poti 2.0

API

Examples

Load Cell 2.0

API

Examples

Motion Detector 2.0

API

Examples

Motorized Linear Poti

API

Examples

Multi Touch

API

Examples

Multi Touch 2.0

API

Examples

NFC

API

OLED 128x64 2.0

API

Examples

OLED 64x48

API

Examples

One Wire

API

Examples

Outdoor Weather

API

Examples

Particulate Matter

API

Examples

Performance DC

API

Examples

Piezo Speaker

API

Examples

Piezo Speaker 2.0

API

Examples

Real-Time Clock

API

Examples

Real-Time Clock 2.0

API

Examples

Remote Switch 2.0

API

Examples

RGB LED 2.0

API

Examples

RGB LED Button

API

Examples

Rotary Encoder 2.0

API

Examples

Rotary Poti

API

Examples

Rotary Poti 2.0

API

Examples

RS232

API

Examples

RS232 2.0

API

Examples

RS485

API

Examples

Segment Display 4x7

API

Examples

Segment Display 4x7 2.0

API

Examples

Servo 2.0

API

Examples

Silent Stepper 2.0

API

Examples

Solid State Relay 2.0

API

Examples

Sound Intensity

API

Examples

Sound Pressure Level

API

Examples

Temperature

API

Examples

Temperature 2.0

API

Examples

Temperature IR 2.0

API

Examples

Thermal Imaging

API

Examples

Thermocouple 2.0

API

Examples

Tilt

API

Examples

UV Light 2.0

API

Examples

Voltage/Current 2.0

API

Examples

XMC1400 Breakout

API

Examples

Bricklets (Discontinued)

Accelerometer

API

Examples

Ambient Light

API

Examples

Ambient Light 2.0

API

Examples

Analog In

API

Examples

Analog In 2.0

API

Examples

Analog Out

API

Examples

Analog Out 2.0

API

Examples

CO2

API

Examples

Current12

API

Examples

Current25

API

Examples

Distance US

API

Examples

Dual Button

API

Examples

Dual Relay

API

Examples

GPS

API

Examples

Humidity

API

Examples

Industrial Analog Out

API

Examples

Industrial Digital In 4

API

Examples

Industrial Dual Analog In

API

Examples

Industrial Quad Relay

API

Examples

IO-4

API

Examples

Laser Range Finder

API

Examples

LCD 16x2

API

Examples

LED Strip

API

Examples

Load Cell

API

Examples

Moisture

API

Examples

Motion Detector

API

Examples

NFC/RFID

API

Examples

OLED 128x64

API

Examples

Piezo Buzzer

API

Examples

PTC

API

Examples

PTC 2.0

API

Examples

Remote Switch

API

Examples

RGB LED

API

Examples

RGB LED Matrix

API

Rotary Encoder

API

Examples

Solid State Relay

API

Examples

Temperature IR

API

Examples

Thermocouple

API

Examples

UV Light

API

Examples

Voltage

API

Examples

Voltage/Current

API

Examples