Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / RS485 Bricklet

C/C++ für Mikrocontroller - RS485 Bricklet¶

Dies ist die Beschreibung der C/C++ für Mikrocontroller API Bindings für das RS485 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS485 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C/C++ für Mikrocontroller API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback¶

Download (example_loopback.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_rs485.h"

// For this example connect the RX+/- pins to TX+/- pins on the same Bricklet
// and configure the DIP switch on the Bricklet to full-duplex mode

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static char buffer[5] = {0}; // +1 for the null terminator

// Callback function for read callback
static void read_handler(TF_RS485 *device, char *message, uint16_t message_length,
                         void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    message[message_length] = '\0';

    tf_hal_printf("Message: \"%s\"\n", message);
}

static TF_RS485 rs485;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_rs485_create(&rs485, NULL, hal), "create device object");

    // Enable full-duplex mode
    check(tf_rs485_set_rs485_configuration(&rs485, 115200, TF_RS485_PARITY_NONE,
                                           TF_RS485_STOPBITS_1, TF_RS485_WORDLENGTH_8,
                                           TF_RS485_DUPLEX_FULL), "call set_rs485_configuration");

    // Register read callback to function read_handler
    tf_rs485_register_read_callback(&rs485,
                                    read_handler,
                                    buffer,
                                    NULL);

    // Enable read callback
    check(tf_rs485_enable_read_callback(&rs485), "call enable_read_callback");

    // Write "test" string
    char write_buffer[] = {'t', 'e', 's', 't'};
    uint16_t written;
    tf_rs485_write(&rs485, write_buffer, sizeof(write_buffer), &written);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

Modbus Slave¶

Download (example_modbus_slave.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_rs485.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static uint8_t received_request_id = 0;
static bool register_address_valid = false;

// Callback function for Modbus slave write single register request callback
static void modbus_slave_write_single_register_request_handler(TF_RS485 *device, uint8_t request_id,
                                                               uint32_t register_address,
                                                               uint16_t register_value,
                                                               void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Request ID: %I8u\n", request_id);
    tf_hal_printf("Register Address: %I32u\n", register_address);
    tf_hal_printf("Register Value: %I16u\n", register_value);
    tf_hal_printf("\n");

    received_request_id = request_id;
    register_address_valid = register_address == 42;

    if (!register_address_valid) {
        tf_hal_printf("Error: Invalid register address\n");
    }
}

static TF_RS485 rs485;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_rs485_create(&rs485, NULL, hal), "create device object");

    // Set operating mode to Modbus RTU slave
    check(tf_rs485_set_mode(&rs485, TF_RS485_MODE_MODBUS_SLAVE_RTU), "call set_mode");

    // Modbus specific configuration:
    // - slave address = 17
    // - master request timeout = 0ms (unused in slave mode)
    check(tf_rs485_set_modbus_configuration(&rs485, 17,
                                            0), "call set_modbus_configuration");

    // Register Modbus slave write single register request callback to function
    // modbus_slave_write_single_register_request_handler
    tf_rs485_register_modbus_slave_write_single_register_request_callback(&rs485,
                                                                          modbus_slave_write_single_register_request_handler,
                                                                          NULL);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    // Polling with 0 will process one packet at most, so we can't miss a request.
    tf_hal_callback_tick(hal, 0);

    if(received_request_id == 0) {
        // We didn't receive a request.
        return;
    }

    if(!register_address_valid) {
        tf_rs485_modbus_slave_report_exception(&rs485, received_request_id, TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS);
    } else {
        tf_rs485_modbus_slave_answer_write_single_register_request(&rs485, received_request_id);
    }

    // Make sure we respond to the request only once.
    received_request_id = 0;
}

Modbus Master¶

Download (example_modbus_master.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_rs485.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static void log_exception(int8_t exception_code) {
    if (exception_code == TF_RS485_EXCEPTION_CODE_TIMEOUT) {
        tf_hal_printf("Exception Code: Timeout\n");
    } else if (exception_code == TF_RS485_EXCEPTION_CODE_SUCCESS) {
        tf_hal_printf("Exception Code: Success\n");
    } else if (exception_code == TF_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION) {
        tf_hal_printf("Exception Code: Illegal Function\n");
    } else if (exception_code == TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS) {
        tf_hal_printf("Exception Code: Illegal Data Address\n");
    } else if (exception_code == TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE) {
        tf_hal_printf("Exception Code: Illegal Data Value\n");
    } else if (exception_code == TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE) {
        tf_hal_printf("Exception Code: Slave Device Failure\n");
    } else if (exception_code == TF_RS485_EXCEPTION_CODE_ACKNOWLEDGE) {
        tf_hal_printf("Exception Code: Acknowledge\n");
    } else if (exception_code == TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY) {
        tf_hal_printf("Exception Code: Slave Device Busy\n");
    } else if (exception_code == TF_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR) {
        tf_hal_printf("Exception Code: Memory Parity Error\n");
    } else if (exception_code == TF_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE) {
        tf_hal_printf("Exception Code: Gateway Path Unavailable\n");
    } else if (exception_code == TF_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND) {
        tf_hal_printf("Exception Code: Gateway Target Device Failed To Respond\n");
    }
}

// Callback function for Modbus master write single register response callback
static void modbus_master_write_single_register_response_handler(TF_RS485 *device, uint8_t request_id,
                                                                 int8_t exception_code,
                                                                 void *user_data) {
    (void)device; // avoid unused parameter warning

    uint8_t expected_request_id = *(uint8_t *)user_data;

    tf_hal_printf("Request ID: %I8u\n", request_id);

    if(exception_code != TF_RS485_EXCEPTION_CODE_SUCCESS) {
        log_exception(exception_code);
    }

    if (request_id != expected_request_id) {
        tf_hal_printf("Error: Unexpected request ID\n");
    }

    tf_hal_printf("\n");
}

static TF_RS485 rs485;
static uint8_t expected_request_id = 0;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_rs485_create(&rs485, NULL, hal), "create device object");

    // Set operating mode to Modbus RTU master
    check(tf_rs485_set_mode(&rs485, TF_RS485_MODE_MODBUS_MASTER_RTU), "call set_mode");

    // Modbus specific configuration:
    // - slave address = 1 (unused in master mode)
    // - master request timeout = 1000ms
    check(tf_rs485_set_modbus_configuration(&rs485, 1,
                                            1000), "call set_modbus_configuration");

    // Register Modbus master write single register response callback to function
    // modbus_master_write_single_register_response_handler
    tf_rs485_register_modbus_master_write_single_register_response_callback(&rs485,
                                                                            modbus_master_write_single_register_response_handler,
                                                                            &expected_request_id);

    // Write 65535 to register 42 of slave 17
    check(tf_rs485_modbus_master_write_single_register(&rs485, 17, 42,
                                                       65535, &expected_request_id), "call modbus_master_write_single_register");
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

API¶

Die meistens Funktionen der C/C++ Bindings für Mikrocontroller geben einen Fehlercode (e_code) zurück

Mögliche Fehlercodes sind:

TF_E_OK = 0
TF_E_TIMEOUT = -1
TF_E_INVALID_PARAMETER = -2
TF_E_NOT_SUPPORTED = -3
TF_E_UNKNOWN_ERROR_CODE = -4
TF_E_STREAM_OUT_OF_SYNC = -5
TF_E_INVALID_CHAR_IN_UID = -6
TF_E_UID_TOO_LONG = -7
TF_E_UID_OVERFLOW = -8
TF_E_TOO_MANY_DEVICES = -9
TF_E_DEVICE_NOT_FOUND = -10
TF_E_WRONG_DEVICE_TYPE = -11
TF_E_CALLBACK_EXEC = -12
TF_E_PORT_NOT_FOUND = -13

(wie in errors.h definiert), sowie die Fehlercodes des verwendeten Hardware-Abstraction-Layers (HALs). Mit tf_hal_strerror (im Header das HALs definiert) kann ein Fehlerstring zu einem Fehlercode abgefragt werden.

Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet. Die Bindings schreiben einen Ausgabeparameter nicht, wenn NULL bzw. nullptr übergeben wird. So können uninteressante Ausgaben ignoriert werden.

Keine der folgend aufgelisteten Funktionen ist Thread-sicher. Details finden sich in der Beschreibung der API-Bindings.

Grundfunktionen¶

int tf_rs485_create(TF_RS485 *rs485, const char *uid, TF_HAL *hal)¶

Parameter:	rs485 – Typ: TF_RS485 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

Erzeugt ein Geräteobjekt rs485 mit der optionalen eindeutigen Geräte ID oder dem Portnamen uid_or_port_name und fügt es dem HAL hal hinzu:

TF_RS485 rs485;
tf_rs485_create(&rs485, NULL, &ipcon);

Im Normalfall kann uid_or_port_name auf NULL belassen werden. Für weitere Details siehe Abschnitt UID oder Port-Name.

int tf_rs485_destroy(TF_RS485 *rs485)¶

Parameter:	rs485 – Typ: TF_RS485 *
Rückgabe:	e_code – Typ: int

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

int tf_rs485_write(TF_RS485 *rs485, const char *message, uint16_t message_length, uint16_t *ret_message_written)¶

Parameter:	rs485 – Typ: TF_RS485 * message – Typ: const char * message_length – Typ: uint16_t
Ausgabeparameter:	ret_message_written – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

Schreibt Zeichen auf die RS485-Schnittstelle. Die Zeichen können Binärdaten sein, ASCII o.ä. ist nicht notwendig.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben wurden.

Siehe tf_rs485_set_rs485_configuration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

int tf_rs485_read(TF_RS485 *rs485, uint16_t length, char *ret_message, uint16_t *ret_message_length)¶

Parameter:	rs485 – Typ: TF_RS485 * length – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_message – Typ: char * ret_message_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Gibt bis zu length Zeichen aus dem Empfangsbuffer zurück.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Diese Funktion gibt nur Daten zurück wenn der Read-Callback nich aktiv ist. Siehe tf_rs485_enable_read_callback() und Read Low Level Callback.

int tf_rs485_set_rs485_configuration(TF_RS485 *rs485, uint32_t baudrate, uint8_t parity, uint8_t stopbits, uint8_t wordlength, uint8_t duplex)¶

Parameter:

Parameter:	rs485 – Typ: TF_RS485 * baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 parity – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 stopbits – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1 wordlength – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 8 duplex – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

rs485 – Typ: TF_RS485 *
baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200
parity – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
stopbits – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1
wordlength – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 8
duplex – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0

Rückgabe:

e_code – Typ: int

Setzt die Konfiguration für die RS485-Kommunikation.

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

Für parity:

TF_RS485_PARITY_NONE = 0
TF_RS485_PARITY_ODD = 1
TF_RS485_PARITY_EVEN = 2

Für stopbits:

TF_RS485_STOPBITS_1 = 1
TF_RS485_STOPBITS_2 = 2

Für wordlength:

TF_RS485_WORDLENGTH_5 = 5
TF_RS485_WORDLENGTH_6 = 6
TF_RS485_WORDLENGTH_7 = 7
TF_RS485_WORDLENGTH_8 = 8

Für duplex:

TF_RS485_DUPLEX_HALF = 0
TF_RS485_DUPLEX_FULL = 1

int tf_rs485_get_rs485_configuration(TF_RS485 *rs485, uint32_t *ret_baudrate, uint8_t *ret_parity, uint8_t *ret_stopbits, uint8_t *ret_wordlength, uint8_t *ret_duplex)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_baudrate – Typ: uint32_t, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 ret_parity – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0 ret_stopbits – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 1 ret_wordlength – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 8 ret_duplex – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_parity:

TF_RS485_PARITY_NONE = 0
TF_RS485_PARITY_ODD = 1
TF_RS485_PARITY_EVEN = 2

Für ret_stopbits:

TF_RS485_STOPBITS_1 = 1
TF_RS485_STOPBITS_2 = 2

Für ret_wordlength:

TF_RS485_WORDLENGTH_5 = 5
TF_RS485_WORDLENGTH_6 = 6
TF_RS485_WORDLENGTH_7 = 7
TF_RS485_WORDLENGTH_8 = 8

Für ret_duplex:

TF_RS485_DUPLEX_HALF = 0
TF_RS485_DUPLEX_FULL = 1

int tf_rs485_set_modbus_configuration(TF_RS485 *rs485, uint8_t slave_address, uint32_t master_request_timeout)¶

Parameter:	rs485 – Typ: TF_RS485 * slave_address – Typ: uint8_t, Wertebereich: [1 bis 247], Standardwert: 1 master_request_timeout – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 1000
Rückgabe:	e_code – Typ: int

Setzt die Konfiguration für die RS485 Modbus Kommunikation. Verfügbare Optionen:

Slave Address: Addresse die vom Modbus-Slave im Modbus-Slave Modus genutzt wird. Der gültige Adressbereich ist 1 bis 247.
Master Request Timeout: Spezifiziert wie lange der Modbus-Master auf eine Antwort von einem Modbus-Slave wartet.

int tf_rs485_get_modbus_configuration(TF_RS485 *rs485, uint8_t *ret_slave_address, uint32_t *ret_master_request_timeout)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_slave_address – Typ: uint8_t, Wertebereich: [1 bis 247], Standardwert: 1 ret_master_request_timeout – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 1000
Rückgabe:	e_code – Typ: int

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

int tf_rs485_set_mode(TF_RS485 *rs485, uint8_t mode)¶

Parameter:	rs485 – Typ: TF_RS485 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Setzt den Modus des Bricklets. Verfügbare Optionen sind

RS485,
Modbus-Master-RTU und
Modbus-Slave-RTU.

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

Für mode:

TF_RS485_MODE_RS485 = 0
TF_RS485_MODE_MODBUS_MASTER_RTU = 1
TF_RS485_MODE_MODBUS_SLAVE_RTU = 2

int tf_rs485_get_mode(TF_RS485 *rs485, uint8_t *ret_mode)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

Für ret_mode:

TF_RS485_MODE_RS485 = 0
TF_RS485_MODE_MODBUS_MASTER_RTU = 1
TF_RS485_MODE_MODBUS_SLAVE_RTU = 2

Fortgeschrittene Funktionen¶

int tf_rs485_set_communication_led_config(TF_RS485 *rs485, uint8_t config)¶

Parameter:	rs485 – Typ: TF_RS485 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig zeigt die LED die RS485 Kommunikation durch Aufblinken an.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

TF_RS485_COMMUNICATION_LED_CONFIG_OFF = 0
TF_RS485_COMMUNICATION_LED_CONFIG_ON = 1
TF_RS485_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_RS485_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

int tf_rs485_get_communication_led_config(TF_RS485 *rs485, uint8_t *ret_config)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

TF_RS485_COMMUNICATION_LED_CONFIG_OFF = 0
TF_RS485_COMMUNICATION_LED_CONFIG_ON = 1
TF_RS485_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_RS485_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

int tf_rs485_set_error_led_config(TF_RS485 *rs485, uint8_t config)¶

Parameter:	rs485 – Typ: TF_RS485 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe Error Count Callback). Wenn diese Funktion danach nochmal mit der "SHOW ERROR"-Option aufgerufen wird, geht die LED wieder aus bis der nächste Error auftritt.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

TF_RS485_ERROR_LED_CONFIG_OFF = 0
TF_RS485_ERROR_LED_CONFIG_ON = 1
TF_RS485_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_RS485_ERROR_LED_CONFIG_SHOW_ERROR = 3

int tf_rs485_get_error_led_config(TF_RS485 *rs485, uint8_t *ret_config)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

TF_RS485_ERROR_LED_CONFIG_OFF = 0
TF_RS485_ERROR_LED_CONFIG_ON = 1
TF_RS485_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_RS485_ERROR_LED_CONFIG_SHOW_ERROR = 3

int tf_rs485_set_buffer_config(TF_RS485 *rs485, uint16_t send_buffer_size, uint16_t receive_buffer_size)¶

Parameter:	rs485 – Typ: TF_RS485 * send_buffer_size – Typ: uint16_t, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120 receive_buffer_size – Typ: uint16_t, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120
Rückgabe:	e_code – Typ: int

Setzt die Größe des Senden- und Empfangsbuffers. In Summe können die Buffer eine Größe von 10240 Byte (10KiB) haben, die Minimalgröße ist 1024 Byte (1KiB) für beide.

Der aktuelle Bufferinhalt geht bei einem Aufruf dieser Funktion verloren.

Der Sendenbuffer hält die Daten welche über tf_rs485_write() übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS485 empfangen wurden aber noch nicht über tf_rs485_read() oder Read Low Level Callback an ein Nutzerprogramm übertragen werden konnten.

int tf_rs485_get_buffer_config(TF_RS485 *rs485, uint16_t *ret_send_buffer_size, uint16_t *ret_receive_buffer_size)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_send_buffer_size – Typ: uint16_t, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120 ret_receive_buffer_size – Typ: uint16_t, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120
Rückgabe:	e_code – Typ: int

Gibt die Buffer-Konfiguration zurück, wie von tf_rs485_set_buffer_config() gesetzt.

int tf_rs485_get_buffer_status(TF_RS485 *rs485, uint16_t *ret_send_buffer_used, uint16_t *ret_receive_buffer_used)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_send_buffer_used – Typ: uint16_t, Einheit: 1 B, Wertebereich: [0 bis 9216] ret_receive_buffer_used – Typ: uint16_t, Einheit: 1 B, Wertebereich: [0 bis 9216]
Rückgabe:	e_code – Typ: int

Gibt die aktuell genutzten Bytes des Sende- und Empfangsbuffers zurück.

Siehe tf_rs485_set_buffer_config() zur Konfiguration der Buffergrößen.

int tf_rs485_get_error_count(TF_RS485 *rs485, uint32_t *ret_overrun_error_count, uint32_t *ret_parity_error_count)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_overrun_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_parity_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt die aktuelle Anzahl an Overrun und Parity Fehlern zurück.

int tf_rs485_get_modbus_common_error_count(TF_RS485 *rs485, uint32_t *ret_timeout_error_count, uint32_t *ret_checksum_error_count, uint32_t *ret_frame_too_big_error_count, uint32_t *ret_illegal_function_error_count, uint32_t *ret_illegal_data_address_error_count, uint32_t *ret_illegal_data_value_error_count, uint32_t *ret_slave_device_failure_error_count)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_timeout_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_checksum_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_frame_too_big_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_illegal_function_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_illegal_data_address_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_illegal_data_value_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_slave_device_failure_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt die aktuelle Fehleranzahl für verschiedene Fehlerarten Modbus-Modus zurück.

Timeout Error Count: Anzahl Timeouts.
Checksum Error Count: Anzahl von Modbus CRC16 Checksummen-Fehlern.
Frame Too Big Error Count: Anzahl von verworfenen Frames auf Grund einer zu großen Frame Größe (maximal 256 Byte).
Illegal Function Error Count: Anzahl der Anfragen von nicht-implementierten oder illegalen Funktionen. Entsprocht Modbus Exception Code 1.
Illegal Data Address Error Count: Anzahl der Anfragen mit ungütiger Adresse. Entspricht Modbus Exception Code 2.
Illegal Data Value Error Count: Anzahl der Anfragen mit ungültigem Datenwert. Entspricht Modbus Exception Code 3.
Slave Device Failure Error Count: Anzahl der nicht-behebaren Fehler eines Slaves. Entspricht Modbus Exception Code 4.

int tf_rs485_modbus_slave_report_exception(TF_RS485 *rs485, uint8_t request_id, int8_t exception_code)¶

Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] exception_code – Typ: int8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Modbus Exception auf eine Modbus-Master Anfrage zurückzugeben.

Request ID: Request ID einer Anfrage eines Slaves.
Exception Code: Modbus Exception Code für den Modbus Master.

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

Für exception_code:

TF_RS485_EXCEPTION_CODE_TIMEOUT = -1
TF_RS485_EXCEPTION_CODE_SUCCESS = 0
TF_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
TF_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
TF_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
TF_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
TF_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

int tf_rs485_modbus_slave_answer_read_coils_request(TF_RS485 *rs485, uint8_t request_id, const bool *coils, uint16_t coils_length)¶

Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] coils – Typ: const bool * coils_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Coils-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.
Coils: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom Modbus Slave Read Coils Request Callback mit der Request ID des Callbacks aufgerufen werden.

int tf_rs485_modbus_master_read_coils(TF_RS485 *rs485, uint8_t slave_address, uint32_t starting_address, uint16_t count, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: TF_RS485 * slave_address – Typ: uint8_t, Wertebereich: [0 bis 247] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16_t, Wertebereich: [1 bis 2000]
Ausgabeparameter:	ret_request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Coils-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 1).

Slave Addresss: Adresse des Modbus-Slave
Starting Address: Nummer der ersten zu lesenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.
Count: Anzahl der zu lesenden Coils.

Nach erfolgreichen Ausführen der Leseoperation gibt diese Funktion eine Request ID zurück die nicht 0 ist. Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

Falls kein Fehler auftritt, wird auch der Modbus Master Read Coils Response Low Level Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwortet auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

int tf_rs485_modbus_slave_answer_read_holding_registers_request(TF_RS485 *rs485, uint8_t request_id, const uint16_t *holding_registers, uint16_t holding_registers_length)¶

Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] holding_registers – Typ: const uint16_t , Wertebereich: [0 bis 2¹⁶ - 1] holding_registers_length* – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Holding Registers-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.
Holding Registers: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom Modbus Slave Read Holding Registers Request Callback mit der Request ID des Callbacks aufgerufen werden.

int tf_rs485_modbus_master_read_holding_registers(TF_RS485 *rs485, uint8_t slave_address, uint32_t starting_address, uint16_t count, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: TF_RS485 * slave_address – Typ: uint8_t, Wertebereich: [0 bis 247] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16_t, Wertebereich: [1 bis 125]
Ausgabeparameter:	ret_request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Holding Register-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 3).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer des ersten zu lesenden Holding Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) ist implizit und muss ausgelassen werden.
Count: Anzahl der zu lesenden Register.

Nach erfolgreichem Ausführen der Leseoperation gibt diese Funktion eine Request ID zurück, die nicht 0 ist. Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

Falls kein Fehler auftritt, wird auch der Modbus Master Read Holding Registers Response Low Level Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

int tf_rs485_modbus_slave_answer_write_single_coil_request(TF_RS485 *rs485, uint8_t request_id)¶

Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Single Coil-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom Modbus Slave Write Single Coil Request Callback mit der Request ID des Callbacks aufgerufen werden.

int tf_rs485_modbus_master_write_single_coil(TF_RS485 *rs485, uint8_t slave_address, uint32_t coil_address, bool coil_value, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: TF_RS485 * slave_address – Typ: uint8_t, Wertebereich: [0 bis 247] coil_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] coil_value – Typ: bool
Ausgabeparameter:	ret_request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine einzelne Coil eines Modbus-Slave zu schreiben (Modbus Funktionscode 5).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Coil Address: Nummer der zu schreibenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.
Coil Value: Zu schreibender Wert

Falls kein Fehler auftritt, wird auch der Modbus Master Write Single Coil Response Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

int tf_rs485_modbus_slave_answer_write_single_register_request(TF_RS485 *rs485, uint8_t request_id)¶

Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Write Single Register-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom Modbus Slave Write Single Register Request Callback mit der Request ID des Callbacks aufgerufen werden.

int tf_rs485_modbus_master_write_single_register(TF_RS485 *rs485, uint8_t slave_address, uint32_t register_address, uint16_t register_value, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: TF_RS485 * slave_address – Typ: uint8_t, Wertebereich: [0 bis 247] register_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] register_value – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabeparameter:	ret_request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Im Modbus-Master Modus kann diese Funktion genutzt werden, um ein einzelnes Register eines Modbus-Slave zu schreiben (Modbus Funktionscode 6).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Register Address: Nummer des zu schreibenden Holding Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) ist implizit und muss ausgelassen werden.
Register Value: Zu schreibender Wert

Falls kein Fehler auftritt, wird auch der Modbus Master Write Single Register Response Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

int tf_rs485_modbus_slave_answer_write_multiple_coils_request(TF_RS485 *rs485, uint8_t request_id)¶

Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Write Multiple Coils-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom Modbus Slave Write Multiple Coils Request Low Level Callback mit der Request ID des Callbacks aufgerufen werden.

int tf_rs485_modbus_master_write_multiple_coils(TF_RS485 *rs485, uint8_t slave_address, uint32_t starting_address, const bool *coils, uint16_t coils_length, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: TF_RS485 * slave_address – Typ: uint8_t, Wertebereich: [0 bis 247] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] coils – Typ: const bool * coils_length – Typ: uint16_t
Ausgabeparameter:	ret_request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine mehrere Coils eines Modbus-Slave zu schreiben (Modbus Funktionscode 15).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer der ersten zu schreibenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Falls kein Fehler auftritt, wird auch der Modbus Master Write Multiple Coils Response Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

int tf_rs485_modbus_slave_answer_write_multiple_registers_request(TF_RS485 *rs485, uint8_t request_id)¶

Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Write Multiple Register-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom Modbus Slave Write Multiple Registers Request Low Level Callback mit der Request ID des Callbacks aufgerufen werden.

int tf_rs485_modbus_master_write_multiple_registers(TF_RS485 *rs485, uint8_t slave_address, uint32_t starting_address, const uint16_t *registers, uint16_t registers_length, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: TF_RS485 * slave_address – Typ: uint8_t, Wertebereich: [0 bis 247] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] registers – Typ: const uint16_t , Wertebereich: [0 bis 2¹⁶ - 1] registers_length* – Typ: uint16_t
Ausgabeparameter:	ret_request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Im Modbus-Master Modus kann diese Funktion genutzt werden, um ein oder mehrere Holding Register eines Modbus-Slave zu schreiben (Modbus Funktionscode 16).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer des ersten zu schreibenden Holding Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) ist implizit und muss ausgelassen werden.

Falls kein Fehler auftritt, wird auch der Modbus Master Write Multiple Registers Response Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

int tf_rs485_modbus_slave_answer_read_discrete_inputs_request(TF_RS485 *rs485, uint8_t request_id, const bool *discrete_inputs, uint16_t discrete_inputs_length)¶

Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] discrete_inputs – Typ: const bool * discrete_inputs_length – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Discrete Inputs-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.
Discrete Inputs: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom Modbus Slave Read Discrete Inputs Request Callback mit der Request ID des Callbacks aufgerufen werden.

int tf_rs485_modbus_master_read_discrete_inputs(TF_RS485 *rs485, uint8_t slave_address, uint32_t starting_address, uint16_t count, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: TF_RS485 * slave_address – Typ: uint8_t, Wertebereich: [0 bis 247] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16_t, Wertebereich: [1 bis 2000]
Ausgabeparameter:	ret_request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Discrete Inputs-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 2).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer des ersten zu lesenden Discrete Inputs. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Discrete-Input-Nummer zwischen 1 und 65536. Die Präfixziffer 1 (für Discrete Input) ist implizit und muss ausgelassen werden.
Count: Anzahl der zu lesenden Register.

Falls kein Fehler auftritt, wird auch der Modbus Master Read Discrete Inputs Response Low Level Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwortet auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

int tf_rs485_modbus_slave_answer_read_input_registers_request(TF_RS485 *rs485, uint8_t request_id, const uint16_t *input_registers, uint16_t input_registers_length)¶

Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] input_registers – Typ: const uint16_t , Wertebereich: [0 bis 2¹⁶ - 1] input_registers_length* – Typ: uint16_t
Rückgabe:	e_code – Typ: int

Im Modbus-Slave Modus kann diese Funktion genutzt werden, um eine Read Input-Anfrage eines Modbus-Masters zu beantworten.

Request ID: Request ID der zu beantwortenden Anfrage.
Input Registers: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom Modbus Slave Read Input Registers Request Callback mit der Request ID des Callbacks aufgerufen werden.

int tf_rs485_modbus_master_read_input_registers(TF_RS485 *rs485, uint8_t slave_address, uint32_t starting_address, uint16_t count, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: TF_RS485 * slave_address – Typ: uint8_t, Wertebereich: [0 bis 247] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16_t, Wertebereich: [1 bis 125]
Ausgabeparameter:	ret_request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Input-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 4).

Slave Address: Addresse des anzusprechenden Modbus-Slave.
Starting Address: Nummer der ersten zu lesenden Input Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Input-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 3 (für Input Register) ist implizit und muss ausgelassen werden.
Count: Anzahl der zu lesenden Register.

Falls kein Fehler auftritt, wird auch der Modbus Master Read Input Registers Response Low Level Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwortet auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

int tf_rs485_get_spitfp_error_count(TF_RS485 *rs485, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_rs485_set_status_led_config(TF_RS485 *rs485, uint8_t config)¶

Parameter:	rs485 – Typ: TF_RS485 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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:

TF_RS485_STATUS_LED_CONFIG_OFF = 0
TF_RS485_STATUS_LED_CONFIG_ON = 1
TF_RS485_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_RS485_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_rs485_get_status_led_config(TF_RS485 *rs485, uint8_t *ret_config)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

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

Für ret_config:

TF_RS485_STATUS_LED_CONFIG_OFF = 0
TF_RS485_STATUS_LED_CONFIG_ON = 1
TF_RS485_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_RS485_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_rs485_get_chip_temperature(TF_RS485 *rs485, int16_t *ret_temperature)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_rs485_reset(TF_RS485 *rs485)¶

Parameter:	rs485 – Typ: TF_RS485 *
Rückgabe:	e_code – Typ: int

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.

int tf_rs485_get_identity(TF_RS485 *rs485, 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:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', '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 2¹⁶ - 1]
Rückgabe:	e_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 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¶

int tf_rs485_enable_read_callback(TF_RS485 *rs485)¶

Parameter:	rs485 – Typ: TF_RS485 *
Rückgabe:	e_code – Typ: int

Aktiviert den Read Low Level Callback. Dies deaktiviert den Frame Readable Callback.

Im Startzustand ist der Callback deaktiviert.

int tf_rs485_disable_read_callback(TF_RS485 *rs485)¶

Parameter:	rs485 – Typ: TF_RS485 *
Rückgabe:	e_code – Typ: int

Deaktiviert den Read Low Level Callback.

Im Startzustand ist der Callback deaktiviert.

int tf_rs485_is_read_callback_enabled(TF_RS485 *rs485, bool *ret_enabled)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_enabled – Typ: bool, Standardwert: false
Rückgabe:	e_code – Typ: int

Gibt true zurück falls Read Low Level Callback aktiviert ist, false sonst.

int tf_rs485_enable_error_count_callback(TF_RS485 *rs485)¶

Parameter:	rs485 – Typ: TF_RS485 *
Rückgabe:	e_code – Typ: int

Aktiviert den Error Count Callback.

Im Startzustand ist der Callback deaktiviert.

int tf_rs485_disable_error_count_callback(TF_RS485 *rs485)¶

Parameter:	rs485 – Typ: TF_RS485 *
Rückgabe:	e_code – Typ: int

Deaktiviert den Error Count Callback.

Im Startzustand ist der Callback deaktiviert.

int tf_rs485_is_error_count_callback_enabled(TF_RS485 *rs485, bool *ret_enabled)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_enabled – Typ: bool, Standardwert: true
Rückgabe:	e_code – Typ: int

Gibt true zurück falls Error Count Callback aktiviert ist, false sonst.

int tf_rs485_set_frame_readable_callback_configuration(TF_RS485 *rs485, uint16_t frame_size)¶

Parameter:	rs485 – Typ: TF_RS485 * frame_size – Typ: uint16_t, Einheit: 1 B, Wertebereich: [0 bis 9216], Standardwert: 0
Rückgabe:	e_code – Typ: int

Konfiguriert den Frame Readable Callback. Die Frame Size ist die Anzahl an Bytes, die lesbar sein müssen, damit der Callback auslöst. Eine Frame Size von 0 deaktiviert den Callback. Eine Frame Size größer als 0 aktiviert diesen und deaktiviert den Read Low Level Callback.

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.5 (Plugin).

int tf_rs485_get_frame_readable_callback_configuration(TF_RS485 *rs485, uint16_t *ret_frame_size)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_frame_size – Typ: uint16_t, Einheit: 1 B, Wertebereich: [0 bis 9216], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

Neu in Version 2.0.5 (Plugin).

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden tf_rs485_register_*_callback Funktion durchgeführt werden. Die user_data, sowie das Gerät, dass das Callback ausgelöst hat, werden dem registrierten Callback-Handler übergeben.

Nur ein Handler kann gleichzeitig auf das selbe Callback registriert werden. Um einen Handler zu deregistrieren, kann die tf_rs485_register_*_callback-Funktion mit NULL als Handler aufgerufen werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist gegenüber der Verwendung von Abfragen zu bevorzugen. Es muss nur ein Byte abgefragt werden um zu prüfen ob ein Callback vorliegt. Siehe hier Performanceoptimierungen.

Warnung

Aus Callback-Handlern heraus können keine Bindings-Funktionen verwendet werden. Siehe hier Callbacks.

int tf_rs485_register_read_low_level_callback(TF_RS485 *rs485, TF_RS485_ReadLowLevelHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint16_t message_length, uint16_t message_chunk_offset, char message_chunk_data[60], void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * message_length – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] message_chunk_offset – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] message_chunk_data – Typ: char[60] user_data – Typ: void *

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen.

Dieser Callback kann durch tf_rs485_enable_read_callback() aktiviert werden.

int tf_rs485_register_error_count_callback(TF_RS485 *rs485, TF_RS485_ErrorCountHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint32_t overrun_error_count, uint32_t parity_error_count, void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * overrun_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] parity_error_count – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] user_data – Typ: void *

Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun and Parity Fehler zurück.

int tf_rs485_register_modbus_slave_read_coils_request_callback(TF_RS485 *rs485, TF_RS485_ModbusSlaveReadCoilsRequestHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, uint32_t starting_address, uint16_t count, void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16_t, Wertebereich: [1 bis 2000] user_data – Typ: void *

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Coils erhält. Die Parameter sind die Request ID der Anfrage, die Nummer der ersten zu lesenden Coil und die Anzahl der zu lesenden Coils. Die Nummer der ersten Coil heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Eine Antwort auf diese Anfrage kann mit der Funktion tf_rs485_modbus_slave_answer_read_coils_request() gesendet werden.

int tf_rs485_register_modbus_master_read_coils_response_low_level_callback(TF_RS485 *rs485, TF_RS485_ModbusMasterReadCoilsResponseLowLevelHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, int8_t exception_code, uint16_t coils_length, uint16_t coils_chunk_offset, bool coils_chunk_data[464], void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] exception_code – Typ: int8_t, Wertebereich: Siehe Konstanten coils_length – Typ: uint16_t, Wertebereich: [0 bis 2000] coils_chunk_offset – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] coils_chunk_data – Typ: bool[464] user_data – Typ: void *

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Coils-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

Ein Exception Code der nicht 0 ist, beschreibt einen Fehler. Wenn die Zahl größer 0 ist, entspricht der Code dem Modbus Exception Code. Wenn die Zahl kleiner 0 ist, ist ein anderer Fehler aufgetreten. Ein Wert von -1 bedeutet, dass es einen Timeout bei der Anfrage gab. Die Länge dieses Timeouts kann per tf_rs485_set_modbus_configuration() gesetzt werden.

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

Für exception_code:

TF_RS485_EXCEPTION_CODE_TIMEOUT = -1
TF_RS485_EXCEPTION_CODE_SUCCESS = 0
TF_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
TF_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
TF_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
TF_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
TF_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

int tf_rs485_register_modbus_slave_read_holding_registers_request_callback(TF_RS485 *rs485, TF_RS485_ModbusSlaveReadHoldingRegistersRequestHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, uint32_t starting_address, uint16_t count, void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16_t, Wertebereich: [1 bis 125] user_data – Typ: void *

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Holding Registern erhält. Die Parameter sind die Request ID der Anfrage, die Nummer des ersten zu lesenden Holding Registers und die Anzahl der zu lesenden Register. Die Nummer des ersten Holding Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion tf_rs485_modbus_slave_answer_read_holding_registers_request() gesendet werden.

int tf_rs485_register_modbus_master_read_holding_registers_response_low_level_callback(TF_RS485 *rs485, TF_RS485_ModbusMasterReadHoldingRegistersResponseLowLevelHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, int8_t exception_code, uint16_t holding_registers_length, uint16_t holding_registers_chunk_offset, uint16_t holding_registers_chunk_data[29], void *user_data)

Callback-Parameter:

rs485 – Typ: TF_RS485 *
request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
exception_code – Typ: int8_t, Wertebereich: Siehe Konstanten
holding_registers_length – Typ: uint16_t, Wertebereich: [0 bis 125]
holding_registers_chunk_offset – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
holding_registers_chunk_data – Typ: uint16_t[29], Wertebereich: [0 bis 2¹⁶ - 1]
user_data – Typ: void *

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Holding Registers-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

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

Für exception_code:

TF_RS485_EXCEPTION_CODE_TIMEOUT = -1
TF_RS485_EXCEPTION_CODE_SUCCESS = 0
TF_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
TF_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
TF_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
TF_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
TF_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

int tf_rs485_register_modbus_slave_write_single_coil_request_callback(TF_RS485 *rs485, TF_RS485_ModbusSlaveWriteSingleCoilRequestHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, uint32_t coil_address, bool coil_value, void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] coil_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] coil_value – Typ: bool user_data – Typ: void *

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer einzelnen Coil erhält. Die Parameter sind die Request ID der Anfrage, die Nummer der Coil und der Wert der zu schreibenen Coil. Die Nummer der Coil heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Eine Antwort auf diese Anfrage kann mit der Funktion tf_rs485_modbus_slave_answer_write_single_coil_request() gesendet werden.

int tf_rs485_register_modbus_master_write_single_coil_response_callback(TF_RS485 *rs485, TF_RS485_ModbusMasterWriteSingleCoilResponseHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, int8_t exception_code, void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] exception_code – Typ: int8_t, Wertebereich: Siehe Konstanten user_data – Typ: void *

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Single Coil-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage und der Exception Code der Antwort.

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

Für exception_code:

TF_RS485_EXCEPTION_CODE_TIMEOUT = -1
TF_RS485_EXCEPTION_CODE_SUCCESS = 0
TF_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
TF_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
TF_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
TF_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
TF_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

int tf_rs485_register_modbus_slave_write_single_register_request_callback(TF_RS485 *rs485, TF_RS485_ModbusSlaveWriteSingleRegisterRequestHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, uint32_t register_address, uint16_t register_value, void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] register_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] register_value – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer einzelnen Holding Registers erhält. Die Parameter sind die Request ID der Anfrage, die Nummer des Holding Registers und der Wert des zuschreibenen Registers. Die Nummer des Holding Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion tf_rs485_modbus_slave_answer_write_single_register_request() gesendet werden.

int tf_rs485_register_modbus_master_write_single_register_response_callback(TF_RS485 *rs485, TF_RS485_ModbusMasterWriteSingleRegisterResponseHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, int8_t exception_code, void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] exception_code – Typ: int8_t, Wertebereich: Siehe Konstanten user_data – Typ: void *

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Single Register-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage und der Exception Code der Antwort.

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

Für exception_code:

TF_RS485_EXCEPTION_CODE_TIMEOUT = -1
TF_RS485_EXCEPTION_CODE_SUCCESS = 0
TF_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
TF_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
TF_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
TF_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
TF_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

int tf_rs485_register_modbus_slave_write_multiple_coils_request_low_level_callback(TF_RS485 *rs485, TF_RS485_ModbusSlaveWriteMultipleCoilsRequestLowLevelHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, uint32_t starting_address, uint16_t coils_length, uint16_t coils_chunk_offset, bool coils_chunk_data[440], void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] coils_length – Typ: uint16_t, Wertebereich: [1 bis 1968] coils_chunk_offset – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] coils_chunk_data – Typ: bool[440] user_data – Typ: void *

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer mehrerer Coils erhält. Die Parameter sind die Request ID der Anfrage, die Nummer der ersten Coil und die zu schreibenen Daten. Die Nummer der ersten Coil heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Eine Antwort auf diese Anfrage kann mit der Funktion tf_rs485_modbus_slave_answer_write_multiple_coils_request() gesendet werden.

int tf_rs485_register_modbus_master_write_multiple_coils_response_callback(TF_RS485 *rs485, TF_RS485_ModbusMasterWriteMultipleCoilsResponseHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, int8_t exception_code, void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] exception_code – Typ: int8_t, Wertebereich: Siehe Konstanten user_data – Typ: void *

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Multiple Coils-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage und der Exception Code der Antwort.

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

Für exception_code:

TF_RS485_EXCEPTION_CODE_TIMEOUT = -1
TF_RS485_EXCEPTION_CODE_SUCCESS = 0
TF_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
TF_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
TF_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
TF_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
TF_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

int tf_rs485_register_modbus_slave_write_multiple_registers_request_low_level_callback(TF_RS485 *rs485, TF_RS485_ModbusSlaveWriteMultipleRegistersRequestLowLevelHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, uint32_t starting_address, uint16_t registers_length, uint16_t registers_chunk_offset, uint16_t registers_chunk_data[27], void *user_data)

Callback-Parameter:

rs485 – Typ: TF_RS485 *
request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶]
registers_length – Typ: uint16_t, Wertebereich: [1 bis 123]
registers_chunk_offset – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
registers_chunk_data – Typ: uint16_t[27], Wertebereich: [0 bis 2¹⁶ - 1]
user_data – Typ: void *

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer mehrerer Holding Register erhält. Die Parameter sind die Request ID der Anfrage, die Nummer des ersten Holding Registers und die zu schreibenen Daten. Die Nummer des ersten Holding Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion tf_rs485_modbus_slave_answer_write_multiple_registers_request() gesendet werden.

int tf_rs485_register_modbus_master_write_multiple_registers_response_callback(TF_RS485 *rs485, TF_RS485_ModbusMasterWriteMultipleRegistersResponseHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, int8_t exception_code, void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] exception_code – Typ: int8_t, Wertebereich: Siehe Konstanten user_data – Typ: void *

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Multiple Register-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage und der Exception Code der Antwort.

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

Für exception_code:

TF_RS485_EXCEPTION_CODE_TIMEOUT = -1
TF_RS485_EXCEPTION_CODE_SUCCESS = 0
TF_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
TF_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
TF_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
TF_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
TF_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

int tf_rs485_register_modbus_slave_read_discrete_inputs_request_callback(TF_RS485 *rs485, TF_RS485_ModbusSlaveReadDiscreteInputsRequestHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, uint32_t starting_address, uint16_t count, void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16_t, Wertebereich: [1 bis 2000] user_data – Typ: void *

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Discrete Inputs erhält. Die Parameter sind die Request ID der Anfrage, die Nummer des ersten Discrete Inputs und die Anzahl der zu lesenden Discrete Inputs. Die Nummer des ersten Discrete Inputs heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Discrete Input-Nummer zwischen 1 und 65536. Die Präfixziffer 1 (für Discrete Input) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion tf_rs485_modbus_slave_answer_read_discrete_inputs_request() gesendet werden.

int tf_rs485_register_modbus_master_read_discrete_inputs_response_low_level_callback(TF_RS485 *rs485, TF_RS485_ModbusMasterReadDiscreteInputsResponseLowLevelHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, int8_t exception_code, uint16_t discrete_inputs_length, uint16_t discrete_inputs_chunk_offset, bool discrete_inputs_chunk_data[464], void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] exception_code – Typ: int8_t, Wertebereich: Siehe Konstanten discrete_inputs_length – Typ: uint16_t, Wertebereich: [1 bis 2000] discrete_inputs_chunk_offset – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] discrete_inputs_chunk_data – Typ: bool[464] user_data – Typ: void *

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Discrete Inputs-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

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

Für exception_code:

TF_RS485_EXCEPTION_CODE_TIMEOUT = -1
TF_RS485_EXCEPTION_CODE_SUCCESS = 0
TF_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
TF_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
TF_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
TF_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
TF_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

int tf_rs485_register_modbus_slave_read_input_registers_request_callback(TF_RS485 *rs485, TF_RS485_ModbusSlaveReadInputRegistersRequestHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, uint32_t starting_address, uint16_t count, void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16_t, Wertebereich: [1 bis 125] user_data – Typ: void *

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Input Registern erhält. Die Parameter sind die Request ID der Anfrage, die Nummer des ersten Input Registers und die Anzahl der zu lesenden Register. Die Nummer des ersten Input Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Input Register-Nummer zwischen 1 und 65536. Die Präfixziffer 3 (für Input Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion tf_rs485_modbus_slave_answer_read_input_registers_request() gesendet werden.

int tf_rs485_register_modbus_master_read_input_registers_response_low_level_callback(TF_RS485 *rs485, TF_RS485_ModbusMasterReadInputRegistersResponseLowLevelHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint8_t request_id, int8_t exception_code, uint16_t input_registers_length, uint16_t input_registers_chunk_offset, uint16_t input_registers_chunk_data[29], void *user_data)

Callback-Parameter:

rs485 – Typ: TF_RS485 *
request_id – Typ: uint8_t, Wertebereich: [0 bis 255]
exception_code – Typ: int8_t, Wertebereich: Siehe Konstanten
input_registers_length – Typ: uint16_t, Wertebereich: [1 bis 125]
input_registers_chunk_offset – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1]
input_registers_chunk_data – Typ: uint16_t[29], Wertebereich: [0 bis 2¹⁶ - 1]
user_data – Typ: void *

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Input Registers-Anfrage zurück bekommt.

Die Parameter sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

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

Für exception_code:

TF_RS485_EXCEPTION_CODE_TIMEOUT = -1
TF_RS485_EXCEPTION_CODE_SUCCESS = 0
TF_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
TF_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
TF_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
TF_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
TF_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
TF_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
TF_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

int tf_rs485_register_frame_readable_callback(TF_RS485 *rs485, TF_RS485_FrameReadableHandler handler, void *user_data)¶

void handler(TF_RS485 *rs485, uint16_t frame_count, void *user_data)

Callback-Parameter:	rs485 – Typ: TF_RS485 * frame_count – Typ: uint16_t, Wertebereich: [0 bis 2¹⁶ - 1] user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn mindestens ein neuer Frame an Daten verfügbar sind. Die Größe eines Frames kann mit tf_rs485_set_frame_readable_callback_configuration() konfiguriert werden. Frame Count ist die Anzahl an Frames, die zum Lesen bereitstehen. Der Callback wird nur einmal pro tf_rs485_read() Aufruf ausgelöst. Das heißt, dass wenn eine Framegröße von X Bytes konfiguriert wird, jedes Mal wenn das Callback ausgelöst wird, X Bytes mit der tf_rs485_read()-Funktion gelesen werden können, ohne dass der Frame Count-Parameter geprüft werden muss.

Neu in Version 2.0.5 (Plugin).

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt.

int tf_rs485_get_response_expected(TF_RS485 *rs485, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	rs485 – Typ: TF_RS485 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_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 tf_rs485_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:

TF_RS485_FUNCTION_ENABLE_READ_CALLBACK = 3
TF_RS485_FUNCTION_DISABLE_READ_CALLBACK = 4
TF_RS485_FUNCTION_SET_RS485_CONFIGURATION = 6
TF_RS485_FUNCTION_SET_MODBUS_CONFIGURATION = 8
TF_RS485_FUNCTION_SET_MODE = 10
TF_RS485_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
TF_RS485_FUNCTION_SET_ERROR_LED_CONFIG = 14
TF_RS485_FUNCTION_SET_BUFFER_CONFIG = 16
TF_RS485_FUNCTION_ENABLE_ERROR_COUNT_CALLBACK = 19
TF_RS485_FUNCTION_DISABLE_ERROR_COUNT_CALLBACK = 20
TF_RS485_FUNCTION_MODBUS_SLAVE_REPORT_EXCEPTION = 24
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_COILS_REQUEST = 25
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_HOLDING_REGISTERS_REQUEST = 27
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_COIL_REQUEST = 29
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_REGISTER_REQUEST = 31
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_COILS_REQUEST = 33
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_REGISTERS_REQUEST = 35
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_DISCRETE_INPUTS_REQUEST = 37
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_INPUT_REGISTERS_REQUEST = 39
TF_RS485_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 59
TF_RS485_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_RS485_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_RS485_FUNCTION_RESET = 243
TF_RS485_FUNCTION_WRITE_UID = 248

int tf_rs485_set_response_expected(TF_RS485 *rs485, uint8_t function_id, bool response_expected)¶

Parameter:	rs485 – Typ: TF_RS485 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_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.

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

Für function_id:

TF_RS485_FUNCTION_ENABLE_READ_CALLBACK = 3
TF_RS485_FUNCTION_DISABLE_READ_CALLBACK = 4
TF_RS485_FUNCTION_SET_RS485_CONFIGURATION = 6
TF_RS485_FUNCTION_SET_MODBUS_CONFIGURATION = 8
TF_RS485_FUNCTION_SET_MODE = 10
TF_RS485_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
TF_RS485_FUNCTION_SET_ERROR_LED_CONFIG = 14
TF_RS485_FUNCTION_SET_BUFFER_CONFIG = 16
TF_RS485_FUNCTION_ENABLE_ERROR_COUNT_CALLBACK = 19
TF_RS485_FUNCTION_DISABLE_ERROR_COUNT_CALLBACK = 20
TF_RS485_FUNCTION_MODBUS_SLAVE_REPORT_EXCEPTION = 24
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_COILS_REQUEST = 25
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_HOLDING_REGISTERS_REQUEST = 27
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_COIL_REQUEST = 29
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_REGISTER_REQUEST = 31
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_COILS_REQUEST = 33
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_REGISTERS_REQUEST = 35
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_DISCRETE_INPUTS_REQUEST = 37
TF_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_INPUT_REGISTERS_REQUEST = 39
TF_RS485_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 59
TF_RS485_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_RS485_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_RS485_FUNCTION_RESET = 243
TF_RS485_FUNCTION_WRITE_UID = 248

int tf_rs485_set_response_expected_all(TF_RS485 *rs485, bool response_expected)¶

Parameter:	rs485 – Typ: TF_RS485 * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Ä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.

int tf_rs485_set_bootloader_mode(TF_RS485 *rs485, uint8_t mode, uint8_t *ret_status)¶

Parameter:	rs485 – Typ: TF_RS485 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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:

TF_RS485_BOOTLOADER_MODE_BOOTLOADER = 0
TF_RS485_BOOTLOADER_MODE_FIRMWARE = 1
TF_RS485_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_RS485_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_RS485_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_RS485_BOOTLOADER_STATUS_OK = 0
TF_RS485_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_RS485_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_RS485_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_RS485_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_RS485_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_rs485_get_bootloader_mode(TF_RS485 *rs485, uint8_t *ret_mode)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Bootloader-Modus zurück, siehe tf_rs485_set_bootloader_mode().

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

Für ret_mode:

TF_RS485_BOOTLOADER_MODE_BOOTLOADER = 0
TF_RS485_BOOTLOADER_MODE_FIRMWARE = 1
TF_RS485_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_RS485_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_RS485_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_rs485_set_write_firmware_pointer(TF_RS485 *rs485, uint32_t pointer)¶

Parameter:	rs485 – Typ: TF_RS485 * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für tf_rs485_write_firmware(). 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.

int tf_rs485_write_firmware(TF_RS485 *rs485, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	rs485 – Typ: TF_RS485 * data – Typ: const uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von tf_rs485_set_write_firmware_pointer() 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.

int tf_rs485_write_uid(TF_RS485 *rs485, uint32_t uid)¶

Parameter:	rs485 – Typ: TF_RS485 * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_rs485_read_uid(TF_RS485 *rs485, uint32_t *ret_uid)¶

Parameter:	rs485 – Typ: TF_RS485 *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

TF_RS485_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein RS485 Bricklet zu identifizieren.

Die Funktionen tf_rs485_get_identity() und tf_hal_get_device_info() haben einen device_identifier Ausgabe-Parameter um den Typ des Bricks oder Bricklets anzugeben.

TF_RS485_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines RS485 Bricklet dar.