Go - Laser Range Finder Bricklet 2.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
34
35

package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    lrf, _ := laser_range_finder_v2_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.SetEnable(true)
    time.Sleep(250 * time.Millisecond)

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

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

    // Turn laser off
    lrf.SetEnable(false)
}

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_v2_bricklet"
    "time"
)

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    lrf, _ := laser_range_finder_v2_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.SetEnable(true)
    time.Sleep(250 * time.Millisecond)

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

    // Set period for distance callback to 0.2s (200ms) without a threshold.
    lrf.SetDistanceCallbackConfiguration(200, false, 'x', 0, 0)

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

    // Turn laser off
    lrf.SetEnable(false)
}

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_v2_bricklet"
    "time"
)

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    lrf, _ := laser_range_finder_v2_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.SetEnable(true)
    time.Sleep(250 * time.Millisecond)

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

    // Configure threshold for distance "greater than 20 cm"
    // with a debounce period of 1s (1000ms).
    lrf.SetDistanceCallbackConfiguration(1000, false, '>', 20, 0)

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

    // Turn laser off
    lrf.SetEnable(false)
}

Grundfunktionen¶

func laser_range_finder_v2_bricklet.New(uid string, ipcon *IPConnection) (device LaserRangeFinderV2Bricklet, err error)¶

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

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

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

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

func (*LaserRangeFinderV2Bricklet) GetDistance() (distance int16, err error)¶

Rückgabe:	distance – Typ: int16, Einheit: 1 cm, Wertebereich: [0 bis 4000] err – Typ: error

Gibt die gemessene Distanz zurück.

Der Laser muss aktiviert werden, siehe SetEnable().

Wenn der Wert periodisch benötigt wird, kann auch der DistanceCallback Callback verwendet werden. Der Callback wird mit der Funktion SetDistanceCallbackConfiguration() konfiguriert.

func (*LaserRangeFinderV2Bricklet) 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.

Die Geschwindigkeitsmessung liefert nur dann stabile Werte, wenn eine feste Messfrequenz (siehe SetConfiguration()) eingestellt ist. Zusätzlich muss der Laser aktiviert werden, siehe SetEnable().

Wenn der Wert periodisch benötigt wird, kann auch der VelocityCallback Callback verwendet werden. Der Callback wird mit der Funktion SetVelocityCallbackConfiguration() konfiguriert.

func (*LaserRangeFinderV2Bricklet) SetEnable(enable bool) (err error)¶

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

Aktiviert den Laser des LIDAR wenn auf true gesetzt.

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

func (*LaserRangeFinderV2Bricklet) GetEnable() (enable bool, err error)¶

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

Gibt den Wert zurück wie von SetEnable() gesetzt.

func (*LaserRangeFinderV2Bricklet) 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

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

Die Standardwerte für Acquisition Count, Enable Quick Termination, Threshold Value und Measurement Frequency sind 128, false, 0 und 0.

func (*LaserRangeFinderV2Bricklet) 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.

func (*LaserRangeFinderV2Bricklet) SetDistanceLEDConfig(config uint8) (err error)¶

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

Konfiguriert die Distanz-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option mit der LED die Distanz anzuzeigen (heller = Objekt näher).

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

Für config:

• laser_range_finder_v2_bricklet.DistanceLEDConfigOff = 0
• laser_range_finder_v2_bricklet.DistanceLEDConfigOn = 1
• laser_range_finder_v2_bricklet.DistanceLEDConfigShowHeartbeat = 2
• laser_range_finder_v2_bricklet.DistanceLEDConfigShowDistance = 3

func (*LaserRangeFinderV2Bricklet) GetDistanceLEDConfig() (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 SetDistanceLEDConfig() gesetzt.

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

Für config:

• laser_range_finder_v2_bricklet.DistanceLEDConfigOff = 0
• laser_range_finder_v2_bricklet.DistanceLEDConfigOn = 1
• laser_range_finder_v2_bricklet.DistanceLEDConfigShowHeartbeat = 2
• laser_range_finder_v2_bricklet.DistanceLEDConfigShowDistance = 3

Fortgeschrittene Funktionen¶

func (*LaserRangeFinderV2Bricklet) SetMovingAverage(distanceAverageLength uint8, velocityAverageLength uint8) (err error)¶

Parameter:	distanceAverageLength – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 10 velocityAverageLength – Typ: uint8, Wertebereich: [0 bis 255], 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 (*LaserRangeFinderV2Bricklet) GetMovingAverage() (distanceAverageLength uint8, velocityAverageLength uint8, err error)¶

Rückgabe:	distanceAverageLength – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 10 velocityAverageLength – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 10 err – Typ: error

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

func (*LaserRangeFinderV2Bricklet) SetOffsetCalibration(offset int16) (err error)¶

Parameter:	offset – Typ: int16, Einheit: 1 cm, Wertebereich: [-215 bis 28767]
Rückgabe:	err – Typ: error

Der Offset wird auf die Distanz addiert. Es wird in nicht-flüchtigen Speicher gespeichert und muss nur einmal gesetzt werden.

Der Offset wird für das Bricklet pro Sensor von Tinkerforge werkskalibriert. Ein Aufruf dieser Funktion sollte also nicht notwendig sein.

Wenn der Offset re-kalibriert werden soll muss er zuerst auf 0 gesetzt. Danach kann der Offset wieder gesetzt werden in dem die Differenz zu einer bekannte Distanz gemessen wird.

func (*LaserRangeFinderV2Bricklet) GetOffsetCalibration() (offset int16, err error)¶

Rückgabe:	offset – Typ: int16, Einheit: 1 cm, Wertebereich: [-215 bis 28767] err – Typ: error

Gibt den Offset-Wert zurück, wie von SetOffsetCalibration() gesetzt.

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

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

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

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

func (*LaserRangeFinderV2Bricklet) 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 (*LaserRangeFinderV2Bricklet) 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 (*LaserRangeFinderV2Bricklet) 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 (*LaserRangeFinderV2Bricklet) SetDistanceCallbackConfiguration(period uint32, valueHasToChange bool, option rune, min int16, max int16) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int16, Einheit: 1 cm, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: int16, Einheit: 1 cm, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Rückgabe:	err – Typ: error

Die Periode ist die Periode mit der der DistanceCallback 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.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den DistanceCallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

• laser_range_finder_v2_bricklet.ThresholdOptionOff = 'x'
• laser_range_finder_v2_bricklet.ThresholdOptionOutside = 'o'
• laser_range_finder_v2_bricklet.ThresholdOptionInside = 'i'
• laser_range_finder_v2_bricklet.ThresholdOptionSmaller = '<'
• laser_range_finder_v2_bricklet.ThresholdOptionGreater = '>'

func (*LaserRangeFinderV2Bricklet) GetDistanceCallbackConfiguration() (period uint32, valueHasToChange bool, option rune, min int16, max int16, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int16, Einheit: 1 cm, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: int16, Einheit: 1 cm, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 err – Typ: error

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

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

Für option:

• laser_range_finder_v2_bricklet.ThresholdOptionOff = 'x'
• laser_range_finder_v2_bricklet.ThresholdOptionOutside = 'o'
• laser_range_finder_v2_bricklet.ThresholdOptionInside = 'i'
• laser_range_finder_v2_bricklet.ThresholdOptionSmaller = '<'
• laser_range_finder_v2_bricklet.ThresholdOptionGreater = '>'

func (*LaserRangeFinderV2Bricklet) SetVelocityCallbackConfiguration(period uint32, valueHasToChange bool, option rune, min int16, max int16) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false 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

Die Periode ist die Periode mit der der VelocityCallback 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.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den VelocityCallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

• laser_range_finder_v2_bricklet.ThresholdOptionOff = 'x'
• laser_range_finder_v2_bricklet.ThresholdOptionOutside = 'o'
• laser_range_finder_v2_bricklet.ThresholdOptionInside = 'i'
• laser_range_finder_v2_bricklet.ThresholdOptionSmaller = '<'
• laser_range_finder_v2_bricklet.ThresholdOptionGreater = '>'

func (*LaserRangeFinderV2Bricklet) GetVelocityCallbackConfiguration() (period uint32, valueHasToChange bool, option rune, min int16, max int16, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false 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 die Callback-Konfiguration zurück, wie mittels SetVelocityCallbackConfiguration() gesetzt.

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

Für option:

• laser_range_finder_v2_bricklet.ThresholdOptionOff = 'x'
• laser_range_finder_v2_bricklet.ThresholdOptionOutside = 'o'
• laser_range_finder_v2_bricklet.ThresholdOptionInside = 'i'
• laser_range_finder_v2_bricklet.ThresholdOptionSmaller = '<'
• laser_range_finder_v2_bricklet.ThresholdOptionGreater = '>'

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 (*LaserRangeFinderV2Bricklet) RegisterDistanceCallback(func(distance int16)) (registrationId uint64)¶

Callback-Parameter:	distance – Typ: int16, Einheit: 1 cm, Wertebereich: [0 bis 4000]
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetDistanceCallbackConfiguration() gesetzten Konfiguration

Der Parameter des Callbacks ist der gleiche wie GetDistance().

func (*LaserRangeFinderV2Bricklet) 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 periodisch ausgelöst abhängig von der mittels SetVelocityCallbackConfiguration() gesetzten Konfiguration

Der Parameter des Callbacks ist der gleiche wie GetVelocity().

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 (*LaserRangeFinderV2Bricklet) 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 (*LaserRangeFinderV2Bricklet) 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_v2_bricklet.FunctionSetDistanceCallbackConfiguration = 2
• laser_range_finder_v2_bricklet.FunctionSetVelocityCallbackConfiguration = 6
• laser_range_finder_v2_bricklet.FunctionSetEnable = 9
• laser_range_finder_v2_bricklet.FunctionSetConfiguration = 11
• laser_range_finder_v2_bricklet.FunctionSetMovingAverage = 13
• laser_range_finder_v2_bricklet.FunctionSetOffsetCalibration = 15
• laser_range_finder_v2_bricklet.FunctionSetDistanceLEDConfig = 17
• laser_range_finder_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
• laser_range_finder_v2_bricklet.FunctionSetStatusLEDConfig = 239
• laser_range_finder_v2_bricklet.FunctionReset = 243
• laser_range_finder_v2_bricklet.FunctionWriteUID = 248

func (*LaserRangeFinderV2Bricklet) 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_v2_bricklet.FunctionSetDistanceCallbackConfiguration = 2
• laser_range_finder_v2_bricklet.FunctionSetVelocityCallbackConfiguration = 6
• laser_range_finder_v2_bricklet.FunctionSetEnable = 9
• laser_range_finder_v2_bricklet.FunctionSetConfiguration = 11
• laser_range_finder_v2_bricklet.FunctionSetMovingAverage = 13
• laser_range_finder_v2_bricklet.FunctionSetOffsetCalibration = 15
• laser_range_finder_v2_bricklet.FunctionSetDistanceLEDConfig = 17
• laser_range_finder_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
• laser_range_finder_v2_bricklet.FunctionSetStatusLEDConfig = 239
• laser_range_finder_v2_bricklet.FunctionReset = 243
• laser_range_finder_v2_bricklet.FunctionWriteUID = 248

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

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

Für status:

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

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

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

func (*LaserRangeFinderV2Bricklet) 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 (*LaserRangeFinderV2Bricklet) 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 (*LaserRangeFinderV2Bricklet) 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 (*LaserRangeFinderV2Bricklet) 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¶

laser_range_finder_v2_bricklet.DeviceIdentifier¶

Diese Konstante wird verwendet um ein Laser Range Finder Bricklet 2.0 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_v2_bricklet.DeviceDisplayName¶

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