Mathematica - DC Brick

Dies ist die Beschreibung der Mathematica API Bindings für den DC Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des DC Brick 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).

Configuration

Download (ExampleConfiguration.nb)

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

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

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

dc@SetDriveMode[Tinkerforge`BrickDC`DRIVEUMODEUDRIVEUCOAST]
dc@SetPWMFrequency[10000](*Use PWM frequency of 10kHz*)
dc@SetAcceleration[5000](*Slow acceleration*)
dc@SetVelocity[32767](*Full speed forward*)
dc@Enable[](*Enable motor power*)

Input["Click OK to exit"]

(*Clean up*)
dc@Disable[](*Disable motor power*)
ipcon@Disconnect[]
ReleaseNETObject[dc]
ReleaseNETObject[ipcon]

Callback

Download (ExampleCallback.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

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

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

(*The acceleration has to be smaller or equal to the maximum*)
(*acceleration of the DC motor, otherwise the velocity reached*)
(*callback will be called too early*)
dc@SetAcceleration[5000](*Slow acceleration*)
dc@SetVelocity[32767](*Full speed forward*)

(*Use velocity reached callback to swing back and forth*)
(*between full speed forward and full speed backward*)
VelocityReachedCB[sender_,velocity_]:=
 Module[{},
  If[velocity==32767,
   Print["Velocity: Full speed forward, now turning backward"];
   sender@SetVelocity[-32767]
  ];
  If[velocity==-32767,
   Print["Velocity: Full speed backward, now turning forward"];
   sender@SetVelocity[32767]
  ]
 ]

AddEventHandler[dc@VelocityReachedCallback,VelocityReachedCB]

(*Enable motor power*)
dc@Enable[]

Input["Click OK to exit"]

(*Clean up*)
dc@Disable[](*Disable motor power*)
ipcon@Disconnect[]
ReleaseNETObject[dc]
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

BrickDC[uid, ipcon] → dc
Parameter:
  • uid -- String
  • ipcon -- NETObject[IPConnection]
Rückgabe:
  • dc -- NETObject[BrickDC]

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

dc=NETNew["Tinkerforge.BrickDC","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.

BrickDC@SetVelocity[velocity] → Null
Parameter:
  • velocity -- Integer

Setzt die Geschwindigkeit des Motors. Hierbei sind -32767 maximale Geschwindigkeit rückwärts, 0 ist Halt und 32767 maximale Geschwindigkeit vorwärts. In Abhängigkeit von der Beschleunigung (siehe SetAcceleration[]) wird der Motor nicht direkt auf die Geschwindigkeit gebracht sondern gleichmäßig beschleunigt.

Die Geschwindigkeit beschreibt das Tastverhältnis der PWM für die Motoransteuerung. Z.B. entspricht ein Geschwindigkeitswert von 3277 einer PWM mit einem Tastverhältnis von 10%. Weiterhin kann neben dem Tastverhältnis auch die Frequenz der PWM verändert werden, siehe SetPWMFrequency[].

Der Standardwert für die Geschwindigkeit ist 0.

BrickDC@GetVelocity[] → velocity
Rückgabe:
  • velocity -- Integer

Gibt die Geschwindigkeit zurück, wie gesetzt von SetVelocity[].

BrickDC@GetCurrentVelocity[] → velocity
Rückgabe:
  • velocity -- Integer

Gibt die aktuelle Geschwindigkeit des Motors zurück. Dieser Wert unterscheidet sich von GetVelocity[], sobald der Motor auf einen neuen Zielwert, wie von SetVelocity[] vorgegeben, beschleunigt.

BrickDC@SetAcceleration[acceleration] → Null
Parameter:
  • acceleration -- Integer

Setzt die Beschleunigung des Motors. Die Einheit dieses Wertes ist Geschwindigkeit/s. Ein Beschleunigungswert von 10000 bedeutet, dass jede Sekunde die Geschwindigkeit um 10000 erhöht wird (entspricht rund 30% Tastverhältnis).

Beispiel: Soll die Geschwindigkeit von 0 auf 16000 (entspricht ungefähr 50% Tastverhältnis) in 10 Sekunden beschleunigt werden, so ist die Beschleunigung auf 1600 einzustellen.

Eine Beschleunigung von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Beschleunigungsrampe gefahren.

Der Standardwert für die Beschleunigung beträgt 10000.

BrickDC@GetAcceleration[] → acceleration
Rückgabe:
  • acceleration -- Integer

Gibt die Beschleunigung zurück, wie gesetzt von SetAcceleration[].

BrickDC@FullBrake[] → Null

Führt eine aktive Vollbremsung aus.

Warnung

Diese Funktion ist für Notsituationen bestimmt, in denen ein unverzüglicher Halt notwendig ist. Abhängig von der aktuellen Geschwindigkeit und der Kraft des Motors kann eine Vollbremsung brachial sein.

Ein Aufruf von SetVelocity[] mit 0 erlaubt einen normalen Stopp des Motors.

BrickDC@Enable[] → Null

Aktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (Geschwindigkeit, Beschleunigung, etc.).

BrickDC@Disable[] → Null

Deaktiviert die Treiberstufe. Die Konfiguration (Geschwindigkeit, Beschleunigung, etc.) bleibt erhalten aber der Motor wird nicht angesteuert bis eine erneute Aktivierung erfolgt.

BrickDC@IsEnabled[] → enabled
Rückgabe:
  • enabled -- True/False

Gibt true zurück wenn die Treiberstufe aktiv ist, sonst false.

Fortgeschrittene Funktionen

BrickDC@SetPWMFrequency[frequency] → Null
Parameter:
  • frequency -- Integer

Setzt die Frequenz (in Hz) der PWM, welche den Motor steuert. Der Wertebereich der Frequenz ist 1-20000Hz. Oftmals ist eine hohe Frequenz geräuschärmer und der Motor läuft dadurch ruhiger. Trotz dessen führt eine geringe Frequenz zu weniger Schaltvorgängen und somit zu weniger Schaltverlusten. Bei einer Vielzahl von Motoren ermöglichen geringere Frequenzen höhere Drehmomente.

Im Allgemeinen kann diese Funktion ignoriert werden, da der Standardwert höchstwahrscheinlich zu einem akzeptablen Ergebnis führt.

Der Standardwert der Frequenz ist 15 kHz.

BrickDC@GetPWMFrequency[] → frequency
Rückgabe:
  • frequency -- Integer

Gibt die PWM Frequenz (in Hz) zurück, wie gesetzt von SetPWMFrequency[].

BrickDC@GetStackInputVoltage[] → voltage
Rückgabe:
  • voltage -- Integer

Gibt die Eingangsspannung (in mV) des Stapels zurück. Die Eingangsspannung des Stapel wird über diesen bereitgestellt und von einer Step-Down oder Step-Up Power Supply erzeugt.

BrickDC@GetExternalInputVoltage[] → voltage
Rückgabe:
  • voltage -- Integer

Gibt die externe Eingangsspannung (in mV) zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den DC Brick, eingespeist.

Sobald eine externe Eingangsspannung und die Spannungsversorgung des Stapels anliegt, wird der Motor über die externe Spannung versorgt. Sollte nur die Spannungsversorgung des Stapels verfügbar sein, erfolgt die Versorgung des Motors über diese.

Warnung

Das bedeutet, bei einer hohen Versorgungsspannung des Stapels und einer geringen externen Versorgungsspannung erfolgt die Spannungsversorgung des Motors über die geringere externe Versorgungsspannung. Wenn dann die externe Spannungsversorgung getrennt wird, erfolgt sofort die Versorgung des Motors über die höhere Versorgungsspannung des Stapels.

BrickDC@GetCurrentConsumption[] → voltage
Rückgabe:
  • voltage -- Integer

Gibt die Stromaufnahme des Motors zurück (in mA).

BrickDC@SetDriveMode[mode] → Null
Parameter:
  • mode -- Integer

Setzt den Fahrmodus. Verfügbare Modi sind:

  • 0 = Fahren/Bremsen
  • 1 = Fahren/Leerlauf

Diese Modi sind verschiedene Arten der Motoransteuerung.

Im Fahren/Bremsen Modus wird der Motor entweder gefahren oder gebremst. Es gibt keinen Leerlauf. Vorteile sind die lineare Korrelation zwischen PWM und Geschwindigkeit, präzisere Beschleunigungen und die Möglichkeit mit geringeren Geschwindigkeiten zu fahren.

Im Fahren/Leerlauf Modus wir der Motor entweder gefahren oder befindet sich im Leerlauf. Vorteile sind die geringere Stromaufnahme und geringere Belastung des Motors und der Treiberstufe.

Der Standardwert ist 0 = Fahren/Bremsen.

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

  • BrickDC`DRIVEUMODEUDRIVEUBRAKE = 0
  • BrickDC`DRIVEUMODEUDRIVEUCOAST = 1
BrickDC@GetDriveMode[] → mode
Rückgabe:
  • mode -- Integer

Gibt den Fahrmodus zurück, wie von SetDriveMode[] gesetzt.

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

  • BrickDC`DRIVEUMODEUDRIVEUBRAKE = 0
  • BrickDC`DRIVEUMODEUDRIVEUCOAST = 1
BrickDC@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Rückgabe:
  • apiVersioni -- Integer

Gibt die Version der API Definition (Major, Minor, Revision) 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.

BrickDC@GetResponseExpected[functionId] → responseExpected
Parameter:
  • functionId -- Integer
Rückgabe:
  • responseExpected -- 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:

  • BrickDC`FUNCTIONUSETUVELOCITY = 1
  • BrickDC`FUNCTIONUSETUACCELERATION = 4
  • BrickDC`FUNCTIONUSETUPWMUFREQUENCY = 6
  • BrickDC`FUNCTIONUFULLUBRAKE = 8
  • BrickDC`FUNCTIONUENABLE = 12
  • BrickDC`FUNCTIONUDISABLE = 13
  • BrickDC`FUNCTIONUSETUMINIMUMUVOLTAGE = 15
  • BrickDC`FUNCTIONUSETUDRIVEUMODE = 17
  • BrickDC`FUNCTIONUSETUCURRENTUVELOCITYUPERIOD = 19
  • BrickDC`FUNCTIONUSETUSPITFPUBAUDRATEUCONFIG = 231
  • BrickDC`FUNCTIONUSETUSPITFPUBAUDRATE = 234
  • BrickDC`FUNCTIONUENABLEUSTATUSULED = 238
  • BrickDC`FUNCTIONUDISABLEUSTATUSULED = 239
  • BrickDC`FUNCTIONURESET = 243
BrickDC@SetResponseExpected[functionId, responseExpected] → Null
Parameter:
  • functionId -- Integer
  • responseExpected -- 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:

  • BrickDC`FUNCTIONUSETUVELOCITY = 1
  • BrickDC`FUNCTIONUSETUACCELERATION = 4
  • BrickDC`FUNCTIONUSETUPWMUFREQUENCY = 6
  • BrickDC`FUNCTIONUFULLUBRAKE = 8
  • BrickDC`FUNCTIONUENABLE = 12
  • BrickDC`FUNCTIONUDISABLE = 13
  • BrickDC`FUNCTIONUSETUMINIMUMUVOLTAGE = 15
  • BrickDC`FUNCTIONUSETUDRIVEUMODE = 17
  • BrickDC`FUNCTIONUSETUCURRENTUVELOCITYUPERIOD = 19
  • BrickDC`FUNCTIONUSETUSPITFPUBAUDRATEUCONFIG = 231
  • BrickDC`FUNCTIONUSETUSPITFPUBAUDRATE = 234
  • BrickDC`FUNCTIONUENABLEUSTATUSULED = 238
  • BrickDC`FUNCTIONUDISABLEUSTATUSULED = 239
  • BrickDC`FUNCTIONURESET = 243
BrickDC@SetResponseExpectedAll[responseExpected] → Null
Parameter:
  • responseExpected -- True/False

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

BrickDC@SetSPITFPBaudrateConfig[enableDynamicBaudrate, minimumDynamicBaudrate] → Null
Parameter:
  • enableDynamicBaudrate -- True/False
  • minimumDynamicBaudrate -- Integer

Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht der Brick die Baudrate anhand des Datenaufkommens zwischen Brick und Bricklet anzupassen.

Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.

Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.

In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.

Die maximale Baudrate kann pro Port mit der Funktion SetSPITFPBaudrate[]. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von SetSPITFPBaudrate[] gesetzt statisch verwendet.

Die minimale dynamische Baudrate hat einen Wertebereich von 400000 bis 2000000 Baud.

Standardmäßig ist die dynamische Baudrate aktiviert und die minimale dynamische Baudrate ist 400000.

Neu in Version 2.3.5 (Firmware).

BrickDC@GetSPITFPBaudrateConfig[out enableDynamicBaudrate, out minimumDynamicBaudrate] → Null
Parameter:
  • enableDynamicBaudrate -- True/False
  • minimumDynamicBaudrate -- Integer

Gibt die Baudratenkonfiguration zurück, siehe SetSPITFPBaudrateConfig[].

Neu in Version 2.3.5 (Firmware).

BrickDC@GetSendTimeoutCount[communicationMethod] → timeoutCount
Parameter:
  • communicationMethod -- Integer
Rückgabe:
  • timeoutCount -- Integer

Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück

Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.

Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.

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

  • BrickDC`COMMUNICATIONUMETHODUNONE = 0
  • BrickDC`COMMUNICATIONUMETHODUUSB = 1
  • BrickDC`COMMUNICATIONUMETHODUSPIUSTACK = 2
  • BrickDC`COMMUNICATIONUMETHODUCHIBI = 3
  • BrickDC`COMMUNICATIONUMETHODURS485 = 4
  • BrickDC`COMMUNICATIONUMETHODUWIFI = 5
  • BrickDC`COMMUNICATIONUMETHODUETHERNET = 6
  • BrickDC`COMMUNICATIONUMETHODUWIFIUV2 = 7

Neu in Version 2.3.3 (Firmware).

BrickDC@SetSPITFPBaudrate[brickletPort, baudrate] → Null
Parameter:
  • brickletPort -- Integer
  • baudrate -- Integer

Setzt die Baudrate eines spezifischen Bricklet Ports ('a' - 'd'). Die Baudrate hat einen möglichen Wertebereich von 400000 bis 2000000.

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe GetSPITFPErrorCount[]) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe SetSPITFPBaudrateConfig[]).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

Die Standardbaudrate für alle Ports ist 1400000.

Neu in Version 2.3.3 (Firmware).

BrickDC@GetSPITFPBaudrate[brickletPort] → baudrate
Parameter:
  • brickletPort -- Integer
Rückgabe:
  • baudrate -- Integer

Gibt die Baudrate für einen Bricklet Port zurück, siehe SetSPITFPBaudrate[].

Neu in Version 2.3.3 (Firmware).

BrickDC@GetSPITFPErrorCount[brickletPort, out errorCountACKChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Parameter:
  • brickletPort -- Integer
  • errorCountACKChecksum -- Integer
  • errorCountMessageChecksum -- Integer
  • errorCountFrame -- Integer
  • errorCountOverflow -- Integer

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.3.3 (Firmware).

BrickDC@EnableStatusLED[] → Null

Aktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

BrickDC@DisableStatusLED[] → Null

Deaktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

BrickDC@IsStatusLEDEnabled[] → enabled
Rückgabe:
  • enabled -- True/False

Gibt true zurück wenn die Status LED aktiviert ist, false sonst.

Neu in Version 2.3.1 (Firmware).

BrickDC@GetProtocol1BrickletName[port, out protocolVersion, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out name] → Null
Parameter:
  • port -- Integer
  • protocolVersion -- Integer
  • firmwareVersioni -- Integer
  • name -- String

Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.

Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.

BrickDC@GetChipTemperature[] → temperature
Rückgabe:
  • temperature -- Integer

Gibt die Temperatur in °C/10, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickDC@Reset[] → Null

Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.

Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.

BrickDC@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Parameter:
  • uid -- String
  • connectedUid -- String
  • position -- Integer
  • hardwareVersioni -- Integer
  • firmwareVersioni -- Integer
  • deviceIdentifier -- Integer

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

Die Position kann '0'-'8' (Stack Position) sein.

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

Konfigurationsfunktionen für Callbacks

BrickDC@SetMinimumVoltage[voltage] → Null
Parameter:
  • voltage -- Integer

Setzt die minimale Spannung in mV, bei welcher der UnderVoltageCallback Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der DC Brick noch funktioniert, ist 6V. Mit dieser Funktion kann eine Entladung der versorgenden Batterie detektiert werden. Beim Einsatz einer Netzstromversorgung wird diese Funktionalität höchstwahrscheinlich nicht benötigt.

Der Standardwert ist 6V.

BrickDC@GetMinimumVoltage[] → voltage
Rückgabe:
  • voltage -- Integer

Gibt die minimale Spannung zurück, wie von SetMinimumVoltage[] gesetzt.

BrickDC@SetCurrentVelocityPeriod[period] → Null
Parameter:
  • period -- Integer

Setzt die Periode in ms mit welcher der CurrentVelocityCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der Standardwert ist 0.

BrickDC@GetCurrentVelocityPeriod[] → period
Rückgabe:
  • period -- Integer

Gibt die Periode zurück, wie von SetCurrentVelocityPeriod[] gesetzt.

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[dc@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 BrickDC@UnderVoltageCallback[sender, voltage]
Parameter:
  • sender -- NETObject[BrickDC]
  • voltage -- Integer

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels SetMinimumVoltage[] gesetzten, Schwellwert sinkt. Der Parameter ist die aktuelle Spannung in mV.

event BrickDC@EmergencyShutdownCallback[sender]
Parameter:
  • sender -- NETObject[BrickDC]

Dieser Callback wird ausgelöst, wenn entweder der Stromverbrauch (über 5A) oder die Temperatur der Treiberstufe zu hoch ist (über 175°C). Beide Möglichkeiten sind letztendlich gleichbedeutend, da die Temperatur ihren Schwellwert überschreitet sobald der Motor zu viel Strom verbraucht. Im Falle einer Spannung unter 3,3V (Stapel- oder externe Spannungsversorgung) wird dieser Callback auch ausgelöst.

Sobald dieser Callback ausgelöst wird, wird die Treiberstufe deaktiviert. Das bedeutet Enable[] muss aufgerufen werden, um den Motor erneut zu fahren.

Bemerkung

Dieser Callback funktioniert nur im Fahren/Bremsen Modus (siehe SetDriveMode[]). Im Fahren/Leerlauf Modus ist es leider nicht möglich das Überstrom/Übertemperatur-Signal zuverlässig aus dem Chip der Treiberstufe auszulesen.

event BrickDC@VelocityReachedCallback[sender, velocity]
Parameter:
  • sender -- NETObject[BrickDC]
  • velocity -- Integer

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Geschwindigkeit erreicht wird. Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist, die Beschleunigung auf 5000 und die Geschwindigkeit auf 10000 konfiguriert ist, wird der VelocityReachedCallback Callback nach ungefähr 2 Sekunden ausgelöst, wenn die konfigurierte Geschwindigkeit letztendlich erreicht ist.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Gleichstrommotor zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe SetAcceleration[]) kleiner oder gleich der maximalen Beschleunigung des Motors ist. Andernfalls wird der Motor hinter dem Vorgabewert zurückbleiben und der Callback wird zu früh ausgelöst.

event BrickDC@CurrentVelocityCallback[sender, velocity]
Parameter:
  • sender -- NETObject[BrickDC]
  • velocity -- Integer

Dieser Callback wird mit der Periode, wie gesetzt mit SetCurrentVelocityPeriod[], ausgelöst. Der Parameter ist die aktuelle vom Motor genutzte Geschwindigkeit.

Der CurrentVelocityCallback Callback wird nur nach Ablauf der Periode ausgelöst, wenn sich die Geschwindigkeit geändert hat.

Konstanten

BrickDC`DEVICEUIDENTIFIER

Diese Konstante wird verwendet um einen DC Brick 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.

BrickDC`DEVICEDISPLAYNAME

Diese Konstante stellt den Anzeigenamen eines DC Brick dar.