Go - Laser Range Finder Bricklet

Dies ist die Beschreibung der Go API Bindings für das Laser Range Finder Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Laser Range Finder Bricklet 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).

Simple

Download (example_simple.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
package main

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

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Laser Range Finder Bricklet.

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

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

    // Turn laser on and wait 250ms for very first measurement to be ready
    lrf.EnableLaser()
    time.Sleep(250 * time.Millisecond)

    // Get current distance.
    distance, _ := lrf.GetDistance()
    fmt.Printf("Distance:  cm\n", distance)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
    lrf.DisableLaser() // Turn laser off
}

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

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

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Laser Range Finder Bricklet.

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

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

    // Turn laser on and wait 250ms for very first measurement to be ready
    lrf.EnableLaser()
    time.Sleep(250 * time.Millisecond)

    lrf.RegisterDistanceCallback(func(distance uint16) {
        fmt.Printf("Distance: %d cm\n", distance)
    })

    // Set period for distance receiver to 0.2s (200ms).
    // Note: The distance callback is only called every 0.2 seconds
    //       if the distance has changed since the last call!
    lrf.SetDistanceCallbackPeriod(200)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
    lrf.DisableLaser() // Turn laser off
}

Threshold

Download (example_threshold.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
package main

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

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Laser Range Finder Bricklet.

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

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

    // Turn laser on and wait 250ms for very first measurement to be ready
    lrf.EnableLaser()
    time.Sleep(250 * time.Millisecond)

    // Get threshold receivers with a debounce time of 10 seconds (10000ms).
    lrf.SetDebouncePeriod(10000)

    lrf.RegisterDistanceReachedCallback(func(distance uint16) {
        fmt.Printf("Distance: %d cm\n", distance)
    })

    // Configure threshold for distance "greater than 20 cm".
    lrf.SetDistanceCallbackThreshold('>', 20, 0)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
    lrf.DisableLaser() // Turn laser off
}

API

Die API des Laser Range Finder Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/laser_range_finder_bricklet 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 laser_range_finder_bricklet.New(uid string, ipcon *IPConnection) (device LaserRangeFinderBricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: LaserRangeFinderBricklet
  • err – Typ: error

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

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

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

func (*LaserRangeFinderBricklet) GetDistance() (distance uint16, err error)
Rückgabe:
  • distance – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 4000]
  • err – Typ: error

Gibt die gemessene Distanz zurück.

Sensor Hardware Version 1 (siehe GetSensorHardwareVersion()) kann nicht gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels SetMode() der Distanzmodus aktiviert sein. Sensor Hardware Version 3 kann gleichzeitig Distanz und Geschwindigkeit messen. Zusätzlich muss der Laser aktiviert werden, siehe EnableLaser().

Wenn der Entfernungswert periodisch abgefragt werden soll, wird empfohlen den RegisterDistanceCallback Callback zu nutzen und die Periode mit SetDistanceCallbackPeriod() vorzugeben.

func (*LaserRangeFinderBricklet) GetVelocity() (velocity int16, err error)
Rückgabe:
  • velocity – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]
  • err – Typ: error

Gibt die gemessene Geschwindigkeit zurück.

Sensor Hardware Version 1 (siehe GetSensorHardwareVersion()) kann nicht gleichzeitig Distanz und Geschwindigkeit messen. Daher muss mittels SetMode() ein Geschwindigkeitsmodus aktiviert sein. Sensor Hardware Version 3 kann gleichzeitig Distanz und Geschwindigkeit messen, jedoch liefert die Geschwindigkeitsmessung nur dann stabile Werte, wenn eine feste Messfrequenz (siehe SetConfiguration()) eingestellt ist. Zusätzlich muss der Laser aktiviert werden, siehe EnableLaser().

Wenn der Geschwindigkeitswert periodisch abgefragt werden soll, wird empfohlen den RegisterVelocityCallback Callback zu nutzen und die Periode mit SetVelocityCallbackPeriod() vorzugeben.

func (*LaserRangeFinderBricklet) SetMode(mode uint8) (err error)
Parameter:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • err – Typ: error

Bemerkung

Diese Funktion ist nur verfügbar, wenn ein LIDAR-Lite Sensor mit Hardware Version 1 verbaut ist. Für Hardware Version 3 gibt es SetConfiguration(). die Hardware Version des Sensors kann mittels GetSensorHardwareVersion() abgefragt werden.

Der LIDAR-Lite Sensor (Hardware Version 1) hat fünf verschiedene Modi. Ein Modus ist für Distanzmessungen und vier Modi sind für Geschwindigkeitsmessungen mit unterschiedlichen Wertebereichen.

Die folgenden Modi können genutzt werden:

  • 0: Distanz wird gemessen mit Auflösung 1,0 cm und Wertebereich 0-4000 cm
  • 1: Geschwindigkeit wird gemessen mit Auflösung 0,1 m/s und Wertebereich 0-12,7 m/s
  • 2: Geschwindigkeit wird gemessen mit Auflösung 0,25 m/s und Wertebereich 0-31,75 m/s
  • 3: Geschwindigkeit wird gemessen mit Auflösung 0,5 m/s und Wertebereich 0-63,5 m/s
  • 4: Geschwindigkeit wird gemessen mit Auflösung 1,0 m/s und Wertebereich 0-127 m/s

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

Für mode:

  • laser_range_finder_bricklet.ModeDistance = 0
  • laser_range_finder_bricklet.ModeVelocityMax13ms = 1
  • laser_range_finder_bricklet.ModeVelocityMax32ms = 2
  • laser_range_finder_bricklet.ModeVelocityMax64ms = 3
  • laser_range_finder_bricklet.ModeVelocityMax127ms = 4
func (*LaserRangeFinderBricklet) GetMode() (mode uint8, err error)
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • err – Typ: error

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

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

Für mode:

  • laser_range_finder_bricklet.ModeDistance = 0
  • laser_range_finder_bricklet.ModeVelocityMax13ms = 1
  • laser_range_finder_bricklet.ModeVelocityMax32ms = 2
  • laser_range_finder_bricklet.ModeVelocityMax64ms = 3
  • laser_range_finder_bricklet.ModeVelocityMax127ms = 4
func (*LaserRangeFinderBricklet) EnableLaser() (err error)
Rückgabe:
  • err – Typ: error

Aktiviert den Laser des LIDAR.

Wir empfehlen nach dem aktivieren des Lasers 250ms zu warten bis zum ersten Aufruf von GetDistance() um stabile Messwerte zu garantieren.

func (*LaserRangeFinderBricklet) DisableLaser() (err error)
Rückgabe:
  • err – Typ: error

Deaktiviert den Laser des LIDAR.

func (*LaserRangeFinderBricklet) IsLaserEnabled() (laserEnabled bool, err error)
Rückgabe:
  • laserEnabled – Typ: bool
  • err – Typ: error

Gibt true zurück wenn der Laser aktiviert ist, false sonst.

func (*LaserRangeFinderBricklet) SetConfiguration(acquisitionCount uint8, enableQuickTermination bool, thresholdValue uint8, measurementFrequency uint16) (err error)
Parameter:
  • acquisitionCount – Typ: uint8, Wertebereich: [1 bis 255], Standardwert: 128
  • enableQuickTermination – Typ: bool, Standardwert: false
  • thresholdValue – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 0
  • measurementFrequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0
Rückgabe:
  • err – Typ: error

Bemerkung

Diese Funktion ist nur verfügbar, wenn ein LIDAR-Lite Sensor mit Hardware Version 3 verbaut ist. Für Hardware Version 1 gibt es SetMode(). Die Hardware Version des Sensors kann mittels GetSensorHardwareVersion() abgefragt werden.

Der Parameter Acquisition Count definiert die Anzahl der Datenerfassungen die integriert werden, um eine Korrelation zu finden. Mit einer größeren Anzahl kann das Bricklet höhere Distanzen messen, mit einer kleineren Anzahl ist die Messrate höher. Erlaubte Werte sind 1-255.

Wenn der Parameter Enable Quick Termination auf true gesetzt wird, wird die Distanzmessung abgeschlossen, sobald das erste mal ein hoher Peak erfasst wird. Dadurch kann eine höhere Messrate erreicht werden wobei gleichzeitig Messungen mit langer Distanz möglich sind. Die Wahrscheinlichkeit einer Falschmessung erhöht sich allerdings.

Normalerweise wird die Distanz mit Hilfe eines Detektionsalgorithmus berechnet. Dieser verwendet Peak-Werte, Signalstärke und Rauschen. Es ist möglich stattdessen über den Parameter Threshold Value einen festen Schwellwert zu setzen der zur Distanzbestimmung genutzt werden soll. Um den Abstand zu einem Objekt mit sehr niedriger Reflektivität zu messen (z.B. Glas) kann der Wert niedrig gesetzt werden. Um den Abstand zu einem Objekt mit sehr hoher Reflektivität zu messen (z.B. Spiegel) kann der Wert sehr hoch gesetzt werden. Mit einem Wert von 0 wird der Standardalgorithmus genutzt. Ansonsten ist der erlaubte Wertebereich 1-255.

Der Measurement Frequency Parameter wird gesetzt. Er erzwingt eine feste Messfrequenz. Wenn der Wert auf 0 gesetzt wird, nutzt das Laser Range Finder Bricklet die optimale Frequenz je nach Konfiguration und aktuell gemessener Distanz. Da die Messrate in diesem Fall nicht fest ist, ist die Geschwindigkeitsmessung nicht stabil. Für eine stabile Geschwindigkeitsmessung sollte eine feste Messfrequenz eingestellt werden. Je niedriger die Frequenz ist, desto größer ist die Auflösung der Geschwindigkeitsmessung. Der erlaubte Wertbereich ist 10Hz-500Hz (und 0 um die feste Messfrequenz auszustellen).

Neu in Version 2.0.3 (Plugin).

func (*LaserRangeFinderBricklet) GetConfiguration() (acquisitionCount uint8, enableQuickTermination bool, thresholdValue uint8, measurementFrequency uint16, err error)
Rückgabe:
  • acquisitionCount – Typ: uint8, Wertebereich: [1 bis 255], Standardwert: 128
  • enableQuickTermination – Typ: bool, Standardwert: false
  • thresholdValue – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 0
  • measurementFrequency – Typ: uint16, Einheit: 1 Hz, Wertebereich: [0, 10 bis 500], Standardwert: 0
  • err – Typ: error

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

Neu in Version 2.0.3 (Plugin).

Fortgeschrittene Funktionen

func (*LaserRangeFinderBricklet) SetMovingAverage(distanceAverageLength uint8, velocityAverageLength uint8) (err error)
Parameter:
  • distanceAverageLength – Typ: uint8, Wertebereich: [0 bis 30], Standardwert: 10
  • velocityAverageLength – Typ: uint8, Wertebereich: [0 bis 30], Standardwert: 10
Rückgabe:
  • err – Typ: error

Setzt die Länge eines gleitenden Mittelwerts für die Entfernung und Geschwindigkeit.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

func (*LaserRangeFinderBricklet) GetMovingAverage() (distanceAverageLength uint8, velocityAverageLength uint8, err error)
Rückgabe:
  • distanceAverageLength – Typ: uint8, Wertebereich: [0 bis 30], Standardwert: 10
  • velocityAverageLength – Typ: uint8, Wertebereich: [0 bis 30], Standardwert: 10
  • err – Typ: error

Gibt die Länge des gleitenden Mittelwerts zurück, wie von SetMovingAverage() gesetzt.

func (*LaserRangeFinderBricklet) GetSensorHardwareVersion() (version uint8, err error)
Rückgabe:
  • version – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

Gibt die LIDAR-Lite Hardware version zurück.

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

Für version:

  • laser_range_finder_bricklet.Version1 = 1
  • laser_range_finder_bricklet.Version3 = 3

Neu in Version 2.0.3 (Plugin).

func (*LaserRangeFinderBricklet) 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', 'i', '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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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 (*LaserRangeFinderBricklet) SetDistanceCallbackPeriod(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 RegisterDistanceCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der RegisterDistanceCallback Callback wird nur ausgelöst, wenn sich der Entfernungswert seit der letzten Auslösung geändert hat.

func (*LaserRangeFinderBricklet) GetDistanceCallbackPeriod() (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 SetDistanceCallbackPeriod() gesetzt.

func (*LaserRangeFinderBricklet) SetVelocityCallbackPeriod(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 RegisterVelocityCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der RegisterVelocityCallback Callback wird nur ausgelöst, wenn sich der Geschwindigkeitswert seit der letzten Auslösung geändert hat.

func (*LaserRangeFinderBricklet) GetVelocityCallbackPeriod() (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 SetVelocityCallbackPeriod() gesetzt.

func (*LaserRangeFinderBricklet) SetDistanceCallbackThreshold(option rune, min uint16, max uint16) (err error)
Parameter:
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

Setzt den Schwellwert für den RegisterDistanceReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Entfernungswert außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn der Entfernungswert innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn der Entfernungswert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Entfernungswert größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • laser_range_finder_bricklet.ThresholdOptionOff = 'x'
  • laser_range_finder_bricklet.ThresholdOptionOutside = 'o'
  • laser_range_finder_bricklet.ThresholdOptionInside = 'i'
  • laser_range_finder_bricklet.ThresholdOptionSmaller = '<'
  • laser_range_finder_bricklet.ThresholdOptionGreater = '>'
func (*LaserRangeFinderBricklet) GetDistanceCallbackThreshold() (option rune, min uint16, max uint16, err error)
Rückgabe:
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • err – Typ: error

Gibt den Schwellwert zurück, wie von SetDistanceCallbackThreshold() gesetzt.

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

Für option:

  • laser_range_finder_bricklet.ThresholdOptionOff = 'x'
  • laser_range_finder_bricklet.ThresholdOptionOutside = 'o'
  • laser_range_finder_bricklet.ThresholdOptionInside = 'i'
  • laser_range_finder_bricklet.ThresholdOptionSmaller = '<'
  • laser_range_finder_bricklet.ThresholdOptionGreater = '>'
func (*LaserRangeFinderBricklet) SetVelocityCallbackThreshold(option rune, min int16, max int16) (err error)
Parameter:
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

Setzt den Schwellwert für den RegisterVelocityReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Geschwindigkeitswert außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn der Geschwindigkeitswert innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn der Geschwindigkeitswert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Geschwindigkeitswert größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • laser_range_finder_bricklet.ThresholdOptionOff = 'x'
  • laser_range_finder_bricklet.ThresholdOptionOutside = 'o'
  • laser_range_finder_bricklet.ThresholdOptionInside = 'i'
  • laser_range_finder_bricklet.ThresholdOptionSmaller = '<'
  • laser_range_finder_bricklet.ThresholdOptionGreater = '>'
func (*LaserRangeFinderBricklet) GetVelocityCallbackThreshold() (option rune, min int16, max int16, err error)
Rückgabe:
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • max – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
  • err – Typ: error

Gibt den Schwellwert zurück, wie von SetVelocityCallbackThreshold() gesetzt.

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

Für option:

  • laser_range_finder_bricklet.ThresholdOptionOff = 'x'
  • laser_range_finder_bricklet.ThresholdOptionOutside = 'o'
  • laser_range_finder_bricklet.ThresholdOptionInside = 'i'
  • laser_range_finder_bricklet.ThresholdOptionSmaller = '<'
  • laser_range_finder_bricklet.ThresholdOptionGreater = '>'
func (*LaserRangeFinderBricklet) SetDebouncePeriod(debounce uint32) (err error)
Parameter:
  • debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • err – Typ: error

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

func (*LaserRangeFinderBricklet) GetDebouncePeriod() (debounce uint32, err error)
Rückgabe:
  • debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
  • err – Typ: error

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() 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 (*LaserRangeFinderBricklet) RegisterDistanceCallback(func(distance uint16)) (registrationId uint64)
Callback-Parameter:
  • distance – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 4000]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetDistanceCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist die Entfernungswert des Sensors.

Der RegisterDistanceCallback Callback wird nur ausgelöst, wenn sich der Entfernungswert seit der letzten Auslösung geändert hat.

func (*LaserRangeFinderBricklet) RegisterVelocityCallback(func(velocity int16)) (registrationId uint64)
Callback-Parameter:
  • velocity – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetVelocityCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist die Geschwindigkeit des Sensors.

Der RegisterVelocityCallback Callback wird nur ausgelöst, wenn sich der Geschwindigkeitswert seit der letzten Auslösung geändert hat.

func (*LaserRangeFinderBricklet) RegisterDistanceReachedCallback(func(distance uint16)) (registrationId uint64)
Callback-Parameter:
  • distance – Typ: uint16, Einheit: 1 cm, Wertebereich: [0 bis 4000]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetDistanceCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist der Entfernungswert des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

func (*LaserRangeFinderBricklet) RegisterVelocityReachedCallback(func(velocity int16)) (registrationId uint64)
Callback-Parameter:
  • velocity – Typ: int16, Einheit: 1 cm/s, Wertebereich: [-12800 bis 12700]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetVelocityCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist der Geschwindigkeitswert des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

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

  • laser_range_finder_bricklet.FunctionSetDistanceCallbackPeriod = 3
  • laser_range_finder_bricklet.FunctionSetVelocityCallbackPeriod = 5
  • laser_range_finder_bricklet.FunctionSetDistanceCallbackThreshold = 7
  • laser_range_finder_bricklet.FunctionSetVelocityCallbackThreshold = 9
  • laser_range_finder_bricklet.FunctionSetDebouncePeriod = 11
  • laser_range_finder_bricklet.FunctionSetMovingAverage = 13
  • laser_range_finder_bricklet.FunctionSetMode = 15
  • laser_range_finder_bricklet.FunctionEnableLaser = 17
  • laser_range_finder_bricklet.FunctionDisableLaser = 18
  • laser_range_finder_bricklet.FunctionSetConfiguration = 25
func (*LaserRangeFinderBricklet) 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:

  • laser_range_finder_bricklet.FunctionSetDistanceCallbackPeriod = 3
  • laser_range_finder_bricklet.FunctionSetVelocityCallbackPeriod = 5
  • laser_range_finder_bricklet.FunctionSetDistanceCallbackThreshold = 7
  • laser_range_finder_bricklet.FunctionSetVelocityCallbackThreshold = 9
  • laser_range_finder_bricklet.FunctionSetDebouncePeriod = 11
  • laser_range_finder_bricklet.FunctionSetMovingAverage = 13
  • laser_range_finder_bricklet.FunctionSetMode = 15
  • laser_range_finder_bricklet.FunctionEnableLaser = 17
  • laser_range_finder_bricklet.FunctionDisableLaser = 18
  • laser_range_finder_bricklet.FunctionSetConfiguration = 25
func (*LaserRangeFinderBricklet) 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

laser_range_finder_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein Laser Range Finder 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.

laser_range_finder_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Laser Range Finder Bricklet dar.