Dies ist die Beschreibung der Go API Bindings für das Color Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Color 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 31 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/color_bricklet"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Color Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
c, _ := color_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 color.
r, g, b, c_, _ := c.GetColor()
fmt.Printf("Color [R]: %d\n", r)
fmt.Printf("Color [G]: %d\n", g)
fmt.Printf("Color [B]: %d\n", b)
fmt.Printf("Color [C]: %d\n", c_)
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 36 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/color_bricklet"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Color Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
c, _ := color_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
c.RegisterColorCallback(func(r uint16, g uint16, b uint16, c uint16) {
fmt.Printf("Color [R]: %d\n", r)
fmt.Printf("Color [G]: %d\n", g)
fmt.Printf("Color [B]: %d\n", b)
fmt.Printf("Color [C]: %d\n", c)
fmt.Println()
})
// Set period for color receiver to 1s (1000ms).
// Note: The color callback is only called every second
// if the color has changed since the last call!
c.SetColorCallbackPeriod(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 37 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/color_bricklet"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Color Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
c, _ := color_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).
c.SetDebouncePeriod(10000)
c.RegisterColorReachedCallback(func(r uint16, g uint16, b uint16, c uint16) {
fmt.Printf("Color [R]: %d\n", r)
fmt.Printf("Color [G]: %d\n", g)
fmt.Printf("Color [B]: %d\n", b)
fmt.Printf("Color [C]: %d\n", c)
fmt.Println()
})
// Configure threshold for color "greater than 100, 200, 300, 400".
c.SetColorCallbackThreshold('>', 100, 0, 200, 0, 300, 0, 400, 0)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Die API des Color Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/color_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.
color_bricklet.
New
(uid string, ipcon *IPConnection) (device ColorBricklet, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues ColorBricklet
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IPConnection ipcon
hinzu:
device, err := color_bricklet.New("YOUR_DEVICE_UID", &ipcon)
Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.
(*ColorBricklet)
GetColor
() (r uint16, g uint16, b uint16, c uint16, err error)¶Rückgabe: |
|
---|
Gibt die gemessene Farbe des Sensors zurück.
Die rot (r), grün (g), blau (b) und clear (c) werden mit vier unterschiedlichen Fotodioden gemessen. Diese sind Empfindlich in unterschiedlichen Wellenlängen:
Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen
den ColorCallback
Callback zu nutzen und die Periode mit
SetColorCallbackPeriod()
vorzugeben.
(*ColorBricklet)
LightOn
() (err error)¶Rückgabe: |
|
---|
Aktiviert die LED.
(*ColorBricklet)
LightOff
() (err error)¶Rückgabe: |
|
---|
Deaktiviert die LED.
(*ColorBricklet)
IsLightOn
() (light uint8, err error)¶Rückgabe: |
|
---|
Gibt den Zustand der LED zurück. Mögliche Werte sind:
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für light:
(*ColorBricklet)
SetConfig
(gain uint8, integrationTime uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Konfiguration des Sensors. Verstärkung und Integrationszeit können eingestellt werden.
Für die Konfiguration der Verstärkung:
Für die Konfiguration der Integrationszeit:
Eine Erhöhung der Verstärkung ermöglicht es dem Sensor Farben aus größeren Entfernungen zu erkennen.
Die Integrationszeit ist ein Trade-off zwischen Konvertierungszeit und Genauigkeit. Mit einer höheren Integrationszeit werden die Werte genauer, es dauert allerdings länger bis ein Resultat bereitsteht.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für gain:
Für integrationTime:
(*ColorBricklet)
GetConfig
() (gain uint8, integrationTime uint8, err error)¶Rückgabe: |
|
---|
Gibt die Einstellungen zurück, wie von SetConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für gain:
Für integrationTime:
(*ColorBricklet)
GetIlluminance
() (illuminance uint32, err error)¶Rückgabe: |
|
---|
Gibt die Beleuchtungsstärke beeinflusst durch die Verstärkung und die
Integrationszeit zurück. Verstärkung und Integrationszeit können mit
SetConfig()
eingestellt werden. Um die Beleuchtungsstärke in Lux zu
ermitteln muss folgende Formel angewendet werden:
lux = illuminance * 700 / gain / integration_time
Für eine korrekte Messung der Beleuchtungsstärke muss sichergestellt
sein, dass die Farbwerte (R, G oder B) nicht saturiert sind. Ein
Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall
kann die Verstärkung per SetConfig()
reduziert werden.
(*ColorBricklet)
GetColorTemperature
() (colorTemperature uint16, err error)¶Rückgabe: |
|
---|
Gibt die Farbtemperatur zurück.
Für eine korrekte Messung der Farbtemperatur muss sichergestellt
sein das die Farbwerte (R, G oder B) nicht saturiert sind. Ein
Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall
kann die Verstärkung per SetConfig()
reduziert werden.
(*ColorBricklet)
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.
(*ColorBricklet)
SetColorCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der ColorCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der ColorCallback
Callback wird nur ausgelöst, wenn sich die Color seit der
letzten Auslösung geändert hat.
(*ColorBricklet)
GetColorCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetColorCallbackPeriod()
gesetzt.
(*ColorBricklet)
SetColorCallbackThreshold
(option rune, minR uint16, maxR uint16, minG uint16, maxG uint16, minB uint16, maxB uint16, minC uint16, maxC uint16) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den ColorReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Temperatur größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*ColorBricklet)
GetColorCallbackThreshold
() (option rune, minR uint16, maxR uint16, minG uint16, maxG uint16, minB uint16, maxB uint16, minC uint16, maxC uint16, err error)¶Rückgabe: |
|
---|
Gibt den Schwellwert zurück, wie von SetColorCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*ColorBricklet)
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.
(*ColorBricklet)
GetDebouncePeriod
() (debounce uint32, err error)¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
gesetzt.
(*ColorBricklet)
SetIlluminanceCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der IlluminanceCallback
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der IlluminanceCallback
Callback wird nur ausgelöst, wenn sich die
Beleuchtungsstärke seit der letzten Auslösung geändert hat.
(*ColorBricklet)
GetIlluminanceCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetIlluminanceCallbackPeriod()
gesetzt.
(*ColorBricklet)
SetColorTemperatureCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der ColorTemperatureCallback
Callback
ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.
Der ColorTemperatureCallback
Callback wird nur ausgelöst, wenn sich die
Farbtemperatur seit der letzten Auslösung geändert hat.
(*ColorBricklet)
GetColorTemperatureCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetColorTemperatureCallbackPeriod()
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.
(*ColorBricklet)
RegisterColorCallback
(func(r uint16, g uint16, b uint16, c uint16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit SetColorCallbackPeriod()
,
ausgelöst. Der Parameter des Callbacks ist die Farbe des Sensors als RGBC.
Der ColorCallback
Callback wird nur ausgelöst, wenn sich die Farbe seit der
letzten Auslösung geändert hat.
(*ColorBricklet)
RegisterColorReachedCallback
(func(r uint16, g uint16, b uint16, c uint16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetColorCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter des Callbacks ist die Farbe des Sensors als RGBC.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
(*ColorBricklet)
RegisterIlluminanceCallback
(func(illuminance uint32)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit SetIlluminanceCallbackPeriod()
,
ausgelöst. Der Parameter des Callbacks ist die Beleuchtungsstärke des Sensors.
Siehe GetIlluminance()
für eine Erklärung wie dieser zu interpretieren ist.
Der IlluminanceCallback
Callback wird nur ausgelöst, wenn sich die
Beleuchtungsstärke seit der letzten Auslösung geändert hat.
(*ColorBricklet)
RegisterColorTemperatureCallback
(func(colorTemperature uint16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit
SetColorTemperatureCallbackPeriod()
, ausgelöst. Der Parameter des Callbacks
ist die Farbtemperatur des Sensors.
Der ColorTemperatureCallback
Callback wird nur ausgelöst, wenn sich die
Farbtemperatur seit der letzten Auslösung geändert hat.
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.
(*ColorBricklet)
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.
(*ColorBricklet)
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:
(*ColorBricklet)
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:
(*ColorBricklet)
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.
color_bricklet.
DeviceIdentifier
¶Diese Konstante wird verwendet um ein Color 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.
color_bricklet.
DeviceDisplayName
¶Diese Konstante stellt den Anzeigenamen eines Color Bricklet dar.