Go - Color Bricklet

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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.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
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]: \n", r)
    fmt.Printf("Color [G]: \n", g)
    fmt.Printf("Color [B]: \n", b)
    fmt.Printf("Color [C]: \n", c_)

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

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
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()
}

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
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()
}

API

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:

  • ipconnection.DeviceErrorSuccess = 0
  • ipconnection.DeviceErrorInvalidParameter = 1
  • ipconnection.DeviceErrorFunctionNotSupported = 2
  • ipconnection.DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func color_bricklet.New(uid string, ipcon *IPConnection) (device ColorBricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: ColorBricklet
  • err – Typ: error

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 wurde (siehe Beispiele oben).

func (*ColorBricklet) GetColor() (r uint16, g uint16, b uint16, c uint16, err error)
Rückgabe:
  • r – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • g – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • b – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • c – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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:

Chart Responsivity / Wavelength

Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen den RegisterColorCallback Callback zu nutzen und die Periode mit SetColorCallbackPeriod() vorzugeben.

func (*ColorBricklet) LightOn() (err error)
Rückgabe:
  • err – Typ: error

Aktiviert die LED.

func (*ColorBricklet) LightOff() (err error)
Rückgabe:
  • err – Typ: error

Deaktiviert die LED.

func (*ColorBricklet) IsLightOn() (light uint8, err error)
Rückgabe:
  • light – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • err – Typ: error

Gibt den Zustand der LED zurück. Mögliche Werte sind:

  • 0: On
  • 1: Off

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

Für light:

  • color_bricklet.LightOn = 0
  • color_bricklet.LightOff = 1
func (*ColorBricklet) SetConfig(gain uint8, integrationTime uint8) (err error)
Parameter:
  • gain – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • integrationTime – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

Setzt die Konfiguration des Sensors. Verstärkung und Integrationszeit können eingestellt werden.

Für die Konfiguration der Verstärkung:

  • 0: 1x Gain
  • 1: 4x Gain
  • 2: 16x Gain
  • 3: 60x Gain

Für die Konfiguration der Integrationszeit:

  • 0: 2,4ms
  • 1: 24ms
  • 2: 101ms
  • 3: 154ms
  • 4: 700ms

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:

  • color_bricklet.Gain1x = 0
  • color_bricklet.Gain4x = 1
  • color_bricklet.Gain16x = 2
  • color_bricklet.Gain60x = 3

Für integrationTime:

  • color_bricklet.IntegrationTime2ms = 0
  • color_bricklet.IntegrationTime24ms = 1
  • color_bricklet.IntegrationTime101ms = 2
  • color_bricklet.IntegrationTime154ms = 3
  • color_bricklet.IntegrationTime700ms = 4
func (*ColorBricklet) GetConfig() (gain uint8, integrationTime uint8, err error)
Rückgabe:
  • gain – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • integrationTime – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

Gibt die Einstellungen zurück, wie von SetConfig() gesetzt.

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

Für gain:

  • color_bricklet.Gain1x = 0
  • color_bricklet.Gain4x = 1
  • color_bricklet.Gain16x = 2
  • color_bricklet.Gain60x = 3

Für integrationTime:

  • color_bricklet.IntegrationTime2ms = 0
  • color_bricklet.IntegrationTime24ms = 1
  • color_bricklet.IntegrationTime101ms = 2
  • color_bricklet.IntegrationTime154ms = 3
  • color_bricklet.IntegrationTime700ms = 4
func (*ColorBricklet) GetIlluminance() (illuminance uint32, err error)
Rückgabe:
  • illuminance – Typ: uint32, Einheit: ? lx, Wertebereich: [0 bis 103438]
  • err – Typ: error

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.

func (*ColorBricklet) GetColorTemperature() (colorTemperature uint16, err error)
Rückgabe:
  • colorTemperature – Typ: uint16, Einheit: 1 K, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

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.

Fortgeschrittene Funktionen

func (*ColorBricklet) 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', 'i', '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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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 (*ColorBricklet) SetColorCallbackPeriod(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 RegisterColorCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

func (*ColorBricklet) GetColorCallbackPeriod() (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 SetColorCallbackPeriod() gesetzt.

func (*ColorBricklet) SetColorCallbackThreshold(option rune, minR uint16, maxR uint16, minG uint16, maxG uint16, minB uint16, maxB uint16, minC uint16, maxC uint16) (err error)
Parameter:
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • minR – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxR – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minG – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxG – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minB – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxB – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minC – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxC – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

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

  • color_bricklet.ThresholdOptionOff = 'x'
  • color_bricklet.ThresholdOptionOutside = 'o'
  • color_bricklet.ThresholdOptionInside = 'i'
  • color_bricklet.ThresholdOptionSmaller = '<'
  • color_bricklet.ThresholdOptionGreater = '>'
func (*ColorBricklet) GetColorCallbackThreshold() (option rune, minR uint16, maxR uint16, minG uint16, maxG uint16, minB uint16, maxB uint16, minC uint16, maxC uint16, err error)
Rückgabe:
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • minR – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxR – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minG – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxG – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minB – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxB – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minC – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxC – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • err – Typ: error

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

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

Für option:

  • color_bricklet.ThresholdOptionOff = 'x'
  • color_bricklet.ThresholdOptionOutside = 'o'
  • color_bricklet.ThresholdOptionInside = 'i'
  • color_bricklet.ThresholdOptionSmaller = '<'
  • color_bricklet.ThresholdOptionGreater = '>'
func (*ColorBricklet) 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

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

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

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

Der RegisterIlluminanceCallback Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

func (*ColorBricklet) GetIlluminanceCallbackPeriod() (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 SetIlluminanceCallbackPeriod() gesetzt.

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

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

func (*ColorBricklet) GetColorTemperatureCallbackPeriod() (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 SetColorTemperatureCallbackPeriod() 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.

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.

func (*ColorBricklet) RegisterColorCallback(func(r uint16, g uint16, b uint16, c uint16)) (registrationId uint64)
Callback-Parameter:
  • r – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • g – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • b – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • c – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetColorCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist die Farbe des Sensors als RGBC.

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

func (*ColorBricklet) RegisterColorReachedCallback(func(r uint16, g uint16, b uint16, c uint16)) (registrationId uint64)
Callback-Parameter:
  • r – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • g – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • b – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • c – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

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.

func (*ColorBricklet) RegisterIlluminanceCallback(func(illuminance uint32)) (registrationId uint64)
Callback-Parameter:
  • illuminance – Typ: uint32, Einheit: ? lx, Wertebereich: [0 bis 103438]
Rückgabe:
  • registrationId – Typ: uint64

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 RegisterIlluminanceCallback Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

func (*ColorBricklet) RegisterColorTemperatureCallback(func(colorTemperature uint16)) (registrationId uint64)
Callback-Parameter:
  • colorTemperature – Typ: uint16, Einheit: 1 K, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetColorTemperatureCallbackPeriod(), ausgelöst. Der Parameter des Callbacks ist die Farbtemperatur des Sensors.

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

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

  • color_bricklet.FunctionSetColorCallbackPeriod = 2
  • color_bricklet.FunctionSetColorCallbackThreshold = 4
  • color_bricklet.FunctionSetDebouncePeriod = 6
  • color_bricklet.FunctionLightOn = 10
  • color_bricklet.FunctionLightOff = 11
  • color_bricklet.FunctionSetConfig = 13
  • color_bricklet.FunctionSetIlluminanceCallbackPeriod = 17
  • color_bricklet.FunctionSetColorTemperatureCallbackPeriod = 19
func (*ColorBricklet) 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:

  • color_bricklet.FunctionSetColorCallbackPeriod = 2
  • color_bricklet.FunctionSetColorCallbackThreshold = 4
  • color_bricklet.FunctionSetDebouncePeriod = 6
  • color_bricklet.FunctionLightOn = 10
  • color_bricklet.FunctionLightOff = 11
  • color_bricklet.FunctionSetConfig = 13
  • color_bricklet.FunctionSetIlluminanceCallbackPeriod = 17
  • color_bricklet.FunctionSetColorTemperatureCallbackPeriod = 19
func (*ColorBricklet) 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

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.