Software / API Bindings / Shell / API Referenz und Beispiele / Bricklets / RS485 Bricklet

Shell - RS485 Bricklet¶

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback¶

Download (example-loopback.sh)

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

# 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

uid=XYZ # Change XYZ to the UID of your RS485 Bricklet

# Enable full-duplex mode
tinkerforge call rs485-bricklet $uid set-rs485-configuration 115200 parity-none stopbits-1 wordlength-8 duplex-full

# Handle incoming read callbacks
tinkerforge dispatch rs485-bricklet $uid read &

# Enable read callback
tinkerforge call rs485-bricklet $uid enable-read-callback

# Write "test" string
tinkerforge call rs485-bricklet $uid write t,e,s,t

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Modbus Slave¶

Download (example-modbus-slave.sh)

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this


uid=XYZ # Change XYZ to the UID of your RS485 Bricklet
export _tmp=$(mktemp)
echo 0 > ${_tmp}

# Register write single register request callback
tinkerforge dispatch rs485-bricklet $uid modbus-slave-write-single-register-request \
  --execute "echo 'Request ID = {request-id}'
             echo 'Register Address = {register-address}'
             echo 'Register Value = {register-value}'

             # Here we assume valid writable register address is 42
             if [ {register-address} != 42 ]; then
               echo 'Requested invalid register address'
               tinkerforge call rs485-bricklet $uid modbus-slave-report-exception {request-id} exception-code-illegal-data-address
             else
               echo 'Request OK'
               tinkerforge call rs485-bricklet $uid modbus-slave-answer-write-single-register-request {request-id}
             fi" &

# Set operating mode to Modbus RTU slave
tinkerforge call rs485-bricklet $uid set-mode mode-modbus-slave-rtu

# Modbus specific configuration:
# - slave address = 17
# - master request timeout = 0ms (unused in slave mode)
tinkerforge call rs485-bricklet $uid set-modbus-configuration 17 0

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Modbus Master¶

Download (example-modbus-master.sh)

#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your RS485 Bricklet

export _tmp=$(mktemp)

# Register write single register response callback
tinkerforge dispatch rs485-bricklet $uid modbus-master-write-single-register-response\
  --execute "export _expected-request-id=\$(cat \$_tmp)

             if [ {request-id} != \"\$_expected-request-id\" ]; then
               echo 'Unexpected request ID'
             else
               echo 'Request ID = {request-id}'
               echo 'Exception Code = {exception-code}'
             fi

             rm -rf $_tmp" &

# Set operating mode to Modbus RTU master
tinkerforge call rs485-bricklet $uid set-mode mode-modbus-master-rtu

# Modbus specific configuration:
# - slave address = 1 (unused in master mode)
# - master request timeout = 1000ms
tinkerforge call rs485-bricklet $uid set-modbus-configuration 1 1000

# Request single register write
tinkerforge call rs485-bricklet $uid modbus-master-write-single-register 17 42 65535\
  --execute "echo {request-id} > ${_tmp}"

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

API¶

Mögliche Exit Codes für alle tinkerforge Befehle sind:

1: Unterbrochen (Ctrl+C)
2: Syntaxfehler
21: Python 2.5 oder neuer wird benötigt
22: Python argparse Modul fehlt
23: Socket-Fehler
24: Andere Exception
25: Ungültiger Platzhalter in Format-String
26: Authentifizierungsfehler
201: Timeout ist aufgetreten
209: Ungültiger Argumentwert
210: Funktion wird nicht unterstützt
211: Unbekannter Fehler

Befehlsstruktur¶

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call rs485-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des RS485 Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

--help zeigt Hilfe für den spezifischen call Befehl an und endet dann
--list-functions zeigt eine Liste der bekannten Funktionen des RS485 Bricklet an und endet dann

tinkerforge dispatch rs485-bricklet [<option>..] <uid> <callback>¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des RS485 Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

--help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
--list-callbacks zeigt eine Liste der bekannten Callbacks des RS485 Bricklet an und endet dann

tinkerforge call rs485-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameter:	<uid> – Typ: String <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

--help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

--execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

--expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch rs485-bricklet <uid> <callback> [<option>..]¶

Parameter:	<uid> – Typ: String <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

--help zeigt Hilfe für den spezifische <callback> an und endet dann
--execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen¶

tinkerforge call rs485-bricklet <uid> write <message>¶

Parameter:	<message> – Typ: Char Array, Länge: variabel
Ausgabe:	message-written – Typ: Int, Wertebereich: [0 bis 2¹⁶ - 1]

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.

tinkerforge call rs485-bricklet <uid> read <length>¶

Parameter:	<length> – Typ: Int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabe:	message – Typ: Char Array, Länge: variabel

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

tinkerforge call rs485-bricklet <uid> set-rs485-configuration <baudrate> <parity> <stopbits> <wordlength> <duplex>¶

Parameter:	<baudrate> – Typ: Int, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 <parity> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0 <stopbits> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1 <wordlength> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 8 <duplex> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
Ausgabe:	keine Ausgabe

Setzt die Konfiguration für die RS485-Kommunikation.

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

Für <parity>:

parity-none = 0
parity-odd = 1
parity-even = 2

Für <stopbits>:

stopbits-1 = 1
stopbits-2 = 2

Für <wordlength>:

wordlength-5 = 5
wordlength-6 = 6
wordlength-7 = 7
wordlength-8 = 8

Für <duplex>:

duplex-half = 0
duplex-full = 1

tinkerforge call rs485-bricklet <uid> get-rs485-configuration¶

Ausgabe:	baudrate – Typ: Int, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200 parity – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0 stopbits – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1 wordlength – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 8 duplex – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Konfiguration zurück, wie von set-rs485-configuration gesetzt.

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

Für parity:

parity-none = 0
parity-odd = 1
parity-even = 2

Für stopbits:

stopbits-1 = 1
stopbits-2 = 2

Für wordlength:

wordlength-5 = 5
wordlength-6 = 6
wordlength-7 = 7
wordlength-8 = 8

Für duplex:

duplex-half = 0
duplex-full = 1

tinkerforge call rs485-bricklet <uid> set-modbus-configuration <slave-address> <master-request-timeout>¶

Parameter:	<slave-address> – Typ: Int, Wertebereich: [1 bis 247], Standardwert: 1 <master-request-timeout> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 1000
Ausgabe:	keine Ausgabe

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.

tinkerforge call rs485-bricklet <uid> get-modbus-configuration¶

Ausgabe:	slave-address – Typ: Int, Wertebereich: [1 bis 247], Standardwert: 1 master-request-timeout – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 1000

Gibt die Konfiguration zurück, wie von set-modbus-configuration gesetzt.

tinkerforge call rs485-bricklet <uid> set-mode <mode>¶

Parameter:	<mode> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
Ausgabe:	keine Ausgabe

Setzt den Modus des Bricklets. Verfügbare Optionen sind

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

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

Für <mode>:

mode-rs485 = 0
mode-modbus-master-rtu = 1
mode-modbus-slave-rtu = 2

tinkerforge call rs485-bricklet <uid> get-mode¶

Ausgabe:	mode – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Konfiguration zurück, wie von set-mode gesetzt.

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

Für mode:

mode-rs485 = 0
mode-modbus-master-rtu = 1
mode-modbus-slave-rtu = 2

Fortgeschrittene Funktionen¶

tinkerforge call rs485-bricklet <uid> set-communication-led-config <config>¶

Parameter:	<config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:	keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <config>:

communication-led-config-off = 0
communication-led-config-on = 1
communication-led-config-show-heartbeat = 2
communication-led-config-show-communication = 3

tinkerforge call rs485-bricklet <uid> get-communication-led-config¶

Ausgabe:	config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von set-communication-led-config gesetzt.

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

Für config:

communication-led-config-off = 0
communication-led-config-on = 1
communication-led-config-show-heartbeat = 2
communication-led-config-show-communication = 3

tinkerforge call rs485-bricklet <uid> set-error-led-config <config>¶

Parameter:	<config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:	keine Ausgabe

Setzt die Konfiguration der Error-LED.

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

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

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

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

Für <config>:

error-led-config-off = 0
error-led-config-on = 1
error-led-config-show-heartbeat = 2
error-led-config-show-error = 3

tinkerforge call rs485-bricklet <uid> get-error-led-config¶

Ausgabe:	config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von set-error-led-config gesetzt.

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

Für config:

error-led-config-off = 0
error-led-config-on = 1
error-led-config-show-heartbeat = 2
error-led-config-show-error = 3

tinkerforge call rs485-bricklet <uid> set-buffer-config <send-buffer-size> <receive-buffer-size>¶

Parameter:	<send-buffer-size> – Typ: Int, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120 <receive-buffer-size> – Typ: Int, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120
Ausgabe:	keine Ausgabe

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

tinkerforge call rs485-bricklet <uid> get-buffer-config¶

Ausgabe:	send-buffer-size – Typ: Int, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120 receive-buffer-size – Typ: Int, Einheit: 1 B, Wertebereich: [2¹⁰ bis 9216], Standardwert: 5120

Gibt die Buffer-Konfiguration zurück, wie von set-buffer-config gesetzt.

tinkerforge call rs485-bricklet <uid> get-buffer-status¶

Ausgabe:	send-buffer-used – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 9216] receive-buffer-used – Typ: Int, 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.

tinkerforge call rs485-bricklet <uid> get-error-count¶

Ausgabe:	overrun-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1] parity-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1]

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

tinkerforge call rs485-bricklet <uid> get-modbus-common-error-count¶

Ausgabe:

Ausgabe:	timeout-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1] checksum-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1] frame-too-big-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1] illegal-function-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1] illegal-data-address-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1] illegal-data-value-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1] slave-device-failure-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1]

timeout-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1]
checksum-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1]
frame-too-big-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1]
illegal-function-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1]
illegal-data-address-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1]
illegal-data-value-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1]
slave-device-failure-error-count – Typ: Int, 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.

tinkerforge call rs485-bricklet <uid> modbus-slave-report-exception <request-id> <exception-code>¶

Parameter:	<request-id> – Typ: Int, Wertebereich: [0 bis 255] <exception-code> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:	keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <exception-code>:

exception-code-timeout = -1
exception-code-success = 0
exception-code-illegal-function = 1
exception-code-illegal-data-address = 2
exception-code-illegal-data-value = 3
exception-code-slave-device-failure = 4
exception-code-acknowledge = 5
exception-code-slave-device-busy = 6
exception-code-memory-parity-error = 8
exception-code-gateway-path-unavailable = 10
exception-code-gateway-target-device-failed-to-respond = 11

tinkerforge call rs485-bricklet <uid> modbus-slave-answer-read-coils-request <request-id> <coils>¶

Parameter:	<request-id> – Typ: Int, Wertebereich: [0 bis 255] <coils> – Typ: Bool Array, Länge: variabel
Ausgabe:	keine Ausgabe

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

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

Diese Funktion muss vom modbus-slave-read-coils-request Callback mit der Request ID des Callbacks aufgerufen werden.

tinkerforge call rs485-bricklet <uid> modbus-master-read-coils <slave-address> <starting-address> <count>¶

Parameter:	<slave-address> – Typ: Int, Wertebereich: [0 bis 247] <starting-address> – Typ: Int, Wertebereich: [1 bis 2¹⁶] <count> – Typ: Int, Wertebereich: [1 bis 2000]
Ausgabe:	request-id – Typ: Int, 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 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.

tinkerforge call rs485-bricklet <uid> modbus-slave-answer-read-holding-registers-request <request-id> <holding-registers>¶

Parameter:	<request-id> – Typ: Int, Wertebereich: [0 bis 255] <holding-registers> – Typ: Int Array, Länge: variabel, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabe:	keine Ausgabe

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

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

Diese Funktion muss vom modbus-slave-read-holding-registers-request Callback mit der Request ID des Callbacks aufgerufen werden.

tinkerforge call rs485-bricklet <uid> modbus-master-read-holding-registers <slave-address> <starting-address> <count>¶

Parameter:	<slave-address> – Typ: Int, Wertebereich: [0 bis 247] <starting-address> – Typ: Int, Wertebereich: [1 bis 2¹⁶] <count> – Typ: Int, Wertebereich: [1 bis 125]
Ausgabe:	request-id – Typ: Int, 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 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.

tinkerforge call rs485-bricklet <uid> modbus-slave-answer-write-single-coil-request <request-id>¶

Parameter:	<request-id> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:	keine Ausgabe

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

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom modbus-slave-write-single-coil-request Callback mit der Request ID des Callbacks aufgerufen werden.

tinkerforge call rs485-bricklet <uid> modbus-master-write-single-coil <slave-address> <coil-address> <coil-value>¶

Parameter:	<slave-address> – Typ: Int, Wertebereich: [0 bis 247] <coil-address> – Typ: Int, Wertebereich: [1 bis 2¹⁶] <coil-value> – Typ: Bool
Ausgabe:	request-id – Typ: Int, 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 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.

tinkerforge call rs485-bricklet <uid> modbus-slave-answer-write-single-register-request <request-id>¶

Parameter:	<request-id> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:	keine Ausgabe

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

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom modbus-slave-write-single-register-request Callback mit der Request ID des Callbacks aufgerufen werden.

tinkerforge call rs485-bricklet <uid> modbus-master-write-single-register <slave-address> <register-address> <register-value>¶

Parameter:	<slave-address> – Typ: Int, Wertebereich: [0 bis 247] <register-address> – Typ: Int, Wertebereich: [1 bis 2¹⁶] <register-value> – Typ: Int, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabe:	request-id – Typ: Int, 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 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.

tinkerforge call rs485-bricklet <uid> modbus-slave-answer-write-multiple-coils-request <request-id>¶

Parameter:	<request-id> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:	keine Ausgabe

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

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom modbus-slave-write-multiple-coils-request Callback mit der Request ID des Callbacks aufgerufen werden.

tinkerforge call rs485-bricklet <uid> modbus-master-write-multiple-coils <slave-address> <starting-address> <coils>¶

Parameter:	<slave-address> – Typ: Int, Wertebereich: [0 bis 247] <starting-address> – Typ: Int, Wertebereich: [1 bis 2¹⁶] <coils> – Typ: Bool Array, Länge: variabel
Ausgabe:	request-id – Typ: Int, 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 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.

tinkerforge call rs485-bricklet <uid> modbus-slave-answer-write-multiple-registers-request <request-id>¶

Parameter:	<request-id> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:	keine Ausgabe

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

Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom modbus-slave-write-multiple-registers-request Callback mit der Request ID des Callbacks aufgerufen werden.

tinkerforge call rs485-bricklet <uid> modbus-master-write-multiple-registers <slave-address> <starting-address> <registers>¶

Parameter:	<slave-address> – Typ: Int, Wertebereich: [0 bis 247] <starting-address> – Typ: Int, Wertebereich: [1 bis 2¹⁶] <registers> – Typ: Int Array, Länge: variabel, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabe:	request-id – Typ: Int, 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 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.

tinkerforge call rs485-bricklet <uid> modbus-slave-answer-read-discrete-inputs-request <request-id> <discrete-inputs>¶

Parameter:	<request-id> – Typ: Int, Wertebereich: [0 bis 255] <discrete-inputs> – Typ: Bool Array, Länge: variabel
Ausgabe:	keine Ausgabe

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

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

Diese Funktion muss vom modbus-slave-read-discrete-inputs-request Callback mit der Request ID des Callbacks aufgerufen werden.

tinkerforge call rs485-bricklet <uid> modbus-master-read-discrete-inputs <slave-address> <starting-address> <count>¶

Parameter:	<slave-address> – Typ: Int, Wertebereich: [0 bis 247] <starting-address> – Typ: Int, Wertebereich: [1 bis 2¹⁶] <count> – Typ: Int, Wertebereich: [1 bis 2000]
Ausgabe:	request-id – Typ: Int, 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 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.

tinkerforge call rs485-bricklet <uid> modbus-slave-answer-read-input-registers-request <request-id> <input-registers>¶

Parameter:	<request-id> – Typ: Int, Wertebereich: [0 bis 255] <input-registers> – Typ: Int Array, Länge: variabel, Wertebereich: [0 bis 2¹⁶ - 1]
Ausgabe:	keine Ausgabe

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

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

Diese Funktion muss vom modbus-slave-read-input-registers-request Callback mit der Request ID des Callbacks aufgerufen werden.

tinkerforge call rs485-bricklet <uid> modbus-master-read-input-registers <slave-address> <starting-address> <count>¶

Parameter:	<slave-address> – Typ: Int, Wertebereich: [0 bis 247] <starting-address> – Typ: Int, Wertebereich: [1 bis 2¹⁶] <count> – Typ: Int, Wertebereich: [1 bis 125]
Ausgabe:	request-id – Typ: Int, 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 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.

tinkerforge call rs485-bricklet <uid> get-spitfp-error-count¶

Ausgabe:	error-count-ack-checksum – Typ: Int, Wertebereich: [0 bis 2³² - 1] error-count-message-checksum – Typ: Int, Wertebereich: [0 bis 2³² - 1] error-count-frame – Typ: Int, Wertebereich: [0 bis 2³² - 1] error-count-overflow – Typ: Int, 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.

tinkerforge call rs485-bricklet <uid> set-status-led-config <config>¶

Parameter:	<config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:	keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <config>:

status-led-config-off = 0
status-led-config-on = 1
status-led-config-show-heartbeat = 2
status-led-config-show-status = 3

tinkerforge call rs485-bricklet <uid> get-status-led-config¶

Ausgabe:	config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

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

Für config:

status-led-config-off = 0
status-led-config-on = 1
status-led-config-show-heartbeat = 2
status-led-config-show-status = 3

tinkerforge call rs485-bricklet <uid> get-chip-temperature¶

Ausgabe:	temperature – Typ: Int, 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.

tinkerforge call rs485-bricklet <uid> reset¶

Ausgabe:	keine Ausgabe

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.

tinkerforge call rs485-bricklet <uid> get-identity¶

Ausgabe:

Ausgabe:	uid – Typ: String, Länge: bis zu 8 connected-uid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: [a bis h, z] hardware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] firmware-version – Typ: Int Array, Länge: 3 0: major – Typ: Int, Wertebereich: [0 bis 255] 1: minor – Typ: Int, Wertebereich: [0 bis 255] 2: revision – Typ: Int, Wertebereich: [0 bis 255] device-identifier – Typ: Int, Wertebereich: [0 bis 2¹⁶ - 1]

uid – Typ: String, Länge: bis zu 8
connected-uid – Typ: String, Länge: bis zu 8
position – Typ: Char, Wertebereich: [a bis h, z]
hardware-version – Typ: Int Array, Länge: 3

0: major – Typ: Int, Wertebereich: [0 bis 255]
1: minor – Typ: Int, Wertebereich: [0 bis 255]
2: revision – Typ: Int, Wertebereich: [0 bis 255]

firmware-version – Typ: Int Array, Länge: 3

0: major – Typ: Int, Wertebereich: [0 bis 255]
1: minor – Typ: Int, Wertebereich: [0 bis 255]
2: revision – Typ: Int, Wertebereich: [0 bis 255]

device-identifier – Typ: Int, 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¶

tinkerforge call rs485-bricklet <uid> enable-read-callback¶

Ausgabe:	keine Ausgabe

Aktiviert den read Callback. Dies deaktiviert den frame-readable Callback.

Im Startzustand ist der Callback deaktiviert.

tinkerforge call rs485-bricklet <uid> disable-read-callback¶

Ausgabe:	keine Ausgabe

Deaktiviert den read Callback.

Im Startzustand ist der Callback deaktiviert.

tinkerforge call rs485-bricklet <uid> is-read-callback-enabled¶

Ausgabe:	enabled – Typ: Bool, Standardwert: false

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

tinkerforge call rs485-bricklet <uid> enable-error-count-callback¶

Ausgabe:	keine Ausgabe

Aktiviert den error-count Callback.

Im Startzustand ist der Callback deaktiviert.

tinkerforge call rs485-bricklet <uid> disable-error-count-callback¶

Ausgabe:	keine Ausgabe

Deaktiviert den error-count Callback.

Im Startzustand ist der Callback deaktiviert.

tinkerforge call rs485-bricklet <uid> is-error-count-callback-enabled¶

Ausgabe:	enabled – Typ: Bool, Standardwert: true

Gibt true zurück falls error-count Callback aktiviert ist, false sonst.

tinkerforge call rs485-bricklet <uid> set-frame-readable-callback-configuration <frame-size>¶

Parameter:	<frame-size> – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 9216], Standardwert: 0
Ausgabe:	keine Ausgabe

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

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.5 (Plugin).

tinkerforge call rs485-bricklet <uid> get-frame-readable-callback-configuration¶

Ausgabe:	frame-size – Typ: Int, 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¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch rs485-bricklet <uid> example

Die verfügbaren Callbacks 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.

tinkerforge dispatch rs485-bricklet <uid> read

Ausgabe:	message – Typ: Char Array, Länge: variabel

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

Dieser Callback kann durch enable-read-callback aktiviert werden.

Bemerkung

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

tinkerforge dispatch rs485-bricklet <uid> error-count¶

Ausgabe:	overrun-error-count – Typ: Int, Wertebereich: [0 bis 2³² - 1] parity-error-count – Typ: Int, 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.

tinkerforge dispatch rs485-bricklet <uid> modbus-slave-read-coils-request¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] starting-address – Typ: Int, Wertebereich: [1 bis 2¹⁶] count – Typ: Int, 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 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 modbus-slave-answer-read-coils-request gesendet werden.

tinkerforge dispatch rs485-bricklet <uid> modbus-master-read-coils-response¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] exception-code – Typ: Int, Wertebereich: Siehe Symbole coils – Typ: Bool Array, Länge: variabel

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 set-modbus-configuration gesetzt werden.

Bemerkung

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

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

Für exception-code:

exception-code-timeout = -1
exception-code-success = 0
exception-code-illegal-function = 1
exception-code-illegal-data-address = 2
exception-code-illegal-data-value = 3
exception-code-slave-device-failure = 4
exception-code-acknowledge = 5
exception-code-slave-device-busy = 6
exception-code-memory-parity-error = 8
exception-code-gateway-path-unavailable = 10
exception-code-gateway-target-device-failed-to-respond = 11

tinkerforge dispatch rs485-bricklet <uid> modbus-slave-read-holding-registers-request¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] starting-address – Typ: Int, Wertebereich: [1 bis 2¹⁶] count – Typ: Int, 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 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 modbus-slave-answer-read-holding-registers-request gesendet werden.

tinkerforge dispatch rs485-bricklet <uid> modbus-master-read-holding-registers-response¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] exception-code – Typ: Int, Wertebereich: Siehe Symbole holding-registers – Typ: Int Array, Länge: variabel, 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 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 None für holding-registers ausgelöst.

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

Für exception-code:

exception-code-timeout = -1
exception-code-success = 0
exception-code-illegal-function = 1
exception-code-illegal-data-address = 2
exception-code-illegal-data-value = 3
exception-code-slave-device-failure = 4
exception-code-acknowledge = 5
exception-code-slave-device-busy = 6
exception-code-memory-parity-error = 8
exception-code-gateway-path-unavailable = 10
exception-code-gateway-target-device-failed-to-respond = 11

tinkerforge dispatch rs485-bricklet <uid> modbus-slave-write-single-coil-request¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] coil-address – Typ: Int, 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 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 modbus-slave-answer-write-single-coil-request gesendet werden.

tinkerforge dispatch rs485-bricklet <uid> modbus-master-write-single-coil-response¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] exception-code – Typ: Int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für exception-code:

exception-code-timeout = -1
exception-code-success = 0
exception-code-illegal-function = 1
exception-code-illegal-data-address = 2
exception-code-illegal-data-value = 3
exception-code-slave-device-failure = 4
exception-code-acknowledge = 5
exception-code-slave-device-busy = 6
exception-code-memory-parity-error = 8
exception-code-gateway-path-unavailable = 10
exception-code-gateway-target-device-failed-to-respond = 11

tinkerforge dispatch rs485-bricklet <uid> modbus-slave-write-single-register-request¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] register-address – Typ: Int, Wertebereich: [1 bis 2¹⁶] register-value – Typ: Int, 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 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 modbus-slave-answer-write-single-register-request gesendet werden.

tinkerforge dispatch rs485-bricklet <uid> modbus-master-write-single-register-response¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] exception-code – Typ: Int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für exception-code:

exception-code-timeout = -1
exception-code-success = 0
exception-code-illegal-function = 1
exception-code-illegal-data-address = 2
exception-code-illegal-data-value = 3
exception-code-slave-device-failure = 4
exception-code-acknowledge = 5
exception-code-slave-device-busy = 6
exception-code-memory-parity-error = 8
exception-code-gateway-path-unavailable = 10
exception-code-gateway-target-device-failed-to-respond = 11

tinkerforge dispatch rs485-bricklet <uid> modbus-slave-write-multiple-coils-request¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] starting-address – Typ: Int, Wertebereich: [1 bis 2¹⁶] coils – Typ: Bool Array, Länge: variabel

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 modbus-slave-answer-write-multiple-coils-request gesendet werden.

Bemerkung

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

tinkerforge dispatch rs485-bricklet <uid> modbus-master-write-multiple-coils-response¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] exception-code – Typ: Int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für exception-code:

exception-code-timeout = -1
exception-code-success = 0
exception-code-illegal-function = 1
exception-code-illegal-data-address = 2
exception-code-illegal-data-value = 3
exception-code-slave-device-failure = 4
exception-code-acknowledge = 5
exception-code-slave-device-busy = 6
exception-code-memory-parity-error = 8
exception-code-gateway-path-unavailable = 10
exception-code-gateway-target-device-failed-to-respond = 11

tinkerforge dispatch rs485-bricklet <uid> modbus-slave-write-multiple-registers-request¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] starting-address – Typ: Int, Wertebereich: [1 bis 2¹⁶] registers – Typ: Int Array, Länge: variabel, 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 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 modbus-slave-answer-write-multiple-registers-request gesendet werden.

Bemerkung

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

tinkerforge dispatch rs485-bricklet <uid> modbus-master-write-multiple-registers-response¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] exception-code – Typ: Int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für exception-code:

exception-code-timeout = -1
exception-code-success = 0
exception-code-illegal-function = 1
exception-code-illegal-data-address = 2
exception-code-illegal-data-value = 3
exception-code-slave-device-failure = 4
exception-code-acknowledge = 5
exception-code-slave-device-busy = 6
exception-code-memory-parity-error = 8
exception-code-gateway-path-unavailable = 10
exception-code-gateway-target-device-failed-to-respond = 11

tinkerforge dispatch rs485-bricklet <uid> modbus-slave-read-discrete-inputs-request¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] starting-address – Typ: Int, Wertebereich: [1 bis 2¹⁶] count – Typ: Int, 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 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 modbus-slave-answer-read-discrete-inputs-request gesendet werden.

tinkerforge dispatch rs485-bricklet <uid> modbus-master-read-discrete-inputs-response¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] exception-code – Typ: Int, Wertebereich: Siehe Symbole discrete-inputs – Typ: Bool Array, Länge: variabel

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 None für discrete-inputs ausgelöst.

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

Für exception-code:

exception-code-timeout = -1
exception-code-success = 0
exception-code-illegal-function = 1
exception-code-illegal-data-address = 2
exception-code-illegal-data-value = 3
exception-code-slave-device-failure = 4
exception-code-acknowledge = 5
exception-code-slave-device-busy = 6
exception-code-memory-parity-error = 8
exception-code-gateway-path-unavailable = 10
exception-code-gateway-target-device-failed-to-respond = 11

tinkerforge dispatch rs485-bricklet <uid> modbus-slave-read-input-registers-request¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] starting-address – Typ: Int, Wertebereich: [1 bis 2¹⁶] count – Typ: Int, 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 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 modbus-slave-answer-read-input-registers-request gesendet werden.

tinkerforge dispatch rs485-bricklet <uid> modbus-master-read-input-registers-response¶

Ausgabe:	request-id – Typ: Int, Wertebereich: [0 bis 255] exception-code – Typ: Int, Wertebereich: Siehe Symbole input-registers – Typ: Int Array, Länge: variabel, 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 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 None für input-registers ausgelöst.

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

Für exception-code:

exception-code-timeout = -1
exception-code-success = 0
exception-code-illegal-function = 1
exception-code-illegal-data-address = 2
exception-code-illegal-data-value = 3
exception-code-slave-device-failure = 4
exception-code-acknowledge = 5
exception-code-slave-device-busy = 6
exception-code-memory-parity-error = 8
exception-code-gateway-path-unavailable = 10
exception-code-gateway-target-device-failed-to-respond = 11

tinkerforge dispatch rs485-bricklet <uid> frame-readable¶

Ausgabe:	frame-count – Typ: Int, 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 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-Funktion gelesen werden können, ohne dass der Frame Count-Parameter 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.

tinkerforge call rs485-bricklet <uid> set-bootloader-mode <mode>¶

Parameter:	<mode> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:	status – Typ: Int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für <mode>:

bootloader-mode-bootloader = 0
bootloader-mode-firmware = 1
bootloader-mode-bootloader-wait-for-reboot = 2
bootloader-mode-firmware-wait-for-reboot = 3
bootloader-mode-firmware-wait-for-erase-and-reboot = 4

Für status:

bootloader-status-ok = 0
bootloader-status-invalid-mode = 1
bootloader-status-no-change = 2
bootloader-status-entry-function-not-present = 3
bootloader-status-device-identifier-incorrect = 4
bootloader-status-crc-mismatch = 5

tinkerforge call rs485-bricklet <uid> get-bootloader-mode¶

Ausgabe:	mode – Typ: Int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

Für mode:

bootloader-mode-bootloader = 0
bootloader-mode-firmware = 1
bootloader-mode-bootloader-wait-for-reboot = 2
bootloader-mode-firmware-wait-for-reboot = 3
bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call rs485-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameter:	<pointer> – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Ausgabe:	keine Ausgabe

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.

tinkerforge call rs485-bricklet <uid> write-firmware <data>¶

Parameter:	<data> – Typ: Int Array, Länge: 64, Wertebereich: [0 bis 255]
Ausgabe:	status – Typ: Int, 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.

tinkerforge call rs485-bricklet <uid> write-uid <uid>¶

Parameter:	<uid> – Typ: Int, Wertebereich: [0 bis 2³² - 1]
Ausgabe:	keine Ausgabe

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.

tinkerforge call rs485-bricklet <uid> read-uid¶

Ausgabe:	uid – Typ: Int, 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.