Go - Humidity Bricklet¶

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

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/humidity_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Humidity Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    h, _ := humidity_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 humidity.
    humidity, _ := h.GetHumidity()
    fmt.Printf("Humidity: %f %%RH\n", float64(humidity)/10.0)

    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

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/humidity_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Humidity Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    h, _ := humidity_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    h.RegisterHumidityCallback(func(humidity uint16) {
        fmt.Printf("Humidity: %f %%RH\n", float64(humidity)/10.0)
    })

    // Set period for humidity receiver to 1s (1000ms).
    // Note: The humidity callback is only called every second
    //       if the humidity has changed since the last call!
    h.SetHumidityCallbackPeriod(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

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/humidity_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your Humidity Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    h, _ := humidity_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).
    h.SetDebouncePeriod(10000)

    h.RegisterHumidityReachedCallback(func(humidity uint16) {
        fmt.Printf("Humidity: %f %%RH\n", float64(humidity)/10.0)
        fmt.Println("Recommended humidity for human comfort is 30 to 60 %RH.")
    })

    // Configure threshold for humidity "outside of 30 to 60 %RH".
    h.SetHumidityCallbackThreshold('o', 30*10, 60*10)

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

Grundfunktionen¶

func humidity_bricklet.New(uid string, ipcon *IPConnection) (device HumidityBricklet, err error)¶

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

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

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

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

func (*HumidityBricklet) GetHumidity() (humidity uint16, err error)¶

Rückgabe:	humidity – Typ: uint16, Einheit: 1/10 %, Wertebereich: [0 bis 1000] err – Typ: error

Gibt die gemessene Luftfeuchtigkeit des Sensors zurück.

Wenn die Luftfeuchtigkeit periodisch abgefragt werden soll, wird empfohlen den RegisterHumidityCallback Callback zu nutzen und die Periode mit SetHumidityCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

func (*HumidityBricklet) GetAnalogValue() (value uint16, err error)¶

Rückgabe:	value – Typ: uint16, Wertebereich: [0 bis 4095] err – Typ: error

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von GetHumidity() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während GetAnalogValue() unverarbeitete Analogwerte zurück gibt. Der zurückgegebene Luftfeuchtigkeitswert ist auf Raumtemperatur kalibriert, d.h. wenn der Sensor in sehr kalten oder warmen Umgebungen verwendet wird, ist es ratsam den Luftfeuchtigkeitswert direkt aus den Analogwerten zu berechnen. Siehe hierzu das HIH 5030 Datenblatt.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den RegisterAnalogValueCallback Callback zu nutzen und die Periode mit SetAnalogValueCallbackPeriod() vorzugeben.

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

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

func (*HumidityBricklet) GetHumidityCallbackPeriod() (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 SetHumidityCallbackPeriod() gesetzt.

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

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

func (*HumidityBricklet) GetAnalogValueCallbackPeriod() (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 SetAnalogValueCallbackPeriod() gesetzt.

func (*HumidityBricklet) SetHumidityCallbackThreshold(option rune, min uint16, max uint16) (err error)¶

Parameter:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: uint16, Einheit: 1/10 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: uint16, Einheit: 1/10 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Rückgabe:	err – Typ: error

Setzt den Schwellwert für den RegisterHumidityReachedCallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Luftfeuchtigkeit außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Luftfeuchtigkeit innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Luftfeuchtigkeit kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Luftfeuchtigkeit größer als der min Wert ist (max wird ignoriert)

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

Für option:

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

func (*HumidityBricklet) GetHumidityCallbackThreshold() (option rune, min uint16, max uint16, err error)¶

Rückgabe:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: uint16, Einheit: 1/10 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: uint16, Einheit: 1/10 %, Wertebereich: [0 bis 216 - 1], Standardwert: 0 err – Typ: error

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

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

Für option:

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

func (*HumidityBricklet) SetAnalogValueCallbackThreshold(option rune, min uint16, max uint16) (err error)¶

Parameter:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Rückgabe:	err – Typ: error

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

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

func (*HumidityBricklet) GetAnalogValueCallbackThreshold() (option rune, min uint16, max uint16, err error)¶

Rückgabe:	option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0 err – Typ: error

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

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

Für option:

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

func (*HumidityBricklet) 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 Callbacks

• RegisterHumidityReachedCallback,
• RegisterAnalogValueReachedCallback

ausgelöst werden, wenn die Schwellwerte

• SetHumidityCallbackThreshold(),
• SetAnalogValueCallbackThreshold()

weiterhin erreicht bleiben.

func (*HumidityBricklet) 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 (*HumidityBricklet) RegisterHumidityCallback(func(humidity uint16)) (registrationId uint64)¶

Callback-Parameter:	humidity – Typ: uint16, Einheit: 1/10 %, Wertebereich: [0 bis 1000]
Rückgabe:	registrationId – Typ: uint64

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

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

func (*HumidityBricklet) RegisterAnalogValueCallback(func(value uint16)) (registrationId uint64)¶

Callback-Parameter:	value – Typ: uint16, Wertebereich: [0 bis 4095]
Rückgabe:	registrationId – Typ: uint64

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

RegisterAnalogValueCallback Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

func (*HumidityBricklet) RegisterHumidityReachedCallback(func(humidity uint16)) (registrationId uint64)¶

Callback-Parameter:	humidity – Typ: uint16, Einheit: 1/10 %, Wertebereich: [0 bis 1000]
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetHumidityCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist die Luftfeuchtigkeit des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod() gesetzt, ausgelöst.

func (*HumidityBricklet) RegisterAnalogValueReachedCallback(func(value uint16)) (registrationId uint64)¶

Callback-Parameter:	value – Typ: uint16, Wertebereich: [0 bis 4095]
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist der Analogwert des Sensors.

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

• humidity_bricklet.FunctionSetHumidityCallbackPeriod = 3
• humidity_bricklet.FunctionSetAnalogValueCallbackPeriod = 5
• humidity_bricklet.FunctionSetHumidityCallbackThreshold = 7
• humidity_bricklet.FunctionSetAnalogValueCallbackThreshold = 9
• humidity_bricklet.FunctionSetDebouncePeriod = 11

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

• humidity_bricklet.FunctionSetHumidityCallbackPeriod = 3
• humidity_bricklet.FunctionSetAnalogValueCallbackPeriod = 5
• humidity_bricklet.FunctionSetHumidityCallbackThreshold = 7
• humidity_bricklet.FunctionSetAnalogValueCallbackThreshold = 9
• humidity_bricklet.FunctionSetDebouncePeriod = 11

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

humidity_bricklet.DeviceIdentifier¶

Diese Konstante wird verwendet um ein Humidity 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.

humidity_bricklet.DeviceDisplayName¶

Diese Konstante stellt den Anzeigenamen eines Humidity Bricklet dar.