Software / API Bindings / C/C++ / API Referenz und Beispiele / Bricklets / RS485 Bricklet

C/C++ - RS485 Bricklet¶

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Modbus Master¶

Download (example_modbus_master.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_rs485.h"

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

// Callback function for Modbus master write single register response callback
void cb_modbus_master_write_single_register_response(uint8_t request_id,
                                                     int8_t exception_code,
                                                     void *user_data) {
    uint8_t expected_request_id = *(uint8_t *)user_data;

    printf("Request ID: %u\n", request_id);
    printf("Exception Code: %d\n", exception_code);

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

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

    // Create device object
    RS485 rs485;
    rs485_create(&rs485, 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

    // Set operating mode to Modbus RTU master
    rs485_set_mode(&rs485, RS485_MODE_MODBUS_MASTER_RTU);

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

    // Register Modbus master write single register response callback to function
    // cb_modbus_master_write_single_register_response
    uint8_t expected_request_id = 0;
    rs485_register_callback(&rs485,
                            RS485_CALLBACK_MODBUS_MASTER_WRITE_SINGLE_REGISTER_RESPONSE,
                            (void (*)(void))cb_modbus_master_write_single_register_response,
                            (void *)&expected_request_id);

    // Write 65535 to register 42 of slave 17
    rs485_modbus_master_write_single_register(&rs485, 17, 42, 65535, &expected_request_id);

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

Modbus Slave¶

Download (example_modbus_slave.c)

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_rs485.h"

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

// Callback function for Modbus slave write single register request callback
void cb_modbus_slave_write_single_register_request(uint8_t request_id,
                                                   uint32_t register_address,
                                                   uint16_t register_value,
                                                   void *user_data) {
    RS485 *rs485 = (RS485 *)user_data;

    printf("Request ID: %d\n", request_id);
    printf("Register Address: %d\n", register_address);
    printf("Register Value: %d\n", register_value);

    if (register_address != 42) {
        printf("Error: Invalid register address\n");
        rs485_modbus_slave_report_exception(rs485, request_id, RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS);
    } else {
        rs485_modbus_slave_answer_write_single_register_request(rs485, request_id);
    }
}

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

    // Create device object
    RS485 rs485;
    rs485_create(&rs485, 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

    // Set operating mode to Modbus RTU slave
    rs485_set_mode(&rs485, RS485_MODE_MODBUS_SLAVE_RTU);

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

    // Register Modbus slave write single register request callback to function
    // cb_modbus_slave_write_single_register_request
    rs485_register_callback(&rs485,
                            RS485_CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_REGISTER_REQUEST,
                            (void (*)(void))cb_modbus_slave_write_single_register_request,
                            (void *)&rs485);

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

Loopback¶

Download (example_loopback.c)

#include <stdio.h>
#include <stdlib.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

#include "ip_connection.h"
#include "bricklet_rs485.h"

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

// Callback function for read callback
void cb_read(char *message, uint16_t message_length, void *user_data) {
    char *buffer;

    (void)user_data; // avoid unused parameter warning

    // Assume that the message consists of ASCII characters and
    // convert it from an array of chars to a NUL-terminated string
    buffer = (char *)malloc(message_length + 1); // +1 for the NUL-terminator
    memcpy(buffer, message, message_length);
    buffer[message_length] = '\0';

    printf("Message: \"%s\"\n", buffer);
    free(buffer);
}

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

    // Create device object
    RS485 rs485;
    rs485_create(&rs485, 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

    // Enable full-duplex mode
    rs485_set_rs485_configuration(&rs485, 115200, RS485_PARITY_NONE, RS485_STOPBITS_1,
                                  RS485_WORDLENGTH_8, RS485_DUPLEX_FULL);

    // Register read callback to function cb_read
    rs485_register_callback(&rs485,
                            RS485_CALLBACK_READ,
                            (void (*)(void))cb_read,
                            NULL);

    // Enable read callback
    rs485_enable_read_callback(&rs485);

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

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

API¶

Die meistens Funktionen der C/C++ Bindings geben einen Fehlercode (e_code) zurück. 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 (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 rs485_create(RS485 *rs485, const char *uid, IPConnection *ipcon)¶

Parameter:	rs485 – Typ: RS485 * uid – Typ: const char * ipcon – Typ: IPConnection *

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

RS485 rs485;
rs485_create(&rs485, "YOUR_DEVICE_UID", &ipcon);

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

void rs485_destroy(RS485 *rs485)¶

Parameter:	rs485 – Typ: RS485 *

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

int rs485_write(RS485 *rs485, const char *message, uint16_t message_length, uint16_t *ret_message_written)¶

Parameter:	rs485 – Typ: 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 rs485_set_rs485_configuration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

int rs485_read(RS485 *rs485, uint16_t length, char *ret_message, uint16_t *ret_message_length)¶

Parameter:	rs485 – Typ: 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 rs485_enable_read_callback() und RS485_CALLBACK_READ Callback.

int rs485_set_rs485_configuration(RS485 *rs485, uint32_t baudrate, uint8_t parity, uint8_t stopbits, uint8_t wordlength, uint8_t duplex)¶

Parameter:

Parameter:	rs485 – Typ: 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: 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:

RS485_PARITY_NONE = 0
RS485_PARITY_ODD = 1
RS485_PARITY_EVEN = 2

Für stopbits:

RS485_STOPBITS_1 = 1
RS485_STOPBITS_2 = 2

Für wordlength:

RS485_WORDLENGTH_5 = 5
RS485_WORDLENGTH_6 = 6
RS485_WORDLENGTH_7 = 7
RS485_WORDLENGTH_8 = 8

Für duplex:

RS485_DUPLEX_HALF = 0
RS485_DUPLEX_FULL = 1

int rs485_get_rs485_configuration(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: 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 rs485_set_rs485_configuration() gesetzt.

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

Für ret_parity:

RS485_PARITY_NONE = 0
RS485_PARITY_ODD = 1
RS485_PARITY_EVEN = 2

Für ret_stopbits:

RS485_STOPBITS_1 = 1
RS485_STOPBITS_2 = 2

Für ret_wordlength:

RS485_WORDLENGTH_5 = 5
RS485_WORDLENGTH_6 = 6
RS485_WORDLENGTH_7 = 7
RS485_WORDLENGTH_8 = 8

Für ret_duplex:

RS485_DUPLEX_HALF = 0
RS485_DUPLEX_FULL = 1

int rs485_set_modbus_configuration(RS485 *rs485, uint8_t slave_address, uint32_t master_request_timeout)¶

Parameter:	rs485 – Typ: 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 rs485_get_modbus_configuration(RS485 *rs485, uint8_t *ret_slave_address, uint32_t *ret_master_request_timeout)¶

Parameter:	rs485 – Typ: 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 rs485_set_modbus_configuration() gesetzt.

int rs485_set_mode(RS485 *rs485, uint8_t mode)¶

Parameter:	rs485 – Typ: 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:

RS485_MODE_RS485 = 0
RS485_MODE_MODBUS_MASTER_RTU = 1
RS485_MODE_MODBUS_SLAVE_RTU = 2

int rs485_get_mode(RS485 *rs485, uint8_t *ret_mode)¶

Parameter:	rs485 – Typ: 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 rs485_set_mode() gesetzt.

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

Für ret_mode:

RS485_MODE_RS485 = 0
RS485_MODE_MODBUS_MASTER_RTU = 1
RS485_MODE_MODBUS_SLAVE_RTU = 2

Fortgeschrittene Funktionen¶

int rs485_set_communication_led_config(RS485 *rs485, uint8_t config)¶

Parameter:	rs485 – Typ: 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:

RS485_COMMUNICATION_LED_CONFIG_OFF = 0
RS485_COMMUNICATION_LED_CONFIG_ON = 1
RS485_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
RS485_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

int rs485_get_communication_led_config(RS485 *rs485, uint8_t *ret_config)¶

Parameter:	rs485 – Typ: 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 rs485_set_communication_led_config() gesetzt.

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

Für ret_config:

RS485_COMMUNICATION_LED_CONFIG_OFF = 0
RS485_COMMUNICATION_LED_CONFIG_ON = 1
RS485_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
RS485_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3

int rs485_set_error_led_config(RS485 *rs485, uint8_t config)¶

Parameter:	rs485 – Typ: 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 RS485_CALLBACK_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:

RS485_ERROR_LED_CONFIG_OFF = 0
RS485_ERROR_LED_CONFIG_ON = 1
RS485_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
RS485_ERROR_LED_CONFIG_SHOW_ERROR = 3

int rs485_get_error_led_config(RS485 *rs485, uint8_t *ret_config)¶

Parameter:	rs485 – Typ: 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 rs485_set_error_led_config() gesetzt.

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

Für ret_config:

RS485_ERROR_LED_CONFIG_OFF = 0
RS485_ERROR_LED_CONFIG_ON = 1
RS485_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
RS485_ERROR_LED_CONFIG_SHOW_ERROR = 3

int rs485_set_buffer_config(RS485 *rs485, uint16_t send_buffer_size, uint16_t receive_buffer_size)¶

Parameter:	rs485 – Typ: 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 rs485_write() übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS485 empfangen wurden aber noch nicht über rs485_read() oder RS485_CALLBACK_READ Callback an ein Nutzerprogramm übertragen werden konnten.

int rs485_get_buffer_config(RS485 *rs485, uint16_t *ret_send_buffer_size, uint16_t *ret_receive_buffer_size)¶

Parameter:	rs485 – Typ: 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 rs485_set_buffer_config() gesetzt.

int rs485_get_buffer_status(RS485 *rs485, uint16_t *ret_send_buffer_used, uint16_t *ret_receive_buffer_used)¶

Parameter:	rs485 – Typ: 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 rs485_set_buffer_config() zur Konfiguration der Buffergrößen.

int rs485_get_error_count(RS485 *rs485, uint32_t *ret_overrun_error_count, uint32_t *ret_parity_error_count)¶

Parameter:	rs485 – Typ: 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 rs485_get_modbus_common_error_count(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: 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 rs485_modbus_slave_report_exception(RS485 *rs485, uint8_t request_id, int8_t exception_code)¶

Parameter:	rs485 – Typ: 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:

RS485_EXCEPTION_CODE_TIMEOUT = -1
RS485_EXCEPTION_CODE_SUCCESS = 0
RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

int rs485_modbus_slave_answer_read_coils_request(RS485 *rs485, uint8_t request_id, bool *coils, uint16_t coils_length)¶

Parameter:	rs485 – Typ: RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] coils – Typ: 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 RS485_CALLBACK_MODBUS_SLAVE_READ_COILS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

int rs485_modbus_master_read_coils(RS485 *rs485, uint8_t slave_address, uint32_t starting_address, uint16_t count, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: 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 RS485_CALLBACK_MODBUS_MASTER_READ_COILS_RESPONSE 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 rs485_modbus_slave_answer_read_holding_registers_request(RS485 *rs485, uint8_t request_id, uint16_t *holding_registers, uint16_t holding_registers_length)¶

Parameter:	rs485 – Typ: RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] holding_registers – Typ: 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 RS485_CALLBACK_MODBUS_SLAVE_READ_HOLDING_REGISTERS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

int rs485_modbus_master_read_holding_registers(RS485 *rs485, uint8_t slave_address, uint32_t starting_address, uint16_t count, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: 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 RS485_CALLBACK_MODBUS_MASTER_READ_HOLDING_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.

int rs485_modbus_slave_answer_write_single_coil_request(RS485 *rs485, uint8_t request_id)¶

Parameter:	rs485 – Typ: 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 RS485_CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_COIL_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

int rs485_modbus_master_write_single_coil(RS485 *rs485, uint8_t slave_address, uint32_t coil_address, bool coil_value, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: 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 RS485_CALLBACK_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 rs485_modbus_slave_answer_write_single_register_request(RS485 *rs485, uint8_t request_id)¶

Parameter:	rs485 – Typ: 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 RS485_CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_REGISTER_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

int rs485_modbus_master_write_single_register(RS485 *rs485, uint8_t slave_address, uint32_t register_address, uint16_t register_value, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: 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 RS485_CALLBACK_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 rs485_modbus_slave_answer_write_multiple_coils_request(RS485 *rs485, uint8_t request_id)¶

Parameter:	rs485 – Typ: 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 RS485_CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_COILS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

int rs485_modbus_master_write_multiple_coils(RS485 *rs485, uint8_t slave_address, uint32_t starting_address, bool *coils, uint16_t coils_length, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: RS485 * slave_address – Typ: uint8_t, Wertebereich: [0 bis 247] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] coils – Typ: 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 RS485_CALLBACK_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 rs485_modbus_slave_answer_write_multiple_registers_request(RS485 *rs485, uint8_t request_id)¶

Parameter:	rs485 – Typ: 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 RS485_CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_REGISTERS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

int rs485_modbus_master_write_multiple_registers(RS485 *rs485, uint8_t slave_address, uint32_t starting_address, uint16_t *registers, uint16_t registers_length, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: RS485 * slave_address – Typ: uint8_t, Wertebereich: [0 bis 247] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] registers – Typ: 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 RS485_CALLBACK_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 rs485_modbus_slave_answer_read_discrete_inputs_request(RS485 *rs485, uint8_t request_id, bool *discrete_inputs, uint16_t discrete_inputs_length)¶

Parameter:	rs485 – Typ: RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] discrete_inputs – Typ: 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 RS485_CALLBACK_MODBUS_SLAVE_READ_DISCRETE_INPUTS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

int rs485_modbus_master_read_discrete_inputs(RS485 *rs485, uint8_t slave_address, uint32_t starting_address, uint16_t count, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: 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 RS485_CALLBACK_MODBUS_MASTER_READ_DISCRETE_INPUTS_RESPONSE 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 rs485_modbus_slave_answer_read_input_registers_request(RS485 *rs485, uint8_t request_id, uint16_t *input_registers, uint16_t input_registers_length)¶

Parameter:	rs485 – Typ: RS485 * request_id – Typ: uint8_t, Wertebereich: [0 bis 255] input_registers – Typ: 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 RS485_CALLBACK_MODBUS_SLAVE_READ_INPUT_REGISTERS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

int rs485_modbus_master_read_input_registers(RS485 *rs485, uint8_t slave_address, uint32_t starting_address, uint16_t count, uint8_t *ret_request_id)¶

Parameter:	rs485 – Typ: 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 RS485_CALLBACK_MODBUS_MASTER_READ_INPUT_REGISTERS_RESPONSE 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 rs485_get_spitfp_error_count(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: 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 rs485_set_status_led_config(RS485 *rs485, uint8_t config)¶

Parameter:	rs485 – Typ: 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:

RS485_STATUS_LED_CONFIG_OFF = 0
RS485_STATUS_LED_CONFIG_ON = 1
RS485_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
RS485_STATUS_LED_CONFIG_SHOW_STATUS = 3

int rs485_get_status_led_config(RS485 *rs485, uint8_t *ret_config)¶

Parameter:	rs485 – Typ: 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 rs485_set_status_led_config() gesetzt.

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

Für ret_config:

RS485_STATUS_LED_CONFIG_OFF = 0
RS485_STATUS_LED_CONFIG_ON = 1
RS485_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
RS485_STATUS_LED_CONFIG_SHOW_STATUS = 3

int rs485_get_chip_temperature(RS485 *rs485, int16_t *ret_temperature)¶

Parameter:	rs485 – Typ: 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 rs485_reset(RS485 *rs485)¶

Parameter:	rs485 – Typ: 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 rs485_get_identity(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: 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¶

void rs485_register_callback(RS485 *rs485, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	rs485 – Typ: RS485 * 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 rs485_enable_read_callback(RS485 *rs485)¶

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

Aktiviert den RS485_CALLBACK_READ Callback. Dies deaktiviert den RS485_CALLBACK_FRAME_READABLE Callback.

Im Startzustand ist der Callback deaktiviert.

int rs485_disable_read_callback(RS485 *rs485)¶

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

Deaktiviert den RS485_CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert.

int rs485_is_read_callback_enabled(RS485 *rs485, bool *ret_enabled)¶

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

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

int rs485_enable_error_count_callback(RS485 *rs485)¶

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

Aktiviert den RS485_CALLBACK_ERROR_COUNT Callback.

Im Startzustand ist der Callback deaktiviert.

int rs485_disable_error_count_callback(RS485 *rs485)¶

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

Deaktiviert den RS485_CALLBACK_ERROR_COUNT Callback.

Im Startzustand ist der Callback deaktiviert.

int rs485_is_error_count_callback_enabled(RS485 *rs485, bool *ret_enabled)¶

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

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

int rs485_set_frame_readable_callback_configuration(RS485 *rs485, uint16_t frame_size)¶

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

Konfiguriert den RS485_CALLBACK_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 RS485_CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.5 (Plugin).

int rs485_get_frame_readable_callback_configuration(RS485 *rs485, uint16_t *ret_frame_size)¶

Parameter:	rs485 – Typ: 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 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 rs485_register_callback() Funktion durchgeführt werden:

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

rs485_register_callback(&rs485,
                        RS485_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.

RS485_CALLBACK_READ¶

void callback(char *message, uint16_t message_length, void *user_data)

Callback-Parameter:	message – Typ: char * message_length – Typ: uint16_t user_data – Typ: void *

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

Dieser Callback kann durch rs485_enable_read_callback() aktiviert werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit NULL für message ausgelöst.

RS485_CALLBACK_ERROR_COUNT¶

void callback(uint32_t overrun_error_count, uint32_t parity_error_count, void *user_data)

Callback-Parameter:	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.

RS485_CALLBACK_MODBUS_SLAVE_READ_COILS_REQUEST¶

void callback(uint8_t request_id, uint32_t starting_address, uint16_t count, void *user_data)

Callback-Parameter:	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 rs485_modbus_slave_answer_read_coils_request() gesendet werden.

RS485_CALLBACK_MODBUS_MASTER_READ_COILS_RESPONSE¶

void callback(uint8_t request_id, int8_t exception_code, bool *coils, uint16_t coils_length, void *user_data)

Callback-Parameter:	request_id – Typ: uint8_t, Wertebereich: [0 bis 255] exception_code – Typ: int8_t, Wertebereich: Siehe Konstanten coils – Typ: bool * coils_length – Typ: uint16_t 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 rs485_set_modbus_configuration() gesetzt werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit NULL für coils ausgelöst.

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

Für exception_code:

RS485_EXCEPTION_CODE_TIMEOUT = -1
RS485_EXCEPTION_CODE_SUCCESS = 0
RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

RS485_CALLBACK_MODBUS_SLAVE_READ_HOLDING_REGISTERS_REQUEST¶

void callback(uint8_t request_id, uint32_t starting_address, uint16_t count, void *user_data)

Callback-Parameter:	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 rs485_modbus_slave_answer_read_holding_registers_request() gesendet werden.

RS485_CALLBACK_MODBUS_MASTER_READ_HOLDING_REGISTERS_RESPONSE¶

void callback(uint8_t request_id, int8_t exception_code, uint16_t *holding_registers, uint16_t holding_registers_length, void *user_data)

Callback-Parameter:	request_id – Typ: uint8_t, Wertebereich: [0 bis 255] exception_code – Typ: int8_t, Wertebereich: Siehe Konstanten holding_registers – Typ: uint16_t , Wertebereich: [0 bis 2¹⁶ - 1] holding_registers_length* – Typ: uint16_t 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.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit NULL für holding_registers ausgelöst.

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

Für exception_code:

RS485_EXCEPTION_CODE_TIMEOUT = -1
RS485_EXCEPTION_CODE_SUCCESS = 0
RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

RS485_CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_COIL_REQUEST¶

void callback(uint8_t request_id, uint32_t coil_address, bool coil_value, void *user_data)

Callback-Parameter:	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 rs485_modbus_slave_answer_write_single_coil_request() gesendet werden.

RS485_CALLBACK_MODBUS_MASTER_WRITE_SINGLE_COIL_RESPONSE¶

void callback(uint8_t request_id, int8_t exception_code, void *user_data)

Callback-Parameter:	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:

RS485_EXCEPTION_CODE_TIMEOUT = -1
RS485_EXCEPTION_CODE_SUCCESS = 0
RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

RS485_CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_REGISTER_REQUEST¶

void callback(uint8_t request_id, uint32_t register_address, uint16_t register_value, void *user_data)

Callback-Parameter:	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 rs485_modbus_slave_answer_write_single_register_request() gesendet werden.

RS485_CALLBACK_MODBUS_MASTER_WRITE_SINGLE_REGISTER_RESPONSE¶

void callback(uint8_t request_id, int8_t exception_code, void *user_data)

Callback-Parameter:	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:

RS485_EXCEPTION_CODE_TIMEOUT = -1
RS485_EXCEPTION_CODE_SUCCESS = 0
RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

RS485_CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_COILS_REQUEST¶

void callback(uint8_t request_id, uint32_t starting_address, bool *coils, uint16_t coils_length, void *user_data)

Callback-Parameter:	request_id – Typ: uint8_t, Wertebereich: [0 bis 255] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] coils – Typ: bool * coils_length – Typ: uint16_t 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 rs485_modbus_slave_answer_write_multiple_coils_request() gesendet werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit NULL für coils ausgelöst.

RS485_CALLBACK_MODBUS_MASTER_WRITE_MULTIPLE_COILS_RESPONSE¶

void callback(uint8_t request_id, int8_t exception_code, void *user_data)

Callback-Parameter:	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:

RS485_EXCEPTION_CODE_TIMEOUT = -1
RS485_EXCEPTION_CODE_SUCCESS = 0
RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

RS485_CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_REGISTERS_REQUEST¶

void callback(uint8_t request_id, uint32_t starting_address, uint16_t *registers, uint16_t registers_length, void *user_data)

Callback-Parameter:	request_id – Typ: uint8_t, Wertebereich: [0 bis 255] starting_address – Typ: uint32_t, Wertebereich: [1 bis 2¹⁶] registers – Typ: uint16_t , Wertebereich: [0 bis 2¹⁶ - 1] registers_length* – Typ: uint16_t 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 rs485_modbus_slave_answer_write_multiple_registers_request() gesendet werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit NULL für registers ausgelöst.

RS485_CALLBACK_MODBUS_MASTER_WRITE_MULTIPLE_REGISTERS_RESPONSE¶

void callback(uint8_t request_id, int8_t exception_code, void *user_data)

Callback-Parameter:	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:

RS485_EXCEPTION_CODE_TIMEOUT = -1
RS485_EXCEPTION_CODE_SUCCESS = 0
RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

RS485_CALLBACK_MODBUS_SLAVE_READ_DISCRETE_INPUTS_REQUEST¶

void callback(uint8_t request_id, uint32_t starting_address, uint16_t count, void *user_data)

Callback-Parameter:	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 rs485_modbus_slave_answer_read_discrete_inputs_request() gesendet werden.

RS485_CALLBACK_MODBUS_MASTER_READ_DISCRETE_INPUTS_RESPONSE¶

void callback(uint8_t request_id, int8_t exception_code, bool *discrete_inputs, uint16_t discrete_inputs_length, void *user_data)

Callback-Parameter:	request_id – Typ: uint8_t, Wertebereich: [0 bis 255] exception_code – Typ: int8_t, Wertebereich: Siehe Konstanten discrete_inputs – Typ: bool * discrete_inputs_length – Typ: uint16_t 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.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit NULL für discrete_inputs ausgelöst.

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

Für exception_code:

RS485_EXCEPTION_CODE_TIMEOUT = -1
RS485_EXCEPTION_CODE_SUCCESS = 0
RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

RS485_CALLBACK_MODBUS_SLAVE_READ_INPUT_REGISTERS_REQUEST¶

void callback(uint8_t request_id, uint32_t starting_address, uint16_t count, void *user_data)

Callback-Parameter:	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 rs485_modbus_slave_answer_read_input_registers_request() gesendet werden.

RS485_CALLBACK_MODBUS_MASTER_READ_INPUT_REGISTERS_RESPONSE¶

void callback(uint8_t request_id, int8_t exception_code, uint16_t *input_registers, uint16_t input_registers_length, void *user_data)

Callback-Parameter:	request_id – Typ: uint8_t, Wertebereich: [0 bis 255] exception_code – Typ: int8_t, Wertebereich: Siehe Konstanten input_registers – Typ: uint16_t , Wertebereich: [0 bis 2¹⁶ - 1] input_registers_length* – Typ: uint16_t 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.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit NULL für input_registers ausgelöst.

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

Für exception_code:

RS485_EXCEPTION_CODE_TIMEOUT = -1
RS485_EXCEPTION_CODE_SUCCESS = 0
RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

RS485_CALLBACK_FRAME_READABLE¶

void callback(uint16_t frame_count, void *user_data)

Callback-Parameter:	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 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 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 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. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int rs485_get_api_version(RS485 *rs485, uint8_t ret_api_version[3])¶

Parameter:	rs485 – Typ: RS485 *
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:	e_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 rs485_get_response_expected(RS485 *rs485, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	rs485 – Typ: 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 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:

RS485_FUNCTION_ENABLE_READ_CALLBACK = 3
RS485_FUNCTION_DISABLE_READ_CALLBACK = 4
RS485_FUNCTION_SET_RS485_CONFIGURATION = 6
RS485_FUNCTION_SET_MODBUS_CONFIGURATION = 8
RS485_FUNCTION_SET_MODE = 10
RS485_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
RS485_FUNCTION_SET_ERROR_LED_CONFIG = 14
RS485_FUNCTION_SET_BUFFER_CONFIG = 16
RS485_FUNCTION_ENABLE_ERROR_COUNT_CALLBACK = 19
RS485_FUNCTION_DISABLE_ERROR_COUNT_CALLBACK = 20
RS485_FUNCTION_MODBUS_SLAVE_REPORT_EXCEPTION = 24
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_COILS_REQUEST = 25
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_HOLDING_REGISTERS_REQUEST = 27
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_COIL_REQUEST = 29
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_REGISTER_REQUEST = 31
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_COILS_REQUEST = 33
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_REGISTERS_REQUEST = 35
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_DISCRETE_INPUTS_REQUEST = 37
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_INPUT_REGISTERS_REQUEST = 39
RS485_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 59
RS485_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
RS485_FUNCTION_SET_STATUS_LED_CONFIG = 239
RS485_FUNCTION_RESET = 243
RS485_FUNCTION_WRITE_UID = 248

int rs485_set_response_expected(RS485 *rs485, uint8_t function_id, bool response_expected)¶

Parameter:	rs485 – Typ: 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:

RS485_FUNCTION_ENABLE_READ_CALLBACK = 3
RS485_FUNCTION_DISABLE_READ_CALLBACK = 4
RS485_FUNCTION_SET_RS485_CONFIGURATION = 6
RS485_FUNCTION_SET_MODBUS_CONFIGURATION = 8
RS485_FUNCTION_SET_MODE = 10
RS485_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
RS485_FUNCTION_SET_ERROR_LED_CONFIG = 14
RS485_FUNCTION_SET_BUFFER_CONFIG = 16
RS485_FUNCTION_ENABLE_ERROR_COUNT_CALLBACK = 19
RS485_FUNCTION_DISABLE_ERROR_COUNT_CALLBACK = 20
RS485_FUNCTION_MODBUS_SLAVE_REPORT_EXCEPTION = 24
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_COILS_REQUEST = 25
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_HOLDING_REGISTERS_REQUEST = 27
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_COIL_REQUEST = 29
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_REGISTER_REQUEST = 31
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_COILS_REQUEST = 33
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_REGISTERS_REQUEST = 35
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_DISCRETE_INPUTS_REQUEST = 37
RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_INPUT_REGISTERS_REQUEST = 39
RS485_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 59
RS485_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
RS485_FUNCTION_SET_STATUS_LED_CONFIG = 239
RS485_FUNCTION_RESET = 243
RS485_FUNCTION_WRITE_UID = 248

int rs485_set_response_expected_all(RS485 *rs485, bool response_expected)¶

Parameter:	rs485 – Typ: 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 rs485_set_bootloader_mode(RS485 *rs485, uint8_t mode, uint8_t *ret_status)¶

Parameter:	rs485 – Typ: 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:

RS485_BOOTLOADER_MODE_BOOTLOADER = 0
RS485_BOOTLOADER_MODE_FIRMWARE = 1
RS485_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
RS485_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
RS485_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

RS485_BOOTLOADER_STATUS_OK = 0
RS485_BOOTLOADER_STATUS_INVALID_MODE = 1
RS485_BOOTLOADER_STATUS_NO_CHANGE = 2
RS485_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
RS485_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
RS485_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int rs485_get_bootloader_mode(RS485 *rs485, uint8_t *ret_mode)¶

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

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

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

Für ret_mode:

RS485_BOOTLOADER_MODE_BOOTLOADER = 0
RS485_BOOTLOADER_MODE_FIRMWARE = 1
RS485_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
RS485_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
RS485_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int rs485_set_write_firmware_pointer(RS485 *rs485, uint32_t pointer)¶

Parameter:	rs485 – Typ: 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 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 rs485_write_firmware(RS485 *rs485, uint8_t data[64], uint8_t *ret_status)¶

Parameter:	rs485 – Typ: RS485 * data – Typ: 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 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 rs485_write_uid(RS485 *rs485, uint32_t uid)¶

Parameter:	rs485 – Typ: 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 rs485_read_uid(RS485 *rs485, uint32_t *ret_uid)¶

Parameter:	rs485 – Typ: 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¶

RS485_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein RS485 Bricklet zu identifizieren.

Die rs485_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.

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