Dies ist die Beschreibung der Go API Bindings für das Accelerometer Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer 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.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/accelerometer_bricklet"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Accelerometer Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
a, _ := accelerometer_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
// Get current acceleration.
x, y, z, _ := a.GetAcceleration()
fmt.Printf("Acceleration [X]: %f g\n", float64(x)/1000.0)
fmt.Printf("Acceleration [Y]: %f g\n", float64(y)/1000.0)
fmt.Printf("Acceleration [Z]: %f g\n", float64(z)/1000.0)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/accelerometer_bricklet"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Accelerometer Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
a, _ := accelerometer_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
a.RegisterAccelerationCallback(func(x int16, y int16, z int16) {
fmt.Printf("Acceleration [X]: %f g\n", float64(x)/1000.0)
fmt.Printf("Acceleration [Y]: %f g\n", float64(y)/1000.0)
fmt.Printf("Acceleration [Z]: %f g\n", float64(z)/1000.0)
fmt.Println()
})
// Set period for acceleration receiver to 1s (1000ms).
// Note: The acceleration callback is only called every second
// if the acceleration has changed since the last call!
a.SetAccelerationCallbackPeriod(1000)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/accelerometer_bricklet"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Accelerometer Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
a, _ := accelerometer_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
// Get threshold receivers with a debounce time of 10 seconds (10000ms).
a.SetDebouncePeriod(10000)
a.RegisterAccelerationReachedCallback(func(x int16, y int16, z int16) {
fmt.Printf("Acceleration [X]: %f g\n", float64(x)/1000.0)
fmt.Printf("Acceleration [Y]: %f g\n", float64(y)/1000.0)
fmt.Printf("Acceleration [Z]: %f g\n", float64(z)/1000.0)
fmt.Println()
})
// Configure threshold for acceleration "greater than 2 g, 2 g, 2 g".
a.SetAccelerationCallbackThreshold('>', 2*1000, 0, 2*1000, 0, 2*1000, 0)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Die API des Accelerometer Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/accelerometer_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:
welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
accelerometer_bricklet.
New
(uid string, ipcon *IPConnection) (device AccelerometerBricklet, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues AccelerometerBricklet
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IPConnection ipcon
hinzu:
device, err := accelerometer_bricklet.New("YOUR_DEVICE_UID", &ipcon)
Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.
(*AccelerometerBricklet)
GetAcceleration
() (x int16, y int16, z int16, err error)¶Rückgabe: |
|
---|
Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte
haben die Einheit gₙ/1000 (1gₙ = 9,80665m/s²). Der Wertebereich
wird mit SetConfiguration()
konfiguriert.
Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen
den AccelerationCallback
Callback zu nutzen und die Periode mit
SetAccelerationCallbackPeriod()
vorzugeben.
(*AccelerometerBricklet)
GetTemperature
() (temperature int16, err error)¶Rückgabe: |
|
---|
Gibt die Temperatur des Beschleunigungssensors zurück.
(*AccelerometerBricklet)
LEDOn
() (err error)¶Rückgabe: |
|
---|
Aktiviert die LED auf dem Bricklet.
(*AccelerometerBricklet)
LEDOff
() (err error)¶Rückgabe: |
|
---|
Deaktiviert die LED auf dem Bricklet.
(*AccelerometerBricklet)
IsLEDOn
() (on bool, err error)¶Rückgabe: |
|
---|
Gibt true zurück wenn die LED aktiviert ist, false sonst.
(*AccelerometerBricklet)
SetConfiguration
(dataRate uint8, fullScale uint8, filterBandwidth uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Konfiguriert die Datenrate, den Wertebereich und die Filterbandbreite. Mögliche Konfigurationswerte sind:
Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für dataRate:
Für fullScale:
Für filterBandwidth:
(*AccelerometerBricklet)
GetConfiguration
() (dataRate uint8, fullScale uint8, filterBandwidth uint8, err error)¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für dataRate:
Für fullScale:
Für filterBandwidth:
(*AccelerometerBricklet)
GetIdentity
() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶Rückgabe: |
|
---|
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.
(*AccelerometerBricklet)
SetAccelerationCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der AccelerationCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der AccelerationCallback
Callback wird nur ausgelöst, wenn sich die Acceleration
seit der letzten Auslösung geändert hat.
(*AccelerometerBricklet)
GetAccelerationCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAccelerationCallbackPeriod()
gesetzt.
(*AccelerometerBricklet)
SetAccelerationCallbackThreshold
(option rune, minX int16, maxX int16, minY int16, maxY int16, minZ int16, maxZ int16) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den AccelerationReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Beschleunigung außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Beschleunigung innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Beschleunigung kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Beschleunigung größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*AccelerometerBricklet)
GetAccelerationCallbackThreshold
() (option rune, minX int16, maxX int16, minY int16, maxY int16, minZ int16, maxZ int16, err error)¶Rückgabe: |
|
---|
Gibt den Schwellwert zurück, wie von SetAccelerationCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*AccelerometerBricklet)
SetDebouncePeriod
(debounce uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher die Schwellwert Callback
ausgelöst wird, wenn der Schwellwert
weiterhin erreicht bleibt.
(*AccelerometerBricklet)
GetDebouncePeriod
() (debounce uint32, err error)¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
gesetzt.
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.
(*AccelerometerBricklet)
RegisterAccelerationCallback
(func(x int16, y int16, z int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetAccelerationCallbackPeriod()
, ausgelöst. Die Parameter des Callbacks
sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich
wird mit SetConfiguration()
konfiguriert.
Der AccelerationCallback
Callback wird nur ausgelöst, wenn sich die Beschleunigung
seit der letzten Auslösung geändert hat.
(*AccelerometerBricklet)
RegisterAccelerationReachedCallback
(func(x int16, y int16, z int16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetAccelerationCallbackThreshold()
gesetzt, erreicht wird.
Die Parameter des Callbacks sind die Beschleunigungen der X-, Y- und Z-Achse. Der Wertebereich
wird mit SetConfiguration()
konfiguriert.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
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.
(*AccelerometerBricklet)
GetAPIVersion
() (apiVersion [3]uint8, err error)¶Rückgabe: |
|
---|
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.
(*AccelerometerBricklet)
GetResponseExpected
(functionId uint8) (responseExpected bool, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
(*AccelerometerBricklet)
SetResponseExpected
(functionId uint8, responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ä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:
(*AccelerometerBricklet)
SetResponseExpectedAll
(responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
accelerometer_bricklet.
DeviceIdentifier
¶Diese Konstante wird verwendet um ein Accelerometer 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.
accelerometer_bricklet.
DeviceDisplayName
¶Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet dar.