Go - Performance DC Bricklet¶

Configuration¶

Download (example_configuration.go)

 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

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/performance_dc_bricklet"
    "time"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Performance DC Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    pdc, _ := performance_dc_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    pdc.SetDriveMode(performance_dc_bricklet.DriveModeDriveCoast)
    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

    fmt.Print("Press enter to exit.")
    fmt.Scanln()

    // Stop motor before disabling motor power
    pdc.SetMotion(4096, 16384)          // Fast decceleration (50 %/s) for stopping
    pdc.SetVelocity(0)                  // Request motor stop
    time.Sleep(2000 * time.Millisecond) // Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
    pdc.SetEnabled(false)               // Disable motor power
}

Callback¶

Download (example_callback.go)

 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

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/performance_dc_bricklet"
    "time"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Performance DC Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    pdc, _ := performance_dc_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    pdc.RegisterVelocityReachedCallback(func(velocity int16) {
        if velocity == 32767 {
            fmt.Println("Velocity: Full speed forward, now turning backward")
            pdc.SetVelocity(-32767)
        } else if velocity == -32767 {
            fmt.Println("Velocity: Full speed backward, now turning forward")
            pdc.SetVelocity(32767)
        } else {
            //can only happen if another program sets velocity
            fmt.Println("Error")
        }
    })

    // 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)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()

    // Stop motor before disabling motor power
    pdc.SetMotion(4096, 16384)          // Fast decceleration (50 %/s) for stopping
    pdc.SetVelocity(0)                  // Request motor stop
    time.Sleep(2000 * time.Millisecond) // Wait for motor to actually stop: velocity (100 %) / decceleration (50 %/s) = 2 s
    pdc.SetEnabled(false)               // Disable motor power
}

Grundfunktionen¶

func performance_dc_bricklet.New(uid string, ipcon *IPConnection) (device PerformanceDCBricklet, err error)¶

Parameter:	uid – Typ: string ipcon – Typ: *IPConnection
Rückgabe:	device – Typ: PerformanceDCBricklet err – Typ: error

Erzeugt ein neues PerformanceDCBricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

device, err := performance_dc_bricklet.New("YOUR_DEVICE_UID", &ipcon)

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.

func (*PerformanceDCBricklet) SetEnabled(enabled bool) (err error)¶

Parameter:	enabled – Typ: bool
Rückgabe:	err – Typ: error

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

func (*PerformanceDCBricklet) GetEnabled() (enabled bool, err error)¶

Rückgabe:	enabled – Typ: bool, Standardwert: false err – Typ: error

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

func (*PerformanceDCBricklet) SetVelocity(velocity int16) (err error)¶

Parameter:	velocity – Typ: int16, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0
Rückgabe:	err – Typ: error

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().

func (*PerformanceDCBricklet) GetVelocity() (velocity int16, err error)¶

Rückgabe:	velocity – Typ: int16, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0 err – Typ: error

Gibt die Geschwindigkeit zurück, wie gesetzt von SetVelocity().

func (*PerformanceDCBricklet) GetCurrentVelocity() (velocity int16, err error)¶

Rückgabe:	velocity – Typ: int16, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1], Standardwert: 0 err – Typ: error

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.

func (*PerformanceDCBricklet) SetMotion(acceleration uint16, deceleration uint16) (err error)¶

Parameter:	acceleration – Typ: uint16, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000 deceleration – Typ: uint16, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Rückgabe:	err – Typ: error

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.

func (*PerformanceDCBricklet) GetMotion() (acceleration uint16, deceleration uint16, err error)¶

Rückgabe:	acceleration – Typ: uint16, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000 deceleration – Typ: uint16, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 10000 err – Typ: error

Gibt die Beschleunigung/Debeschleunigung zurück, wie gesetzt von SetMotion().

func (*PerformanceDCBricklet) FullBrake() (err error)¶

Rückgabe:	err – Typ: error

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.

func (*PerformanceDCBricklet) GetPWMFrequency() (frequency uint16, err error)¶

Rückgabe:	frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000 err – Typ: error

Gibt die PWM Frequenz zurück, wie gesetzt von SetPWMFrequency().

func (*PerformanceDCBricklet) GetPowerStatistics() (voltage uint16, current uint16, temperature int16, err error)¶

Rückgabe:	voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] current – Typ: uint16, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1] temperature – Typ: int16, Einheit: 1/10 °, Wertebereich: [-215 bis 215 - 1] err – Typ: error

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

func (*PerformanceDCBricklet) SetThermalShutdown(temperature uint8) (err error)¶

Parameter:	temperature – Typ: uint8, Einheit: 1 °, Wertebereich: [0 bis 255], Standardwert: 125
Rückgabe:	err – Typ: error

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.

func (*PerformanceDCBricklet) GetThermalShutdown() (temperature uint8, err error)¶

Rückgabe:	temperature – Typ: uint8, Einheit: 1 °, Wertebereich: [0 bis 255] err – Typ: error

Gibt die thermale Abschalttemperatur zurück, wie von SetThermalShutdown() gesetzt.

func (*PerformanceDCBricklet) SetGPIOConfiguration(channel uint8, debounce uint16, stopDeceleration uint16) (err error)¶

Parameter:	channel – Typ: uint8, Wertebereich: [0 bis 1] debounce – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 200 stopDeceleration – Typ: uint16, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1
Rückgabe:	err – Typ: error

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().

func (*PerformanceDCBricklet) GetGPIOConfiguration(channel uint8) (debounce uint16, stopDeceleration uint16, err error)¶

Parameter:	channel – Typ: uint8, Wertebereich: [0 bis 1]
Rückgabe:	debounce – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 200 stopDeceleration – Typ: uint16, Einheit: 100/32767 %/s, Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1 err – Typ: error

Gibt die GPIO-Konfiguration für einen Kanal zurück, wie von SetGPIOConfiguration() gesetzt.

func (*PerformanceDCBricklet) SetGPIOAction(channel uint8, action uint32) (err error)¶

Parameter:	channel – Typ: uint8, Wertebereich: [0 bis 1] action – Typ: uint32, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	err – Typ: error

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:

• performance_dc_bricklet.GPIOActionNone = 0
• performance_dc_bricklet.GPIOActionNormalStopRisingEdge = 1
• performance_dc_bricklet.GPIOActionNormalStopFallingEdge = 2
• performance_dc_bricklet.GPIOActionFullBrakeRisingEdge = 4
• performance_dc_bricklet.GPIOActionFullBrakeFallingEdge = 8
• performance_dc_bricklet.GPIOActionCallbackRisingEdge = 16
• performance_dc_bricklet.GPIOActionCallbackFallingEdge = 32

func (*PerformanceDCBricklet) GetGPIOAction(channel uint8) (action uint32, err error)¶

Parameter:	channel – Typ: uint8, Wertebereich: [0 bis 1]
Rückgabe:	action – Typ: uint32, Wertebereich: Siehe Konstanten, Standardwert: 0 err – Typ: error

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:

• performance_dc_bricklet.GPIOActionNone = 0
• performance_dc_bricklet.GPIOActionNormalStopRisingEdge = 1
• performance_dc_bricklet.GPIOActionNormalStopFallingEdge = 2
• performance_dc_bricklet.GPIOActionFullBrakeRisingEdge = 4
• performance_dc_bricklet.GPIOActionFullBrakeFallingEdge = 8
• performance_dc_bricklet.GPIOActionCallbackRisingEdge = 16
• performance_dc_bricklet.GPIOActionCallbackFallingEdge = 32

func (*PerformanceDCBricklet) GetGPIOState() (gpioState [2]bool, err error)¶

Rückgabe:	gpioState – Typ: [2]bool err – Typ: error

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¶

func (*PerformanceDCBricklet) SetDriveMode(mode uint8) (err error)¶

Parameter:	mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	err – Typ: error

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

Für mode:

• performance_dc_bricklet.DriveModeDriveBrake = 0
• performance_dc_bricklet.DriveModeDriveCoast = 1

func (*PerformanceDCBricklet) GetDriveMode() (mode uint8, err error)¶

Rückgabe:	mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0 err – Typ: error

Gibt den Fahrmodus zurück, wie von SetDriveMode() gesetzt.

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

Für mode:

• performance_dc_bricklet.DriveModeDriveBrake = 0
• performance_dc_bricklet.DriveModeDriveCoast = 1

func (*PerformanceDCBricklet) SetPWMFrequency(frequency uint16) (err error)¶

Parameter:	frequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [1 bis 20000], Standardwert: 15000
Rückgabe:	err – Typ: error

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.

func (*PerformanceDCBricklet) SetErrorLEDConfig(config uint8) (err error)¶

Parameter:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	err – Typ: error

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

Für config:

• performance_dc_bricklet.ErrorLEDConfigOff = 0
• performance_dc_bricklet.ErrorLEDConfigOn = 1
• performance_dc_bricklet.ErrorLEDConfigShowHeartbeat = 2
• performance_dc_bricklet.ErrorLEDConfigShowError = 3

func (*PerformanceDCBricklet) GetErrorLEDConfig() (config uint8, err error)¶

Rückgabe:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 err – Typ: error

Gibt die LED-Konfiguration zurück, wie von SetErrorLEDConfig() gesetzt.

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

Für config:

• performance_dc_bricklet.ErrorLEDConfigOff = 0
• performance_dc_bricklet.ErrorLEDConfigOn = 1
• performance_dc_bricklet.ErrorLEDConfigShowHeartbeat = 2
• performance_dc_bricklet.ErrorLEDConfigShowError = 3

func (*PerformanceDCBricklet) SetCWLEDConfig(config uint8) (err error)¶

Parameter:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	err – Typ: error

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:

• performance_dc_bricklet.CWLEDConfigOff = 0
• performance_dc_bricklet.CWLEDConfigOn = 1
• performance_dc_bricklet.CWLEDConfigShowHeartbeat = 2
• performance_dc_bricklet.CWLEDConfigShowCWAsForward = 3
• performance_dc_bricklet.CWLEDConfigShowCWAsBackward = 4

func (*PerformanceDCBricklet) GetCWLEDConfig() (config uint8, err error)¶

Rückgabe:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 err – Typ: error

Gibt die LED-Konfiguration zurück, wie von SetCWLEDConfig() gesetzt.

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

Für config:

• performance_dc_bricklet.CWLEDConfigOff = 0
• performance_dc_bricklet.CWLEDConfigOn = 1
• performance_dc_bricklet.CWLEDConfigShowHeartbeat = 2
• performance_dc_bricklet.CWLEDConfigShowCWAsForward = 3
• performance_dc_bricklet.CWLEDConfigShowCWAsBackward = 4

func (*PerformanceDCBricklet) SetCCWLEDConfig(config uint8) (err error)¶

Parameter:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	err – Typ: error

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:

• performance_dc_bricklet.CCWLEDConfigOff = 0
• performance_dc_bricklet.CCWLEDConfigOn = 1
• performance_dc_bricklet.CCWLEDConfigShowHeartbeat = 2
• performance_dc_bricklet.CCWLEDConfigShowCCWAsForward = 3
• performance_dc_bricklet.CCWLEDConfigShowCCWAsBackward = 4

func (*PerformanceDCBricklet) GetCCWLEDConfig() (config uint8, err error)¶

Rückgabe:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 err – Typ: error

Gibt die LED-Konfiguration zurück, wie von SetCCWLEDConfig() gesetzt.

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

Für config:

• performance_dc_bricklet.CCWLEDConfigOff = 0
• performance_dc_bricklet.CCWLEDConfigOn = 1
• performance_dc_bricklet.CCWLEDConfigShowHeartbeat = 2
• performance_dc_bricklet.CCWLEDConfigShowCCWAsForward = 3
• performance_dc_bricklet.CCWLEDConfigShowCCWAsBackward = 4

func (*PerformanceDCBricklet) SetGPIOLEDConfig(channel uint8, config uint8) (err error)¶

Parameter:	channel – Typ: uint8, Wertebereich: [0 bis 1] config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 4
Rückgabe:	err – Typ: error

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:

• performance_dc_bricklet.GPIOLEDConfigOff = 0
• performance_dc_bricklet.GPIOLEDConfigOn = 1
• performance_dc_bricklet.GPIOLEDConfigShowHeartbeat = 2
• performance_dc_bricklet.GPIOLEDConfigShowGPIOActiveHigh = 3
• performance_dc_bricklet.GPIOLEDConfigShowGPIOActiveLow = 4

func (*PerformanceDCBricklet) GetGPIOLEDConfig(channel uint8) (config uint8, err error)¶

Parameter:	channel – Typ: uint8, Wertebereich: [0 bis 1]
Rückgabe:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 4 err – Typ: error

Gibt die LED-Konfiguration zurück, wie von SetGPIOLEDConfig() gesetzt.

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

Für config:

• performance_dc_bricklet.GPIOLEDConfigOff = 0
• performance_dc_bricklet.GPIOLEDConfigOn = 1
• performance_dc_bricklet.GPIOLEDConfigShowHeartbeat = 2
• performance_dc_bricklet.GPIOLEDConfigShowGPIOActiveHigh = 3
• performance_dc_bricklet.GPIOLEDConfigShowGPIOActiveLow = 4

func (*PerformanceDCBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)¶

Rückgabe:	errorCountAckChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1] errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1] errorCountFrame – Typ: uint32, Wertebereich: [0 bis 232 - 1] errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 232 - 1] err – Typ: error

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.

func (*PerformanceDCBricklet) SetStatusLEDConfig(config uint8) (err error)¶

Parameter:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	err – Typ: error

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:

• performance_dc_bricklet.StatusLEDConfigOff = 0
• performance_dc_bricklet.StatusLEDConfigOn = 1
• performance_dc_bricklet.StatusLEDConfigShowHeartbeat = 2
• performance_dc_bricklet.StatusLEDConfigShowStatus = 3

func (*PerformanceDCBricklet) GetStatusLEDConfig() (config uint8, err error)¶

Rückgabe:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 err – Typ: error

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

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

Für config:

• performance_dc_bricklet.StatusLEDConfigOff = 0
• performance_dc_bricklet.StatusLEDConfigOn = 1
• performance_dc_bricklet.StatusLEDConfigShowHeartbeat = 2
• performance_dc_bricklet.StatusLEDConfigShowStatus = 3

func (*PerformanceDCBricklet) GetChipTemperature() (temperature int16, err error)¶

Rückgabe:	temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1] err – Typ: error

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.

func (*PerformanceDCBricklet) Reset() (err error)¶

Rückgabe:	err – Typ: error

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.

func (*PerformanceDCBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶

Rückgabe:

uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: rune, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: [3]uint8 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmwareVersion – Typ: [3]uint8 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 1] err – Typ: error

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.

Konfigurationsfunktionen für Callbacks¶

func (*PerformanceDCBricklet) SetEmergencyShutdownCallbackConfiguration(enabled bool) (err error)¶

Parameter:	enabled – Typ: bool, Standardwert: false
Rückgabe:	err – Typ: error

Aktiviert/Deaktiviert EmergencyShutdownCallback Callback.

func (*PerformanceDCBricklet) GetEmergencyShutdownCallbackConfiguration() (enabled bool, err error)¶

Rückgabe:	enabled – Typ: bool, Standardwert: true err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetEmergencyShutdownCallbackConfiguration() gesetzt.

func (*PerformanceDCBricklet) SetVelocityReachedCallbackConfiguration(enabled bool) (err error)¶

Parameter:	enabled – Typ: bool, Standardwert: false
Rückgabe:	err – Typ: error

Aktiviert/Deaktiviert VelocityReachedCallback Callback.

func (*PerformanceDCBricklet) GetVelocityReachedCallbackConfiguration() (enabled bool, err error)¶

Rückgabe:	enabled – Typ: bool, Standardwert: false err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetVelocityReachedCallbackConfiguration() gesetzt.

func (*PerformanceDCBricklet) SetCurrentVelocityCallbackConfiguration(period uint32, valueHasToChange bool) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false
Rückgabe:	err – Typ: error

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.

func (*PerformanceDCBricklet) GetCurrentVelocityCallbackConfiguration() (period uint32, valueHasToChange bool, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetCurrentVelocityCallbackConfiguration() gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden Register*Callback-Function durchgeführt werden, welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback später deregistriert werden.

func (*PerformanceDCBricklet) RegisterEmergencyShutdownCallback(func()) (registrationId uint64)¶

Rückgabe:	registrationId – Typ: uint64

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.

func (*PerformanceDCBricklet) RegisterVelocityReachedCallback(func(velocity int16)) (registrationId uint64)¶

Callback-Parameter:	velocity – Typ: int16, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1]
Rückgabe:	registrationId – Typ: uint64

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.

func (*PerformanceDCBricklet) RegisterCurrentVelocityCallback(func(velocity int16)) (registrationId uint64)¶

Callback-Parameter:	velocity – Typ: int16, Einheit: 100/32767 %, Wertebereich: [-215 + 1 bis 215 - 1]
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetCurrentVelocityCallbackConfiguration(), ausgelöst. Der Parameter des Callbacks 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.

func (*PerformanceDCBricklet) RegisterGPIOStateCallback(func(gpioState [2]bool)) (registrationId uint64)¶

Callback-Parameter:	gpioState – Typ: [2]bool
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird ausgelöst durch GPIO-Änderungen wenn er über SetGPIOAction() aktiviert wurde.

Neu in Version 2.0.1 (Plugin).

Virtuelle Funktionen¶

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

func (*PerformanceDCBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)¶

Rückgabe:	apiVersion – Typ: [3]uint8 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] err – Typ: error

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.

func (*PerformanceDCBricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)¶

Parameter:	functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: bool err – Typ: error

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:

• performance_dc_bricklet.FunctionSetEnabled = 1
• performance_dc_bricklet.FunctionSetVelocity = 3
• performance_dc_bricklet.FunctionSetMotion = 6
• performance_dc_bricklet.FunctionFullBrake = 8
• performance_dc_bricklet.FunctionSetDriveMode = 9
• performance_dc_bricklet.FunctionSetPWMFrequency = 11
• performance_dc_bricklet.FunctionSetThermalShutdown = 14
• performance_dc_bricklet.FunctionSetGPIOConfiguration = 16
• performance_dc_bricklet.FunctionSetGPIOAction = 18
• performance_dc_bricklet.FunctionSetErrorLEDConfig = 21
• performance_dc_bricklet.FunctionSetCWLEDConfig = 23
• performance_dc_bricklet.FunctionSetCCWLEDConfig = 25
• performance_dc_bricklet.FunctionSetGPIOLEDConfig = 27
• performance_dc_bricklet.FunctionSetEmergencyShutdownCallbackConfiguration = 29
• performance_dc_bricklet.FunctionSetVelocityReachedCallbackConfiguration = 31
• performance_dc_bricklet.FunctionSetCurrentVelocityCallbackConfiguration = 33
• performance_dc_bricklet.FunctionSetWriteFirmwarePointer = 237
• performance_dc_bricklet.FunctionSetStatusLEDConfig = 239
• performance_dc_bricklet.FunctionReset = 243
• performance_dc_bricklet.FunctionWriteUID = 248

func (*PerformanceDCBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)¶

Parameter:	functionId – Typ: uint8, Wertebereich: Siehe Konstanten responseExpected – Typ: bool
Rückgabe:	err – Typ: error

Ä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:

• performance_dc_bricklet.FunctionSetEnabled = 1
• performance_dc_bricklet.FunctionSetVelocity = 3
• performance_dc_bricklet.FunctionSetMotion = 6
• performance_dc_bricklet.FunctionFullBrake = 8
• performance_dc_bricklet.FunctionSetDriveMode = 9
• performance_dc_bricklet.FunctionSetPWMFrequency = 11
• performance_dc_bricklet.FunctionSetThermalShutdown = 14
• performance_dc_bricklet.FunctionSetGPIOConfiguration = 16
• performance_dc_bricklet.FunctionSetGPIOAction = 18
• performance_dc_bricklet.FunctionSetErrorLEDConfig = 21
• performance_dc_bricklet.FunctionSetCWLEDConfig = 23
• performance_dc_bricklet.FunctionSetCCWLEDConfig = 25
• performance_dc_bricklet.FunctionSetGPIOLEDConfig = 27
• performance_dc_bricklet.FunctionSetEmergencyShutdownCallbackConfiguration = 29
• performance_dc_bricklet.FunctionSetVelocityReachedCallbackConfiguration = 31
• performance_dc_bricklet.FunctionSetCurrentVelocityCallbackConfiguration = 33
• performance_dc_bricklet.FunctionSetWriteFirmwarePointer = 237
• performance_dc_bricklet.FunctionSetStatusLEDConfig = 239
• performance_dc_bricklet.FunctionReset = 243
• performance_dc_bricklet.FunctionWriteUID = 248

func (*PerformanceDCBricklet) SetResponseExpectedAll(responseExpected bool) (err error)¶

Parameter:	responseExpected – Typ: bool
Rückgabe:	err – Typ: error

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

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.

func (*PerformanceDCBricklet) SetBootloaderMode(mode uint8) (status uint8, err error)¶

Parameter:	mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: uint8, Wertebereich: Siehe Konstanten err – Typ: error

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:

• performance_dc_bricklet.BootloaderModeBootloader = 0
• performance_dc_bricklet.BootloaderModeFirmware = 1
• performance_dc_bricklet.BootloaderModeBootloaderWaitForReboot = 2
• performance_dc_bricklet.BootloaderModeFirmwareWaitForReboot = 3
• performance_dc_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

Für status:

• performance_dc_bricklet.BootloaderStatusOK = 0
• performance_dc_bricklet.BootloaderStatusInvalidMode = 1
• performance_dc_bricklet.BootloaderStatusNoChange = 2
• performance_dc_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
• performance_dc_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
• performance_dc_bricklet.BootloaderStatusCRCMismatch = 5

func (*PerformanceDCBricklet) GetBootloaderMode() (mode uint8, err error)¶

Rückgabe:	mode – Typ: uint8, Wertebereich: Siehe Konstanten err – Typ: error

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

Für mode:

• performance_dc_bricklet.BootloaderModeBootloader = 0
• performance_dc_bricklet.BootloaderModeFirmware = 1
• performance_dc_bricklet.BootloaderModeBootloaderWaitForReboot = 2
• performance_dc_bricklet.BootloaderModeFirmwareWaitForReboot = 3
• performance_dc_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

func (*PerformanceDCBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)¶

Parameter:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:	err – Typ: error

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.

func (*PerformanceDCBricklet) WriteFirmware(data [64]uint8) (status uint8, err error)¶

Parameter:	data – Typ: [64]uint8, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: uint8, Wertebereich: [0 bis 255] err – Typ: error

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.

func (*PerformanceDCBricklet) WriteUID(uid uint32) (err error)¶

Parameter:	uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:	err – Typ: error

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.

func (*PerformanceDCBricklet) ReadUID() (uid uint32, err error)¶

Rückgabe:	uid – Typ: uint32, Wertebereich: [0 bis 232 - 1] err – Typ: error

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

Konstanten¶

performance_dc_bricklet.DeviceIdentifier¶

Diese Konstante wird verwendet um ein Performance DC Bricklet zu identifizieren.

Die GetIdentity() Funktion und der (*IPConnection) RegisterEnumerateCallback Callback der IPConnection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

performance_dc_bricklet.DeviceDisplayName¶

Diese Konstante stellt den Anzeigenamen eines Performance DC Bricklet dar.