Go - Moisture Bricklet¶

Simple¶

Download (example_simple.go)

 1package main
 2
 3import (
 4    "fmt"
 5    "github.com/Tinkerforge/go-api-bindings/ipconnection"
 6    "github.com/Tinkerforge/go-api-bindings/moisture_bricklet"
 7)
 8
 9const ADDR string = "localhost:4223"
10const UID string = "XYZ" // Change XYZ to the UID of your Moisture Bricklet.
11
12func main() {
13    ipcon := ipconnection.New()
14    defer ipcon.Close()
15    m, _ := moisture_bricklet.New(UID, &ipcon) // Create device object.
16
17    ipcon.Connect(ADDR) // Connect to brickd.
18    defer ipcon.Disconnect()
19    // Don't use device before ipcon is connected.
20
21    // Get current moisture value.
22    moisture, _ := m.GetMoistureValue()
23    fmt.Printf("Moisture Value: %d\n", moisture)
24
25    fmt.Print("Press enter to exit.")
26    fmt.Scanln()
27}

Callback¶

Download (example_callback.go)

 1package main
 2
 3import (
 4    "fmt"
 5    "github.com/Tinkerforge/go-api-bindings/ipconnection"
 6    "github.com/Tinkerforge/go-api-bindings/moisture_bricklet"
 7)
 8
 9const ADDR string = "localhost:4223"
10const UID string = "XYZ" // Change XYZ to the UID of your Moisture Bricklet.
11
12func main() {
13    ipcon := ipconnection.New()
14    defer ipcon.Close()
15    m, _ := moisture_bricklet.New(UID, &ipcon) // Create device object.
16
17    ipcon.Connect(ADDR) // Connect to brickd.
18    defer ipcon.Disconnect()
19    // Don't use device before ipcon is connected.
20
21    m.RegisterMoistureCallback(func(moisture uint16) {
22        fmt.Printf("Moisture Value: %d\n", moisture)
23    })
24
25    // Set period for moisture value receiver to 1s (1000ms).
26    // Note: The moisture value callback is only called every second
27    //       if the moisture value has changed since the last call!
28    m.SetMoistureCallbackPeriod(1000)
29
30    fmt.Print("Press enter to exit.")
31    fmt.Scanln()
32}

Threshold¶

Download (example_threshold.go)

 1package main
 2
 3import (
 4    "fmt"
 5    "github.com/Tinkerforge/go-api-bindings/ipconnection"
 6    "github.com/Tinkerforge/go-api-bindings/moisture_bricklet"
 7)
 8
 9const ADDR string = "localhost:4223"
10const UID string = "XYZ" // Change XYZ to the UID of your Moisture Bricklet.
11
12func main() {
13    ipcon := ipconnection.New()
14    defer ipcon.Close()
15    m, _ := moisture_bricklet.New(UID, &ipcon) // Create device object.
16
17    ipcon.Connect(ADDR) // Connect to brickd.
18    defer ipcon.Disconnect()
19    // Don't use device before ipcon is connected.
20
21    // Get threshold receivers with a debounce time of 1 second (1000ms).
22    m.SetDebouncePeriod(1000)
23
24    m.RegisterMoistureReachedCallback(func(moisture uint16) {
25        fmt.Printf("Moisture Value: %d\n", moisture)
26    })
27
28    // Configure threshold for moisture value "greater than 200".
29    m.SetMoistureCallbackThreshold('>', 200, 0)
30
31    fmt.Print("Press enter to exit.")
32    fmt.Scanln()
33}

Grundfunktionen¶

func moisture_bricklet.New(uid string, ipcon *IPConnection) (device MoistureBricklet, err error)¶

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

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

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

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.

func (*MoistureBricklet) GetMoistureValue() (moisture uint16, err error)¶

Rückgabe:	moisture – Typ: uint16, Wertebereich: [0 bis 212 - 1] err – Typ: error

Gibt den aktuellen Feuchtigkeitswert zurück. Ein kleiner Wert entspricht einer geringen Feuchtigkeit, ein großer Wert entspricht einer hohen Feuchtigkeit.

Wenn der Feuchtigkeitswert periodisch abgefragt werden soll, wird empfohlen den MoistureCallback Callback zu nutzen und die Periode mit SetMoistureCallbackPeriod() vorzugeben.

Fortgeschrittene Funktionen¶

func (*MoistureBricklet) SetMovingAverage(average uint8) (err error)¶

Parameter:	average – Typ: uint8, Wertebereich: [0 bis 100], Standardwert: 100
Rückgabe:	err – Typ: error

Setzt die Länge eines gleitenden Mittelwerts für den Feuchtigkeitswert.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

func (*MoistureBricklet) GetMovingAverage() (average uint8, err error)¶

Rückgabe:	average – Typ: uint8, Wertebereich: [0 bis 100], Standardwert: 100 err – Typ: error

Gibt die Länge des gleitenden Mittelwerts zurück, wie von SetMovingAverage() gesetzt.

func (*MoistureBricklet) 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', '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 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.

Konfigurationsfunktionen für Callbacks¶

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

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

func (*MoistureBricklet) GetMoistureCallbackPeriod() (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 SetMoistureCallbackPeriod() gesetzt.

func (*MoistureBricklet) SetMoistureCallbackThreshold(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 MoistureReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

• moisture_bricklet.ThresholdOptionOff = 'x'

• moisture_bricklet.ThresholdOptionOutside = 'o'

• moisture_bricklet.ThresholdOptionInside = 'i'

• moisture_bricklet.ThresholdOptionSmaller = '<'

• moisture_bricklet.ThresholdOptionGreater = '>'

func (*MoistureBricklet) GetMoistureCallbackThreshold() (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 SetMoistureCallbackThreshold() gesetzt.

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

Für option:

• moisture_bricklet.ThresholdOptionOff = 'x'

• moisture_bricklet.ThresholdOptionOutside = 'o'

• moisture_bricklet.ThresholdOptionInside = 'i'

• moisture_bricklet.ThresholdOptionSmaller = '<'

• moisture_bricklet.ThresholdOptionGreater = '>'

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

• MoistureReachedCallback

ausgelöst wird, wenn der Schwellwert

• SetMoistureCallbackThreshold()

weiterhin erreicht bleibt.

func (*MoistureBricklet) 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 (*MoistureBricklet) RegisterMoistureCallback(func(moisture uint16)) (registrationId uint64)¶

Callback-Parameter:	moisture – Typ: uint16, Wertebereich: [0 bis 212 - 1]
Rückgabe:	registrationId – Typ: uint64

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

The MoistureCallback Callback wird nur ausgelöst, wenn sich der Feuchtigkeitswert seit der letzten Auslösung geändert hat.

func (*MoistureBricklet) RegisterMoistureReachedCallback(func(moisture uint16)) (registrationId uint64)¶

Callback-Parameter:	moisture – Typ: uint16, Wertebereich: [0 bis 212 - 1]
Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetMoistureCallbackThreshold() gesetzt, erreicht wird. Der Parameter des Callbacks ist die Feuchtigkeitswert 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 (*MoistureBricklet) 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 (*MoistureBricklet) 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:

• moisture_bricklet.FunctionSetMoistureCallbackPeriod = 2

• moisture_bricklet.FunctionSetMoistureCallbackThreshold = 4

• moisture_bricklet.FunctionSetDebouncePeriod = 6

• moisture_bricklet.FunctionSetMovingAverage = 10

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

• moisture_bricklet.FunctionSetMoistureCallbackPeriod = 2

• moisture_bricklet.FunctionSetMoistureCallbackThreshold = 4

• moisture_bricklet.FunctionSetDebouncePeriod = 6

• moisture_bricklet.FunctionSetMovingAverage = 10

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

moisture_bricklet.DeviceIdentifier¶

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

moisture_bricklet.DeviceDisplayName¶

Diese Konstante stellt den Anzeigenamen eines Moisture Bricklet dar.