Go - Stepper Brick

Dies ist die Beschreibung der Go API Bindings für den Stepper Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Stepper Brick sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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
package main

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

const ADDR string = "localhost:4223"
const UID string = "XXYYZZ" // Change XXYYZZ to the UID of your Stepper Brick.

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

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

    stepper.SetMotorCurrent(800) // 800mA
    stepper.SetStepMode(8)       // 1/8 step mode
    stepper.SetMaxVelocity(2000) // Velocity 2000 steps/s

    // Slow acceleration (500 steps/s^2),
    // Fast deacceleration (5000 steps/s^2)
    stepper.SetSpeedRamping(500, 5000)

    stepper.Enable()        // Enable motor power
    stepper.SetSteps(60000) // Drive 60000 steps forward

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
    stepper.Disable()
}

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
package main

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

const ADDR string = "localhost:4223"
const UID string = "XXYYZZ" // Change XXYYZZ to the UID of your Stepper Brick.

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

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

    rng := rand.New(rand.NewSource(time.Now().UnixNano()))

    stepper.RegisterPositionReachedCallback(func(position int32) {
        steps := int32(0)
        if rng.Int31()%2 == 0 {
            steps = rng.Int31n(4001) + 1000
            fmt.Printf("Driving forward: %d steps\n", steps)
        } else {
            steps = -(rng.Int31n(4001) + 1000)
            fmt.Printf("Driving backward: %d steps\n", steps)
        }

        vel := uint16(rng.Int31n(1800) + 200)
        acc := uint16(rng.Int31n(900) + 100)
        dec := uint16(rng.Int31n(900) + 100)

        fmt.Printf("Configuration: (vel, acc, dec): (%d, %d, %d)\n", vel, acc, dec)
        stepper.SetSpeedRamping(acc, dec)
        stepper.SetMaxVelocity(vel)
        stepper.SetSteps(steps)
    })

    stepper.Enable()    // Enable motor power
    stepper.SetSteps(1) // Drive one step forward to get things going

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

    stepper.Disable()
}

API

Die API des Stepper Brick ist im Package github.com/Tinkerforge/go-api-bindings/stepper_brick definiert.

Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func stepper_brick.New(uid string, ipcon *IPConnection) (device StepperBrick, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: StepperBrick
  • err – Typ: error

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

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

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden wurde (siehe Beispiele oben).

func (*StepperBrick) SetMaxVelocity(velocity uint16) (err error)
Parameter:
  • velocity – Typ: uint16, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • err – Typ: error

Setzt die maximale Geschwindigkeit des Schrittmotors. Diese Funktion startet nicht den Motor, sondern setzt nur die maximale Geschwindigkeit auf welche der Schrittmotor beschleunigt wird. Um den Motor zu fahren können SetTargetPosition(), SetSteps(), DriveForward() oder DriveBackward() verwendet werden.

func (*StepperBrick) GetMaxVelocity() (velocity uint16, err error)
Rückgabe:
  • velocity – Typ: uint16, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

func (*StepperBrick) GetCurrentVelocity() (velocity uint16, err error)
Rückgabe:
  • velocity – Typ: uint16, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

Gibt die aktuelle Geschwindigkeit des Schrittmotors zurück.

func (*StepperBrick) SetSpeedRamping(acceleration uint16, deacceleration uint16) (err error)
Parameter:
  • acceleration – Typ: uint16, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • deacceleration – Typ: uint16, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
Rückgabe:
  • err – Typ: error

Setzt die Beschleunigung und die Verzögerung des Schrittmotors. Eine Beschleunigung von 1000 bedeutet, dass jede Sekunde die Geschwindigkeit um 1000 Schritte/s erhöht wird.

Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist und es soll auf eine Geschwindigkeit von 8000 Schritten/s in 10 Sekunden beschleunigt werden, muss die Beschleunigung auf 800 Schritte/s² gesetzt werden.

Eine Beschleunigung/Verzögerung von 0 bedeutet ein sprunghaftes Beschleunigen/Verzögern (nicht empfohlen).

func (*StepperBrick) GetSpeedRamping() (acceleration uint16, deacceleration uint16, err error)
Rückgabe:
  • acceleration – Typ: uint16, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • deacceleration – Typ: uint16, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
  • err – Typ: error

Gibt die Beschleunigung und Verzögerung zurück, wie von SetSpeedRamping() gesetzt.

func (*StepperBrick) 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 Stop() stoppt den Motor.

func (*StepperBrick) SetSteps(steps int32) (err error)
Parameter:
  • steps – Typ: int32, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • err – Typ: error

Setzt die Anzahl der Schritte die der Schrittmotor fahren soll. Positive Werte fahren den Motor vorwärts und negative rückwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit SetMaxVelocity() und SetSpeedRamping() gesetzt, verwendet.

func (*StepperBrick) GetSteps() (steps int32, err error)
Rückgabe:
  • steps – Typ: int32, Wertebereich: [-231 bis 231 - 1]
  • err – Typ: error

Gibt die letzten Schritte zurück, wie von SetSteps() gesetzt.

func (*StepperBrick) GetRemainingSteps() (steps int32, err error)
Rückgabe:
  • steps – Typ: int32, Wertebereich: [-231 bis 231 - 1]
  • err – Typ: error

Gibt die verbleibenden Schritte des letzten Aufrufs von SetSteps() zurück. Beispiel: Wenn SetSteps() mit 2000 aufgerufen wird und GetRemainingSteps() aufgerufen wird wenn der Motor 500 Schritte fahren hat, wird 1500 zurückgegeben.

func (*StepperBrick) DriveForward() (err error)
Rückgabe:
  • err – Typ: error

Fährt den Schrittmotor vorwärts bis DriveBackward() oder Stop() aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit SetMaxVelocity() und SetSpeedRamping() gesetzt, verwendet.

func (*StepperBrick) DriveBackward() (err error)
Rückgabe:
  • err – Typ: error

Fährt den Schrittmotor rückwärts bis DriveForward() oder Stop() aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit SetMaxVelocity() und SetSpeedRamping() gesetzt, verwendet.

func (*StepperBrick) Stop() (err error)
Rückgabe:
  • err – Typ: error

Stoppt den Schrittmotor mit der Verzögerung, wie von SetSpeedRamping() gesetzt.

func (*StepperBrick) SetMotorCurrent(current uint16) (err error)
Parameter:
  • current – Typ: uint16, Einheit: 1 mA, Wertebereich: [100 bis 2291], Standardwert: 800
Rückgabe:
  • err – Typ: error

Setzt den Strom mit welchem der Motor angetrieben wird.

Warnung

Dieser Wert sollte nicht über die Spezifikation des Schrittmotors gesetzt werden. Sonst ist eine Beschädigung des Motors möglich.

func (*StepperBrick) GetMotorCurrent() (current uint16, err error)
Rückgabe:
  • current – Typ: uint16, Einheit: 1 mA, Wertebereich: [100 bis 2291], Standardwert: 800
  • err – Typ: error

Gibt den Strom zurück, wie von SetMotorCurrent() gesetzt.

func (*StepperBrick) Enable() (err error)
Rückgabe:
  • err – Typ: error

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

func (*StepperBrick) Disable() (err error)
Rückgabe:
  • err – Typ: error

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

func (*StepperBrick) IsEnabled() (enabled bool, err error)
Rückgabe:
  • enabled – Typ: bool
  • err – Typ: error

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

Fortgeschrittene Funktionen

func (*StepperBrick) SetCurrentPosition(position int32) (err error)
Parameter:
  • position – Typ: int32, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • err – Typ: error

Setzt den aktuellen Schrittwert des internen Schrittzählers. Dies kann benutzt werden um die aktuelle Position auf 0 zu setzen wenn ein definierter Startpunkt erreicht wurde (z.B. wenn eine CNC Maschine eine Ecke erreicht).

func (*StepperBrick) GetCurrentPosition() (position int32, err error)
Rückgabe:
  • position – Typ: int32, Wertebereich: [-231 bis 231 - 1]
  • err – Typ: error

Gibt die aktuelle Position des Schrittmotors in Schritten zurück. Nach dem Hochfahren ist die Position 0. Die Schritte werden bei Verwendung aller möglichen Fahrfunktionen gezählt (SetTargetPosition(), SetSteps(), DriveForward() der DriveBackward()). Es ist auch möglich den Schrittzähler auf 0 oder jeden anderen gewünschten Wert zu setzen mit SetCurrentPosition().

func (*StepperBrick) SetTargetPosition(position int32) (err error)
Parameter:
  • position – Typ: int32, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • err – Typ: error

Setzt die Zielposition des Schrittmotors in Schritten. Beispiel: Wenn die aktuelle Position des Motors 500 ist und SetTargetPosition() mit 1000 aufgerufen wird, dann verfährt der Schrittmotor 500 Schritte vorwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit SetMaxVelocity() und SetSpeedRamping() gesetzt, verwendet.

Ein Aufruf von SetTargetPosition() mit dem Parameter x ist äquivalent mit einem Aufruf von SetSteps() mit dem Parameter (x - GetCurrentPosition()).

func (*StepperBrick) GetTargetPosition() (position int32, err error)
Rückgabe:
  • position – Typ: int32, Wertebereich: [-231 bis 231 - 1]
  • err – Typ: error

Gibt die letzte Zielposition zurück, wie von SetTargetPosition() gesetzt.

func (*StepperBrick) SetStepMode(mode uint8) (err error)
Parameter:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 8
Rückgabe:
  • err – Typ: error

Setzt den Schrittmodus des Schrittmotors. Mögliche Werte sind:

  • Vollschritt = 1
  • Halbschritt = 2
  • Viertelschritt = 4
  • Achtelschritt = 8

Ein höherer Wert erhöht die Auflösung und verringert das Drehmoment des Schrittmotors.

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

Für mode:

  • stepper_brick.StepModeFullStep = 1
  • stepper_brick.StepModeHalfStep = 2
  • stepper_brick.StepModeQuarterStep = 4
  • stepper_brick.StepModeEighthStep = 8
func (*StepperBrick) GetStepMode() (mode uint8, err error)
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 8
  • err – Typ: error

Gibt den Schrittmodus zurück, wie von SetStepMode() gesetzt.

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

Für mode:

  • stepper_brick.StepModeFullStep = 1
  • stepper_brick.StepModeHalfStep = 2
  • stepper_brick.StepModeQuarterStep = 4
  • stepper_brick.StepModeEighthStep = 8
func (*StepperBrick) GetStackInputVoltage() (voltage uint16, err error)
Rückgabe:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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

func (*StepperBrick) GetExternalInputVoltage() (voltage uint16, err error)
Rückgabe:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

Gibt die externe Eingangsspannung zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den Stepper Brick, eingespeist.

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

Warnung

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

func (*StepperBrick) GetCurrentConsumption() (current uint16, err error)
Rückgabe:
  • current – Typ: uint16, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

Gibt die Stromaufnahme des Motors zurück.

func (*StepperBrick) SetDecay(decay uint16) (err error)
Parameter:
  • decay – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
Rückgabe:
  • err – Typ: error

Setzt den Decay Modus (Abklingmodus) des Schrittmotors. Ein Wert von 0 setzt den Fast Decay Modus (schneller Stromabbau), ein Wert von 65535 den Slow Decay Modus (langsamer Stromabbau) ein Wert dazwischen den Mixed Decay Modus (Nutzung beider Modi).

Eine Änderung des Decay Modus ist nur möglich wenn die Synchrongleichrichtung aktiviert ist (siehe SetSyncRect()).

Für eine gute Erläuterung der verschiedenen Decay Modi siehe diesen Blogeintrag (Englisch) von Avayan oder diesen Blogeintrag (Deutsch) von T. Ostermann.

Ein guter Decay Modus ist leider unterschiedlich für jeden Motor. Der beste Weg einen guten Decay Modus für den jeweiligen Schrittmotor zu finden, wenn der Strom nicht mit einem Oszilloskop gemessen werden kann, ist auf die Geräusche des Motors zu hören. Wenn der Wert zu gering ist, ist oftmals ein hoher Ton zu hören und wenn er zu hoch ist, oftmals ein brummendes Geräusch.

Im Allgemeinen ist der Fast Decay Modus (kleine Werte) geräuschvoller, erlaubt aber höhere Motorgeschwindigkeiten.

Bemerkung

Es existiert leider keine Formel zur Berechnung des optimalen Decay Modus eines Schrittmotors. Sollten Probleme mit lauten Geräuschen oder einer zu geringen maximalen Motorgeschwindigkeit bestehen, bleibt nur Ausprobieren um einen besseren Decay Modus zu finden.

func (*StepperBrick) GetDecay() (decay uint16, err error)
Rückgabe:
  • decay – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 10000
  • err – Typ: error

Gibt den Decay Modus zurück, wie von SetDecay() gesetzt.

func (*StepperBrick) SetSyncRect(syncRect bool) (err error)
Parameter:
  • syncRect – Typ: bool, Standardwert: false
Rückgabe:
  • err – Typ: error

Aktiviert oder deaktiviert (true oder false) die Synchrongleichrichtung.

Bei aktiver Synchrongleichrichtung kann der Decay Modus geändert werden (Siehe SetDecay()). Ohne Synchrongleichrichtung wird der Fast Decay Modus verwendet.

Für eine Erläuterung der Synchrongleichrichtung siehe hier.

Warnung

Wenn hohe Geschwindigkeiten (> 10000 Schritte/s) mit einem großen Schrittmotor mit einer hohen Induktivität genutzt werden sollen, wird dringend geraten die Synchrongleichrichtung zu deaktivieren. Sonst kann es vorkommen, dass der Brick die Last nicht bewältigen kann und überhitzt.

func (*StepperBrick) IsSyncRect() (syncRect bool, err error)
Rückgabe:
  • syncRect – Typ: bool, Standardwert: false
  • err – Typ: error

Gibt zurück ob die Synchrongleichrichtung aktiviert ist.

func (*StepperBrick) SetTimeBase(timeBase uint32) (err error)
Parameter:
  • timeBase – Typ: uint32, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1
Rückgabe:
  • err – Typ: error

Setzt die Zeitbasis der Geschwindigkeit und Beschleunigung des Stepper Brick.

Beispiel: Wenn aller 1,5 Sekunden ein Schritt gefahren werden soll, kann die Zeitbasis auf 15 und die Geschwindigkeit auf 10 gesetzt werden. Damit ist die Geschwindigkeit 10Schritte/15s = 1Schritt/1,5s.

func (*StepperBrick) GetTimeBase() (timeBase uint32, err error)
Rückgabe:
  • timeBase – Typ: uint32, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1
  • err – Typ: error

Gibt die Zeitbasis zurück, wie von SetTimeBase() gesetzt.

func (*StepperBrick) GetAllData() (currentVelocity uint16, currentPosition int32, remainingSteps int32, stackVoltage uint16, externalVoltage uint16, currentConsumption uint16, err error)
Rückgabe:
  • currentVelocity – Typ: uint16, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
  • currentPosition – Typ: int32, Wertebereich: [-231 bis 231 - 1]
  • remainingSteps – Typ: int32, Wertebereich: [-231 bis 231 - 1]
  • stackVoltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • externalVoltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • currentConsumption – Typ: uint16, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

Gibt die folgenden Parameter zurück: Die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.

Es existiert auch ein Callback für diese Funktion, siehe RegisterAllDataCallback Callback.

func (*StepperBrick) SetSPITFPBaudrateConfig(enableDynamicBaudrate bool, minimumDynamicBaudrate uint32) (err error)
Parameter:
  • enableDynamicBaudrate – Typ: bool, Standardwert: true
  • minimumDynamicBaudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Rückgabe:
  • err – Typ: error

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

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

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

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

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

Neu in Version 2.3.6 (Firmware).

func (*StepperBrick) GetSPITFPBaudrateConfig() (enableDynamicBaudrate bool, minimumDynamicBaudrate uint32, err error)
Rückgabe:
  • enableDynamicBaudrate – Typ: bool, Standardwert: true
  • minimumDynamicBaudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
  • err – Typ: error

Gibt die Baudratenkonfiguration zurück, siehe SetSPITFPBaudrateConfig().

Neu in Version 2.3.6 (Firmware).

func (*StepperBrick) GetSendTimeoutCount(communicationMethod uint8) (timeoutCount uint32, err error)
Parameter:
  • communicationMethod – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • timeoutCount – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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

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

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

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

Für communicationMethod:

  • stepper_brick.CommunicationMethodNone = 0
  • stepper_brick.CommunicationMethodUSB = 1
  • stepper_brick.CommunicationMethodSPIStack = 2
  • stepper_brick.CommunicationMethodChibi = 3
  • stepper_brick.CommunicationMethodRS485 = 4
  • stepper_brick.CommunicationMethodWIFI = 5
  • stepper_brick.CommunicationMethodEthernet = 6
  • stepper_brick.CommunicationMethodWIFIV2 = 7

Neu in Version 2.3.4 (Firmware).

func (*StepperBrick) SetSPITFPBaudrate(brickletPort rune, baudrate uint32) (err error)
Parameter:
  • brickletPort – Typ: rune, Wertebereich: ['a' bis 'b']
  • baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Rückgabe:
  • err – Typ: error

Setzt die Baudrate eines spezifischen Bricklet Ports .

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

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

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

Neu in Version 2.3.3 (Firmware).

func (*StepperBrick) GetSPITFPBaudrate(brickletPort rune) (baudrate uint32, err error)
Parameter:
  • brickletPort – Typ: rune, Wertebereich: ['a' bis 'b']
Rückgabe:
  • baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
  • err – Typ: error

Gibt die Baudrate für einen Bricklet Port zurück, siehe SetSPITFPBaudrate().

Neu in Version 2.3.3 (Firmware).

func (*StepperBrick) GetSPITFPErrorCount(brickletPort rune) (errorCountACKChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
Parameter:
  • brickletPort – Typ: rune, Wertebereich: ['a' bis 'b']
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 Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.3.3 (Firmware).

func (*StepperBrick) EnableStatusLED() (err error)
Rückgabe:
  • err – Typ: error

Aktiviert die Status LED.

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

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

func (*StepperBrick) DisableStatusLED() (err error)
Rückgabe:
  • err – Typ: error

Deaktiviert die Status LED.

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

Der Standardzustand ist aktiviert.

Neu in Version 2.3.1 (Firmware).

func (*StepperBrick) IsStatusLEDEnabled() (enabled bool, err error)
Rückgabe:
  • enabled – Typ: bool, Standardwert: true
  • err – Typ: error

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

Neu in Version 2.3.1 (Firmware).

func (*StepperBrick) GetProtocol1BrickletName(port rune) (protocolVersion uint8, firmwareVersion [3]uint8, name string, err error)
Parameter:
  • port – Typ: rune, Wertebereich: ['a' bis 'b']
Rückgabe:
  • protocolVersion – 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]
  • name – Typ: string, Länge: bis zu 40
  • err – Typ: error

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

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

func (*StepperBrick) GetChipTemperature() (temperature int16, err error)
Rückgabe:
  • temperature – Typ: int16, Einheit: 1/10 °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 Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

func (*StepperBrick) Reset() (err error)
Rückgabe:
  • err – Typ: error

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

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

func (*StepperBrick) WriteBrickletPlugin(port rune, offset uint8, chunk [32]uint8) (err error)
Parameter:
  • port – Typ: rune, Wertebereich: ['a' bis 'b']
  • offset – Typ: uint8, Wertebereich: [0 bis 255]
  • chunk – Typ: [32]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

func (*StepperBrick) ReadBrickletPlugin(port rune, offset uint8) (chunk [32]uint8, err error)
Parameter:
  • port – Typ: rune, Wertebereich: ['a' bis 'b']
  • offset – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • chunk – Typ: [32]uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Liest 32 Bytes Firmware vom Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden ab der Position offset * 32 gelesen.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

func (*StepperBrick) 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: ['0' bis '8']
  • 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 der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

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

Konfigurationsfunktionen für Callbacks

func (*StepperBrick) SetMinimumVoltage(voltage uint16) (err error)
Parameter:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000
Rückgabe:
  • err – Typ: error

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

func (*StepperBrick) GetMinimumVoltage() (voltage uint16, err error)
Rückgabe:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000
  • err – Typ: error

Gibt die minimale Spannung zurück, wie von SetMinimumVoltage() gesetzt.

func (*StepperBrick) SetAllDataPeriod(period uint32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

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

func (*StepperBrick) GetAllDataPeriod() (period uint32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

Gibt die Periode zurück, wie von SetAllDataPeriod() 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.

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.

func (*StepperBrick) RegisterUnderVoltageCallback(func(voltage uint16)) (registrationId uint64)
Callback-Parameter:
  • voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels SetMinimumVoltage() gesetzten, Schwellwert sinkt. Der Parameter des Callbacks ist die aktuelle Spannung.

func (*StepperBrick) RegisterPositionReachedCallback(func(position int32)) (registrationId uint64)
Callback-Parameter:
  • position – Typ: int32, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Position, wie von SetSteps() oder SetTargetPosition() gesetzt, erreicht wird.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Schrittmotor zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe SetSpeedRamping()) 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 (*StepperBrick) RegisterAllDataCallback(func(currentVelocity uint16, currentPosition int32, remainingSteps int32, stackVoltage uint16, externalVoltage uint16, currentConsumption uint16)) (registrationId uint64)
Callback-Parameter:
  • currentVelocity – Typ: uint16, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
  • currentPosition – Typ: int32, Wertebereich: [-231 bis 231 - 1]
  • remainingSteps – Typ: int32, Wertebereich: [-231 bis 231 - 1]
  • stackVoltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • externalVoltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]
  • currentConsumption – Typ: uint16, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetAllDataPeriod(), ausgelöst. Die Parameter des Callbacks sind die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.

func (*StepperBrick) RegisterNewStateCallback(func(stateNew uint8, statePrevious uint8)) (registrationId uint64)
Callback-Parameter:
  • stateNew – Typ: uint8, Wertebereich: Siehe Konstanten
  • statePrevious – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird immer dann ausgelöst, wenn der Stepper Brick einen neuen Zustand erreicht. Es wird sowohl der neue wie auch der alte Zustand zurückgegeben.

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

Für stateNew:

  • stepper_brick.StateStop = 1
  • stepper_brick.StateAcceleration = 2
  • stepper_brick.StateRun = 3
  • stepper_brick.StateDeacceleration = 4
  • stepper_brick.StateDirectionChangeToForward = 5
  • stepper_brick.StateDirectionChangeToBackward = 6

Für statePrevious:

  • stepper_brick.StateStop = 1
  • stepper_brick.StateAcceleration = 2
  • stepper_brick.StateRun = 3
  • stepper_brick.StateDeacceleration = 4
  • stepper_brick.StateDirectionChangeToForward = 5
  • stepper_brick.StateDirectionChangeToBackward = 6

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 (*StepperBrick) 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 (*StepperBrick) 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:

  • stepper_brick.FunctionSetMaxVelocity = 1
  • stepper_brick.FunctionSetSpeedRamping = 4
  • stepper_brick.FunctionFullBrake = 6
  • stepper_brick.FunctionSetCurrentPosition = 7
  • stepper_brick.FunctionSetTargetPosition = 9
  • stepper_brick.FunctionSetSteps = 11
  • stepper_brick.FunctionSetStepMode = 14
  • stepper_brick.FunctionDriveForward = 16
  • stepper_brick.FunctionDriveBackward = 17
  • stepper_brick.FunctionStop = 18
  • stepper_brick.FunctionSetMotorCurrent = 22
  • stepper_brick.FunctionEnable = 24
  • stepper_brick.FunctionDisable = 25
  • stepper_brick.FunctionSetDecay = 27
  • stepper_brick.FunctionSetMinimumVoltage = 29
  • stepper_brick.FunctionSetSyncRect = 33
  • stepper_brick.FunctionSetTimeBase = 35
  • stepper_brick.FunctionSetAllDataPeriod = 38
  • stepper_brick.FunctionSetSPITFPBaudrateConfig = 231
  • stepper_brick.FunctionSetSPITFPBaudrate = 234
  • stepper_brick.FunctionEnableStatusLED = 238
  • stepper_brick.FunctionDisableStatusLED = 239
  • stepper_brick.FunctionReset = 243
  • stepper_brick.FunctionWriteBrickletPlugin = 246
func (*StepperBrick) 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:

  • stepper_brick.FunctionSetMaxVelocity = 1
  • stepper_brick.FunctionSetSpeedRamping = 4
  • stepper_brick.FunctionFullBrake = 6
  • stepper_brick.FunctionSetCurrentPosition = 7
  • stepper_brick.FunctionSetTargetPosition = 9
  • stepper_brick.FunctionSetSteps = 11
  • stepper_brick.FunctionSetStepMode = 14
  • stepper_brick.FunctionDriveForward = 16
  • stepper_brick.FunctionDriveBackward = 17
  • stepper_brick.FunctionStop = 18
  • stepper_brick.FunctionSetMotorCurrent = 22
  • stepper_brick.FunctionEnable = 24
  • stepper_brick.FunctionDisable = 25
  • stepper_brick.FunctionSetDecay = 27
  • stepper_brick.FunctionSetMinimumVoltage = 29
  • stepper_brick.FunctionSetSyncRect = 33
  • stepper_brick.FunctionSetTimeBase = 35
  • stepper_brick.FunctionSetAllDataPeriod = 38
  • stepper_brick.FunctionSetSPITFPBaudrateConfig = 231
  • stepper_brick.FunctionSetSPITFPBaudrate = 234
  • stepper_brick.FunctionEnableStatusLED = 238
  • stepper_brick.FunctionDisableStatusLED = 239
  • stepper_brick.FunctionReset = 243
  • stepper_brick.FunctionWriteBrickletPlugin = 246
func (*StepperBrick) 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.

Konstanten

stepper_brick.DeviceIdentifier

Diese Konstante wird verwendet um einen Stepper Brick zu identifizieren.

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

stepper_brick.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Stepper Brick dar.