Go - Color Bricklet 2.0

Dies ist die Beschreibung der Go API Bindings für das Color Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Color Bricklet 2.0 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_v2_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 2.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    c, _ := color_v2_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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/color_v2_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 2.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    c, _ := color_v2_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 callback to 0.1s (100ms).
    c.SetColorCallbackConfiguration(100, false)

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

API

Die API des Color Bricklet 2.0 ist im Package github.com/Tinkerforge/go-api-bindings/color_v2_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_v2_bricklet.New(uid string, ipcon *IPConnection) (device ColorV2Bricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: ColorV2Bricklet
  • err – Typ: error

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

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

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden wurde (siehe Beispiele oben).

func (*ColorV2Bricklet) 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) Farbanteile 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 SetColorCallbackConfiguration() vorzugeben.

func (*ColorV2Bricklet) 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 SetConfiguration() 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 SetConfiguration() reduziert werden.

Wenn der Wert periodisch benötigt wird, kann auch der RegisterIlluminanceCallback Callback verwendet werden. Der Callback wird mit der Funktion SetIlluminanceCallbackConfiguration() konfiguriert.

func (*ColorV2Bricklet) 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, 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 SetConfiguration() reduziert werden.

Wenn der Wert periodisch benötigt wird, kann auch der RegisterColorTemperatureCallback Callback verwendet werden. Der Callback wird mit der Funktion SetColorTemperatureCallbackConfiguration() konfiguriert.

func (*ColorV2Bricklet) SetLight(enable bool) (err error)
Parameter:
  • enable – Typ: bool, Standardwert: false
Rückgabe:
  • err – Typ: error

Aktiviert/deaktiviert die weiße LED auf dem Bricklet.

func (*ColorV2Bricklet) GetLight() (enable bool, err error)
Rückgabe:
  • enable – Typ: bool, Standardwert: false
  • err – Typ: error

Gibt den Wert zurück, wie von SetLight() gesetzt.

func (*ColorV2Bricklet) SetConfiguration(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_v2_bricklet.Gain1x = 0
  • color_v2_bricklet.Gain4x = 1
  • color_v2_bricklet.Gain16x = 2
  • color_v2_bricklet.Gain60x = 3

Für integrationTime:

  • color_v2_bricklet.IntegrationTime2ms = 0
  • color_v2_bricklet.IntegrationTime24ms = 1
  • color_v2_bricklet.IntegrationTime101ms = 2
  • color_v2_bricklet.IntegrationTime154ms = 3
  • color_v2_bricklet.IntegrationTime700ms = 4
func (*ColorV2Bricklet) GetConfiguration() (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 SetConfiguration() gesetzt.

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

Für gain:

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

Für integrationTime:

  • color_v2_bricklet.IntegrationTime2ms = 0
  • color_v2_bricklet.IntegrationTime24ms = 1
  • color_v2_bricklet.IntegrationTime101ms = 2
  • color_v2_bricklet.IntegrationTime154ms = 3
  • color_v2_bricklet.IntegrationTime700ms = 4

Fortgeschrittene Funktionen

func (*ColorV2Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
Rückgabe:
  • errorCountAckChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

func (*ColorV2Bricklet) SetBootloaderMode(mode uint8) (status uint8, err error)
Parameter:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

  • color_v2_bricklet.BootloaderModeBootloader = 0
  • color_v2_bricklet.BootloaderModeFirmware = 1
  • color_v2_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • color_v2_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • color_v2_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

Für status:

  • color_v2_bricklet.BootloaderStatusOK = 0
  • color_v2_bricklet.BootloaderStatusInvalidMode = 1
  • color_v2_bricklet.BootloaderStatusNoChange = 2
  • color_v2_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • color_v2_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • color_v2_bricklet.BootloaderStatusCRCMismatch = 5
func (*ColorV2Bricklet) GetBootloaderMode() (mode uint8, err error)
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

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

Für mode:

  • color_v2_bricklet.BootloaderModeBootloader = 0
  • color_v2_bricklet.BootloaderModeFirmware = 1
  • color_v2_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • color_v2_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • color_v2_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*ColorV2Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
Parameter:
  • pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

Setzt den Firmware-Pointer für WriteFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

func (*ColorV2Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
Parameter:
  • data – Typ: [64]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Schreibt 64 Bytes Firmware an die Position die vorher von SetWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

func (*ColorV2Bricklet) SetStatusLEDConfig(config uint8) (err error)
Parameter:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

  • color_v2_bricklet.StatusLEDConfigOff = 0
  • color_v2_bricklet.StatusLEDConfigOn = 1
  • color_v2_bricklet.StatusLEDConfigShowHeartbeat = 2
  • color_v2_bricklet.StatusLEDConfigShowStatus = 3
func (*ColorV2Bricklet) GetStatusLEDConfig() (config uint8, err error)
Rückgabe:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

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

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

Für config:

  • color_v2_bricklet.StatusLEDConfigOff = 0
  • color_v2_bricklet.StatusLEDConfigOn = 1
  • color_v2_bricklet.StatusLEDConfigShowHeartbeat = 2
  • color_v2_bricklet.StatusLEDConfigShowStatus = 3
func (*ColorV2Bricklet) GetChipTemperature() (temperature int16, err error)
Rückgabe:
  • temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
  • err – Typ: error

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

func (*ColorV2Bricklet) Reset() (err error)
Rückgabe:
  • err – Typ: error

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

func (*ColorV2Bricklet) WriteUID(uid uint32) (err error)
Parameter:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: error

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

func (*ColorV2Bricklet) ReadUID() (uid uint32, err error)
Rückgabe:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

func (*ColorV2Bricklet) 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 (*ColorV2Bricklet) SetColorCallbackConfiguration(period uint32, valueHasToChange bool) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
Rückgabe:
  • err – Typ: error

Die Periode ist die Periode mit der der RegisterColorCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

func (*ColorV2Bricklet) GetColorCallbackConfiguration() (period uint32, valueHasToChange bool, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetColorCallbackConfiguration() gesetzt.

func (*ColorV2Bricklet) SetIlluminanceCallbackConfiguration(period uint32, valueHasToChange bool, option rune, min uint32, max uint32) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: uint32, Einheit: ? lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • max – Typ: uint32, Einheit: ? lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

Die Periode ist die Periode mit der der RegisterIlluminanceCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den RegisterIlluminanceCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • color_v2_bricklet.ThresholdOptionOff = 'x'
  • color_v2_bricklet.ThresholdOptionOutside = 'o'
  • color_v2_bricklet.ThresholdOptionInside = 'i'
  • color_v2_bricklet.ThresholdOptionSmaller = '<'
  • color_v2_bricklet.ThresholdOptionGreater = '>'
func (*ColorV2Bricklet) GetIlluminanceCallbackConfiguration() (period uint32, valueHasToChange bool, option rune, min uint32, max uint32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: uint32, Einheit: ? lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • max – Typ: uint32, Einheit: ? lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetIlluminanceCallbackConfiguration() gesetzt.

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

Für option:

  • color_v2_bricklet.ThresholdOptionOff = 'x'
  • color_v2_bricklet.ThresholdOptionOutside = 'o'
  • color_v2_bricklet.ThresholdOptionInside = 'i'
  • color_v2_bricklet.ThresholdOptionSmaller = '<'
  • color_v2_bricklet.ThresholdOptionGreater = '>'
func (*ColorV2Bricklet) SetColorTemperatureCallbackConfiguration(period uint32, valueHasToChange bool, option rune, min uint16, max uint16) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: uint16, Einheit: 1 K, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Einheit: 1 K, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

Die Periode ist die Periode mit der der RegisterColorTemperatureCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den RegisterColorTemperatureCallback Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • color_v2_bricklet.ThresholdOptionOff = 'x'
  • color_v2_bricklet.ThresholdOptionOutside = 'o'
  • color_v2_bricklet.ThresholdOptionInside = 'i'
  • color_v2_bricklet.ThresholdOptionSmaller = '<'
  • color_v2_bricklet.ThresholdOptionGreater = '>'
func (*ColorV2Bricklet) GetColorTemperatureCallbackConfiguration() (period uint32, valueHasToChange bool, option rune, min uint16, max uint16, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: uint16, Einheit: 1 K, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Einheit: 1 K, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetColorTemperatureCallbackConfiguration() gesetzt.

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

Für option:

  • color_v2_bricklet.ThresholdOptionOff = 'x'
  • color_v2_bricklet.ThresholdOptionOutside = 'o'
  • color_v2_bricklet.ThresholdOptionInside = 'i'
  • color_v2_bricklet.ThresholdOptionSmaller = '<'
  • color_v2_bricklet.ThresholdOptionGreater = '>'

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 (*ColorV2Bricklet) 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 SetColorCallbackConfiguration(), 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 (*ColorV2Bricklet) 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 periodisch ausgelöst abhängig von der mittels SetIlluminanceCallbackConfiguration() gesetzten Konfiguration

Der Parameter des Callbacks ist der gleiche wie GetIlluminance().

func (*ColorV2Bricklet) 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 periodisch ausgelöst abhängig von der mittels SetColorTemperatureCallbackConfiguration() gesetzten Konfiguration

Der Parameter des Callbacks ist der gleiche wie GetColorTemperature().

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 (*ColorV2Bricklet) 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 (*ColorV2Bricklet) 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_v2_bricklet.FunctionSetColorCallbackConfiguration = 2
  • color_v2_bricklet.FunctionSetIlluminanceCallbackConfiguration = 6
  • color_v2_bricklet.FunctionSetColorTemperatureCallbackConfiguration = 10
  • color_v2_bricklet.FunctionSetLight = 13
  • color_v2_bricklet.FunctionSetConfiguration = 15
  • color_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
  • color_v2_bricklet.FunctionSetStatusLEDConfig = 239
  • color_v2_bricklet.FunctionReset = 243
  • color_v2_bricklet.FunctionWriteUID = 248
func (*ColorV2Bricklet) 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_v2_bricklet.FunctionSetColorCallbackConfiguration = 2
  • color_v2_bricklet.FunctionSetIlluminanceCallbackConfiguration = 6
  • color_v2_bricklet.FunctionSetColorTemperatureCallbackConfiguration = 10
  • color_v2_bricklet.FunctionSetLight = 13
  • color_v2_bricklet.FunctionSetConfiguration = 15
  • color_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
  • color_v2_bricklet.FunctionSetStatusLEDConfig = 239
  • color_v2_bricklet.FunctionReset = 243
  • color_v2_bricklet.FunctionWriteUID = 248
func (*ColorV2Bricklet) 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_v2_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein Color Bricklet 2.0 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_v2_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Color Bricklet 2.0 dar.