C# - RS485 Bricklet

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

Eine Installationanleitung für die C# API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback

Download (ExampleLoopback.cs)

 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
46
47
using System;
using Tinkerforge;

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

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your RS485 Bricklet

    // Callback function for read callback
    static void ReadCB(BrickletRS485 sender, char[] message)
    {
        // Assume that the message consists of ASCII characters and
        // convert it from an array of chars to a string
        Console.WriteLine("Message: \"" + new string(message) + "\"");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletRS485 rs485 = new BrickletRS485(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.SetRS485Configuration(115200, BrickletRS485.PARITY_NONE,
                                    BrickletRS485.STOPBITS_1, BrickletRS485.WORDLENGTH_8,
                                    BrickletRS485.DUPLEX_FULL);

        // Register read callback to function ReadCB
        rs485.ReadCallback += ReadCB;

        // Enable read callback
        rs485.EnableReadCallback();

        // Write "test" string
        rs485.Write("test".ToCharArray());

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Modbus Master

Download (ExampleModbusMaster.cs)

 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
46
47
48
49
50
51
52
53
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your RS485 Bricklet

    private static byte expectedRequestID = 0;

    // Callback function for Modbus master write single register response callback
    static void ModbusMasterWriteSingleRegisterResponseCB(BrickletRS485 sender,
                                                          byte requestID,
                                                          short exceptionCode)
    {
        Console.WriteLine("Request ID: " + requestID);
        Console.WriteLine("Exception Code: " + exceptionCode);

        if (requestID != expectedRequestID)
        {
            Console.WriteLine("Error: Unexpected request ID");
        }
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletRS485 rs485 = new BrickletRS485(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 master
        rs485.SetMode(BrickletRS485.MODE_MODBUS_MASTER_RTU);

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

        // Register Modbus master write single register response callback to function
        // ModbusMasterWriteSingleRegisterResponseCB
        rs485.ModbusMasterWriteSingleRegisterResponseCallback += ModbusMasterWriteSingleRegisterResponseCB;

        // Write 65535 to register 42 of slave 17
        expectedRequestID = rs485.ModbusMasterWriteSingleRegister(17, 42, 65535);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Modbus Slave

Download (ExampleModbusSlave.cs)

 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
46
47
48
49
50
51
52
53
54
55
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your RS485 Bricklet

    // Callback function for Modbus slave write single register request callback
    static void ModbusSlaveWriteSingleRegisterRequestCB(BrickletRS485 sender,
                                                        byte requestID,
                                                        long registerAddress,
                                                        int registerValue)
    {
        Console.WriteLine("Request ID: " + requestID);
        Console.WriteLine("Register Address: " + registerAddress);
        Console.WriteLine("Register Value: " + registerValue);

        if (registerAddress != 42)
        {
            Console.WriteLine("Error: Invalid register address");
            sender.ModbusSlaveReportException(requestID, BrickletRS485.EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS);
        }
        else
        {
            sender.ModbusSlaveAnswerWriteSingleRegisterRequest(requestID);
        }
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletRS485 rs485 = new BrickletRS485(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.SetMode(BrickletRS485.MODE_MODBUS_SLAVE_RTU);

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

        // Register Modbus slave write single register request callback to function
        // ModbusSlaveWriteSingleRegisterRequestCB
        rs485.ModbusSlaveWriteSingleRegisterRequestCallback += ModbusSlaveWriteSingleRegisterRequestCB;

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

API

Prinzipiell kann jede Funktion der C# Bindings, welche einen Wert zurück gibt eine Tinkerforge.TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Da C# nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

class BrickletRS485(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • rs485 – Typ: BrickletRS485

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

BrickletRS485 rs485 = new BrickletRS485("YOUR_DEVICE_UID", ipcon);

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

int BrickletRS485.Write(char[] message)
Parameter:
  • message – Typ: char[], Länge: variabel
Rückgabe:
  • messageWritten – Typ: int, Wertebereich: [0 bis 216 - 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 SetRS485Configuration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

char[] BrickletRS485.Read(int length)
Parameter:
  • length – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • message – Typ: char[], 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 EnableReadCallback() und ReadCallback Callback.

void BrickletRS485.SetRS485Configuration(long baudrate, byte parity, byte stopbits, byte wordlength, byte duplex)
Parameter:
  • baudrate – Typ: long, Wertebereich: [0 bis 232 - 1]
  • parity – Typ: byte, Wertebereich: Siehe Konstanten
  • stopbits – Typ: byte, Wertebereich: Siehe Konstanten
  • wordlength – Typ: byte, Wertebereich: Siehe Konstanten
  • duplex – Typ: byte, Wertebereich: Siehe Konstanten

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:

Für parity:

  • BrickletRS485.PARITY_NONE = 0
  • BrickletRS485.PARITY_ODD = 1
  • BrickletRS485.PARITY_EVEN = 2

Für stopbits:

  • BrickletRS485.STOPBITS_1 = 1
  • BrickletRS485.STOPBITS_2 = 2

Für wordlength:

  • BrickletRS485.WORDLENGTH_5 = 5
  • BrickletRS485.WORDLENGTH_6 = 6
  • BrickletRS485.WORDLENGTH_7 = 7
  • BrickletRS485.WORDLENGTH_8 = 8

Für duplex:

  • BrickletRS485.DUPLEX_HALF = 0
  • BrickletRS485.DUPLEX_FULL = 1
void BrickletRS485.GetRS485Configuration(out long baudrate, out byte parity, out byte stopbits, out byte wordlength, out byte duplex)
Ausgabeparameter:
  • baudrate – Typ: long, Wertebereich: [0 bis 232 - 1]
  • parity – Typ: byte, Wertebereich: Siehe Konstanten
  • stopbits – Typ: byte, Wertebereich: Siehe Konstanten
  • wordlength – Typ: byte, Wertebereich: Siehe Konstanten
  • duplex – Typ: byte, Wertebereich: Siehe Konstanten

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

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

Für parity:

  • BrickletRS485.PARITY_NONE = 0
  • BrickletRS485.PARITY_ODD = 1
  • BrickletRS485.PARITY_EVEN = 2

Für stopbits:

  • BrickletRS485.STOPBITS_1 = 1
  • BrickletRS485.STOPBITS_2 = 2

Für wordlength:

  • BrickletRS485.WORDLENGTH_5 = 5
  • BrickletRS485.WORDLENGTH_6 = 6
  • BrickletRS485.WORDLENGTH_7 = 7
  • BrickletRS485.WORDLENGTH_8 = 8

Für duplex:

  • BrickletRS485.DUPLEX_HALF = 0
  • BrickletRS485.DUPLEX_FULL = 1
void BrickletRS485.SetModbusConfiguration(byte slaveAddress, long masterRequestTimeout)
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 255]
  • masterRequestTimeout – Typ: long, Wertebereich: [0 bis 232 - 1]

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

void BrickletRS485.GetModbusConfiguration(out byte slaveAddress, out long masterRequestTimeout)
Ausgabeparameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 255]
  • masterRequestTimeout – Typ: long, Wertebereich: [0 bis 232 - 1]

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

void BrickletRS485.SetMode(byte mode)
Parameter:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten

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:

Für mode:

  • BrickletRS485.MODE_RS485 = 0
  • BrickletRS485.MODE_MODBUS_MASTER_RTU = 1
  • BrickletRS485.MODE_MODBUS_SLAVE_RTU = 2
byte BrickletRS485.GetMode()
Rückgabe:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten

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

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

Für mode:

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

Fortgeschrittene Funktionen

void BrickletRS485.SetCommunicationLEDConfig(byte config)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten

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:

Für config:

  • 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
byte BrickletRS485.GetCommunicationLEDConfig()
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten

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

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

Für config:

  • 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
void BrickletRS485.SetErrorLEDConfig(byte config)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe ErrorCountCallback 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:

Für config:

  • 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
byte BrickletRS485.GetErrorLEDConfig()
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten

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

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

Für config:

  • 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
void BrickletRS485.SetBufferConfig(int sendBufferSize, int receiveBufferSize)
Parameter:
  • sendBufferSize – Typ: int, Wertebereich: [0 bis 216 - 1]
  • receiveBufferSize – Typ: int, Wertebereich: [0 bis 216 - 1]

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 ReadCallback Callback an ein Nutzerprogramm übertragen werden konnten.

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

void BrickletRS485.GetBufferConfig(out int sendBufferSize, out int receiveBufferSize)
Ausgabeparameter:
  • sendBufferSize – Typ: int, Wertebereich: [0 bis 216 - 1]
  • receiveBufferSize – Typ: int, Wertebereich: [0 bis 216 - 1]

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

void BrickletRS485.GetBufferStatus(out int sendBufferUsed, out int receiveBufferUsed)
Ausgabeparameter:
  • sendBufferUsed – Typ: int, Wertebereich: [0 bis 216 - 1]
  • receiveBufferUsed – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

void BrickletRS485.GetErrorCount(out long overrunErrorCount, out long parityErrorCount)
Ausgabeparameter:
  • overrunErrorCount – Typ: long, Wertebereich: [0 bis 232 - 1]
  • parityErrorCount – Typ: long, Wertebereich: [0 bis 232 - 1]

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

void BrickletRS485.GetModbusCommonErrorCount(out long timeoutErrorCount, out long checksumErrorCount, out long frameTooBigErrorCount, out long illegalFunctionErrorCount, out long illegalDataAddressErrorCount, out long illegalDataValueErrorCount, out long slaveDeviceFailureErrorCount)
Ausgabeparameter:
  • timeoutErrorCount – Typ: long, Wertebereich: [0 bis 232 - 1]
  • checksumErrorCount – Typ: long, Wertebereich: [0 bis 232 - 1]
  • frameTooBigErrorCount – Typ: long, Wertebereich: [0 bis 232 - 1]
  • illegalFunctionErrorCount – Typ: long, Wertebereich: [0 bis 232 - 1]
  • illegalDataAddressErrorCount – Typ: long, Wertebereich: [0 bis 232 - 1]
  • illegalDataValueErrorCount – Typ: long, Wertebereich: [0 bis 232 - 1]
  • slaveDeviceFailureErrorCount – Typ: long, Wertebereich: [0 bis 232 - 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.
void BrickletRS485.ModbusSlaveReportException(byte requestID, short exceptionCode)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: short, Wertebereich: Siehe Konstanten

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

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

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

Für exceptionCode:

  • 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
void BrickletRS485.ModbusSlaveAnswerReadCoilsRequest(byte requestID, bool[] coils)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • coils – Typ: bool[], Länge: variabel

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

byte BrickletRS485.ModbusMasterReadCoils(byte slaveAddress, long startingAddress, int count)
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • count – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

void BrickletRS485.ModbusSlaveAnswerReadHoldingRegistersRequest(byte requestID, int[] holdingRegisters)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • holdingRegisters – Typ: int[], Länge: variabel, Wertebereich: [0 bis 216 - 1]

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

byte BrickletRS485.ModbusMasterReadHoldingRegisters(byte slaveAddress, long startingAddress, int count)
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • count – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

void BrickletRS485.ModbusSlaveAnswerWriteSingleCoilRequest(byte requestID)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

byte BrickletRS485.ModbusMasterWriteSingleCoil(byte slaveAddress, long coilAddress, bool coilValue)
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 255]
  • coilAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • coilValue – Typ: bool
Rückgabe:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

void BrickletRS485.ModbusSlaveAnswerWriteSingleRegisterRequest(byte requestID)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

byte BrickletRS485.ModbusMasterWriteSingleRegister(byte slaveAddress, long registerAddress, int registerValue)
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 255]
  • registerAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • registerValue – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

void BrickletRS485.ModbusSlaveAnswerWriteMultipleCoilsRequest(byte requestID)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

byte BrickletRS485.ModbusMasterWriteMultipleCoils(byte slaveAddress, long startingAddress, bool[] coils)
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • coils – Typ: bool[], Länge: variabel
Rückgabe:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

void BrickletRS485.ModbusSlaveAnswerWriteMultipleRegistersRequest(byte requestID)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

byte BrickletRS485.ModbusMasterWriteMultipleRegisters(byte slaveAddress, long startingAddress, int[] registers)
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • registers – Typ: int[], Länge: variabel, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • requestID – Typ: byte, 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 ModbusMasterWriteMultipleRegistersResponseCallback 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.

void BrickletRS485.ModbusSlaveAnswerReadDiscreteInputsRequest(byte requestID, bool[] discreteInputs)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • discreteInputs – Typ: bool[], Länge: variabel

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

byte BrickletRS485.ModbusMasterReadDiscreteInputs(byte slaveAddress, long startingAddress, int count)
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • count – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

void BrickletRS485.ModbusSlaveAnswerReadInputRegistersRequest(byte requestID, int[] inputRegisters)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • inputRegisters – Typ: int[], Länge: variabel, Wertebereich: [0 bis 216 - 1]

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

byte BrickletRS485.ModbusMasterReadInputRegisters(byte slaveAddress, long startingAddress, int count)
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • count – Typ: int, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

byte[] BrickletRS485.GetAPIVersion()
Rückgabe:
  • apiVersion – Typ: byte[], Länge: 3, Wertebereich: [0 bis 255]

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.

bool BrickletRS485.GetResponseExpected(byte functionId)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool

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 SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

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

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

Für functionId:

  • 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
void BrickletRS485.SetResponseExpected(byte functionId, bool responseExpected)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: 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 Konstanten sind für diese Funktion verfügbar:

Für functionId:

  • 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
void BrickletRS485.SetResponseExpectedAll(bool responseExpected)
Parameter:
  • responseExpected – Typ: bool

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

void BrickletRS485.GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)
Ausgabeparameter:
  • errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: long, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: long, Wertebereich: [0 bis 232 - 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.

byte BrickletRS485.SetBootloaderMode(byte mode)
Parameter:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: byte, Wertebereich: Siehe Konstanten

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:

Für mode:

  • 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

Für status:

  • 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
byte BrickletRS485.GetBootloaderMode()
Rückgabe:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • 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
void BrickletRS485.SetWriteFirmwarePointer(long pointer)
Parameter:
  • pointer – Typ: long, Wertebereich: [0 bis 232 - 1]

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

byte BrickletRS485.WriteFirmware(byte[] data)
Parameter:
  • data – Typ: byte[], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: byte, Wertebereich: [0 bis 255]

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

void BrickletRS485.SetStatusLEDConfig(byte config)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten

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

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

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

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

Für config:

  • 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
byte BrickletRS485.GetStatusLEDConfig()
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten

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

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

Für config:

  • 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
short BrickletRS485.GetChipTemperature()
Rückgabe:
  • temperature – Typ: short, Wertebereich: [-215 bis 215 - 1]

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.

void BrickletRS485.Reset()

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.

void BrickletRS485.WriteUID(long uid)
Parameter:
  • uid – Typ: long, Wertebereich: [0 bis 232 - 1]

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.

long BrickletRS485.ReadUID()
Rückgabe:
  • uid – Typ: long, Wertebereich: [0 bis 232 - 1]

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

void BrickletRS485.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)
Ausgabeparameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: byte[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: byte[], Länge: 3, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 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 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.

Konfigurationsfunktionen für Callbacks

void BrickletRS485.EnableReadCallback()

Aktiviert den ReadCallback Callback.

Im Startzustand ist der Callback deaktiviert.

void BrickletRS485.DisableReadCallback()

Deaktiviert den ReadCallback Callback.

Im Startzustand ist der Callback deaktiviert.

bool BrickletRS485.IsReadCallbackEnabled()
Rückgabe:
  • enabled – Typ: bool

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

void BrickletRS485.EnableErrorCountCallback()

Aktiviert den ErrorCountCallback Callback.

Im Startzustand ist der Callback deaktiviert.

void BrickletRS485.DisableErrorCountCallback()

Deaktiviert den ErrorCountCallback Callback.

Im Startzustand ist der Callback deaktiviert.

bool BrickletRS485.IsErrorCountCallbackEnabled()
Rückgabe:
  • enabled – Typ: bool

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

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:

void MyCallback(BrickletRS485 sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

rs485.ExampleCallback += MyCallback;

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

event BrickletRS485.ReadCallback(BrickletRS485 sender, char[] message)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • message – Typ: char[], Länge: variabel

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

Dieser Callback kann durch EnableReadCallback() aktiviert werden.

Bemerkung

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

event BrickletRS485.ErrorCountCallback(BrickletRS485 sender, long overrunErrorCount, long parityErrorCount)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • overrunErrorCount – Typ: long, Wertebereich: [0 bis 232 - 1]
  • parityErrorCount – Typ: long, Wertebereich: [0 bis 232 - 1]

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

event BrickletRS485.ModbusSlaveReadCoilsRequestCallback(BrickletRS485 sender, byte requestID, long startingAddress, int count)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • count – Typ: int, Wertebereich: [0 bis 216 - 1]

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 ModbusSlaveAnswerReadCoilsRequest() gesendet werden.

event BrickletRS485.ModbusMasterReadCoilsResponseCallback(BrickletRS485 sender, byte requestID, short exceptionCode, bool[] coils)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: short, Wertebereich: Siehe Konstanten
  • coils – Typ: bool[], 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 SetModbusConfiguration() gesetzt werden.

Bemerkung

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

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

Für exceptionCode:

  • 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
event BrickletRS485.ModbusSlaveReadHoldingRegistersRequestCallback(BrickletRS485 sender, byte requestID, long startingAddress, int count)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • count – Typ: int, Wertebereich: [0 bis 216 - 1]

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 ModbusSlaveAnswerReadHoldingRegistersRequest() gesendet werden.

event BrickletRS485.ModbusMasterReadHoldingRegistersResponseCallback(BrickletRS485 sender, byte requestID, short exceptionCode, int[] holdingRegisters)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: short, Wertebereich: Siehe Konstanten
  • holdingRegisters – Typ: int[], Länge: variabel, Wertebereich: [0 bis 216 - 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.

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 SetModbusConfiguration() gesetzt werden.

Bemerkung

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

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

Für exceptionCode:

  • 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
event BrickletRS485.ModbusSlaveWriteSingleCoilRequestCallback(BrickletRS485 sender, byte requestID, long coilAddress, bool coilValue)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • coilAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • coilValue – 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 ModbusSlaveAnswerWriteSingleCoilRequest() gesendet werden.

event BrickletRS485.ModbusMasterWriteSingleCoilResponseCallback(BrickletRS485 sender, byte requestID, short exceptionCode)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: short, Wertebereich: Siehe Konstanten

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 SetModbusConfiguration() gesetzt werden.

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

Für exceptionCode:

  • 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
event BrickletRS485.ModbusSlaveWriteSingleRegisterRequestCallback(BrickletRS485 sender, byte requestID, long registerAddress, int registerValue)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • registerAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • registerValue – Typ: int, Wertebereich: [0 bis 216 - 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 ModbusSlaveAnswerWriteSingleRegisterRequest() gesendet werden.

event BrickletRS485.ModbusMasterWriteSingleRegisterResponseCallback(BrickletRS485 sender, byte requestID, short exceptionCode)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: short, Wertebereich: Siehe Konstanten

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 SetModbusConfiguration() gesetzt werden.

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

Für exceptionCode:

  • 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
event BrickletRS485.ModbusSlaveWriteMultipleCoilsRequestCallback(BrickletRS485 sender, byte requestID, long startingAddress, bool[] coils)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • coils – Typ: bool[], 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 ModbusSlaveAnswerWriteMultipleCoilsRequest() gesendet werden.

Bemerkung

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

event BrickletRS485.ModbusMasterWriteMultipleCoilsResponseCallback(BrickletRS485 sender, byte requestID, short exceptionCode)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: short, Wertebereich: Siehe Konstanten

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 SetModbusConfiguration() gesetzt werden.

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

Für exceptionCode:

  • 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
event BrickletRS485.ModbusSlaveWriteMultipleRegistersRequestCallback(BrickletRS485 sender, byte requestID, long startingAddress, int[] registers)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • registers – Typ: int[], Länge: variabel, Wertebereich: [0 bis 216 - 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 ModbusSlaveAnswerWriteMultipleRegistersRequest() gesendet werden.

Bemerkung

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

event BrickletRS485.ModbusMasterWriteMultipleRegistersResponseCallback(BrickletRS485 sender, byte requestID, short exceptionCode)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: short, Wertebereich: Siehe Konstanten

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 SetModbusConfiguration() gesetzt werden.

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

Für exceptionCode:

  • 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
event BrickletRS485.ModbusSlaveReadDiscreteInputsRequestCallback(BrickletRS485 sender, byte requestID, long startingAddress, int count)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • count – Typ: int, Wertebereich: [0 bis 216 - 1]

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 ModbusSlaveAnswerReadDiscreteInputsRequest() gesendet werden.

event BrickletRS485.ModbusMasterReadDiscreteInputsResponseCallback(BrickletRS485 sender, byte requestID, short exceptionCode, bool[] discreteInputs)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: short, Wertebereich: Siehe Konstanten
  • discreteInputs – Typ: bool[], 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.

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 SetModbusConfiguration() gesetzt werden.

Bemerkung

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

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

Für exceptionCode:

  • 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
event BrickletRS485.ModbusSlaveReadInputRegistersRequestCallback(BrickletRS485 sender, byte requestID, long startingAddress, int count)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: long, Wertebereich: [0 bis 232 - 1]
  • count – Typ: int, Wertebereich: [0 bis 216 - 1]

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 ModbusSlaveAnswerReadInputRegistersRequest() gesendet werden.

event BrickletRS485.ModbusMasterReadInputRegistersResponseCallback(BrickletRS485 sender, byte requestID, short exceptionCode, int[] inputRegisters)
Callback-Parameter:
  • sender – Typ: BrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: short, Wertebereich: Siehe Konstanten
  • inputRegisters – Typ: int[], Länge: variabel, Wertebereich: [0 bis 216 - 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.

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 SetModbusConfiguration() gesetzt werden.

Bemerkung

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

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

Für exceptionCode:

  • 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

int BrickletRS485.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RS485 Bricklet zu identifizieren.

Die GetIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

string BrickletRS485.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RS485 Bricklet dar.