C/C++ - PTC Bricklet

Dies ist die Beschreibung der C/C++ 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 C/C++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.c)

 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
35
36
37
38
39
40
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_ptc.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your PTC Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    PTC ptc;
    ptc_create(&ptc, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get current temperature
    int32_t temperature;
    if(ptc_get_temperature(&ptc, &temperature) < 0) {
        fprintf(stderr, "Could not get temperature, probably timeout\n");
        return 1;
    }

    printf("Temperature: %f °C\n", temperature/100.0);

    printf("Press key to exit\n");
    getchar();
    ptc_destroy(&ptc);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Callback

Download (example_callback.c)

 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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_ptc.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your PTC Bricklet

// Callback function for temperature callback
void cb_temperature(int32_t temperature, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Temperature: %f °C\n", temperature/100.0);
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    PTC ptc;
    ptc_create(&ptc, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register temperature callback to function cb_temperature
    ptc_register_callback(&ptc,
                          PTC_CALLBACK_TEMPERATURE,
                          (void (*)(void))cb_temperature,
                          NULL);

    // Set period for temperature callback to 1s (1000ms)
    // Note: The temperature callback is only called every second
    //       if the temperature has changed since the last call!
    ptc_set_temperature_callback_period(&ptc, 1000);

    printf("Press key to exit\n");
    getchar();
    ptc_destroy(&ptc);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Threshold

Download (example_threshold.c)

 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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_ptc.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your PTC Bricklet

// Callback function for temperature reached callback
void cb_temperature_reached(int32_t temperature, void *user_data) {
    (void)user_data; // avoid unused parameter warning

    printf("Temperature: %f °C\n", temperature/100.0);
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    PTC ptc;
    ptc_create(&ptc, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    ptc_set_debounce_period(&ptc, 10000);

    // Register temperature reached callback to function cb_temperature_reached
    ptc_register_callback(&ptc,
                          PTC_CALLBACK_TEMPERATURE_REACHED,
                          (void (*)(void))cb_temperature_reached,
                          NULL);

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

    printf("Press key to exit\n");
    getchar();
    ptc_destroy(&ptc);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (wird seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14
  • E_WRONG_DEVICE_TYPE = -15
  • E_DEVICE_REPLACED = -16
  • E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void ptc_create(PTC *ptc, const char *uid, IPConnection *ipcon)
Parameter:
  • ptc – Typ: PTC *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt ptc mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

PTC ptc;
ptc_create(&ptc, "YOUR_DEVICE_UID", &ipcon);

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

void ptc_destroy(PTC *ptc)
Parameter:
  • ptc – Typ: PTC *

Entfernt das Geräteobjekt ptc von dessen IP Connection und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int ptc_get_temperature(PTC *ptc, int32_t *ret_temperature)
Parameter:
  • ptc – Typ: PTC *
Ausgabeparameter:
  • ret_temperature – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]
Rückgabe:
  • error_code – Typ: int

Gibt die Temperatur des verbundenen Sensors zurück.

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

int ptc_is_sensor_connected(PTC *ptc, bool *ret_connected)
Parameter:
  • ptc – Typ: PTC *
Ausgabeparameter:
  • ret_connected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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.

int ptc_set_wire_mode(PTC *ptc, uint8_t mode)
Parameter:
  • ptc – Typ: PTC *
  • mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 2
Rückgabe:
  • error_code – Typ: int

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:

  • PTC_WIRE_MODE_2 = 2
  • PTC_WIRE_MODE_3 = 3
  • PTC_WIRE_MODE_4 = 4
int ptc_get_wire_mode(PTC *ptc, uint8_t *ret_mode)
Parameter:
  • ptc – Typ: PTC *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 2
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_mode:

  • PTC_WIRE_MODE_2 = 2
  • PTC_WIRE_MODE_3 = 3
  • PTC_WIRE_MODE_4 = 4

Fortgeschrittene Funktionen

int ptc_get_resistance(PTC *ptc, int32_t *ret_resistance)
Parameter:
  • ptc – Typ: PTC *
Ausgabeparameter:
  • ret_resistance – Typ: int32_t, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

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 PTC_CALLBACK_RESISTANCE Callback zu nutzen und die Periode mit ptc_set_resistance_callback_period() vorzugeben.

int ptc_set_noise_rejection_filter(PTC *ptc, uint8_t filter)
Parameter:
  • ptc – Typ: PTC *
  • filter – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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:

  • PTC_FILTER_OPTION_50HZ = 0
  • PTC_FILTER_OPTION_60HZ = 1
int ptc_get_noise_rejection_filter(PTC *ptc, uint8_t *ret_filter)
Parameter:
  • ptc – Typ: PTC *
Ausgabeparameter:
  • ret_filter – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_filter:

  • PTC_FILTER_OPTION_50HZ = 0
  • PTC_FILTER_OPTION_60HZ = 1
int ptc_get_identity(PTC *ptc, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)
Parameter:
  • ptc – Typ: PTC *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • ret_hardware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

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

void ptc_register_callback(PTC *ptc, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • ptc – Typ: PTC *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

int ptc_set_temperature_callback_period(PTC *ptc, uint32_t period)
Parameter:
  • ptc – Typ: PTC *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

int ptc_get_temperature_callback_period(PTC *ptc, uint32_t *ret_period)
Parameter:
  • ptc – Typ: PTC *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

int ptc_set_resistance_callback_period(PTC *ptc, uint32_t period)
Parameter:
  • ptc – Typ: PTC *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

int ptc_get_resistance_callback_period(PTC *ptc, uint32_t *ret_period)
Parameter:
  • ptc – Typ: PTC *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

int ptc_set_temperature_callback_threshold(PTC *ptc, char option, int32_t min, int32_t max)
Parameter:
  • ptc – Typ: PTC *
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

Für option:

  • PTC_THRESHOLD_OPTION_OFF = 'x'
  • PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
  • PTC_THRESHOLD_OPTION_INSIDE = 'i'
  • PTC_THRESHOLD_OPTION_SMALLER = '<'
  • PTC_THRESHOLD_OPTION_GREATER = '>'
int ptc_get_temperature_callback_threshold(PTC *ptc, char *ret_option, int32_t *ret_min, int32_t *ret_max)
Parameter:
  • ptc – Typ: PTC *
Ausgabeparameter:
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • ret_max – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_option:

  • PTC_THRESHOLD_OPTION_OFF = 'x'
  • PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
  • PTC_THRESHOLD_OPTION_INSIDE = 'i'
  • PTC_THRESHOLD_OPTION_SMALLER = '<'
  • PTC_THRESHOLD_OPTION_GREATER = '>'
int ptc_set_resistance_callback_threshold(PTC *ptc, char option, int32_t min, int32_t max)
Parameter:
  • ptc – Typ: PTC *
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int32_t, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32_t, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

Für option:

  • PTC_THRESHOLD_OPTION_OFF = 'x'
  • PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
  • PTC_THRESHOLD_OPTION_INSIDE = 'i'
  • PTC_THRESHOLD_OPTION_SMALLER = '<'
  • PTC_THRESHOLD_OPTION_GREATER = '>'
int ptc_get_resistance_callback_threshold(PTC *ptc, char *ret_option, int32_t *ret_min, int32_t *ret_max)
Parameter:
  • ptc – Typ: PTC *
Ausgabeparameter:
  • ret_option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • ret_min – Typ: int32_t, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • ret_max – Typ: int32_t, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_option:

  • PTC_THRESHOLD_OPTION_OFF = 'x'
  • PTC_THRESHOLD_OPTION_OUTSIDE = 'o'
  • PTC_THRESHOLD_OPTION_INSIDE = 'i'
  • PTC_THRESHOLD_OPTION_SMALLER = '<'
  • PTC_THRESHOLD_OPTION_GREATER = '>'
int ptc_set_debounce_period(PTC *ptc, uint32_t debounce)
Parameter:
  • ptc – Typ: PTC *
  • debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • error_code – Typ: int

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

int ptc_get_debounce_period(PTC *ptc, uint32_t *ret_debounce)
Parameter:
  • ptc – Typ: PTC *
Ausgabeparameter:
  • ret_debounce – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Rückgabe:
  • error_code – Typ: int

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

int ptc_set_sensor_connected_callback_configuration(PTC *ptc, bool enabled)
Parameter:
  • ptc – Typ: PTC *
  • enabled – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

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

Neu in Version 2.0.2 (Plugin).

int ptc_get_sensor_connected_callback_configuration(PTC *ptc, bool *ret_enabled)
Parameter:
  • ptc – Typ: PTC *
Ausgabeparameter:
  • ret_enabled – Typ: bool, Standardwert: false
Rückgabe:
  • error_code – Typ: int

Gibt die Konfiguration zurück, wie von ptc_set_sensor_connected_callback_configuration() 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 ptc_register_callback() Funktion durchgeführt werden:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

ptc_register_callback(&ptc,
                      PTC_CALLBACK_EXAMPLE,
                      (void (*)(void))my_callback,
                      NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

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.

PTC_CALLBACK_TEMPERATURE
void callback(int32_t temperature, void *user_data)
Callback-Parameter:
  • temperature – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]
  • user_data – Typ: void *

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

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

PTC_CALLBACK_TEMPERATURE_REACHED
void callback(int32_t temperature, void *user_data)
Callback-Parameter:
  • temperature – Typ: int32_t, Einheit: 1/100 °C, Wertebereich: [-24600 bis 84900]
  • user_data – Typ: void *

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

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

PTC_CALLBACK_RESISTANCE
void callback(int32_t resistance, void *user_data)
Callback-Parameter:
  • resistance – Typ: int32_t, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]
  • user_data – Typ: void *

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

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

PTC_CALLBACK_RESISTANCE_REACHED
void callback(int32_t resistance, void *user_data)
Callback-Parameter:
  • resistance – Typ: int32_t, Einheit: ? Ω, Wertebereich: [-231 bis 231 - 1]
  • user_data – Typ: void *

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

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

PTC_CALLBACK_SENSOR_CONNECTED
void callback(bool connected, void *user_data)
Callback-Parameter:
  • connected – Typ: bool
  • user_data – Typ: void *

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

Der Parameter ist der gleiche wie bei ptc_is_sensor_connected().

Neu in Version 2.0.2 (Plugin).

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.

int ptc_get_api_version(PTC *ptc, uint8_t ret_api_version[3])
Parameter:
  • ptc – Typ: PTC *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

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.

int ptc_get_response_expected(PTC *ptc, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • ptc – Typ: PTC *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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 ptc_set_response_expected(). 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 function_id:

  • PTC_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
  • PTC_FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
  • PTC_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
  • PTC_FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
  • PTC_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • PTC_FUNCTION_SET_NOISE_REJECTION_FILTER = 17
  • PTC_FUNCTION_SET_WIRE_MODE = 20
  • PTC_FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22
int ptc_set_response_expected(PTC *ptc, uint8_t function_id, bool response_expected)
Parameter:
  • ptc – Typ: PTC *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ä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 function_id:

  • PTC_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
  • PTC_FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
  • PTC_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
  • PTC_FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
  • PTC_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • PTC_FUNCTION_SET_NOISE_REJECTION_FILTER = 17
  • PTC_FUNCTION_SET_WIRE_MODE = 20
  • PTC_FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22
int ptc_set_response_expected_all(PTC *ptc, bool response_expected)
Parameter:
  • ptc – Typ: PTC *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

Konstanten

PTC_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein PTC Bricklet zu identifizieren.

Die ptc_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

PTC_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines PTC Bricklet dar.