Dies ist die Beschreibung der Python 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 Python API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example_configuration.py)
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 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Performance DC Bricklet
import time
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_performance_dc import BrickletPerformanceDC
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
pdc = BrickletPerformanceDC(UID, ipcon) # Create device object
ipcon.connect(HOST, PORT) # Connect to brickd
# Don't use device before ipcon is connected
pdc.set_drive_mode(pdc.DRIVE_MODE_DRIVE_COAST)
pdc.set_pwm_frequency(10000) # Use PWM frequency of 10 kHz
pdc.set_motion(4096, 4096) # Slow ac-/deceleration (12.5 %/s)
pdc.set_velocity(32767) # Full speed forward (100 %)
pdc.set_enabled(True) # Enable motor power
input("Press key to exit\n") # Use raw_input() in Python 2
# Stop motor before disabling motor power
pdc.set_motion(4096, 16384) # Fast decceleration (50 %/s) for stopping
pdc.set_velocity(0) # Request motor stop
time.sleep(2) # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
pdc.set_enabled(False) # Disable motor power
ipcon.disconnect()
|
Download (example_callback.py)
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 | #!/usr/bin/env python
# -*- coding: utf-8 -*-
HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Performance DC Bricklet
import time
from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_performance_dc import BrickletPerformanceDC
# Use velocity reached callback to swing back and forth
# between full speed forward and full speed backward
def cb_velocity_reached(velocity, pdc):
if velocity == 32767:
print('Velocity: Full speed forward, now turning backward')
pdc.set_velocity(-32767)
elif velocity == -32767:
print('Velocity: Full speed backward, now turning forward')
pdc.set_velocity(32767)
else:
print('Error') # Can only happen if another program sets velocity
if __name__ == "__main__":
ipcon = IPConnection() # Create IP connection
pdc = 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 cb_velocity_reached
pdc.register_callback(pdc.CALLBACK_VELOCITY_REACHED,
lambda x: cb_velocity_reached(x, pdc))
# Enable velocity reached callback
pdc.set_velocity_reached_callback_configuration(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.set_motion(4096, 4096) # Slow acceleration (12.5 %/s)
pdc.set_velocity(32767) # Full speed forward (100 %)
# Enable motor power
pdc.set_enabled(True)
input("Press key to exit\n") # Use raw_input() in Python 2
# Stop motor before disabling motor power
pdc.set_motion(4096, 16384) # Fast decceleration (50 %/s) for stopping
pdc.set_velocity(0) # Request motor stop
time.sleep(2) # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
pdc.set_enabled(False) # Disable motor power
ipcon.disconnect()
|
Prinzipiell kann jede Funktion der Python Bindings
tinkerforge.ip_connection.Error
Exception werfen, welche ein value
und
eine description
Property hat. value
kann verschiende Werte haben:
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
BrickletPerformanceDC
(uid, ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
performance_dc = BrickletPerformanceDC("YOUR_DEVICE_UID", ipcon)
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletPerformanceDC.
set_enabled
(enabled)¶Parameter: |
|
---|---|
Rückgabe: |
|
Aktiviert/Deaktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (Geschwindigkeit, Beschleunigung, etc.).
BrickletPerformanceDC.
get_enabled
()¶Rückgabe: |
|
---|
Gibt true zurück wenn die Treiberstufe aktiv ist, sonst false.
BrickletPerformanceDC.
set_velocity
(velocity)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 set_motion()
)
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 set_pwm_frequency()
.
BrickletPerformanceDC.
get_velocity
()¶Rückgabe: |
|
---|
Gibt die Geschwindigkeit zurück, wie gesetzt von set_velocity()
.
BrickletPerformanceDC.
get_current_velocity
()¶Rückgabe: |
|
---|
Gibt die aktuelle Geschwindigkeit des Motors zurück. Dieser Wert
unterscheidet sich von get_velocity()
, sobald der Motor auf einen
neuen Zielwert, wie von set_velocity()
vorgegeben, beschleunigt.
BrickletPerformanceDC.
set_motion
(acceleration, deceleration)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
get_motion
()¶Rückgabeobjekt: |
|
---|
Gibt die Beschleunigung/Debeschleunigung zurück, wie gesetzt von set_motion()
.
BrickletPerformanceDC.
full_brake
()¶Rückgabe: |
|
---|
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 set_velocity()
mit 0 erlaubt einen normalen Stopp des Motors.
BrickletPerformanceDC.
get_pwm_frequency
()¶Rückgabe: |
|
---|
Gibt die PWM Frequenz zurück, wie gesetzt von set_pwm_frequency()
.
BrickletPerformanceDC.
get_power_statistics
()¶Rückgabeobjekt: |
|
---|
Gibt die Eingangsspannung, den Stromverbrauch und die Temperatur des Treibers zurück.
BrickletPerformanceDC.
set_thermal_shutdown
(temperature)¶Parameter: |
|
---|---|
Rückgabe: |
|
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 set_enabled()
wieder aktiviert werden.
BrickletPerformanceDC.
get_thermal_shutdown
()¶Rückgabe: |
|
---|
Gibt die thermale Abschalttemperatur zurück, wie von set_thermal_shutdown()
gesetzt.
BrickletPerformanceDC.
set_gpio_configuration
(channel, debounce, stop_deceleration)¶Parameter: |
|
---|---|
Rückgabe: |
|
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
set_gpio_action()
.
BrickletPerformanceDC.
get_gpio_configuration
(channel)¶Parameter: |
|
---|---|
Rückgabeobjekt: |
|
Gibt die GPIO-Konfiguration für einen Kanal zurück, wie von set_gpio_configuration()
gesetzt.
BrickletPerformanceDC.
set_gpio_action
(channel, action)¶Parameter: |
|
---|---|
Rückgabe: |
|
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
set_gpio_configuration()
konfiguriert werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für action:
BrickletPerformanceDC.
get_gpio_action
(channel)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die GPIO-Action für einen Kanal zurück, wie von set_gpio_action()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für action:
BrickletPerformanceDC.
get_gpio_state
()¶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.
set_drive_mode
(mode)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
get_drive_mode
()¶Rückgabe: |
|
---|
Gibt den Fahrmodus zurück, wie von set_drive_mode()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletPerformanceDC.
set_pwm_frequency
(frequency)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
set_error_led_config
(config)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
get_error_led_config
()¶Rückgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von set_error_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
set_cw_led_config
(config)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
get_cw_led_config
()¶Rückgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von set_cw_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
set_ccw_led_config
(config)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
get_ccw_led_config
()¶Rückgabe: |
|
---|
Gibt die LED-Konfiguration zurück, wie von set_ccw_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
set_gpio_led_config
(channel, config)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
get_gpio_led_config
(channel)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt die LED-Konfiguration zurück, wie von set_gpio_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
get_spitfp_error_count
()¶Rückgabeobjekt: |
|
---|
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.
set_status_led_config
(config)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
get_status_led_config
()¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set_status_led_config()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
BrickletPerformanceDC.
get_chip_temperature
()¶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
()¶Rückgabe: |
|
---|
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.
get_identity
()¶Rückgabeobjekt: |
|
---|
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.
register_callback
(callback_id, function)¶Parameter: |
|
---|---|
Rückgabe: |
|
Registriert die function
für die gegebene callback_id
.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
BrickletPerformanceDC.
set_emergency_shutdown_callback_configuration
(enabled)¶Parameter: |
|
---|---|
Rückgabe: |
|
Aktiviert/Deaktiviert CALLBACK_EMERGENCY_SHUTDOWN
Callback.
BrickletPerformanceDC.
get_emergency_shutdown_callback_configuration
()¶Rückgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
set_emergency_shutdown_callback_configuration()
gesetzt.
BrickletPerformanceDC.
set_velocity_reached_callback_configuration
(enabled)¶Parameter: |
|
---|---|
Rückgabe: |
|
Aktiviert/Deaktiviert CALLBACK_VELOCITY_REACHED
Callback.
BrickletPerformanceDC.
get_velocity_reached_callback_configuration
()¶Rückgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
set_velocity_reached_callback_configuration()
gesetzt.
BrickletPerformanceDC.
set_current_velocity_callback_configuration
(period, value_has_to_change)¶Parameter: |
|
---|---|
Rückgabe: |
|
Die Periode ist die Periode mit der der CALLBACK_CURRENT_VELOCITY
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.
get_current_velocity_callback_configuration
()¶Rückgabeobjekt: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels
set_current_velocity_callback_configuration()
gesetzt.
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der Funktion register_callback()
des
Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID
und der zweite Parameter die Callback-Funktion:
def my_callback(param):
print(param)
performance_dc.register_callback(BrickletPerformanceDC.CALLBACK_EXAMPLE, my_callback)
Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.
CALLBACK_EMERGENCY_SHUTDOWN
¶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 set_thermal_shutdown()
).
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 set_enabled()
muss aufgerufen werden, um den Motor
erneut zu fahren.
BrickletPerformanceDC.
CALLBACK_VELOCITY_REACHED
¶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 CALLBACK_VELOCITY_REACHED
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
set_motion()
) 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.
CALLBACK_CURRENT_VELOCITY
¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
set_current_velocity_callback_configuration()
, ausgelöst. Der Parameter ist die
aktuelle vom Motor genutzte Geschwindigkeit.
Der CALLBACK_CURRENT_VELOCITY
Callback wird nur nach Ablauf der Periode
ausgelöst, wenn sich die Geschwindigkeit geändert hat.
BrickletPerformanceDC.
CALLBACK_GPIO_STATE
¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst durch GPIO-Änderungen wenn er über set_gpio_action()
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.
get_api_version
()¶Rückgabeobjekt: |
|
---|
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.
get_response_expected
(function_id)¶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 set_response_expected()
. 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 function_id:
BrickletPerformanceDC.
set_response_expected
(function_id, response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ä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 function_id:
BrickletPerformanceDC.
set_response_expected_all
(response_expected)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ä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.
set_bootloader_mode
(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.
get_bootloader_mode
()¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
BrickletPerformanceDC.
set_write_firmware_pointer
(pointer)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Firmware-Pointer für write_firmware()
. 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.
write_firmware
(data)¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
set_write_firmware_pointer()
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.
write_uid
(uid)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
read_uid
()¶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 get_identity()
Funktion und der
IPConnection.CALLBACK_ENUMERATE
Callback der IP Connection haben ein device_identifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
BrickletPerformanceDC.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Performance DC Bricklet dar.