Dies ist die Beschreibung der C# API Bindings für das Performance DC Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Performance DC Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die C# API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (ExampleConfiguration.cs)
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 | using System;
using System.Threading;
using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "XYZ"; // Change XYZ to the UID of your Performance DC Bricklet
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletPerformanceDC pdc = new BrickletPerformanceDC(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
pdc.SetDriveMode(BrickletPerformanceDC.DRIVE_MODE_DRIVE_COAST);
pdc.SetPWMFrequency(10000); // Use PWM frequency of 10 kHz
pdc.SetMotion(4096, 4096); // Slow ac-/deceleration (12.5 %/s)
pdc.SetVelocity(32767); // Full speed forward (100 %)
pdc.SetEnabled(true); // Enable motor power
Console.WriteLine("Press enter to exit");
Console.ReadLine();
// Stop motor before disabling motor power
pdc.SetMotion(4096, 16384); // Fast decceleration (50 %/s) for stopping
pdc.SetVelocity(0); // Request motor stop
Thread.Sleep(2000); // Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
pdc.SetEnabled(false); // Disable motor power
ipcon.Disconnect();
}
}
|
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 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 | using System;
using System.Threading;
using Tinkerforge;
class Example
{
private static string HOST = "localhost";
private static int PORT = 4223;
private static string UID = "XYZ"; // Change XYZ to the UID of your Performance DC Bricklet
// Use velocity reached callback to swing back and forth
// between full speed forward and full speed backward
static void VelocityReachedCB(BrickletPerformanceDC sender, short velocity)
{
if(velocity == 32767)
{
Console.WriteLine("Velocity: Full speed forward, now turning backward");
sender.SetVelocity(-32767);
}
else if(velocity == -32767)
{
Console.WriteLine("Velocity: Full speed backward, now turning forward");
sender.SetVelocity(32767);
}
else
{
// Can only happen if another program sets velocity
Console.WriteLine("Error");
}
}
static void Main()
{
IPConnection ipcon = new IPConnection(); // Create IP connection
BrickletPerformanceDC pdc = new BrickletPerformanceDC(UID, ipcon); // Create device object
ipcon.Connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Register velocity reached callback to function VelocityReachedCB
pdc.VelocityReachedCallback += VelocityReachedCB;
// Enable velocity reached callback
pdc.SetVelocityReachedCallbackConfiguration(true);
// 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
pdc.SetMotion(4096, 4096); // Slow acceleration (12.5 %/s)
pdc.SetVelocity(32767); // Full speed forward (100 %)
// Enable motor power
pdc.SetEnabled(true);
Console.WriteLine("Press enter to exit");
Console.ReadLine();
// Stop motor before disabling motor power
pdc.SetMotion(4096, 16384); // Fast decceleration (50 %/s) for stopping
pdc.SetVelocity(0); // Request motor stop
Thread.Sleep(2000); // Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
pdc.SetEnabled(false); // Disable motor power
ipcon.Disconnect();
}
}
|
Prinzipiell kann jede Funktion der C# 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 C# nicht mehrere Rückgabewerte direkt unterstützt, wird das out
Schlüsselwort
genutzt, um mehrere Werte aus einer Funktion zurückzugeben.
Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist
Tinkerforge.*
.
Alle folgend aufgelisteten Methoden sind Thread-sicher.
BrickletPerformanceDC
(string uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletPerformanceDC performanceDC = new BrickletPerformanceDC("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletPerformanceDC.
SetEnabled
(bool enabled)¶Parameter: |
|
---|
Aktiviert/Deaktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (Geschwindigkeit, Beschleunigung, etc.).
BrickletPerformanceDC.
GetEnabled
()¶Rückgabe: |
|
---|
Gibt true zurück wenn die Treiberstufe aktiv ist, sonst false.
BrickletPerformanceDC.
SetVelocity
(short velocity)¶Parameter: |
|
---|
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 SetMotion()
)
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()
.
BrickletPerformanceDC.
GetVelocity
()¶Rückgabe: |
|
---|
Gibt die Geschwindigkeit zurück, wie gesetzt von SetVelocity()
.
BrickletPerformanceDC.
GetCurrentVelocity
()¶Rückgabe: |
|
---|
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.
BrickletPerformanceDC.
SetMotion
(int acceleration, int deceleration)¶Parameter: |
|
---|
Setzt die Beschleunigung/Debeschleunigung 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/Debeschleunigung von 0 bedeutet ein direkter Sprung des Motors auf die Zielgeschwindigkeit. Es Wird keine Rampe gefahren.
BrickletPerformanceDC.
GetMotion
(out int acceleration, out int deceleration)¶Ausgabeparameter: |
|
---|
Gibt die Beschleunigung/Debeschleunigung zurück, wie gesetzt von SetMotion()
.
BrickletPerformanceDC.
FullBrake
()¶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.
BrickletPerformanceDC.
GetPWMFrequency
()¶Rückgabe: |
|
---|
Gibt die PWM Frequenz zurück, wie gesetzt von SetPWMFrequency()
.
BrickletPerformanceDC.
GetPowerStatistics
(out int voltage, out int current, out short temperature)¶Ausgabeparameter: |
|
---|
Gibt die Eingangsspannung, den Stromverbrauch und die Temperatur des Treibers zurück.
BrickletPerformanceDC.
SetThermalShutdown
(byte temperature)¶Parameter: |
|
---|
Setzt den Temperatur-Grenzwert für eine thermale Abschaltung.
Neben diesem nutzerdefinierten Grenzwert schaltet er Treiber selbst ab einer Temperatur von 150° ab.
Wenn es zu einer thermalen Abschaltung kommt wird der Treiber deaktiviert und er
muss explizit per SetEnabled()
wieder aktiviert werden.
BrickletPerformanceDC.
GetThermalShutdown
()¶Rückgabe: |
|
---|
Gibt die thermale Abschalttemperatur zurück, wie von SetThermalShutdown()
gesetzt.
BrickletPerformanceDC.
SetGPIOConfiguration
(byte channel, int debounce, int stopDeceleration)¶Parameter: |
|
---|
Setzt die GPIO-Konfiguration für einen Kanal.
Es kann ein Debounce und eine Debeschleunigung gesetzt werden. Letzteres wird
genutzt wenn die Action auf normal stop
konfiguriert ist. Siehe
SetGPIOAction()
.
BrickletPerformanceDC.
GetGPIOConfiguration
(byte channel, out int debounce, out int stopDeceleration)¶Parameter: |
|
---|---|
Ausgabeparameter: |
|
Gibt die GPIO-Konfiguration für einen Kanal zurück, wie von SetGPIOConfiguration()
gesetzt.
BrickletPerformanceDC.
SetGPIOAction
(byte channel, long action)¶Parameter: |
|
---|
Setzt die GPIO-Action für einen Kanal.
Die Action kann ein normal stop
, ein full brake
oder ein callback
sein. Jeweils für eine steigende oder fallende Flanke.
Die Actions sind eine Bitmaske und sie können simultan verwendet werden.
Es ist zum Beispiel möglich einen full brake
und callback
gleichzeitig
zu triggern oder eine auf eine steigende und fallende Flanke gleichzeitig.
Die Debeschleunigung für den normal stop
kann über
SetGPIOConfiguration()
konfiguriert werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für action:
BrickletPerformanceDC.
GetGPIOAction
(byte channel)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die GPIO-Action für einen Kanal zurück, wie von SetGPIOAction()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für action:
BrickletPerformanceDC.
GetGPIOState
()¶Rückgabe: |
|
---|
Gibt den GPIO-Zustand für beide Kanäle zurück. True wenn der der Zustand
high
ist und false wenn der Zustand low
ist.
BrickletPerformanceDC.
SetDriveMode
(byte mode)¶Parameter: |
|
---|
Setzt den Fahrmodus. Verfügbare Modi sind:
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.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletPerformanceDC.
GetDriveMode
()¶Rückgabe: |
|
---|
Gibt den Fahrmodus zurück, wie von SetDriveMode()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletPerformanceDC.
SetPWMFrequency
(int frequency)¶Parameter: |
|
---|
Setzt die Frequenz der PWM, welche den Motor steuert. 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.
BrickletPerformanceDC.
SetErrorLEDConfig
(byte config)¶Parameter: |
|
---|
Konfiguriert die Touch-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option den Fehler-Status anzuzeigen.
Wenn die LED konfiguriert ist um Fehler anzuzeigen gibt es drei unterschiedliche Zustände:
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
GetErrorLEDConfig
()¶Rückgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von SetErrorLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
SetCWLEDConfig
(byte config)¶Parameter: |
|
---|
Konfiguriert die CW-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option anzuzeigen ob der Motor im Uhrzeigersinn dreht.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
GetCWLEDConfig
()¶Rückgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von SetCWLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
SetCCWLEDConfig
(byte config)¶Parameter: |
|
---|
Konfiguriert die CCW-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option anzuzeigen ob der Motor gegen den Uhrzeigersinn dreht.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
GetCCWLEDConfig
()¶Rückgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von SetCCWLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
SetGPIOLEDConfig
(byte channel, byte config)¶Parameter: |
|
---|
Konfiguriert die GPIO-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option den GPIO-Zustand anzuzeigen.
Die GPIO-LED kann für beide Kanäle konfiguriert werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
GetGPIOLEDConfig
(byte channel)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die LED-Konfiguration zurück, wie von SetGPIOLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
GetSPITFPErrorCount
(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)¶Ausgabeparameter: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
BrickletPerformanceDC.
SetStatusLEDConfig
(byte config)¶Parameter: |
|
---|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
GetStatusLEDConfig
()¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetStatusLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
GetChipTemperature
()¶Rückgabe: |
|
---|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
BrickletPerformanceDC.
Reset
()¶Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
BrickletPerformanceDC.
GetIdentity
(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)¶Ausgabeparameter: |
|
---|
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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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.
BrickletPerformanceDC.
SetEmergencyShutdownCallbackConfiguration
(bool enabled)¶Parameter: |
|
---|
Aktiviert/Deaktiviert EmergencyShutdownCallback
Callback.
BrickletPerformanceDC.
GetEmergencyShutdownCallbackConfiguration
()¶Rückgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
SetEmergencyShutdownCallbackConfiguration()
gesetzt.
BrickletPerformanceDC.
SetVelocityReachedCallbackConfiguration
(bool enabled)¶Parameter: |
|
---|
Aktiviert/Deaktiviert VelocityReachedCallback
Callback.
BrickletPerformanceDC.
GetVelocityReachedCallbackConfiguration
()¶Rückgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
SetVelocityReachedCallbackConfiguration()
gesetzt.
BrickletPerformanceDC.
SetCurrentVelocityCallbackConfiguration
(long period, bool valueHasToChange)¶Parameter: |
|
---|
Die Periode ist die Periode mit der der CurrentVelocityCallback
Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
BrickletPerformanceDC.
GetCurrentVelocityCallbackConfiguration
(out long period, out bool valueHasToChange)¶Ausgabeparameter: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
SetCurrentVelocityCallbackConfiguration()
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:
void MyCallback(BrickletPerformanceDC sender, int value)
{
System.Console.WriteLine("Value: " + value);
}
performanceDC.ExampleCallback += MyCallback;
Die verfügbaren Events 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.
BrickletPerformanceDC.
EmergencyShutdownCallback
(BrickletPerformanceDC sender)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn entweder der Stromverbrauch
oder die Temperatur der Treiberstufe zu hoch ist (über 150°C) oder die
nutzerdefinierte Abschaltungstemperatur überstiegen wird (siehe SetThermalShutdown()
).
Im Falle einer Spannung unter 6V (Eingangsspannung) wird dieser Callback auch ausgelöst.
Sobald dieser Callback ausgelöst wird, wird die Treiberstufe deaktiviert.
Das bedeutet SetEnabled()
muss aufgerufen werden, um den Motor
erneut zu fahren.
BrickletPerformanceDC.
VelocityReachedCallback
(BrickletPerformanceDC sender, short velocity)¶Callback-Parameter: |
|
---|
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
SetMotion()
) 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.
BrickletPerformanceDC.
CurrentVelocityCallback
(BrickletPerformanceDC sender, short velocity)¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetCurrentVelocityCallbackConfiguration()
, 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.
BrickletPerformanceDC.
GPIOStateCallback
(BrickletPerformanceDC sender, bool[] gpioState)¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst durch GPIO-Änderungen wenn er über SetGPIOAction()
aktiviert wurde.
Neu in Version 2.0.1 (Plugin).
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.
BrickletPerformanceDC.
GetAPIVersion
()¶Ausgabeparameter: |
|
---|
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.
BrickletPerformanceDC.
GetResponseExpected
(byte functionId)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
BrickletPerformanceDC.
SetResponseExpected
(byte functionId, bool responseExpected)¶Parameter: |
|
---|
Ä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:
BrickletPerformanceDC.
SetResponseExpectedAll
(bool responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
BrickletPerformanceDC.
SetBootloaderMode
(byte mode)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Für status:
BrickletPerformanceDC.
GetBootloaderMode
()¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletPerformanceDC.
SetWriteFirmwarePointer
(long pointer)¶Parameter: |
|
---|
Setzt den Firmware-Pointer für WriteFirmware()
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletPerformanceDC.
WriteFirmware
(byte[] data)¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
SetWriteFirmwarePointer()
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletPerformanceDC.
WriteUID
(long uid)¶Parameter: |
|
---|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
BrickletPerformanceDC.
ReadUID
()¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
BrickletPerformanceDC.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Performance DC 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.
BrickletPerformanceDC.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Performance DC Bricklet dar.