Mathematica - Remote Switch Bricklet

Dies ist die Beschreibung der Mathematica API Bindings für das Remote Switch Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Remote Switch Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Mathematica API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Switch Socket

Download (ExampleSwitchSocket.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Remote Switch Bricklet*)

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

(*Switch on a type A socket with house code 17 and receiver code 1.*)
(*House code 17 is 10001 in binary (least-significant bit first)*)
(*and means that the DIP switches 1 and 5 are on and 2-4 are off.*)
(*Receiver code 1 is 10000 in binary (least-significant bit first)*)
(*and means that the DIP switch A is on and B-E are off.*)
rs@SwitchSocketA[17,1,Tinkerforge`BrickletRemoteSwitch`SWITCHUTOUON]

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

API

Prinzipiell kann jede Funktion der Mathematica Bindings, welche einen Wert zurück gibt eine Tinkerforge.TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Da .NET/Link nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben. Weitere Informationen über das out Schlüsselwort in .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickletRemoteSwitch[uid, ipcon] → remoteSwitch
Parameter:
  • uid – Typ: String
  • ipcon – Typ: NETObject[IPConnection]
Rückgabe:
  • remoteSwitch – Typ: NETObject[BrickletRemoteSwitch]

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

remoteSwitch=NETNew["Tinkerforge.BrickletRemoteSwitch","YOUR_DEVICE_UID",ipcon]

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

Die .NET Runtime hat eingebauten Garbage Collection welche Objekte wieder freigibt, wenn sie vom Programm nicht mehr verwendet werden. Da Mathematica aber selbst nicht automatisch feststellen kann, wann ein Mathematica "Programm" ein .NET Objekt nicht mehr verwendet, muss sich das Programm selbst darum kümmern. Für diesen Zweck wird die ReleaseNETObject[] Funktion in den Beispielen verwendet.

Weitere Informationen über Objekt-Verwaltung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

BrickletRemoteSwitch@SwitchSocket[houseCode, receiverCode, switchTo] → Null
Parameter:
  • houseCode – Typ: Integer, Wertebereich: [0 bis 31]
  • receiverCode – Typ: Integer, Wertebereich: [0 bis 31]
  • switchTo – Typ: Integer, Wertebereich: Siehe Konstanten

Diese Funktion ist veraltet und wurde durch SwitchSocketA[] ersetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für switchTo:

  • BrickletRemoteSwitch`SWITCHUTOUOFF = 0
  • BrickletRemoteSwitch`SWITCHUTOUON = 1
BrickletRemoteSwitch@GetSwitchingState[] → state
Rückgabe:
  • state – Typ: Integer, Wertebereich: Siehe Konstanten

Gibt den aktuellen Zustand des Schaltens zurück. Wenn der aktuell Zustand busy (beschäftigt) ist, sendet das Bricklet gerade einen Code um eine Steckdose zu schalten. Weitere Aufrufe von SwitchSocket[] werden ignoriert bis der Zustand auf ready (fertig) wechselt.

Die Länge des Schaltvorgangs ist abhängig von der Anzahl der Wiederholungen, siehe SetRepeats[].

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für state:

  • BrickletRemoteSwitch`SWITCHINGUSTATEUREADY = 0
  • BrickletRemoteSwitch`SWITCHINGUSTATEUBUSY = 1
BrickletRemoteSwitch@SwitchSocketA[houseCode, receiverCode, switchTo] → Null
Parameter:
  • houseCode – Typ: Integer, Wertebereich: [0 bis 31]
  • receiverCode – Typ: Integer, Wertebereich: [0 bis 31]
  • switchTo – Typ: Integer, Wertebereich: Siehe Konstanten

Um eine Typ A Steckdose zu schalten muss der Housecode, Receivercode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Eine detaillierte Beschreibung wie man den House- und Receivercode herausfinden kann gibt es hier.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für switchTo:

  • BrickletRemoteSwitch`SWITCHUTOUOFF = 0
  • BrickletRemoteSwitch`SWITCHUTOUON = 1

Neu in Version 2.0.1 (Plugin).

BrickletRemoteSwitch@SwitchSocketB[address, unit, switchTo] → Null
Parameter:
  • address – Typ: Integer, Wertebereich: [0 bis 67108863]
  • unit – Typ: Integer, Wertebereich: [0 bis 15, 255]
  • switchTo – Typ: Integer, Wertebereich: Siehe Konstanten

Um eine Typ B Steckdose zu schalten muss die Adresse und Unit sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Um alle Geräte mit der selben Adresse zu schalten kann die Unit auf 255 gesetzt werden.

Eine detaillierte Beschreibung wie man Adresse und Unit einer Steckdose anlernen kann gibt es hier.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für switchTo:

  • BrickletRemoteSwitch`SWITCHUTOUOFF = 0
  • BrickletRemoteSwitch`SWITCHUTOUON = 1

Neu in Version 2.0.1 (Plugin).

BrickletRemoteSwitch@DimSocketB[address, unit, dimValue] → Null
Parameter:
  • address – Typ: Integer, Wertebereich: [0 bis 67108863]
  • unit – Typ: Integer, Wertebereich: [0 bis 15, 255]
  • dimValue – Typ: Integer, Wertebereich: [0 bis 255]

Um eine Typ B Dimmer zu steuern muss die Adresse und Unit sowie der Dimmwert auf der Dimmer gesetzt werden soll übergeben werden.

Eine detaillierte Beschreibung wie man Adresse und Unit einem Dimmer anlernen kann gibt es hier.

Neu in Version 2.0.1 (Plugin).

BrickletRemoteSwitch@SwitchSocketC[systemCode, deviceCode, switchTo] → Null
Parameter:
  • systemCode – Typ: Integer, Wertebereich: [ToCharacterCode["A"][[0]] bis ToCharacterCode["P"][[0]]]
  • deviceCode – Typ: Integer, Wertebereich: [1 bis 16]
  • switchTo – Typ: Integer, Wertebereich: Siehe Konstanten

Um eine Typ C Steckdose zu schalten muss der Systemcode, Gerätecode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Eine detaillierte Beschreibung wie man den System- und Gerätecode herausfinden kann gibt es hier.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für switchTo:

  • BrickletRemoteSwitch`SWITCHUTOUOFF = 0
  • BrickletRemoteSwitch`SWITCHUTOUON = 1

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

BrickletRemoteSwitch@SetRepeats[repeats] → Null
Parameter:
  • repeats – Typ: Integer, Wertebereich: [0 bis 255], Standardwert: 5

Setzt die Anzahl der Wiederholungen die verwendet werden um einen Code zu senden wenn eine der SwitchSocket[] Funktionen aufgerufen wird. Die Wiederholungen korrespondieren zu der Zeit die eine Taste auf der Fernbedienung gedrückt wird.

Einige Dimmer werden über die Länge des Tastendrucks kontrolliert, dies kann simuliert werden indem man die Anzahl der Wiederholungen inkrementiert.

BrickletRemoteSwitch@GetRepeats[] → repeats
Rückgabe:
  • repeats – Typ: Integer, Wertebereich: [0 bis 255], Standardwert: 5

Gibt die Anzahl der Wiederholungen zurück, wie von SetRepeats[] gesetzt.

BrickletRemoteSwitch@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Ausgabeparameter:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: Integer, Wertebereich: [ToCharacterCode["a"][[0]] bis ToCharacterCode["h"][[0]], ToCharacterCode["i"][[0]], ToCharacterCode["z"][[0]]]
  • hardwareVersioni – Typ: Integer
    • 1: major – Typ: Integer, Wertebereich: [0 bis 255]
    • 2: minor – Typ: Integer, Wertebereich: [0 bis 255]
    • 3: revision – Typ: Integer, Wertebereich: [0 bis 255]
  • firmwareVersioni – Typ: Integer
    • 1: major – Typ: Integer, Wertebereich: [0 bis 255]
    • 2: minor – Typ: Integer, Wertebereich: [0 bis 255]
    • 3: revision – Typ: Integer, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: Integer, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[remoteSwitch@ExampleCallback,MyCallback]

Weitere Informationen über Event-Behandlung mittels .NET/Link sind in der entsprechende Mathematica .NET/Link Dokumentation zu finden.

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

event BrickletRemoteSwitch@SwitchingDoneCallback[sender]
Callback-Parameter:
  • sender – Typ: NETObject[BrickletRemoteSwitch]

Dieser Callback wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe GetSwitchingState[].

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickletRemoteSwitch@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Ausgabeparameter:
  • apiVersioni – Typ: Integer
    • 1: major – Typ: Integer, Wertebereich: [0 bis 255]
    • 2: minor – Typ: Integer, Wertebereich: [0 bis 255]
    • 3: revision – Typ: Integer, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletRemoteSwitch@GetResponseExpected[functionId] → responseExpected
Parameter:
  • functionId – Typ: Integer, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: True/False

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected[]. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für functionId:

  • BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKET = 1
  • BrickletRemoteSwitch`FUNCTIONUSETUREPEATS = 4
  • BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKETUA = 6
  • BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKETUB = 7
  • BrickletRemoteSwitch`FUNCTIONUDIMUSOCKETUB = 8
  • BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKETUC = 9
BrickletRemoteSwitch@SetResponseExpected[functionId, responseExpected] → Null
Parameter:
  • functionId – Typ: Integer, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: True/False

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für functionId:

  • BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKET = 1
  • BrickletRemoteSwitch`FUNCTIONUSETUREPEATS = 4
  • BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKETUA = 6
  • BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKETUB = 7
  • BrickletRemoteSwitch`FUNCTIONUDIMUSOCKETUB = 8
  • BrickletRemoteSwitch`FUNCTIONUSWITCHUSOCKETUC = 9
BrickletRemoteSwitch@SetResponseExpectedAll[responseExpected] → Null
Parameter:
  • responseExpected – Typ: True/False

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

BrickletRemoteSwitch`DEVICEUIDENTIFIER

Diese Konstante wird verwendet um ein Remote Switch Bricklet zu identifizieren.

Die GetIdentity[] Funktion und der IPConnection@EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletRemoteSwitch`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet dar.