Go - Distance US Bricklet¶

Simple¶

Download (example_simple.go)

 1package main
 2
 3import (
 4    "fmt"
 5    "github.com/Tinkerforge/go-api-bindings/distance_us_bricklet"
 6    "github.com/Tinkerforge/go-api-bindings/ipconnection"
 7)
 8
 9const ADDR string = "localhost:4223"
10const UID string = "XYZ" // Change XYZ to the UID of your Distance US Bricklet.
11
12func main() {
13    ipcon := ipconnection.New()
14    defer ipcon.Close()
15    dus, _ := distance_us_bricklet.New(UID, &ipcon) // Create device object.
16
17    ipcon.Connect(ADDR) // Connect to brickd.
18    defer ipcon.Disconnect()
19    // Don't use device before ipcon is connected.
20
21    // Get current distance value.
22    distance, _ := dus.GetDistanceValue()
23    fmt.Printf("Distance Value: %d\n", distance)
24
25    fmt.Print("Press enter to exit.")
26    fmt.Scanln()
27}

Callback¶

Download (example_callback.go)

 1package main
 2
 3import (
 4    "fmt"
 5    "github.com/Tinkerforge/go-api-bindings/distance_us_bricklet"
 6    "github.com/Tinkerforge/go-api-bindings/ipconnection"
 7)
 8
 9const ADDR string = "localhost:4223"
10const UID string = "XYZ" // Change XYZ to the UID of your Distance US Bricklet.
11
12func main() {
13    ipcon := ipconnection.New()
14    defer ipcon.Close()
15    dus, _ := distance_us_bricklet.New(UID, &ipcon) // Create device object.
16
17    ipcon.Connect(ADDR) // Connect to brickd.
18    defer ipcon.Disconnect()
19    // Don't use device before ipcon is connected.
20
21    dus.RegisterDistanceCallback(func(distance uint16) {
22        fmt.Printf("Distance Value: %d\n", distance)
23    })
24
25    // Set period for distance value receiver to 0.2s (200ms).
26    // Note: The distance value callback is only called every 0.2 seconds
27    //       if the distance value has changed since the last call!
28    dus.SetDistanceCallbackPeriod(200)
29
30    fmt.Print("Press enter to exit.")
31    fmt.Scanln()
32}

Threshold¶

Download (example_threshold.go)

 1package main
 2
 3import (
 4    "fmt"
 5    "github.com/Tinkerforge/go-api-bindings/distance_us_bricklet"
 6    "github.com/Tinkerforge/go-api-bindings/ipconnection"
 7)
 8
 9const ADDR string = "localhost:4223"
10const UID string = "XYZ" // Change XYZ to the UID of your Distance US Bricklet.
11
12func main() {
13    ipcon := ipconnection.New()
14    defer ipcon.Close()
15    dus, _ := distance_us_bricklet.New(UID, &ipcon) // Create device object.
16
17    ipcon.Connect(ADDR) // Connect to brickd.
18    defer ipcon.Disconnect()
19    // Don't use device before ipcon is connected.
20
21    // Get threshold receivers with a debounce time of 10 seconds (10000ms).
22    dus.SetDebouncePeriod(10000)
23
24    dus.RegisterDistanceReachedCallback(func(distance uint16) {
25        fmt.Printf("Distance Value: %d\n", distance)
26    })
27
28    // Configure threshold for distance value "smaller than 200".
29    dus.SetDistanceCallbackThreshold('<', 200, 0)
30
31    fmt.Print("Press enter to exit.")
32    fmt.Scanln()
33}

Grundfunktionen¶

func distance_us_bricklet.New(uid string, ipcon *IPConnection) (device DistanceUSBricklet, err error)¶

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

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

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

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

func (*DistanceUSBricklet) GetDistanceValue() (distance uint16, err error)¶

Rückgabe:	distance – Typ: uint16, Wertebereich: [0 bis 212 - 1] err – Typ: error

Gibt den aktuellen Entfernungswert zurück. Ein kleiner Wert entspricht einer kleinen Entfernung, ein großer Wert entspricht einer großen Entfernung. Das Verhältnis zwischen gemessenem Entfernungswert und wirklicher Entfernung wird durch die 5V Versorgungsspannung beeinflusst (Abweichungen der Versorgungsspannung führen zu Abweichungen in den Entfernungswerten) und ist nicht-linear (Auflösung ist größer im Nahbereich).

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

Fortgeschrittene Funktionen¶

func (*DistanceUSBricklet) SetMovingAverage(average uint8) (err error)¶

Parameter:	average – Typ: uint8, Wertebereich: [0 bis 100], Standardwert: 20
Rückgabe:	err – Typ: error

Setzt die Länge eines gleitenden Mittelwerts für den Entfernungswert.

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 (*DistanceUSBricklet) GetMovingAverage() (average uint8, err error)¶

Rückgabe:	average – Typ: uint8, Wertebereich: [0 bis 100], Standardwert: 20 err – Typ: error

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

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

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

func (*DistanceUSBricklet) 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 (*DistanceUSBricklet) SetDistanceCallbackThreshold(option rune, min uint16, max uint16) (err error)¶

Parameter:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: uint16, Wertebereich: [0 bis 212 - 1] max – Typ: uint16, Wertebereich: [0 bis 212 - 1]
Rückgabe:	err – Typ: error

Setzt den Schwellwert für den DistanceReachedCallback 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:

• distance_us_bricklet.ThresholdOptionOff = 'x'

• distance_us_bricklet.ThresholdOptionOutside = 'o'

• distance_us_bricklet.ThresholdOptionInside = 'i'

• distance_us_bricklet.ThresholdOptionSmaller = '<'

• distance_us_bricklet.ThresholdOptionGreater = '>'

func (*DistanceUSBricklet) GetDistanceCallbackThreshold() (option rune, min uint16, max uint16, err error)¶

Rückgabe:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: uint16, Wertebereich: [0 bis 212 - 1] max – Typ: uint16, Wertebereich: [0 bis 212 - 1] 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:

• distance_us_bricklet.ThresholdOptionOff = 'x'

• distance_us_bricklet.ThresholdOptionOutside = 'o'

• distance_us_bricklet.ThresholdOptionInside = 'i'

• distance_us_bricklet.ThresholdOptionSmaller = '<'

• distance_us_bricklet.ThresholdOptionGreater = '>'

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

• DistanceReachedCallback,

ausgelöst werden, wenn die Schwellwerte

• SetDistanceCallbackThreshold(),

weiterhin erreicht bleiben.

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

func (*DistanceUSBricklet) RegisterDistanceCallback(func(distance uint16)) (registrationId uint64)¶

Callback-Parameter:	distance – Typ: uint16, Wertebereich: [0 bis 212 - 1]
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 DistanceCallback Callback wird nur ausgelöst, wenn sich der Entfernungswert seit der letzten Auslösung geändert hat.

func (*DistanceUSBricklet) RegisterDistanceReachedCallback(func(distance uint16)) (registrationId uint64)¶

Callback-Parameter:	distance – Typ: uint16, Wertebereich: [0 bis 212 - 1]
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.

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

• distance_us_bricklet.FunctionSetDistanceCallbackPeriod = 2

• distance_us_bricklet.FunctionSetDistanceCallbackThreshold = 4

• distance_us_bricklet.FunctionSetDebouncePeriod = 6

• distance_us_bricklet.FunctionSetMovingAverage = 10

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

• distance_us_bricklet.FunctionSetDistanceCallbackPeriod = 2

• distance_us_bricklet.FunctionSetDistanceCallbackThreshold = 4

• distance_us_bricklet.FunctionSetDebouncePeriod = 6

• distance_us_bricklet.FunctionSetMovingAverage = 10

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

distance_us_bricklet.DeviceIdentifier¶

Diese Konstante wird verwendet um ein Distance US 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.

distance_us_bricklet.DeviceDisplayName¶

Diese Konstante stellt den Anzeigenamen eines Distance US Bricklet dar.