Go - Accelerometer Bricklet¶

Simple¶

Download (example_simple.go)

 1package main
 2
 3import (
 4    "fmt"
 5    "github.com/Tinkerforge/go-api-bindings/accelerometer_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 Accelerometer Bricklet.
11
12func main() {
13    ipcon := ipconnection.New()
14    defer ipcon.Close()
15    a, _ := accelerometer_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 acceleration.
22    x, y, z, _ := a.GetAcceleration()
23
24    fmt.Printf("Acceleration [X]: %f g\n", float64(x)/1000.0)
25    fmt.Printf("Acceleration [Y]: %f g\n", float64(y)/1000.0)
26    fmt.Printf("Acceleration [Z]: %f g\n", float64(z)/1000.0)
27
28    fmt.Print("Press enter to exit.")
29    fmt.Scanln()
30}

Callback¶

Download (example_callback.go)

 1package main
 2
 3import (
 4    "fmt"
 5    "github.com/Tinkerforge/go-api-bindings/accelerometer_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 Accelerometer Bricklet.
11
12func main() {
13    ipcon := ipconnection.New()
14    defer ipcon.Close()
15    a, _ := accelerometer_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    a.RegisterAccelerationCallback(func(x int16, y int16, z int16) {
22        fmt.Printf("Acceleration [X]: %f g\n", float64(x)/1000.0)
23        fmt.Printf("Acceleration [Y]: %f g\n", float64(y)/1000.0)
24        fmt.Printf("Acceleration [Z]: %f g\n", float64(z)/1000.0)
25        fmt.Println()
26    })
27
28    // Set period for acceleration receiver to 1s (1000ms).
29    // Note: The acceleration callback is only called every second
30    //       if the acceleration has changed since the last call!
31    a.SetAccelerationCallbackPeriod(1000)
32
33    fmt.Print("Press enter to exit.")
34    fmt.Scanln()
35}

Threshold¶

Download (example_threshold.go)

 1package main
 2
 3import (
 4    "fmt"
 5    "github.com/Tinkerforge/go-api-bindings/accelerometer_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 Accelerometer Bricklet.
11
12func main() {
13    ipcon := ipconnection.New()
14    defer ipcon.Close()
15    a, _ := accelerometer_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    a.SetDebouncePeriod(10000)
23
24    a.RegisterAccelerationReachedCallback(func(x int16, y int16, z int16) {
25        fmt.Printf("Acceleration [X]: %f g\n", float64(x)/1000.0)
26        fmt.Printf("Acceleration [Y]: %f g\n", float64(y)/1000.0)
27        fmt.Printf("Acceleration [Z]: %f g\n", float64(z)/1000.0)
28        fmt.Println()
29    })
30
31    // Configure threshold for acceleration "greater than 2 g, 2 g, 2 g".
32    a.SetAccelerationCallbackThreshold('>', 2*1000, 0, 2*1000, 0, 2*1000, 0)
33
34    fmt.Print("Press enter to exit.")
35    fmt.Scanln()
36}

Grundfunktionen¶

func accelerometer_bricklet.New(uid string, ipcon *IPConnection) (device AccelerometerBricklet, err error)¶

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

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.

func (*AccelerometerBricklet) GetAcceleration() (x int16, y int16, z int16, err error)¶

Rückgabe:	x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ? y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ? z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ? err – Typ: error

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.

func (*AccelerometerBricklet) GetTemperature() (temperature int16, err error)¶

Rückgabe:	temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-103 bis 152] err – Typ: error

Gibt die Temperatur des Beschleunigungssensors zurück.

func (*AccelerometerBricklet) LEDOn() (err error)¶

Rückgabe:	err – Typ: error

Aktiviert die LED auf dem Bricklet.

func (*AccelerometerBricklet) LEDOff() (err error)¶

Rückgabe:	err – Typ: error

Deaktiviert die LED auf dem Bricklet.

func (*AccelerometerBricklet) IsLEDOn() (on bool, err error)¶

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

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

Fortgeschrittene Funktionen¶

func (*AccelerometerBricklet) SetConfiguration(dataRate uint8, fullScale uint8, filterBandwidth uint8) (err error)¶

Parameter:	dataRate – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 6 fullScale – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1 filterBandwidth – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 2
Rückgabe:	err – Typ: error

Konfiguriert die Datenrate, den Wertebereich und die Filterbandbreite. Mögliche Konfigurationswerte sind:

• Datenrate zwischen 0Hz und 1600Hz.

• Wertebereich von ±2gₙ bis zu ±16gₙ.

• Filterbandbreite zwischen 50Hz und 800Hz.

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:

• accelerometer_bricklet.DataRateOff = 0

• accelerometer_bricklet.DataRate3Hz = 1

• accelerometer_bricklet.DataRate6Hz = 2

• accelerometer_bricklet.DataRate12Hz = 3

• accelerometer_bricklet.DataRate25Hz = 4

• accelerometer_bricklet.DataRate50Hz = 5

• accelerometer_bricklet.DataRate100Hz = 6

• accelerometer_bricklet.DataRate400Hz = 7

• accelerometer_bricklet.DataRate800Hz = 8

• accelerometer_bricklet.DataRate1600Hz = 9

Für fullScale:

• accelerometer_bricklet.FullScale2g = 0

• accelerometer_bricklet.FullScale4g = 1

• accelerometer_bricklet.FullScale6g = 2

• accelerometer_bricklet.FullScale8g = 3

• accelerometer_bricklet.FullScale16g = 4

Für filterBandwidth:

• accelerometer_bricklet.FilterBandwidth800Hz = 0

• accelerometer_bricklet.FilterBandwidth400Hz = 1

• accelerometer_bricklet.FilterBandwidth200Hz = 2

• accelerometer_bricklet.FilterBandwidth50Hz = 3

func (*AccelerometerBricklet) GetConfiguration() (dataRate uint8, fullScale uint8, filterBandwidth uint8, err error)¶

Rückgabe:	dataRate – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 6 fullScale – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1 filterBandwidth – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 2 err – Typ: error

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

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

Für dataRate:

• accelerometer_bricklet.DataRateOff = 0

• accelerometer_bricklet.DataRate3Hz = 1

• accelerometer_bricklet.DataRate6Hz = 2

• accelerometer_bricklet.DataRate12Hz = 3

• accelerometer_bricklet.DataRate25Hz = 4

• accelerometer_bricklet.DataRate50Hz = 5

• accelerometer_bricklet.DataRate100Hz = 6

• accelerometer_bricklet.DataRate400Hz = 7

• accelerometer_bricklet.DataRate800Hz = 8

• accelerometer_bricklet.DataRate1600Hz = 9

Für fullScale:

• accelerometer_bricklet.FullScale2g = 0

• accelerometer_bricklet.FullScale4g = 1

• accelerometer_bricklet.FullScale6g = 2

• accelerometer_bricklet.FullScale8g = 3

• accelerometer_bricklet.FullScale16g = 4

Für filterBandwidth:

• accelerometer_bricklet.FilterBandwidth800Hz = 0

• accelerometer_bricklet.FilterBandwidth400Hz = 1

• accelerometer_bricklet.FilterBandwidth200Hz = 2

• accelerometer_bricklet.FilterBandwidth50Hz = 3

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

func (*AccelerometerBricklet) GetAccelerationCallbackPeriod() (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 SetAccelerationCallbackPeriod() gesetzt.

func (*AccelerometerBricklet) SetAccelerationCallbackThreshold(option rune, minX int16, maxX int16, minY int16, maxY int16, minZ int16, maxZ int16) (err error)¶

Parameter:

option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxX – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 minY – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxY – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 minZ – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxZ – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Rückgabe:

err – Typ: error

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:

• accelerometer_bricklet.ThresholdOptionOff = 'x'

• accelerometer_bricklet.ThresholdOptionOutside = 'o'

• accelerometer_bricklet.ThresholdOptionInside = 'i'

• accelerometer_bricklet.ThresholdOptionSmaller = '<'

• accelerometer_bricklet.ThresholdOptionGreater = '>'

func (*AccelerometerBricklet) GetAccelerationCallbackThreshold() (option rune, minX int16, maxX int16, minY int16, maxY int16, minZ int16, maxZ int16, err error)¶

Rückgabe:

option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' minX – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxX – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 minY – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxY – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 minZ – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 maxZ – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 err – Typ: error

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

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

Für option:

• accelerometer_bricklet.ThresholdOptionOff = 'x'

• accelerometer_bricklet.ThresholdOptionOutside = 'o'

• accelerometer_bricklet.ThresholdOptionInside = 'i'

• accelerometer_bricklet.ThresholdOptionSmaller = '<'

• accelerometer_bricklet.ThresholdOptionGreater = '>'

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

• AccelerationReachedCallback

ausgelöst wird, wenn der Schwellwert

• SetAccelerationCallbackThreshold()

weiterhin erreicht bleibt.

func (*AccelerometerBricklet) 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 (*AccelerometerBricklet) RegisterAccelerationCallback(func(x int16, y int16, z int16)) (registrationId uint64)¶

Callback-Parameter:	x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ? y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ? z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ?
Rückgabe:	registrationId – Typ: uint64

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.

func (*AccelerometerBricklet) RegisterAccelerationReachedCallback(func(x int16, y int16, z int16)) (registrationId uint64)¶

Callback-Parameter:	x – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ? y – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ? z – Typ: int16, Einheit: 1/1000 gₙ, Wertebereich: ?
Rückgabe:	registrationId – Typ: uint64

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¶

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

• accelerometer_bricklet.FunctionSetAccelerationCallbackPeriod = 2

• accelerometer_bricklet.FunctionSetAccelerationCallbackThreshold = 4

• accelerometer_bricklet.FunctionSetDebouncePeriod = 6

• accelerometer_bricklet.FunctionSetConfiguration = 9

• accelerometer_bricklet.FunctionLEDOn = 11

• accelerometer_bricklet.FunctionLEDOff = 12

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

• accelerometer_bricklet.FunctionSetAccelerationCallbackPeriod = 2

• accelerometer_bricklet.FunctionSetAccelerationCallbackThreshold = 4

• accelerometer_bricklet.FunctionSetDebouncePeriod = 6

• accelerometer_bricklet.FunctionSetConfiguration = 9

• accelerometer_bricklet.FunctionLEDOn = 11

• accelerometer_bricklet.FunctionLEDOff = 12

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

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.