Go - PTC Bricklet

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

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    ptc, _ := ptc_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 temperature.
    temperature, _ := ptc.GetTemperature()
    fmt.Printf("Temperature: %f °C\n", float64(temperature)/100.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/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/ptc_bricklet"
)

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

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

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

    ptc.RegisterTemperatureCallback(func(temperature int32) {
        fmt.Printf("Temperature: %f °C\n", float64(temperature)/100.0)
    })

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

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

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

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

    ptc.RegisterTemperatureReachedCallback(func(temperature int32) {
        fmt.Printf("Temperature: %f °C\n", float64(temperature)/100.0)
    })

    // Configure threshold for temperature "greater than 30 °C".
    ptc.SetTemperatureCallbackThreshold('>', 30*100, 0)

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

API

Die API des PTC Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/ptc_bricklet definiert.

Fast alle Funktionen der Go Bindings können einen DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

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

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

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func NewPTCBricklet(uid string, ipcon *IPConnection) (device PTCBricklet, err error)

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

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

func (*PTCBricklet) GetTemperature() (temperature int32, err error)

Gibt die Temperatur des verbundenen Sensors zurück. Der Wertebereich ist von -246 bis 849 °C und wird in °C/100 angegeben, z.B. bedeutet ein Wert von 4223 eine gemessene Temperatur von 42,23 °C.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den RegisterTemperatureCallback Callback zu nutzen und die Periode mit SetTemperatureCallbackPeriod() vorzugeben.

func (*PTCBricklet) IsSensorConnected() (connected bool, err error)

Gibt true zurück wenn ein Sensor korrekt verbunden ist.

Falls diese Funktion false zurück gibt, ist entweder kein Pt100 oder Pt1000 Sensor verbunden, der Sensor ist inkorrekt verbunden oder der Sensor selbst ist fehlerhaft.

func (*PTCBricklet) SetWireMode(mode WireMode) (err error)

Stellt die Leiter-Konfiguration des Sensors ein. Mögliche Werte sind 2, 3 und 4, dies entspricht 2-, 3- und 4-Leiter-Sensoren. Der Wert muss er Jumper-Konfiguration am Bricklet entsprechen.

Der Standardwert ist 2 = 2-Leiter.

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

  • WireMode2 = 2
  • WireMode3 = 3
  • WireMode4 = 4
func (*PTCBricklet) GetWireMode() (mode WireMode, err error)

Gibt die Leiter-Konfiguration zurück, wie von SetWireMode() gesetzt.

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

  • WireMode2 = 2
  • WireMode3 = 3
  • WireMode4 = 4

Fortgeschrittene Funktionen

func (*PTCBricklet) GetResistance() (resistance int32, err error)

Gibt den Wert zurück, wie vom "MAX31865 Präzisions Delta-Sigma ADC" berechnet.

Der Wert kann mit den folgenden Formeln in einen Widerstand konvertiert werden:

  • Pt100: Widerstand = (Wert * 390) / 32768
  • Pt1000: Widerstand = (Wert * 3900) / 32768

Wenn der Widerstand periodisch abgefragt werden soll, wird empfohlen den RegisterResistanceCallback Callback zu nutzen und die Periode mit SetResistanceCallbackPeriod() vorzugeben.

func (*PTCBricklet) SetNoiseRejectionFilter(filter FilterOption) (err error)

Setzt den Entstörfilter auf 50Hz (0) oder 60Hz (1). Störungen von 50Hz oder 60Hz Stromquellen (inklusive Oberwellen der Stromquellen-Grundfrequenz) werden um 82dB abgeschwächt.

Der Standardwert ist 0 = 50Hz.

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

  • FilterOption50Hz = 0
  • FilterOption60Hz = 1
func (*PTCBricklet) GetNoiseRejectionFilter() (filter FilterOption, err error)

Gibt die Einstellung des Entstörfilters zurück, wie von SetNoiseRejectionFilter() gesetzt.

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

  • FilterOption50Hz = 0
  • FilterOption60Hz = 1
func (*PTCBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)

Gibt die Version der API Definition (Major, Minor, Revision) 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 (*PTCBricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err 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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

func (*PTCBricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • FunctionSetTemperatureCallbackPeriod = 3
  • FunctionSetResistanceCallbackPeriod = 5
  • FunctionSetTemperatureCallbackThreshold = 7
  • FunctionSetResistanceCallbackThreshold = 9
  • FunctionSetDebouncePeriod = 11
  • FunctionSetNoiseRejectionFilter = 17
  • FunctionSetWireMode = 20
  • FunctionSetSensorConnectedCallbackConfiguration = 22
func (*PTCBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

func (*PTCBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err 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 kann 'a', 'b', 'c' oder 'd' sein.

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 (*PTCBricklet) SetTemperatureCallbackPeriod(period uint32) (err error)

Setzt die Periode in ms mit welcher der RegisterTemperatureCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

Der Standardwert ist 0.

func (*PTCBricklet) GetTemperatureCallbackPeriod() (period uint32, err error)

Gibt die Periode zurück, wie von SetTemperatureCallbackPeriod() gesetzt.

func (*PTCBricklet) SetResistanceCallbackPeriod(period uint32) (err error)

Setzt die Periode in ms mit welcher der RegisterResistanceCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

Der Standardwert ist 0.

func (*PTCBricklet) GetResistanceCallbackPeriod() (period uint32, err error)

Gibt die Periode zurück, wie von SetResistanceCallbackPeriod() gesetzt.

func (*PTCBricklet) SetTemperatureCallbackThreshold(option ThresholdOption, min int32, max int32) (err error)

Setzt den Schwellwert für den RegisterTemperatureReachedCallback 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)

Der Standardwert ist ('x', 0, 0).

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

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*PTCBricklet) GetTemperatureCallbackThreshold() (option ThresholdOption, min int32, max int32, err error)

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

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

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*PTCBricklet) SetResistanceCallbackThreshold(option ThresholdOption, min int32, max int32) (err error)

Setzt den Schwellwert für den RegisterResistanceReachedCallback 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)

Der Standardwert ist ('x', 0, 0).

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

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*PTCBricklet) GetResistanceCallbackThreshold() (option ThresholdOption, min int32, max int32, err error)

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

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

  • ThresholdOptionOff = 'x'
  • ThresholdOptionOutside = 'o'
  • ThresholdOptionInside = 'i'
  • ThresholdOptionSmaller = '<'
  • ThresholdOptionGreater = '>'
func (*PTCBricklet) SetDebouncePeriod(debounce uint32) (err error)

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

func (*PTCBricklet) GetDebouncePeriod() (debounce uint32, err error)

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.

func (*PTCBricklet) SetSensorConnectedCallbackConfiguration(enabled bool) (err error)

Wenn dieser Callback aktiviert ist, wird der RegisterSensorConnectedCallback Callback jedes mal ausgelöst, wenn ein Pt-Sensor verbunden/getrennt wird.

Standardmäßig ist dieser Callback deaktiviert.

Neu in Version 2.0.2 (Plugin).

func (*PTCBricklet) GetSensorConnectedCallbackConfiguration() (enabled bool, err error)

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

Neu in Version 2.0.2 (Plugin).

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 (*PTCBricklet) RegisterTemperatureCallback(func(temperature int32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterTemperatureCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterTemperatureCallback(registrationId uint64) wieder entfernt werden.

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

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

func (*PTCBricklet) RegisterTemperatureReachedCallback(func(temperature int32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterTemperatureReachedCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterTemperatureReachedCallback(registrationId uint64) wieder entfernt werden.

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

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

func (*PTCBricklet) RegisterResistanceCallback(func(resistance int32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterResistanceCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterResistanceCallback(registrationId uint64) wieder entfernt werden.

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

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

func (*PTCBricklet) RegisterResistanceReachedCallback(func(resistance int32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterResistanceReachedCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterResistanceReachedCallback(registrationId uint64) wieder entfernt werden.

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

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

func (*PTCBricklet) RegisterSensorConnectedCallback(func(connected bool)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterSensorConnectedCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterSensorConnectedCallback(registrationId uint64) wieder entfernt werden.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetSensorConnectedCallbackConfiguration() gesetzten Konfiguration

Der Parameter des Callbacks ist der gleiche wie bei IsSensorConnected().

Neu in Version 2.0.2 (Plugin).

Konstanten

ptc_bricklet.DeviceIdentifier

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

ptc_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines PTC Bricklet dar.