Dies ist die Beschreibung der Go API Bindings für das Ambient Light Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Ambient Light 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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ambient_light_bricklet"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Ambient Light Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
al, _ := ambient_light_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 illuminance.
illuminance, _ := al.GetIlluminance()
fmt.Printf("Illuminance: %f lx\n", float64(illuminance)/10.0)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Download (example_callback.go)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ambient_light_bricklet"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Ambient Light Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
al, _ := ambient_light_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
al.RegisterIlluminanceCallback(func(illuminance uint16) {
fmt.Printf("Illuminance: %f lx\n", float64(illuminance)/10.0)
})
// Set period for illuminance receiver to 1s (1000ms).
// Note: The illuminance callback is only called every second
// if the illuminance has changed since the last call!
al.SetIlluminanceCallbackPeriod(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 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ambient_light_bricklet"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
)
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Ambient Light Bricklet.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
al, _ := ambient_light_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).
al.SetDebouncePeriod(10000)
al.RegisterIlluminanceReachedCallback(func(illuminance uint16) {
fmt.Printf("Illuminance: %f lx\n", float64(illuminance)/10.0)
fmt.Println("Too bright, close the curtains!")
})
// Configure threshold for illuminance "greater than 200 lx".
al.SetIlluminanceCallbackThreshold('>', 200*10, 0)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Die API des Ambient Light Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/ambient_light_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.
ambient_light_bricklet.
New
(uid string, ipcon *IPConnection) (device AmbientLightBricklet, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues AmbientLightBricklet
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IPConnection ipcon
hinzu:
device, err := ambient_light_bricklet.New("YOUR_DEVICE_UID", &ipcon)
Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.
(*AmbientLightBricklet)
GetIlluminance
() (illuminance uint16, err error)¶Rückgabe: |
|
---|
Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück.
Wenn die Beleuchtungsstärke periodisch abgefragt werden soll, wird empfohlen
den IlluminanceCallback
Callback zu nutzen und die Periode mit
SetIlluminanceCallbackPeriod()
vorzugeben.
(*AmbientLightBricklet)
GetAnalogValue
() (value uint16, err error)¶Rückgabe: |
|
---|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von GetIlluminance()
zurückgegebene Wert ist über mehrere
Messwerte gemittelt um das Rauschen zu vermindern, während GetAnalogValue()
unverarbeitete Analogwerte zurück gibt. Der einzige Grund GetAnalogValue()
zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.
Weiterhin deckt der Analog-Digital-Wandler drei unterschiedliche Bereiche ab, welche dynamisch gewechselt werden abhängig von der Lichtintensität. Es ist nicht möglich, anhand der Analogwerte, zwischen diesen Bereichen zu unterscheiden.
Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen
den AnalogValueCallback
Callback zu nutzen und die Periode mit
SetAnalogValueCallbackPeriod()
vorzugeben.
(*AmbientLightBricklet)
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.
(*AmbientLightBricklet)
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.
(*AmbientLightBricklet)
GetIlluminanceCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetIlluminanceCallbackPeriod()
gesetzt.
(*AmbientLightBricklet)
SetAnalogValueCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher der AnalogValueCallback
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der AnalogValueCallback
Callback wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
(*AmbientLightBricklet)
GetAnalogValueCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAnalogValueCallbackPeriod()
gesetzt.
(*AmbientLightBricklet)
SetIlluminanceCallbackThreshold
(option rune, min uint16, max uint16) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den IlluminanceReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Beleuchtungsstärke außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Beleuchtungsstärke innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Beleuchtungsstärke kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Beleuchtungsstärke größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*AmbientLightBricklet)
GetIlluminanceCallbackThreshold
() (option rune, min uint16, max uint16, err error)¶Rückgabe: |
|
---|
Gibt den Schwellwert zurück, wie von SetIlluminanceCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*AmbientLightBricklet)
SetAnalogValueCallbackThreshold
(option rune, min uint16, max uint16) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Schwellwert für den AnalogValueReachedCallback
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*AmbientLightBricklet)
GetAnalogValueCallbackThreshold
() (option rune, min uint16, max uint16, err error)¶Rückgabe: |
|
---|
Gibt den Schwellwert zurück, wie von SetAnalogValueCallbackThreshold()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
(*AmbientLightBricklet)
SetDebouncePeriod
(debounce uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
(*AmbientLightBricklet)
GetDebouncePeriod
() (debounce uint32, err error)¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von SetDebouncePeriod()
gesetzt.
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der entsprechenden Register*Callback
-Function durchgeführt werden,
welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback
später deregistriert werden.
Bemerkung
Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.
(*AmbientLightBricklet)
RegisterIlluminanceCallback
(func(illuminance uint16)) (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 Umgebungslichtsensors.
Der IlluminanceCallback
Callback wird nur ausgelöst, wenn sich die
Beleuchtungsstärke seit der letzten Auslösung geändert hat.
(*AmbientLightBricklet)
RegisterAnalogValueCallback
(func(value uint16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit SetAnalogValueCallbackPeriod()
,
ausgelöst. Der Parameter des Callbacks ist der Analogwert des Umgebungslichtsensors.
Der AnalogValueCallback
Callback wird nur ausgelöst, wenn sich der Analogwert seit
der letzten Auslösung geändert hat.
(*AmbientLightBricklet)
RegisterIlluminanceReachedCallback
(func(illuminance uint16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetIlluminanceCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter des Callbacks ist die Beleuchtungsstärke des Umgebungslichtsensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
(*AmbientLightBricklet)
RegisterAnalogValueReachedCallback
(func(value uint16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
SetAnalogValueCallbackThreshold()
gesetzt, erreicht wird.
Der Parameter des Callbacks ist der Analogwert des Umgebungslichtsensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit SetDebouncePeriod()
gesetzt, ausgelöst.
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
(*AmbientLightBricklet)
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.
(*AmbientLightBricklet)
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:
(*AmbientLightBricklet)
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:
(*AmbientLightBricklet)
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.
ambient_light_bricklet.
DeviceIdentifier
¶Diese Konstante wird verwendet um ein Ambient Light 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.
ambient_light_bricklet.
DeviceDisplayName
¶Diese Konstante stellt den Anzeigenamen eines Ambient Light Bricklet dar.