Spezifikationen / Modbus Protokoll / API / Bricklets / RS485 Bricklet

Modbus - RS485 Bricklet¶

Dies ist die Beschreibung des Modbus Protokolls für das RS485 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS485 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API¶

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletRS485.write_low_level¶

Funktions-ID:	1
Anfrage:	message_length – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] message_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] message_chunk_data – Typ: char[60]
Antwort:	message_chunk_written – Typ: uint8, Wertebereich: [0 bis 255]

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 set_rs485_configuration für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

BrickletRS485.read_low_level¶

Funktions-ID:	2
Anfrage:	length – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	message_length – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] message_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] message_chunk_data – Typ: char[60]

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 enable_read_callback und CALLBACK_READ_LOW_LEVEL Callback.

BrickletRS485.set_rs485_configuration¶

Funktions-ID:	6
Anfrage:	baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 parity – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 stopbits – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1 wordlength – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 8 duplex – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
Antwort:	keine Antwort

Setzt die Konfiguration für die RS485-Kommunikation.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für parity:

0 = None
1 = Odd
2 = Even

Für stopbits:

1 = 1
2 = 2

Für wordlength:

5 = 5
6 = 6
7 = 7
8 = 8

Für duplex:

0 = Half
1 = Full

BrickletRS485.get_rs485_configuration¶

Funktions-ID:	7
Anfrage:	keine Nutzdaten
Antwort:	baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 parity – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0 stopbits – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1 wordlength – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 8 duplex – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

Gibt die Konfiguration zurück, wie von set_rs485_configuration gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für parity:

0 = None
1 = Odd
2 = Even

Für stopbits:

1 = 1
2 = 2

Für wordlength:

5 = 5
6 = 6
7 = 7
8 = 8

Für duplex:

0 = Half
1 = Full

BrickletRS485.set_modbus_configuration¶

Funktions-ID:	8
Anfrage:	slave_address – Typ: uint8, Wertebereich: [1 bis 247], Standardwert: 1 master_request_timeout – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 1000
Antwort:	keine Antwort

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.

BrickletRS485.get_modbus_configuration¶

Funktions-ID:	9
Anfrage:	keine Nutzdaten
Antwort:	slave_address – Typ: uint8, Wertebereich: [1 bis 247], Standardwert: 1 master_request_timeout – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 1000

Gibt die Konfiguration zurück, wie von set_modbus_configuration gesetzt.

BrickletRS485.set_mode¶

Funktions-ID:	10
Anfrage:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0
Antwort:	keine Antwort

Setzt den Modus des Bricklets. Verfügbare Optionen sind

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

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

0 = RS485
1 = Modbus Master RTU
2 = Modbus Slave RTU

BrickletRS485.get_mode¶

Funktions-ID:	11
Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 0

Gibt die Konfiguration zurück, wie von set_mode gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

0 = RS485
1 = Modbus Master RTU
2 = Modbus Slave RTU

Fortgeschrittene Funktionen¶

BrickletRS485.set_communication_led_config¶

Funktions-ID:	12
Anfrage:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:	keine Antwort

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Communication

BrickletRS485.get_communication_led_config¶

Funktions-ID:	13
Anfrage:	keine Nutzdaten
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

Gibt die Konfiguration zurück, wie von set_communication_led_config gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Communication

BrickletRS485.set_error_led_config¶

Funktions-ID:	14
Anfrage:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:	keine Antwort

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe 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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Error

BrickletRS485.get_error_led_config¶

Funktions-ID:	15
Anfrage:	keine Nutzdaten
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

Gibt die Konfiguration zurück, wie von set_error_led_config gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Error

BrickletRS485.set_buffer_config¶

Funktions-ID:	16
Anfrage:	send_buffer_size – Typ: uint16, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120 receive_buffer_size – Typ: uint16, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120
Antwort:	keine Antwort

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 write_low_level übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS485 empfangen wurden aber noch nicht über read_low_level oder CALLBACK_READ_LOW_LEVEL Callback an ein Nutzerprogramm übertragen werden konnten.

BrickletRS485.get_buffer_config¶

Funktions-ID:	17
Anfrage:	keine Nutzdaten
Antwort:	send_buffer_size – Typ: uint16, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120 receive_buffer_size – Typ: uint16, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120

Gibt die Buffer-Konfiguration zurück, wie von set_buffer_config gesetzt.

BrickletRS485.get_buffer_status¶

Funktions-ID:	18
Anfrage:	keine Nutzdaten
Antwort:	send_buffer_used – Typ: uint16, Einheit: 1 B, Wertebereich: [0 bis 9216] receive_buffer_used – Typ: uint16, Einheit: 1 B, Wertebereich: [0 bis 9216]

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

Siehe set_buffer_config zur Konfiguration der Buffergrößen.

BrickletRS485.get_error_count¶

Funktions-ID:	22
Anfrage:	keine Nutzdaten
Antwort:	overrun_error_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1] parity_error_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1]

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

BrickletRS485.get_modbus_common_error_count¶

Funktions-ID:	23
Anfrage:	keine Nutzdaten
Antwort:	timeout_error_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1] checksum_error_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1] frame_too_big_error_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1] illegal_function_error_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1] illegal_data_address_error_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1] illegal_data_value_error_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1] slave_device_failure_error_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1]

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.

BrickletRS485.modbus_slave_report_exception¶

Funktions-ID:	24
Anfrage:	request_id – Typ: uint8, Wertebereich: [0 bis 255] exception_code – Typ: int8, Wertebereich: Siehe Bedeutungen
Antwort:	keine Antwort

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für exception_code:

-1 = Timeout
0 = Success
1 = Illegal Function
2 = Illegal Data Address
3 = Illegal Data Value
4 = Slave Device Failure
5 = Acknowledge
6 = Slave Device Busy
8 = Memory Parity Error
10 = Gateway Path Unavailable
11 = Gateway Target Device Failed To Respond

BrickletRS485.modbus_slave_answer_read_coils_request_low_level¶

Funktions-ID:	25
Anfrage:	request_id – Typ: uint8, Wertebereich: [0 bis 255] coils_length – Typ: uint16, Wertebereich: [1 bis 2000] coils_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] coils_chunk_data – Typ: bool[472]
Antwort:	keine Antwort

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 CALLBACK_MODBUS_SLAVE_READ_COILS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbus_master_read_coils¶

Funktions-ID:	26
Anfrage:	slave_address – Typ: uint8, Wertebereich: [0 bis 247] starting_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16, Wertebereich: [1 bis 2000]
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255]

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

BrickletRS485.modbus_slave_answer_read_holding_registers_request_low_level¶

Funktions-ID:	27
Anfrage:	request_id – Typ: uint8, Wertebereich: [0 bis 255] holding_registers_length – Typ: uint16, Wertebereich: [1 bis 125] holding_registers_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] holding_registers_chunk_data – Typ: uint16[29], Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	keine Antwort

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 CALLBACK_MODBUS_SLAVE_READ_HOLDING_REGISTERS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbus_master_read_holding_registers¶

Funktions-ID:	28
Anfrage:	slave_address – Typ: uint8, Wertebereich: [0 bis 247] starting_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16, Wertebereich: [1 bis 125]
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255]

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

BrickletRS485.modbus_slave_answer_write_single_coil_request¶

Funktions-ID:	29
Anfrage:	request_id – Typ: uint8, Wertebereich: [0 bis 255]
Antwort:	keine Antwort

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 CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_COIL_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbus_master_write_single_coil¶

Funktions-ID:	30
Anfrage:	slave_address – Typ: uint8, Wertebereich: [0 bis 247] coil_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] coil_value – Typ: bool
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255]

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

BrickletRS485.modbus_slave_answer_write_single_register_request¶

Funktions-ID:	31
Anfrage:	request_id – Typ: uint8, Wertebereich: [0 bis 255]
Antwort:	keine Antwort

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 CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_REGISTER_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbus_master_write_single_register¶

Funktions-ID:	32
Anfrage:	slave_address – Typ: uint8, Wertebereich: [0 bis 247] register_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] register_value – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255]

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

BrickletRS485.modbus_slave_answer_write_multiple_coils_request¶

Funktions-ID:	33
Anfrage:	request_id – Typ: uint8, Wertebereich: [0 bis 255]
Antwort:	keine Antwort

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 CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_COILS_REQUEST_LOW_LEVEL Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbus_master_write_multiple_coils_low_level¶

Funktions-ID:	34
Anfrage:	slave_address – Typ: uint8, Wertebereich: [0 bis 247] starting_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] coils_length – Typ: uint16, Wertebereich: [1 bis 1968] coils_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] coils_chunk_data – Typ: bool[440]
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255]

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

BrickletRS485.modbus_slave_answer_write_multiple_registers_request¶

Funktions-ID:	35
Anfrage:	request_id – Typ: uint8, Wertebereich: [0 bis 255]
Antwort:	keine Antwort

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 CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_REGISTERS_REQUEST_LOW_LEVEL Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbus_master_write_multiple_registers_low_level¶

Funktions-ID:	36
Anfrage:	slave_address – Typ: uint8, Wertebereich: [0 bis 247] starting_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] registers_length – Typ: uint16, Wertebereich: [1 bis 123] registers_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] registers_chunk_data – Typ: uint16[27], Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255]

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

BrickletRS485.modbus_slave_answer_read_discrete_inputs_request_low_level¶

Funktions-ID:	37
Anfrage:	request_id – Typ: uint8, Wertebereich: [0 bis 255] discrete_inputs_length – Typ: uint16, Wertebereich: [1 bis 2000] discrete_inputs_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] discrete_inputs_chunk_data – Typ: bool[472]
Antwort:	keine Antwort

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 CALLBACK_MODBUS_SLAVE_READ_DISCRETE_INPUTS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbus_master_read_discrete_inputs¶

Funktions-ID:	38
Anfrage:	slave_address – Typ: uint8, Wertebereich: [0 bis 247] starting_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16, Wertebereich: [1 bis 2000]
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255]

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

BrickletRS485.modbus_slave_answer_read_input_registers_request_low_level¶

Funktions-ID:	39
Anfrage:	request_id – Typ: uint8, Wertebereich: [0 bis 255] input_registers_length – Typ: uint16, Wertebereich: [1 bis 125] input_registers_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] input_registers_chunk_data – Typ: uint16[29], Wertebereich: [0 bis 2¹⁶ - 1]
Antwort:	keine Antwort

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 CALLBACK_MODBUS_SLAVE_READ_INPUT_REGISTERS_REQUEST Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485.modbus_master_read_input_registers¶

Funktions-ID:	40
Anfrage:	slave_address – Typ: uint8, Wertebereich: [0 bis 247] starting_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16, Wertebereich: [1 bis 125]
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255]

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

BrickletRS485.get_spitfp_error_count¶

Funktions-ID:	234
Anfrage:	keine Nutzdaten
Antwort:	error_count_ack_checksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: uint32, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: uint32, Wertebereich: [0 bis 2³² - 1]

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.

BrickletRS485.set_status_led_config¶

Funktions-ID:	239
Anfrage:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:	keine Antwort

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Status

BrickletRS485.get_status_led_config¶

Funktions-ID:	240
Anfrage:	keine Nutzdaten
Antwort:	config – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für config:

0 = Off
1 = On
2 = Show Heartbeat
3 = Show Status

BrickletRS485.get_chip_temperature¶

Funktions-ID:	242
Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

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.

BrickletRS485.reset¶

Funktions-ID:	243
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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.

BrickletRS485.get_identity¶

Funktions-ID:	255
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: char[8] connected_uid – Typ: char[8] position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] device_identifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]

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.

Konfigurationsfunktionen für Callbacks¶

BrickletRS485.enable_read_callback¶

Funktions-ID:	3
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Aktiviert den CALLBACK_READ_LOW_LEVEL Callback. Dies deaktiviert den CALLBACK_FRAME_READABLE Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS485.disable_read_callback¶

Funktions-ID:	4
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Deaktiviert den CALLBACK_READ_LOW_LEVEL Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS485.is_read_callback_enabled¶

Funktions-ID:	5
Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: false

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

BrickletRS485.enable_error_count_callback¶

Funktions-ID:	19
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Aktiviert den CALLBACK_ERROR_COUNT Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS485.disable_error_count_callback¶

Funktions-ID:	20
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Deaktiviert den CALLBACK_ERROR_COUNT Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS485.is_error_count_callback_enabled¶

Funktions-ID:	21
Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: true

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

BrickletRS485.set_frame_readable_callback_configuration¶

Funktions-ID:	59
Anfrage:	frame_size – Typ: uint16, Einheit: 1 B, Wertebereich: [0 bis 9216], Standardwert: 0
Antwort:	keine Antwort

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

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.5 (Plugin).

BrickletRS485.get_frame_readable_callback_configuration¶

Funktions-ID:	60
Anfrage:	keine Nutzdaten
Antwort:	frame_size – Typ: uint16, Einheit: 1 B, Wertebereich: [0 bis 9216], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels set_frame_readable_callback_configuration gesetzt.

Neu in Version 2.0.5 (Plugin).

Callbacks¶

BrickletRS485.CALLBACK_READ_LOW_LEVEL¶

Funktions-ID:	41
Antwort:	message_length – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] message_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] message_chunk_data – Typ: char[60]

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

Dieser Callback kann durch enable_read_callback aktiviert werden.

BrickletRS485.CALLBACK_ERROR_COUNT¶

Funktions-ID:	42
Antwort:	overrun_error_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1] parity_error_count – Typ: uint32, Wertebereich: [0 bis 2³² - 1]

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

BrickletRS485.CALLBACK_MODBUS_SLAVE_READ_COILS_REQUEST¶

Funktions-ID:	43
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] starting_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16, Wertebereich: [1 bis 2000]

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Coils erhält. Die Rückgabewerte 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 modbus_slave_answer_read_coils_request_low_level gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_READ_COILS_RESPONSE_LOW_LEVEL¶

Funktions-ID:	44
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] exception_code – Typ: int8, Wertebereich: Siehe Bedeutungen coils_length – Typ: uint16, Wertebereich: [0 bis 2000] coils_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] coils_chunk_data – Typ: bool[464]

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

Die Rückgabewerte 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 set_modbus_configuration gesetzt werden.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für exception_code:

-1 = Timeout
0 = Success
1 = Illegal Function
2 = Illegal Data Address
3 = Illegal Data Value
4 = Slave Device Failure
5 = Acknowledge
6 = Slave Device Busy
8 = Memory Parity Error
10 = Gateway Path Unavailable
11 = Gateway Target Device Failed To Respond

BrickletRS485.CALLBACK_MODBUS_SLAVE_READ_HOLDING_REGISTERS_REQUEST¶

Funktions-ID:	45
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] starting_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16, Wertebereich: [1 bis 125]

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 Rückgabewerte 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 modbus_slave_answer_read_holding_registers_request_low_level gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_READ_HOLDING_REGISTERS_RESPONSE_LOW_LEVEL¶

Funktions-ID:	46
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] exception_code – Typ: int8, Wertebereich: Siehe Bedeutungen holding_registers_length – Typ: uint16, Wertebereich: [0 bis 125] holding_registers_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] holding_registers_chunk_data – Typ: uint16[29], Wertebereich: [0 bis 2¹⁶ - 1]

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 Rückgabewerte sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für exception_code:

-1 = Timeout
0 = Success
1 = Illegal Function
2 = Illegal Data Address
3 = Illegal Data Value
4 = Slave Device Failure
5 = Acknowledge
6 = Slave Device Busy
8 = Memory Parity Error
10 = Gateway Path Unavailable
11 = Gateway Target Device Failed To Respond

BrickletRS485.CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_COIL_REQUEST¶

Funktions-ID:	47
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] coil_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] coil_value – Typ: bool

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 Rückgabewerte 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 modbus_slave_answer_write_single_coil_request gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_WRITE_SINGLE_COIL_RESPONSE¶

Funktions-ID:	48
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] exception_code – Typ: int8, Wertebereich: Siehe Bedeutungen

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 Rückgabewerte sind die Request ID der Anfrage und der Exception Code der Antwort.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für exception_code:

-1 = Timeout
0 = Success
1 = Illegal Function
2 = Illegal Data Address
3 = Illegal Data Value
4 = Slave Device Failure
5 = Acknowledge
6 = Slave Device Busy
8 = Memory Parity Error
10 = Gateway Path Unavailable
11 = Gateway Target Device Failed To Respond

BrickletRS485.CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_REGISTER_REQUEST¶

Funktions-ID:	49
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] register_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] register_value – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]

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 Rückgabewerte 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 modbus_slave_answer_write_single_register_request gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_WRITE_SINGLE_REGISTER_RESPONSE¶

Funktions-ID:	50
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] exception_code – Typ: int8, Wertebereich: Siehe Bedeutungen

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 Rückgabewerte sind die Request ID der Anfrage und der Exception Code der Antwort.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für exception_code:

-1 = Timeout
0 = Success
1 = Illegal Function
2 = Illegal Data Address
3 = Illegal Data Value
4 = Slave Device Failure
5 = Acknowledge
6 = Slave Device Busy
8 = Memory Parity Error
10 = Gateway Path Unavailable
11 = Gateway Target Device Failed To Respond

BrickletRS485.CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_COILS_REQUEST_LOW_LEVEL¶

Funktions-ID:	51
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] starting_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] coils_length – Typ: uint16, Wertebereich: [1 bis 1968] coils_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] coils_chunk_data – Typ: bool[440]

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 Rückgabewerte 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 modbus_slave_answer_write_multiple_coils_request gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_WRITE_MULTIPLE_COILS_RESPONSE¶

Funktions-ID:	52
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] exception_code – Typ: int8, Wertebereich: Siehe Bedeutungen

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 Rückgabewerte sind die Request ID der Anfrage und der Exception Code der Antwort.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für exception_code:

-1 = Timeout
0 = Success
1 = Illegal Function
2 = Illegal Data Address
3 = Illegal Data Value
4 = Slave Device Failure
5 = Acknowledge
6 = Slave Device Busy
8 = Memory Parity Error
10 = Gateway Path Unavailable
11 = Gateway Target Device Failed To Respond

BrickletRS485.CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_REGISTERS_REQUEST_LOW_LEVEL¶

Funktions-ID:	53
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] starting_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] registers_length – Typ: uint16, Wertebereich: [1 bis 123] registers_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] registers_chunk_data – Typ: uint16[27], Wertebereich: [0 bis 2¹⁶ - 1]

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 Rückgabewerte 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 modbus_slave_answer_write_multiple_registers_request gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_WRITE_MULTIPLE_REGISTERS_RESPONSE¶

Funktions-ID:	54
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] exception_code – Typ: int8, Wertebereich: Siehe Bedeutungen

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 Rückgabewerte sind die Request ID der Anfrage und der Exception Code der Antwort.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für exception_code:

-1 = Timeout
0 = Success
1 = Illegal Function
2 = Illegal Data Address
3 = Illegal Data Value
4 = Slave Device Failure
5 = Acknowledge
6 = Slave Device Busy
8 = Memory Parity Error
10 = Gateway Path Unavailable
11 = Gateway Target Device Failed To Respond

BrickletRS485.CALLBACK_MODBUS_SLAVE_READ_DISCRETE_INPUTS_REQUEST¶

Funktions-ID:	55
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] starting_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16, Wertebereich: [1 bis 2000]

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 Rückgabewerte 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 modbus_slave_answer_read_discrete_inputs_request_low_level gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_READ_DISCRETE_INPUTS_RESPONSE_LOW_LEVEL¶

Funktions-ID:	56
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] exception_code – Typ: int8, Wertebereich: Siehe Bedeutungen discrete_inputs_length – Typ: uint16, Wertebereich: [1 bis 2000] discrete_inputs_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] discrete_inputs_chunk_data – Typ: bool[464]

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 Rückgabewerte sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für exception_code:

-1 = Timeout
0 = Success
1 = Illegal Function
2 = Illegal Data Address
3 = Illegal Data Value
4 = Slave Device Failure
5 = Acknowledge
6 = Slave Device Busy
8 = Memory Parity Error
10 = Gateway Path Unavailable
11 = Gateway Target Device Failed To Respond

BrickletRS485.CALLBACK_MODBUS_SLAVE_READ_INPUT_REGISTERS_REQUEST¶

Funktions-ID:	57
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] starting_address – Typ: uint32, Wertebereich: [1 bis 2¹⁶] count – Typ: uint16, Wertebereich: [1 bis 125]

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 Rückgabewerte 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 modbus_slave_answer_read_input_registers_request_low_level gesendet werden.

BrickletRS485.CALLBACK_MODBUS_MASTER_READ_INPUT_REGISTERS_RESPONSE_LOW_LEVEL¶

Funktions-ID:	58
Antwort:	request_id – Typ: uint8, Wertebereich: [0 bis 255] exception_code – Typ: int8, Wertebereich: Siehe Bedeutungen input_registers_length – Typ: uint16, Wertebereich: [1 bis 125] input_registers_chunk_offset – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] input_registers_chunk_data – Typ: uint16[29], Wertebereich: [0 bis 2¹⁶ - 1]

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 Rückgabewerte sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für exception_code:

-1 = Timeout
0 = Success
1 = Illegal Function
2 = Illegal Data Address
3 = Illegal Data Value
4 = Slave Device Failure
5 = Acknowledge
6 = Slave Device Busy
8 = Memory Parity Error
10 = Gateway Path Unavailable
11 = Gateway Target Device Failed To Respond

BrickletRS485.CALLBACK_FRAME_READABLE¶

Funktions-ID:	61
Antwort:	frame_count – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]

Dieser Callback wird ausgelöst, wenn mindestens ein neuer Frame an Daten verfügbar sind. Die Größe eines Frames kann mit set_frame_readable_callback_configuration konfiguriert werden. Frame Count ist die Anzahl an Frames, die zum Lesen bereitstehen. Der Callback wird nur einmal pro read_low_level 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 read_low_level-Funktion gelesen werden können, ohne dass der Frame Count-Rückgabewert geprüft werden muss.

Neu in Version 2.0.5 (Plugin).

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.

BrickletRS485.set_bootloader_mode¶

Funktions-ID:	235
Anfrage:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:	status – Typ: uint8, Wertebereich: Siehe Bedeutungen

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

0 = Bootloader
1 = Firmware
2 = Bootloader Wait For Reboot
3 = Firmware Wait For Reboot
4 = Firmware Wait For Erase And Reboot

Für status:

0 = OK
1 = Invalid Mode
2 = No Change
3 = Entry Function Not Present
4 = Device Identifier Incorrect
5 = CRC Mismatch

BrickletRS485.get_bootloader_mode¶

Funktions-ID:	236
Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: uint8, Wertebereich: Siehe Bedeutungen

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mode:

0 = Bootloader
1 = Firmware
2 = Bootloader Wait For Reboot
3 = Firmware Wait For Reboot
4 = Firmware Wait For Erase And Reboot

BrickletRS485.set_write_firmware_pointer¶

Funktions-ID:	237
Anfrage:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Antwort:	keine Antwort

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

BrickletRS485.write_firmware¶

Funktions-ID:	238
Anfrage:	data – Typ: uint8[64], Wertebereich: [0 bis 255]
Antwort:	status – Typ: uint8, Wertebereich: [0 bis 255]

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

BrickletRS485.write_uid¶

Funktions-ID:	248
Anfrage:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 1]
Antwort:	keine Antwort

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.

BrickletRS485.read_uid¶

Funktions-ID:	249
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 1]

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