MQTT - Performance DC Bricklet¶

Configuration¶

Download (example-configuration.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# Change XYZ to the UID of your Performance DC Bricklet

setup:
    publish '{"mode": "drive_coast"}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_drive_mode

    publish '{"frequency": 10000}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_pwm_frequency # Use PWM frequency of 10 kHz

    publish '{"acceleration": 4096, "deceleration": 4096}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_motion # Slow ac-/deceleration (12.5 %/s)

    publish '{"velocity": 32767}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_velocity # Full speed forward (100 %)

    publish '{"enabled": true}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_enabled # Enable motor power

cleanup:
    # If you are done, run this to clean up
    # Stop motor before disabling motor power
    publish '{"acceleration": 4096, "deceleration": 16384}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_motion # Fast decceleration (50 %/s) for stopping

    publish '{"velocity": 0}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_velocity # Request motor stop

    wait for 2s # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s

    publish '{"enabled": false}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_enabled # Disable motor power

Callback¶

Download (example-callback.txt)

 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

# Change XYZ to the UID of your Performance DC Bricklet

setup:
    # Use velocity reached callback to swing back and forth
    # between full speed forward and full speed backward
    subscribe to tinkerforge/callback/performance_dc_bricklet/XYZ/velocity_reached
        if a message arrives
            # message contains velocity as int
            if velocity == 32767
                print "Velocity: Full speed forward, now turning backward"
                publish '{"velocity": -32767}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_velocity
            elseif velocity == -32767
                print "Velocity: Full speed backward, now turning forward"
                publish '{"velocity": 32767}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_velocity
            else
                print "Error"
            endif
        endif
    endsubscribe

    publish '{"register": true}' to tinkerforge/register/performance_dc_bricklet/XYZ/velocity_reached # Register velocity_reached callback

    # Enable velocity reached callback
    publish '{"enabled": true}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_velocity_reached_callback_configuration

    # 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
    publish '{"acceleration": 4096, "deceleration": 4096}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_motion # Slow acceleration (12.5 %/s)

    publish '{"velocity": 32767}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_velocity # Full speed forward (100 %)

    # Enable motor power
    publish '{"enabled": true}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_enabled

cleanup:
    # If you are done, run this to clean up
    # Stop motor before disabling motor power
    publish '{"acceleration": 4096, "deceleration": 16384}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_motion # Fast decceleration (50 %/s) for stopping

    publish '{"velocity": 0}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_velocity # Request motor stop

    wait for 2s # Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s

    publish '{"enabled": false}' to tinkerforge/request/performance_dc_bricklet/XYZ/set_enabled # Disable motor power

Grundfunktionen¶

request/performance_dc_bricklet/<UID>/set_enabled¶

Anfrage:	enabled – Typ: bool
Antwort:	keine Antwort

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

request/performance_dc_bricklet/<UID>/get_enabled¶

Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: false

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

request/performance_dc_bricklet/<UID>/set_velocity¶

Anfrage:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0
Antwort:	keine Antwort

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 request/performance_dc_bricklet/<UID>/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 request/performance_dc_bricklet/<UID>/set_pwm_frequency.

request/performance_dc_bricklet/<UID>/get_velocity¶

Anfrage:	keine Nutzdaten
Antwort:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0

Gibt die Geschwindigkeit zurück, wie gesetzt von request/performance_dc_bricklet/<UID>/set_velocity.

request/performance_dc_bricklet/<UID>/get_current_velocity¶

Anfrage:	keine Nutzdaten
Antwort:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0

Gibt die aktuelle Geschwindigkeit des Motors zurück. Dieser Wert unterscheidet sich von request/performance_dc_bricklet/<UID>/get_velocity, sobald der Motor auf einen neuen Zielwert, wie von request/performance_dc_bricklet/<UID>/set_velocity vorgegeben, beschleunigt.

request/performance_dc_bricklet/<UID>/set_motion¶

Anfrage:	acceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000 deceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Antwort:	keine Antwort

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.

request/performance_dc_bricklet/<UID>/get_motion¶

Anfrage:	keine Nutzdaten
Antwort:	acceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000 deceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000

Gibt die Beschleunigung/Debeschleunigung zurück, wie gesetzt von request/performance_dc_bricklet/<UID>/set_motion.

request/performance_dc_bricklet/<UID>/full_brake¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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 request/performance_dc_bricklet/<UID>/set_velocity mit 0 erlaubt einen normalen Stopp des Motors.

request/performance_dc_bricklet/<UID>/get_pwm_frequency¶

Anfrage:	keine Nutzdaten
Antwort:	frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000

Gibt die PWM Frequenz zurück, wie gesetzt von request/performance_dc_bricklet/<UID>/set_pwm_frequency.

request/performance_dc_bricklet/<UID>/get_power_statistics¶

Anfrage:	keine Nutzdaten
Antwort:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1] temperature – Typ: int, Einheit: 1/10 °, Wertebereich: [-215 bis 215 - 1]

Gibt die Eingangsspannung, den Stromverbrauch und die Temperatur des Treibers zurück.

request/performance_dc_bricklet/<UID>/set_thermal_shutdown¶

Anfrage:	temperature – Typ: int, Einheit: 1 °, Wertebereich: [0 bis 255], Standardwert: 125
Antwort:	keine Antwort

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 request/performance_dc_bricklet/<UID>/set_enabled wieder aktiviert werden.

request/performance_dc_bricklet/<UID>/get_thermal_shutdown¶

Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int, Einheit: 1 °, Wertebereich: [0 bis 255]

Gibt die thermale Abschalttemperatur zurück, wie von request/performance_dc_bricklet/<UID>/set_thermal_shutdown gesetzt.

request/performance_dc_bricklet/<UID>/set_gpio_configuration¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 1] debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 200 stop_deceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1
Antwort:	keine Antwort

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 request/performance_dc_bricklet/<UID>/set_gpio_action.

request/performance_dc_bricklet/<UID>/get_gpio_configuration¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 1]
Antwort:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 200 stop_deceleration – Typ: int, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

Gibt die GPIO-Konfiguration für einen Kanal zurück, wie von request/performance_dc_bricklet/<UID>/set_gpio_configuration gesetzt.

request/performance_dc_bricklet/<UID>/set_gpio_action¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 1] action – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
Antwort:	keine Antwort

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 request/performance_dc_bricklet/<UID>/set_gpio_configuration konfiguriert werden.

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

Für action:

• "none" = 0
• "normal_stop_rising_edge" = 1
• "normal_stop_falling_edge" = 2
• "full_brake_rising_edge" = 4
• "full_brake_falling_edge" = 8
• "callback_rising_edge" = 16
• "callback_falling_edge" = 32

request/performance_dc_bricklet/<UID>/get_gpio_action¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 1]
Antwort:	action – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die GPIO-Action für einen Kanal zurück, wie von request/performance_dc_bricklet/<UID>/set_gpio_action gesetzt.

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

Für action:

• "none" = 0
• "normal_stop_rising_edge" = 1
• "normal_stop_falling_edge" = 2
• "full_brake_rising_edge" = 4
• "full_brake_falling_edge" = 8
• "callback_rising_edge" = 16
• "callback_falling_edge" = 32

request/performance_dc_bricklet/<UID>/get_gpio_state¶

Anfrage:	keine Nutzdaten
Antwort:	gpio_state – Typ: [bool, ...], Länge: 2

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.

Fortgeschrittene Funktionen¶

request/performance_dc_bricklet/<UID>/set_drive_mode¶

Anfrage:	mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
Antwort:	keine Antwort

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.

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

Für mode:

• "drive_brake" = 0
• "drive_coast" = 1

request/performance_dc_bricklet/<UID>/get_drive_mode¶

Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt den Fahrmodus zurück, wie von request/performance_dc_bricklet/<UID>/set_drive_mode gesetzt.

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

Für mode:

• "drive_brake" = 0
• "drive_coast" = 1

request/performance_dc_bricklet/<UID>/set_pwm_frequency¶

Anfrage:	frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000
Antwort:	keine Antwort

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.

request/performance_dc_bricklet/<UID>/set_error_led_config¶

Anfrage:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:	keine Antwort

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:

• Aus: Es liegt kein Fehler vor.
• 1s Intervall-Blinken: Eingangsspannung zu klein (unter 6V).
• 250ms Intervall-Blinken: Übertemperatur oder Überstrom.

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

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_error" = 3

request/performance_dc_bricklet/<UID>/get_error_led_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von request/performance_dc_bricklet/<UID>/set_error_led_config gesetzt.

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

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_error" = 3

request/performance_dc_bricklet/<UID>/set_cw_led_config¶

Anfrage:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_cw_as_forward" = 3
• "show_cw_as_backward" = 4

request/performance_dc_bricklet/<UID>/get_cw_led_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von request/performance_dc_bricklet/<UID>/set_cw_led_config gesetzt.

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

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_cw_as_forward" = 3
• "show_cw_as_backward" = 4

request/performance_dc_bricklet/<UID>/set_ccw_led_config¶

Anfrage:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_ccw_as_forward" = 3
• "show_ccw_as_backward" = 4

request/performance_dc_bricklet/<UID>/get_ccw_led_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von request/performance_dc_bricklet/<UID>/set_ccw_led_config gesetzt.

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

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_ccw_as_forward" = 3
• "show_ccw_as_backward" = 4

request/performance_dc_bricklet/<UID>/set_gpio_led_config¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 1] config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 4
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_gpio_active_high" = 3
• "show_gpio_active_low" = 4

request/performance_dc_bricklet/<UID>/get_gpio_led_config¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 1]
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 4

Gibt die LED-Konfiguration zurück, wie von request/performance_dc_bricklet/<UID>/set_gpio_led_config gesetzt.

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

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_gpio_active_high" = 3
• "show_gpio_active_low" = 4

request/performance_dc_bricklet/<UID>/get_spitfp_error_count¶

Anfrage:	keine Nutzdaten
Antwort:	error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1] error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

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 Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

request/performance_dc_bricklet/<UID>/set_status_led_config¶

Anfrage:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_status" = 3

request/performance_dc_bricklet/<UID>/get_status_led_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/performance_dc_bricklet/<UID>/set_status_led_config gesetzt.

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

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_status" = 3

request/performance_dc_bricklet/<UID>/get_chip_temperature¶

Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

request/performance_dc_bricklet/<UID>/reset¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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.

request/performance_dc_bricklet/<UID>/get_identity¶

Anfrage:

keine Nutzdaten

Antwort:

uid – Typ: string, Länge: bis zu 8 connected_uid – Typ: string, Länge: bis zu 8 position – Typ: char, Wertebereich: ["a" bis "h", "z"] hardware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] firmware_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255] device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1] _display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Performance DC.

Konfigurationsfunktionen für Callbacks¶

request/performance_dc_bricklet/<UID>/set_emergency_shutdown_callback_configuration¶

Anfrage:	enabled – Typ: bool, Standardwert: false
Antwort:	keine Antwort

Aktiviert/Deaktiviert register/performance_dc_bricklet/<UID>/emergency_shutdown Callback.

request/performance_dc_bricklet/<UID>/get_emergency_shutdown_callback_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: true

Gibt die Callback-Konfiguration zurück, wie mittels request/performance_dc_bricklet/<UID>/set_emergency_shutdown_callback_configuration gesetzt.

request/performance_dc_bricklet/<UID>/set_velocity_reached_callback_configuration¶

Anfrage:	enabled – Typ: bool, Standardwert: false
Antwort:	keine Antwort

Aktiviert/Deaktiviert register/performance_dc_bricklet/<UID>/velocity_reached Callback.

request/performance_dc_bricklet/<UID>/get_velocity_reached_callback_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels request/performance_dc_bricklet/<UID>/set_velocity_reached_callback_configuration gesetzt.

request/performance_dc_bricklet/<UID>/set_current_velocity_callback_configuration¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false
Antwort:	keine Antwort

Die Periode ist die Periode mit der der register/performance_dc_bricklet/<UID>/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.

request/performance_dc_bricklet/<UID>/get_current_velocity_callback_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 value_has_to_change – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels request/performance_dc_bricklet/<UID>/set_current_velocity_callback_configuration gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

register/performance_dc_bricklet/<UID>/emergency_shutdown¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	keine Nutzdaten

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/performance_dc_bricklet/<UID>/emergency_shutdown[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/performance_dc_bricklet/<UID>/emergency_shutdown[/<SUFFIX>]-Topic veröffentlicht.

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 request/performance_dc_bricklet/<UID>/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 request/performance_dc_bricklet/<UID>/set_enabled muss aufgerufen werden, um den Motor erneut zu fahren.

register/performance_dc_bricklet/<UID>/velocity_reached¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/performance_dc_bricklet/<UID>/velocity_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/performance_dc_bricklet/<UID>/velocity_reached[/<SUFFIX>]-Topic veröffentlicht.

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 register/performance_dc_bricklet/<UID>/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 request/performance_dc_bricklet/<UID>/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.

register/performance_dc_bricklet/<UID>/current_velocity¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	velocity – Typ: int, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/performance_dc_bricklet/<UID>/current_velocity[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/performance_dc_bricklet/<UID>/current_velocity[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/performance_dc_bricklet/<UID>/set_current_velocity_callback_configuration, ausgelöst. Der Payload des Callbacks ist die aktuelle vom Motor genutzte Geschwindigkeit.

Der register/performance_dc_bricklet/<UID>/current_velocity Callback wird nur nach Ablauf der Periode ausgelöst, wenn sich die Geschwindigkeit geändert hat.

register/performance_dc_bricklet/<UID>/gpio_state¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	gpio_state – Typ: [bool, ...], Länge: 2

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/performance_dc_bricklet/<UID>/gpio_state[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/performance_dc_bricklet/<UID>/gpio_state[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst durch GPIO-Änderungen wenn er über request/performance_dc_bricklet/<UID>/set_gpio_action aktiviert wurde.

Neu in Version 2.0.1 (Plugin).

Interne Funktionen¶

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.

request/performance_dc_bricklet/<UID>/set_bootloader_mode¶

Anfrage:	mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:	status – Typ: int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für mode:

• "bootloader" = 0
• "firmware" = 1
• "bootloader_wait_for_reboot" = 2
• "firmware_wait_for_reboot" = 3
• "firmware_wait_for_erase_and_reboot" = 4

Für status:

• "ok" = 0
• "invalid_mode" = 1
• "no_change" = 2
• "entry_function_not_present" = 3
• "device_identifier_incorrect" = 4
• "crc_mismatch" = 5

request/performance_dc_bricklet/<UID>/get_bootloader_mode¶

Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/performance_dc_bricklet/<UID>/set_bootloader_mode.

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

Für mode:

• "bootloader" = 0
• "firmware" = 1
• "bootloader_wait_for_reboot" = 2
• "firmware_wait_for_reboot" = 3
• "firmware_wait_for_erase_and_reboot" = 4

request/performance_dc_bricklet/<UID>/set_write_firmware_pointer¶

Anfrage:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

Setzt den Firmware-Pointer für request/performance_dc_bricklet/<UID>/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.

request/performance_dc_bricklet/<UID>/write_firmware¶

Anfrage:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:	status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/performance_dc_bricklet/<UID>/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.

request/performance_dc_bricklet/<UID>/write_uid¶

Anfrage:	uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

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.

request/performance_dc_bricklet/<UID>/read_uid¶

Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.