Ruby - RS485 Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback

Download (example_loopback.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

# 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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_rs485'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your RS485 Bricklet

ipcon = IPConnection.new # Create IP connection
rs485 = BrickletRS485.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Enable full-duplex mode
rs485.set_rs485_configuration 115200, BrickletRS485::PARITY_NONE, \
                              BrickletRS485::STOPBITS_1, BrickletRS485::WORDLENGTH_8, \
                              BrickletRS485::DUPLEX_FULL

# Register read callback
rs485.register_callback(BrickletRS485::CALLBACK_READ) do |message|
  puts "Message: #{message.join('')}"
end

# Enable read callback
rs485.enable_read_callback

# Write "test" string
rs485.write 'test'.split ''

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Modbus Master

Download (example_modbus_master.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_rs485'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your RS485 Bricklet

ipcon = IPConnection.new # Create IP connection
rs485 = BrickletRS485.new UID, ipcon # Create device object

expected_request_id = 0

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Set operating mode to Modbus RTU master
rs485.set_mode BrickletRS485::MODE_MODBUS_MASTER_RTU

# Modbus specific configuration:
# - slave address = 1 (unused in master mode)
# - master request timeout = 1000ms
rs485.set_modbus_configuration 1, 1000

# Register Modbus master write single register response callback
rs485.register_callback(BrickletRS485::CALLBACK_MODBUS_MASTER_WRITE_SINGLE_REGISTER_RESPONSE) do |request_id,
                                                                                                  exception_code|
  puts "Request ID: #{request_id}"
  puts "Exception Code: #{exception_code}"
  if request_id != expected_request_id
    puts "Unexpected request ID"
  end
  puts ''
end

# Write 65535 to register 42 of slave 17
expected_request_id = rs485.modbus_master_write_single_register 17, 42, 65535

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Modbus Slave

Download (example_modbus_slave.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_rs485'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your RS485 Bricklet

ipcon = IPConnection.new # Create IP connection
rs485 = BrickletRS485.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Set operating mode to Modbus RTU slave
rs485.set_mode BrickletRS485::MODE_MODBUS_SLAVE_RTU

# Modbus specific configuration:
# - slave address = 17
# - master request timeout = 0ms (unused in slave mode)
rs485.set_modbus_configuration 17, 0

# Register Modbus slave write single register request callback
rs485.register_callback(BrickletRS485::CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_REGISTER_REQUEST) do |request_id,
                                                                                                register_address,
                                                                                                register_value|
  puts "Request ID: #{request_id}"
  puts "Register Address: #{register_address}"
  puts "Register Value: #{register_value}"

  if register_address != 42
    puts 'Error: Invalid register address'
    rs485.modbus_slave_report_exception request_id, BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS
  else
    rs485.modbus_slave_answer_write_single_register_request request_id
  end
end

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletRS485::new(uid, ipcon) → rs485
Parameter:
  • uid -- str
  • ipcon -- IPConnection

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

rs485 = BrickletRS485.new 'YOUR_DEVICE_UID', ipcon

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletRS485#write(message) → int
Parameter:message -- [str, str, ...]

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(length) → [str, str, ...]
Parameter:length -- int

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

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Diese Funktion gibt nur Daten zurück wenn der Read-Callback nich aktiv ist. Siehe #enable_read_callback und ::CALLBACK_READ Callback.

BrickletRS485#set_rs485_configuration(baudrate, parity, stopbits, wordlength, duplex) → nil
Parameter:
  • baudrate -- int
  • parity -- int
  • stopbits -- int
  • wordlength -- int
  • duplex -- int

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

  • Baudrate zwischen 100 und 2000000 Baud.
  • Parität von None, Odd und Even.
  • Stop Bits von 1 oder 2.
  • Wortlänge zwischen 5 und 8.
  • Halb- oder Voll-Duplex.

Der Standard ist: 115200 Baud, Parität None, 1 Stop Bits, Wortlänge 8, Halb-Duplex.

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

  • BrickletRS485::PARITY_NONE = 0
  • BrickletRS485::PARITY_ODD = 1
  • BrickletRS485::PARITY_EVEN = 2
  • BrickletRS485::STOPBITS_1 = 1
  • BrickletRS485::STOPBITS_2 = 2
  • BrickletRS485::WORDLENGTH_5 = 5
  • BrickletRS485::WORDLENGTH_6 = 6
  • BrickletRS485::WORDLENGTH_7 = 7
  • BrickletRS485::WORDLENGTH_8 = 8
  • BrickletRS485::DUPLEX_HALF = 0
  • BrickletRS485::DUPLEX_FULL = 1
BrickletRS485#get_rs485_configuration → [int, int, int, int, int]

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

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

  • BrickletRS485::PARITY_NONE = 0
  • BrickletRS485::PARITY_ODD = 1
  • BrickletRS485::PARITY_EVEN = 2
  • BrickletRS485::STOPBITS_1 = 1
  • BrickletRS485::STOPBITS_2 = 2
  • BrickletRS485::WORDLENGTH_5 = 5
  • BrickletRS485::WORDLENGTH_6 = 6
  • BrickletRS485::WORDLENGTH_7 = 7
  • BrickletRS485::WORDLENGTH_8 = 8
  • BrickletRS485::DUPLEX_HALF = 0
  • BrickletRS485::DUPLEX_FULL = 1

Das zurückgegebene Array enthält die Werte baudrate, parity, stopbits, wordlength und duplex.

BrickletRS485#set_modbus_configuration(slave_address, master_request_timeout) → nil
Parameter:
  • slave_address -- int
  • master_request_timeout -- int

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

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

Die Standardwerte sind Slave Address = 1 und Master Request Timeout = 1000 Millisekunden (1 Sekunde).

BrickletRS485#get_modbus_configuration → [int, int]

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

Das zurückgegebene Array enthält die Werte slave_address und master_request_timeout.

BrickletRS485#set_mode(mode) → nil
Parameter:mode -- int

Setzt den Modus des Bricklets. Verfügbare Optionen sind

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

Der Standardmodus ist RS485.

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

  • BrickletRS485::MODE_RS485 = 0
  • BrickletRS485::MODE_MODBUS_MASTER_RTU = 1
  • BrickletRS485::MODE_MODBUS_SLAVE_RTU = 2
BrickletRS485#get_mode → int

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

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

  • BrickletRS485::MODE_RS485 = 0
  • BrickletRS485::MODE_MODBUS_MASTER_RTU = 1
  • BrickletRS485::MODE_MODBUS_SLAVE_RTU = 2

Fortgeschrittene Funktionen

BrickletRS485#set_communication_led_config(config) → nil
Parameter:config -- int

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

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

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

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

  • BrickletRS485::COMMUNICATION_LED_CONFIG_OFF = 0
  • BrickletRS485::COMMUNICATION_LED_CONFIG_ON = 1
  • BrickletRS485::COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRS485::COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
BrickletRS485#get_communication_led_config → int

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

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

  • BrickletRS485::COMMUNICATION_LED_CONFIG_OFF = 0
  • BrickletRS485::COMMUNICATION_LED_CONFIG_ON = 1
  • BrickletRS485::COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRS485::COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
BrickletRS485#set_error_led_config(config) → nil
Parameter:config -- int

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 Bootlodermodus befindet ist die LED aus.

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

  • BrickletRS485::ERROR_LED_CONFIG_OFF = 0
  • BrickletRS485::ERROR_LED_CONFIG_ON = 1
  • BrickletRS485::ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRS485::ERROR_LED_CONFIG_SHOW_ERROR = 3
BrickletRS485#get_error_led_config → int

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

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

  • BrickletRS485::ERROR_LED_CONFIG_OFF = 0
  • BrickletRS485::ERROR_LED_CONFIG_ON = 1
  • BrickletRS485::ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRS485::ERROR_LED_CONFIG_SHOW_ERROR = 3
BrickletRS485#set_buffer_config(send_buffer_size, receive_buffer_size) → nil
Parameter:
  • send_buffer_size -- int
  • receive_buffer_size -- int

Setzt die Größe des Senden- und Empfangsbuffers. In Summe können die Buffer eine Größe von 10240 Byte (10kb) haben, die Minimumalgröße ist 1024 byte (1kb) 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 ::CALLBACK_READ Callback an ein Nutzerprogramm übertragen werden konnten.

Die Standardkonfiguration ist 5120 Byte (5kb) pro Buffer.

BrickletRS485#get_buffer_config → [int, int]

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

Das zurückgegebene Array enthält die Werte send_buffer_size und receive_buffer_size.

BrickletRS485#get_buffer_status → [int, int]

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

Siehe #set_buffer_config zur Konfiguration der Buffergrößen.

Das zurückgegebene Array enthält die Werte send_buffer_used und receive_buffer_used.

BrickletRS485#get_error_count → [int, int]

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

Das zurückgegebene Array enthält die Werte overrun_error_count und parity_error_count.

BrickletRS485#get_modbus_common_error_count → [int, int, int, int, int, int, int]

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

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

Das zurückgegebene Array enthält die Werte timeout_error_count, checksum_error_count, frame_too_big_error_count, illegal_function_error_count, illegal_data_address_error_count, illegal_data_value_error_count und slave_device_failure_error_count.

BrickletRS485#modbus_slave_report_exception(request_id, exception_code) → nil
Parameter:
  • request_id -- int
  • exception_code -- int

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

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

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

  • BrickletRS485::EXCEPTION_CODE_TIMEOUT = -1
  • BrickletRS485::EXCEPTION_CODE_SUCCESS = 0
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BrickletRS485::EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BrickletRS485::EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
BrickletRS485#modbus_slave_answer_read_coils_request(request_id, coils) → nil
Parameter:
  • request_id -- int
  • coils -- [bool, bool, ...]

Im Modbus-Slave Modus kann diese Funktion genutzt werden un 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(slave_address, starting_address, count) → int
Parameter:
  • slave_address -- int
  • starting_address -- int
  • count -- int

Im Modbus-Master Modus kann diese Funktion genutzt werden um Coils vom Slave zu lesen.

  • 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 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(request_id, holding_registers) → nil
Parameter:
  • request_id -- int
  • holding_registers -- [int, int, ...]

Im Modbus-Slave Modus kann diese Funktion genutzt werden un 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(slave_address, starting_address, count) → int
Parameter:
  • slave_address -- int
  • starting_address -- int
  • count -- int

Im Modbus-Master Modus kann diese Funktion genutzt werden un 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 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(request_id) → nil
Parameter:request_id -- int

Im Modbus-Slave Modus kann diese Funktion genutzt werden un 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(slave_address, coil_address, coil_value) → int
Parameter:
  • slave_address -- int
  • coil_address -- int
  • coil_value -- bool

Im Modbus-Master Modus kann diese Funktion genutzt werden un 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(request_id) → nil
Parameter:request_id -- int

Im Modbus-Slave Modus kann diese Funktion genutzt werden un 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(slave_address, register_address, register_value) → int
Parameter:
  • slave_address -- int
  • register_address -- int
  • register_value -- int

Im Modbus-Master Modus kann diese Funktion genutzt werden un 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(request_id) → nil
Parameter:request_id -- int

Im Modbus-Slave Modus kann diese Funktion genutzt werden un 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 Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485#modbus_master_write_multiple_coils(slave_address, starting_address, coils) → int
Parameter:
  • slave_address -- int
  • starting_address -- int
  • coils -- [bool, bool, ...]

Im Modbus-Master Modus kann diese Funktion genutzt werden un 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(request_id) → nil
Parameter:request_id -- int

Im Modbus-Slave Modus kann diese Funktion genutzt werden un 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 Callback mit der Request ID des Callbacks aufgerufen werden.

BrickletRS485#modbus_master_write_multiple_registers(slave_address, starting_address, registers) → int
Parameter:
  • slave_address -- int
  • starting_address -- int
  • registers -- [int, int, ...]

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

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

Falls kein Fehler auftritt, wird auch der ::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(request_id, discrete_inputs) → nil
Parameter:
  • request_id -- int
  • discrete_inputs -- [bool, bool, ...]

Im Modbus-Slave Modus kann diese Funktion genutzt werden un 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(slave_address, starting_address, count) → int
Parameter:
  • slave_address -- int
  • starting_address -- int
  • count -- int

Im Modbus-Master Modus kann diese Funktion genutzt werden un 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 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(request_id, input_registers) → nil
Parameter:
  • request_id -- int
  • input_registers -- [int, int, ...]

Im Modbus-Slave Modus kann diese Funktion genutzt werden un 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(slave_address, starting_address, count) → int
Parameter:
  • slave_address -- int
  • starting_address -- int
  • count -- int

Im Modbus-Master Modus kann diese Funktion genutzt werden un 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 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_api_version → [int, int, int]

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletRS485#get_response_expected(function_id) → bool
Parameter:function_id -- int

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels #set_response_expected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Siehe #set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

BrickletRS485#set_response_expected(function_id, response_expected) → nil
Parameter:
  • function_id -- int
  • response_expected -- bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

  • BrickletRS485::FUNCTION_ENABLE_READ_CALLBACK = 3
  • BrickletRS485::FUNCTION_DISABLE_READ_CALLBACK = 4
  • BrickletRS485::FUNCTION_SET_RS485_CONFIGURATION = 6
  • BrickletRS485::FUNCTION_SET_MODBUS_CONFIGURATION = 8
  • BrickletRS485::FUNCTION_SET_MODE = 10
  • BrickletRS485::FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
  • BrickletRS485::FUNCTION_SET_ERROR_LED_CONFIG = 14
  • BrickletRS485::FUNCTION_SET_BUFFER_CONFIG = 16
  • BrickletRS485::FUNCTION_ENABLE_ERROR_COUNT_CALLBACK = 19
  • BrickletRS485::FUNCTION_DISABLE_ERROR_COUNT_CALLBACK = 20
  • BrickletRS485::FUNCTION_MODBUS_SLAVE_REPORT_EXCEPTION = 24
  • BrickletRS485::FUNCTION_MODBUS_SLAVE_ANSWER_READ_COILS_REQUEST = 25
  • BrickletRS485::FUNCTION_MODBUS_SLAVE_ANSWER_READ_HOLDING_REGISTERS_REQUEST = 27
  • BrickletRS485::FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_COIL_REQUEST = 29
  • BrickletRS485::FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_REGISTER_REQUEST = 31
  • BrickletRS485::FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_COILS_REQUEST = 33
  • BrickletRS485::FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_REGISTERS_REQUEST = 35
  • BrickletRS485::FUNCTION_MODBUS_SLAVE_ANSWER_READ_DISCRETE_INPUTS_REQUEST = 37
  • BrickletRS485::FUNCTION_MODBUS_SLAVE_ANSWER_READ_INPUT_REGISTERS_REQUEST = 39
  • BrickletRS485::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRS485::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRS485::FUNCTION_RESET = 243
  • BrickletRS485::FUNCTION_WRITE_UID = 248
BrickletRS485#set_response_expected_all(response_expected) → nil
Parameter:response_expected -- bool

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

BrickletRS485#get_spitfp_error_count → [int, int, int, int]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

Das zurückgegebene Array enthält die Werte error_count_ack_checksum, error_count_message_checksum, error_count_frame und error_count_overflow.

BrickletRS485#set_bootloader_mode(mode) → int
Parameter:mode -- int

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

  • BrickletRS485::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRS485::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRS485::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRS485::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRS485::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletRS485::BOOTLOADER_STATUS_OK = 0
  • BrickletRS485::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletRS485::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletRS485::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletRS485::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletRS485::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletRS485#get_bootloader_mode → int

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

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

  • BrickletRS485::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRS485::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRS485::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRS485::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRS485::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletRS485#set_write_firmware_pointer(pointer) → nil
Parameter:pointer -- int

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(data) → int
Parameter:data -- [int, int, ..61x.., int]

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#set_status_led_config(config) → nil
Parameter:config -- int

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

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

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

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

  • BrickletRS485::STATUS_LED_CONFIG_OFF = 0
  • BrickletRS485::STATUS_LED_CONFIG_ON = 1
  • BrickletRS485::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRS485::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletRS485#get_status_led_config → int

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

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

  • BrickletRS485::STATUS_LED_CONFIG_OFF = 0
  • BrickletRS485::STATUS_LED_CONFIG_ON = 1
  • BrickletRS485::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRS485::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletRS485#get_chip_temperature → int

Gibt die Temperatur in °C, 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 → nil

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#write_uid(uid) → nil
Parameter:uid -- int

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletRS485#read_uid → int

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

BrickletRS485#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Das zurückgegebene Array enthält die Werte uid, connected_uid, position, hardware_version, firmware_version und device_identifier.

Konfigurationsfunktionen für Callbacks

BrickletRS485#register_callback(callback_id) { |param [, ...]| block } → nil
Parameter:callback_id -- int

Registriert den block für die gegebene callback_id.

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

BrickletRS485#enable_read_callback → nil

Aktiviert den ::CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS485#disable_read_callback → nil

Deaktiviert den ::CALLBACK_READ Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS485#is_read_callback_enabled → bool

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

BrickletRS485#enable_error_count_callback → nil

Aktiviert den ::CALLBACK_ERROR_COUNT Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS485#disable_error_count_callback → nil

Deaktiviert den ::CALLBACK_ERROR_COUNT Callback.

Im Startzustand ist der Callback deaktiviert.

BrickletRS485#is_error_count_callback_enabled → bool

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

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion #register_callback des Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID und der zweite Parameter der Block:

rs485.register_callback BrickletRS485::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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.

BrickletRS485::CALLBACK_READ
Parameter:message -- [str, str, ...]

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

Dieser Callback kann durch #enable_read_callback aktiviert werden.

BrickletRS485::CALLBACK_ERROR_COUNT
Parameter:
  • overrun_error_count -- int
  • parity_error_count -- int

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
Parameter:
  • request_id -- int
  • starting_address -- int
  • count -- int

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.

BrickletRS485::CALLBACK_MODBUS_MASTER_READ_COILS_RESPONSE
Parameter:
  • request_id -- int
  • exception_code -- int
  • coils -- [bool, bool, ...]

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.

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

  • BrickletRS485::EXCEPTION_CODE_TIMEOUT = -1
  • BrickletRS485::EXCEPTION_CODE_SUCCESS = 0
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BrickletRS485::EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BrickletRS485::EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
BrickletRS485::CALLBACK_MODBUS_SLAVE_READ_HOLDING_REGISTERS_REQUEST
Parameter:
  • request_id -- int
  • starting_address -- int
  • count -- int

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.

BrickletRS485::CALLBACK_MODBUS_MASTER_READ_HOLDING_REGISTERS_RESPONSE
Parameter:
  • request_id -- int
  • exception_code -- int
  • holding_registers -- [int, int, ...]

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.

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

  • BrickletRS485::EXCEPTION_CODE_TIMEOUT = -1
  • BrickletRS485::EXCEPTION_CODE_SUCCESS = 0
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BrickletRS485::EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BrickletRS485::EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
BrickletRS485::CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_COIL_REQUEST
Parameter:
  • request_id -- int
  • coil_address -- int
  • coil_value -- 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.

BrickletRS485::CALLBACK_MODBUS_MASTER_WRITE_SINGLE_COIL_RESPONSE
Parameter:
  • request_id -- int
  • exception_code -- int

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.

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

  • BrickletRS485::EXCEPTION_CODE_TIMEOUT = -1
  • BrickletRS485::EXCEPTION_CODE_SUCCESS = 0
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BrickletRS485::EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BrickletRS485::EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
BrickletRS485::CALLBACK_MODBUS_SLAVE_WRITE_SINGLE_REGISTER_REQUEST
Parameter:
  • request_id -- int
  • register_address -- int
  • register_value -- int

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.

BrickletRS485::CALLBACK_MODBUS_MASTER_WRITE_SINGLE_REGISTER_RESPONSE
Parameter:
  • request_id -- int
  • exception_code -- int

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.

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

  • BrickletRS485::EXCEPTION_CODE_TIMEOUT = -1
  • BrickletRS485::EXCEPTION_CODE_SUCCESS = 0
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BrickletRS485::EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BrickletRS485::EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
BrickletRS485::CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_COILS_REQUEST
Parameter:
  • request_id -- int
  • starting_address -- int
  • coils -- [bool, bool, ...]

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.

BrickletRS485::CALLBACK_MODBUS_MASTER_WRITE_MULTIPLE_COILS_RESPONSE
Parameter:
  • request_id -- int
  • exception_code -- int

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.

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

  • BrickletRS485::EXCEPTION_CODE_TIMEOUT = -1
  • BrickletRS485::EXCEPTION_CODE_SUCCESS = 0
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BrickletRS485::EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BrickletRS485::EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
BrickletRS485::CALLBACK_MODBUS_SLAVE_WRITE_MULTIPLE_REGISTERS_REQUEST
Parameter:
  • request_id -- int
  • starting_address -- int
  • registers -- [int, int, ...]

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.

BrickletRS485::CALLBACK_MODBUS_MASTER_WRITE_MULTIPLE_REGISTERS_RESPONSE
Parameter:
  • request_id -- int
  • exception_code -- int

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.

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

  • BrickletRS485::EXCEPTION_CODE_TIMEOUT = -1
  • BrickletRS485::EXCEPTION_CODE_SUCCESS = 0
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BrickletRS485::EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BrickletRS485::EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
BrickletRS485::CALLBACK_MODBUS_SLAVE_READ_DISCRETE_INPUTS_REQUEST
Parameter:
  • request_id -- int
  • starting_address -- int
  • count -- int

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.

BrickletRS485::CALLBACK_MODBUS_MASTER_READ_DISCRETE_INPUTS_RESPONSE
Parameter:
  • request_id -- int
  • exception_code -- int
  • discrete_inputs -- [bool, bool, ...]

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.

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

  • BrickletRS485::EXCEPTION_CODE_TIMEOUT = -1
  • BrickletRS485::EXCEPTION_CODE_SUCCESS = 0
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BrickletRS485::EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BrickletRS485::EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
BrickletRS485::CALLBACK_MODBUS_SLAVE_READ_INPUT_REGISTERS_REQUEST
Parameter:
  • request_id -- int
  • starting_address -- int
  • count -- int

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.

BrickletRS485::CALLBACK_MODBUS_MASTER_READ_INPUT_REGISTERS_RESPONSE
Parameter:
  • request_id -- int
  • exception_code -- int
  • input_registers -- [int, int, ...]

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.

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

  • BrickletRS485::EXCEPTION_CODE_TIMEOUT = -1
  • BrickletRS485::EXCEPTION_CODE_SUCCESS = 0
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BrickletRS485::EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BrickletRS485::EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BrickletRS485::EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BrickletRS485::EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BrickletRS485::EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11

Konstanten

BrickletRS485::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RS485 Bricklet zu identifizieren.

Die #get_identity() Funktion und der IPConnection::CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletRS485::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RS485 Bricklet dar.