C# - API Bindings

Bemerkung

Es gibt einen extra Abschnitt für C# und Windows Phone.

Die C# Bindings ermöglichen es Bricks und Bricklets aus selbst erstellen C# Programmen heraus zu steuern. Die ZIP Datei für die Bindings beinhaltet:

  • Tinkerforge.dll, eine vorkompilierte C#/.NET Bibliothek (ohne Debug-Informationen)
  • Tinkerforge.dll.mdb, Debug-Informationen für Tinkerforge.dll
  • Tinkerforge.xml, die API Dokumentation für Visual Studio, MonoDevelop, usw.
  • in source/ den Quelltext für Tinkerforge.dll
  • in examples/ die Beispiele für alle Bricks und Bricklets

Die C#/.NET Bibliothek hat keine weiteren Abhängigkeiten.

Voraussetzungen

  • C# Compiler

Installation

Ob und wie die C# Bindings installiert werden müssen hängt stark davon ab wie sie benutzt werden sollen. Wenn der C# Compiler direkt von der Kommandozeile aufgerufen wird genügt es die Tinkerforge.dll Datei im gleichen Verzeichnis wie den C# Quelltext des Programms abzulegen.

Um die Bindings in einer IDE zu verwenden muss die Tinkerforge.dll Datei wahrscheinlich zuerst dem Assembly-Katalog der IDE hinzugefügt werden. Wie dies gemacht wird hängt von der IDE ab und wird in der Dokumentation der jeweiligen IDE erklärt.

Die C# Bindings sind auch als NuGet Package verfügbar, das in Visual Studio und MonoDevelop (via NuGet Addin) zum jeweiligen Projekt hinzugefügt werden kann.

Das NuGet Package beinhaltet weder den Quelltext der Bindings noch die Beispiele. Diese sind als Teil der ZIP Datei der Bindings verfügbar.

Test eines Beispiels

Um ein C# Beispiel testen zu können müssen zuerst Brick Daemon und Brick Viewer installiert werden. Brick Daemon arbeitet als Proxy zwischen der USB Schnittstelle der Bricks und den API Bindings. Brick Viewer kann sich mit Brick Daemon verbinden und gibt Informationen über die angeschlossenen Bricks und Bricklets aus.

Als Beispiel wird im Folgenden das Konfigurationsbeispiel des Stepper Bricks auf der Kommandozeile kompiliert. Dafür müssen zuerst die Tinkerforge.dll Datei und die ExampleConfiguration.cs Datei aus dem examples/Brick/Stepper/ Ordner in einen neuen Ordner kopiert werden:

example_project/
 -> Tinkerforge.dll
 -> ExampleConfiguration.cs

Am Anfang des Beispiels ist mit HOST und PORT angegeben unter welcher Netzwerkadresse der Stepper Brick zu erreichen ist. Ist er lokal per USB angeschlossen dann ist localhost und 4223 richtig. Als UID muss die UID des angeschlossen Stepper Bricks angegeben werden, diese kann über den Brick Viewer ermittelt werden:

private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "XYZ"; // Change to your UID

Jetzt kann im example_project/ Ordner der Visual Studio C# Compiler auf Windows so aufgerufen werden:

csc /target:exe /out:Example.exe /reference:Tinkerforge.dll ExampleConfiguration.cs

oder so der Mono Compiler auf Linux und macOS:

mcs /target:exe /out:Example.exe /reference:Tinkerforge.dll ExampleConfiguration.cs

Alternativ können die Beispiele auch in einer C# IDE deiner Wahl verwendet werden, wie z.B. Visual Studio oder MonoDevelop.

CLS Konformität

Seit Version 2.0.0 sind die C# Bindings konform zur Common Language Specification. Dies erlaubt es diese Bindings mit allen .NET kompatiblen Sprachen zu verwenden. Für Visual Basic .NET, Mathematica und LabVIEW (Windows) stehen eigene Beispiele und Dokumentation zur Verfügung, um dies zu demonstrieren.

API Referenz und Beispiele

Links zur API Referenz der IP Connection, Bricks und Bricklets sowie die Beispiele aus der ZIP Datei der Bindings sind in der folgenden Tabelle aufgelistet. Anleitungen für weiterführende Projekte finden sich im Abschnitt über Kits.

  API Beispiele
IP Connection API Beispiele
     
Bricks    
DC API Beispiele
HAT API Beispiele
HAT Zero API Beispiele
IMU 2.0 API Beispiele
Master API Beispiele
RED API Beispiele
Servo API Beispiele
Silent Stepper API Beispiele
Stepper API Beispiele
     
Bricks (Abgekündigt)    
IMU API Beispiele
     
Bricklets    
Accelerometer API Beispiele
Accelerometer 2.0 API Beispiele
Air Quality API Beispiele
Ambient Light 3.0 API Beispiele
Analog In 3.0 API Beispiele
Analog Out 2.0 API Beispiele
Analog Out 3.0 API Beispiele
Barometer API Beispiele
Barometer 2.0 API Beispiele
CAN API Beispiele
CAN 2.0 API Beispiele
CO2 2.0 API Beispiele
Color API Beispiele
Distance IR API Beispiele
Distance IR 2.0 API Beispiele
DMX API Beispiele
Dual Button API Beispiele
Dual Button 2.0 API Beispiele
Dual Relay API Beispiele
Dust Detector API Beispiele
E-Paper 296x128 API Beispiele
GPS 2.0 API Beispiele
Hall Effect API Beispiele
Hall Effect 2.0 API Beispiele
Humidity 2.0 API Beispiele
Industrial Analog Out API Beispiele
Industrial Analog Out 2.0 API Beispiele
Industrial Counter API Beispiele
Industrial Digital In 4 2.0 API Beispiele
Industrial Digital Out 4 API Beispiele
Industrial Digital Out 4 2.0 API Beispiele
Industrial Dual 0-20mA API Beispiele
Industrial Dual 0-20mA 2.0 API Beispiele
Industrial Dual Analog In 2.0 API Beispiele
Industrial Dual Relay API Beispiele
Industrial Quad Relay 2.0 API Beispiele
IO-16 API Beispiele
IO-16 2.0 API Beispiele
IO-4 2.0 API Beispiele
Isolator API Beispiele
Joystick API Beispiele
Joystick 2.0 API Beispiele
Laser Range Finder 2.0 API Beispiele
LCD 128x64 API Beispiele
LCD 20x4 API Beispiele
LED Strip 2.0 API Beispiele
Line API Beispiele
Linear Poti API Beispiele
Linear Poti 2.0 API Beispiele
Load Cell 2.0 API Beispiele
Moisture API Beispiele
Motion Detector API Beispiele
Motion Detector 2.0 API Beispiele
Motorized Linear Poti API Beispiele
Multi Touch API Beispiele
NFC API Beispiele
OLED 128x64 API Beispiele
OLED 128x64 2.0 API Beispiele
OLED 64x48 API Beispiele
One Wire API Beispiele
Outdoor Weather API Beispiele
Particulate Matter API Beispiele
Piezo Speaker API Beispiele
Piezo Speaker 2.0 API Beispiele
PTC 2.0 API Beispiele
Real-Time Clock API Beispiele
Real-Time Clock 2.0 API Beispiele
Remote Switch 2.0 API Beispiele
RGB LED API Beispiele
RGB LED 2.0 API Beispiele
RGB LED Button API Beispiele
Rotary Encoder 2.0 API Beispiele
Rotary Poti API Beispiele
RS232 API Beispiele
RS232 2.0 API Beispiele
RS485 API Beispiele
Segment Display 4x7 API Beispiele
Segment Display 4x7 2.0 API Beispiele
Solid State Relay 2.0 API Beispiele
Sound Intensity API Beispiele
Sound Pressure Level API Beispiele
Temperature API Beispiele
Temperature 2.0 API Beispiele
Temperature IR 2.0 API Beispiele
Thermal Imaging API Beispiele
Thermocouple 2.0 API Beispiele
Tilt API Beispiele
UV Light API Beispiele
UV Light 2.0 API Beispiele
Voltage/Current 2.0 API Beispiele
     
Bricklets (Abgekündigt)    
Ambient Light API Beispiele
Ambient Light 2.0 API Beispiele
Analog In API Beispiele
Analog In 2.0 API Beispiele
Analog Out API Beispiele
CO2 API Beispiele
Current12 API Beispiele
Current25 API Beispiele
Distance US API Beispiele
GPS API Beispiele
Humidity API Beispiele
Industrial Digital In 4 API Beispiele
Industrial Dual Analog In API Beispiele
Industrial Quad Relay API Beispiele
IO-4 API Beispiele
Laser Range Finder API Beispiele
LCD 16x2 API Beispiele
LED Strip API Beispiele
Load Cell API Beispiele
NFC/RFID API Beispiele
Piezo Buzzer API Beispiele
PTC API Beispiele
Remote Switch API Beispiele
RGB LED Matrix API Beispiele
Rotary Encoder API Beispiele
Solid State Relay API Beispiele
Temperature IR API Beispiele
Thermocouple API Beispiele
Voltage API Beispiele
Voltage/Current API Beispiele