Software / API Bindings / Go / API Referenz und Beispiele / Bricklets / Industrial PTC Bricklet

Go - Industrial PTC Bricklet¶

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

package main

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

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

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

package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    ptc, _ := industrial_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 callback to 1s (1000ms) without a threshold.
    ptc.SetTemperatureCallbackConfiguration(1000, false, 'x', 0, 0)

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

Threshold¶

Download (example_threshold.go)

package main

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

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

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

    // Configure threshold for temperature "greater than 30 °C"
    // with a debounce period of 1s (1000ms).
    ptc.SetTemperatureCallbackConfiguration(1000, false, '>', 30*100, 0)

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

API¶

Die API des Industrial PTC Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/industrial_ptc_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 industrial_ptc_bricklet.New(uid string, ipcon *IPConnection) (device IndustrialPTCBricklet, err error)¶

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

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

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

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

func (*IndustrialPTCBricklet) GetTemperature() (temperature int32, err error)¶

Rückgabe:	temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900] err – Typ: error

Gibt die Temperatur des verbundenen Sensors zurück.

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

func (*IndustrialPTCBricklet) GetResistance() (resistance int32, err error)¶

Rückgabe:	resistance – Typ: int32, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1] err – Typ: 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 Wert periodisch benötigt wird, kann auch der ResistanceCallback Callback verwendet werden. Der Callback wird mit der Funktion SetResistanceCallbackConfiguration() konfiguriert.

func (*IndustrialPTCBricklet) IsSensorConnected() (connected bool, err error)¶

Rückgabe:	connected – Typ: bool err – Typ: 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.

Zum automatischen übertragen des Status kann auch der SensorConnectedCallback Callback verwendet werden. Der Callback wird mit der Funktion SetSensorConnectedCallbackConfiguration() konfiguriert.

func (*IndustrialPTCBricklet) SetWireMode(mode uint8) (err error)¶

Parameter:	mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 2
Rückgabe:	err – Typ: 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.

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

Für mode:

industrial_ptc_bricklet.WireMode2 = 2
industrial_ptc_bricklet.WireMode3 = 3
industrial_ptc_bricklet.WireMode4 = 4

func (*IndustrialPTCBricklet) GetWireMode() (mode uint8, err error)¶

Rückgabe:	mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 2 err – Typ: error

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

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

Für mode:

industrial_ptc_bricklet.WireMode2 = 2
industrial_ptc_bricklet.WireMode3 = 3
industrial_ptc_bricklet.WireMode4 = 4

func (*IndustrialPTCBricklet) SetMovingAverageConfiguration(movingAverageLengthResistance uint16, movingAverageLengthTemperature uint16) (err error)¶

Parameter:	movingAverageLengthResistance – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 1 movingAverageLengthTemperature – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 40
Rückgabe:	err – Typ: error

Setzt die Länge eines gleitenden Mittelwerts für den Widerstand und die Temperatur.

Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

Einer neue Wert wird alle 20ms gemessen. Mit einer Mittelwerts-Länge von 1000 hat das resultierende gleitende Fenster eine Zeitspanne von 20s. Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.

Die Standardwerte entsprechen den nicht-änderbaren Mittelwert-Einstellungen des alten PTC Bricklet 1.0.

func (*IndustrialPTCBricklet) GetMovingAverageConfiguration() (movingAverageLengthResistance uint16, movingAverageLengthTemperature uint16, err error)¶

Rückgabe:	movingAverageLengthResistance – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 1 movingAverageLengthTemperature – Typ: uint16, Wertebereich: [1 bis 1000], Standardwert: 40 err – Typ: error

Gibt die Moving Average-Konfiguration zurück, wie von SetMovingAverageConfiguration() gesetzt.

Fortgeschrittene Funktionen¶

func (*IndustrialPTCBricklet) SetNoiseRejectionFilter(filter uint8) (err error)¶

Parameter:	filter – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	err – Typ: 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.

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

Für filter:

industrial_ptc_bricklet.FilterOption50Hz = 0
industrial_ptc_bricklet.FilterOption60Hz = 1

func (*IndustrialPTCBricklet) GetNoiseRejectionFilter() (filter uint8, err error)¶

Rückgabe:	filter – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0 err – Typ: error

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

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

Für filter:

industrial_ptc_bricklet.FilterOption50Hz = 0
industrial_ptc_bricklet.FilterOption60Hz = 1

func (*IndustrialPTCBricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)¶

Rückgabe:	errorCountAckChecksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: uint32, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 2³² - 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 (*IndustrialPTCBricklet) 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:

industrial_ptc_bricklet.StatusLEDConfigOff = 0
industrial_ptc_bricklet.StatusLEDConfigOn = 1
industrial_ptc_bricklet.StatusLEDConfigShowHeartbeat = 2
industrial_ptc_bricklet.StatusLEDConfigShowStatus = 3

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

industrial_ptc_bricklet.StatusLEDConfigOff = 0
industrial_ptc_bricklet.StatusLEDConfigOn = 1
industrial_ptc_bricklet.StatusLEDConfigShowHeartbeat = 2
industrial_ptc_bricklet.StatusLEDConfigShowStatus = 3

func (*IndustrialPTCBricklet) GetChipTemperature() (temperature int16, err error)¶

Rückgabe:	temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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 (*IndustrialPTCBricklet) 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 (*IndustrialPTCBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶

Rückgabe:

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 2¹⁶ - 1] err – Typ: error

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 2¹⁶ - 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 (*IndustrialPTCBricklet) SetTemperatureCallbackConfiguration(period uint32, valueHasToChange bool, option rune, min int32, max int32) (err error)¶

Parameter:

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	err – Typ: error

period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
valueHasToChange – Typ: bool, Standardwert: false
option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
max – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Rückgabe:

err – Typ: error

Die Periode ist die Periode mit der der TemperatureCallback 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 TemperatureCallback 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:

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

func (*IndustrialPTCBricklet) GetTemperatureCallbackConfiguration() (period uint32, valueHasToChange bool, option rune, min int32, max int32, err error)¶

Rückgabe:

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 err – Typ: error

period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
valueHasToChange – Typ: bool, Standardwert: false
option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
max – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
err – Typ: error

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

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

Für option:

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

func (*IndustrialPTCBricklet) SetResistanceCallbackConfiguration(period uint32, valueHasToChange bool, option rune, min int32, max int32) (err error)¶

Parameter:

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
Rückgabe:	err – Typ: error

period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
valueHasToChange – Typ: bool, Standardwert: false
option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: int32, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
max – Typ: int32, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0

Rückgabe:

err – Typ: error

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

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 ResistanceCallback 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:

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

func (*IndustrialPTCBricklet) GetResistanceCallbackConfiguration() (period uint32, valueHasToChange bool, option rune, min int32, max int32, err error)¶

Rückgabe:

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 valueHasToChange – Typ: bool, Standardwert: false option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int32, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 max – Typ: int32, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0 err – Typ: error

period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
valueHasToChange – Typ: bool, Standardwert: false
option – Typ: rune, Wertebereich: Siehe Konstanten, Standardwert: 'x'
min – Typ: int32, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
max – Typ: int32, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1], Standardwert: 0
err – Typ: error

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

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

Für option:

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

func (*IndustrialPTCBricklet) SetSensorConnectedCallbackConfiguration(enabled bool) (err error)¶

Parameter:	enabled – Typ: bool, Standardwert: false
Rückgabe:	err – Typ: error

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

func (*IndustrialPTCBricklet) GetSensorConnectedCallbackConfiguration() (enabled bool, err error)¶

Rückgabe:	enabled – Typ: bool, Standardwert: false err – Typ: error

Gibt die Konfiguration zurück, wie von SetSensorConnectedCallbackConfiguration() 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.

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

Callback-Parameter:	temperature – Typ: int32, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]
Rückgabe:	registrationId – Typ: uint64

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

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

func (*IndustrialPTCBricklet) RegisterResistanceCallback(func(resistance int32)) (registrationId uint64)¶

Callback-Parameter:	resistance – Typ: int32, Einheit: ? Ω, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	registrationId – Typ: uint64

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

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

func (*IndustrialPTCBricklet) RegisterSensorConnectedCallback(func(connected bool)) (registrationId uint64)¶

Callback-Parameter:	connected – Typ: bool
Rückgabe:	registrationId – Typ: uint64

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

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

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

industrial_ptc_bricklet.FunctionSetTemperatureCallbackConfiguration = 2
industrial_ptc_bricklet.FunctionSetResistanceCallbackConfiguration = 6
industrial_ptc_bricklet.FunctionSetNoiseRejectionFilter = 9
industrial_ptc_bricklet.FunctionSetWireMode = 12
industrial_ptc_bricklet.FunctionSetMovingAverageConfiguration = 14
industrial_ptc_bricklet.FunctionSetSensorConnectedCallbackConfiguration = 16
industrial_ptc_bricklet.FunctionSetWriteFirmwarePointer = 237
industrial_ptc_bricklet.FunctionSetStatusLEDConfig = 239
industrial_ptc_bricklet.FunctionReset = 243
industrial_ptc_bricklet.FunctionWriteUID = 248

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

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

Für functionId:

industrial_ptc_bricklet.FunctionSetTemperatureCallbackConfiguration = 2
industrial_ptc_bricklet.FunctionSetResistanceCallbackConfiguration = 6
industrial_ptc_bricklet.FunctionSetNoiseRejectionFilter = 9
industrial_ptc_bricklet.FunctionSetWireMode = 12
industrial_ptc_bricklet.FunctionSetMovingAverageConfiguration = 14
industrial_ptc_bricklet.FunctionSetSensorConnectedCallbackConfiguration = 16
industrial_ptc_bricklet.FunctionSetWriteFirmwarePointer = 237
industrial_ptc_bricklet.FunctionSetStatusLEDConfig = 239
industrial_ptc_bricklet.FunctionReset = 243
industrial_ptc_bricklet.FunctionWriteUID = 248

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

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

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

Für status:

industrial_ptc_bricklet.BootloaderStatusOK = 0
industrial_ptc_bricklet.BootloaderStatusInvalidMode = 1
industrial_ptc_bricklet.BootloaderStatusNoChange = 2
industrial_ptc_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
industrial_ptc_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
industrial_ptc_bricklet.BootloaderStatusCRCMismatch = 5

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

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

func (*IndustrialPTCBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)¶

Parameter:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 2³² - 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 (*IndustrialPTCBricklet) 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 (*IndustrialPTCBricklet) WriteUID(uid uint32) (err error)¶

Parameter:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 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 (*IndustrialPTCBricklet) ReadUID() (uid uint32, err error)¶

Rückgabe:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 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.

Konstanten¶

industrial_ptc_bricklet.DeviceIdentifier¶

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

industrial_ptc_bricklet.DeviceDisplayName¶: Diese Konstante stellt den Anzeigenamen eines Industrial PTC Bricklet dar.