Deutsch
English
Menu
Software / API Bindings / Delphi/Lazarus / API Referenz und Beispiele / Bricklets / RS485 Bricklet

Delphi/Lazarus - RS485 Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback

Download (ExampleLoopback.pas)

 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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
program ExampleLoopback;

{ 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 }

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletRS485;

type
  TExample = class
  private
    ipcon: TIPConnection;
    rs485: TBrickletRS485;
  public
    procedure ReadCB(sender: TBrickletRS485; const message_: TArrayOfChar);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your RS485 Bricklet }

var
  e: TExample;

{ Callback procedure for read callback }
procedure TExample.ReadCB(sender: TBrickletRS485; const message_: TArrayOfChar);
var str: string;
begin
  { Assume that the message consists of ASCII characters and
    convert it from an array of chars to a string }
  SetString(str, PChar(@message_[0]), Length(message_));
  WriteLn(Format('Message: "%s"', [str]));
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  rs485 := TBrickletRS485.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { Don't use device before ipcon is connected }

  { Enable full-duplex mode }
  rs485.SetRS485Configuration(115200, BRICKLET_RS485_PARITY_NONE,
                              BRICKLET_RS485_STOPBITS_1, BRICKLET_RS485_WORDLENGTH_8,
                              BRICKLET_RS485_DUPLEX_FULL);

  { Register read callback to procedure ReadCB }
  rs485.OnRead := {$ifdef FPC}@{$endif}ReadCB;

  { Enable read callback }
  rs485.EnableReadCallback;

  { Write "test" string }
  rs485.Write(['t', 'e', 's', 't']);

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Modbus Master

Download (ExampleModbusMaster.pas)

 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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
program ExampleModbusMaster;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletRS485;

type
  TExample = class
  private
    ipcon: TIPConnection;
    rs485: TBrickletRS485;
  public
    procedure ModbusMasterWriteSingleRegisterResponseCB(sender: TBrickletRS485;
                                                        const requestID: byte;
                                                        const exceptionCode: shortint);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your RS485 Bricklet }

var
  e: TExample;
  expectedRequestID: byte;

{ Callback procedure for Modbus master write single register response callback }
procedure TExample.ModbusMasterWriteSingleRegisterResponseCB(sender: TBrickletRS485;
                                                             const requestID: byte;
                                                             const exceptionCode: shortint);
begin
  WriteLn(Format('Request ID: %d', [requestID]));
  WriteLn(Format('Exception Code: %d', [exceptionCode]));

  if (requestID <> expectedRequestID) then begin
    WriteLn('Error: Unexpected request ID');
  end;
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  rs485 := TBrickletRS485.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { Don't use device before ipcon is connected }

  { Set operating mode to Modbus RTU master }
  rs485.SetMode(BRICKLET_RS485_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 procedure
    ModbusMasterWriteSingleRegisterResponseCB }
  rs485.OnModbusMasterWriteSingleRegisterResponse := {$ifdef FPC}@{$endif}ModbusMasterWriteSingleRegisterResponseCB;

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

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Modbus Slave

Download (ExampleModbusSlave.pas)

 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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
program ExampleModbusSlave;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletRS485;

type
  TExample = class
  private
    ipcon: TIPConnection;
    rs485: TBrickletRS485;
  public
    procedure ModbusSlaveWriteSingleRegisterRequestCB(sender: TBrickletRS485;
                                                      const requestID: byte;
                                                      const registerAddress: longword;
                                                      const registerValue: word);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your RS485 Bricklet }

var
  e: TExample;

{ Callback procedure for Modbus slave write single register request callback }
procedure TExample.ModbusSlaveWriteSingleRegisterRequestCB(sender: TBrickletRS485;
                                                           const requestID: byte;
                                                           const registerAddress: longword;
                                                           const registerValue: word);
begin
  WriteLn(Format('Request ID: %d', [requestID]));
  WriteLn(Format('Register Address: %d', [registerAddress]));
  WriteLn(Format('Register Value: %d', [registerValue]));

  if (registerAddress <> 42) then begin
    WriteLn('Error: Invalid register address');
    sender.ModbusSlaveReportException(requestID, BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS);
  end
  else begin
    sender.ModbusSlaveAnswerWriteSingleRegisterRequest(requestID);
  end
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  rs485 := TBrickletRS485.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { Don't use device before ipcon is connected }

  { Set operating mode to Modbus RTU slave }
  rs485.SetMode(BRICKLET_RS485_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 procedure
    ModbusSlaveWriteSingleRegisterRequestCB }
  rs485.OnModbusSlaveWriteSingleRegisterRequest := {$ifdef FPC}@{$endif}ModbusSlaveWriteSingleRegisterRequestCB;

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

API

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

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

constructor TBrickletRS485.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • rs485 – Typ: TBrickletRS485

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

rs485 := TBrickletRS485.Create('YOUR_DEVICE_UID', ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

function TBrickletRS485.Write(const message: array of char): word
Parameter:
  • message – Typ: array of char
Rückgabe:
  • messageWritten – Typ: word, 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.

function TBrickletRS485.Read(const length: word): array of char
Parameter:
  • length – Typ: word, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • message – Typ: array of char

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

procedure TBrickletRS485.SetRS485Configuration(const baudrate: longword; const parity: byte; const stopbits: byte; const wordlength: byte; const duplex: byte)
Parameter:
  • baudrate – Typ: longword, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200
  • parity – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • stopbits – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1
  • wordlength – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 8
  • duplex – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt die Konfiguration für die RS485-Kommunikation.

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

Für parity:

  • BRICKLET_RS485_PARITY_NONE = 0
  • BRICKLET_RS485_PARITY_ODD = 1
  • BRICKLET_RS485_PARITY_EVEN = 2

Für stopbits:

  • BRICKLET_RS485_STOPBITS_1 = 1
  • BRICKLET_RS485_STOPBITS_2 = 2

Für wordlength:

  • BRICKLET_RS485_WORDLENGTH_5 = 5
  • BRICKLET_RS485_WORDLENGTH_6 = 6
  • BRICKLET_RS485_WORDLENGTH_7 = 7
  • BRICKLET_RS485_WORDLENGTH_8 = 8

Für duplex:

  • BRICKLET_RS485_DUPLEX_HALF = 0
  • BRICKLET_RS485_DUPLEX_FULL = 1
procedure TBrickletRS485.GetRS485Configuration(out baudrate: longword; out parity: byte; out stopbits: byte; out wordlength: byte; out duplex: byte)
Ausgabeparameter:
  • baudrate – Typ: longword, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200
  • parity – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • stopbits – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 1
  • wordlength – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 8
  • duplex – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für parity:

  • BRICKLET_RS485_PARITY_NONE = 0
  • BRICKLET_RS485_PARITY_ODD = 1
  • BRICKLET_RS485_PARITY_EVEN = 2

Für stopbits:

  • BRICKLET_RS485_STOPBITS_1 = 1
  • BRICKLET_RS485_STOPBITS_2 = 2

Für wordlength:

  • BRICKLET_RS485_WORDLENGTH_5 = 5
  • BRICKLET_RS485_WORDLENGTH_6 = 6
  • BRICKLET_RS485_WORDLENGTH_7 = 7
  • BRICKLET_RS485_WORDLENGTH_8 = 8

Für duplex:

  • BRICKLET_RS485_DUPLEX_HALF = 0
  • BRICKLET_RS485_DUPLEX_FULL = 1
procedure TBrickletRS485.SetModbusConfiguration(const slaveAddress: byte; const masterRequestTimeout: longword)
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [1 bis 247], Standardwert: 1
  • masterRequestTimeout – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 1000

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.
procedure TBrickletRS485.GetModbusConfiguration(out slaveAddress: byte; out masterRequestTimeout: longword)
Ausgabeparameter:
  • slaveAddress – Typ: byte, Wertebereich: [1 bis 247], Standardwert: 1
  • masterRequestTimeout – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 1000

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

procedure TBrickletRS485.SetMode(const mode: byte)
Parameter:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den Modus des Bricklets. Verfügbare Optionen sind

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

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

Für mode:

  • BRICKLET_RS485_MODE_RS485 = 0
  • BRICKLET_RS485_MODE_MODBUS_MASTER_RTU = 1
  • BRICKLET_RS485_MODE_MODBUS_SLAVE_RTU = 2
function TBrickletRS485.GetMode: byte
Rückgabe:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für mode:

  • BRICKLET_RS485_MODE_RS485 = 0
  • BRICKLET_RS485_MODE_MODBUS_MASTER_RTU = 1
  • BRICKLET_RS485_MODE_MODBUS_SLAVE_RTU = 2

Fortgeschrittene Funktionen

procedure TBrickletRS485.SetCommunicationLEDConfig(const config: byte)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

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

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

Für config:

  • BRICKLET_RS485_COMMUNICATION_LED_CONFIG_OFF = 0
  • BRICKLET_RS485_COMMUNICATION_LED_CONFIG_ON = 1
  • BRICKLET_RS485_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_RS485_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
function TBrickletRS485.GetCommunicationLEDConfig: byte
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • BRICKLET_RS485_COMMUNICATION_LED_CONFIG_OFF = 0
  • BRICKLET_RS485_COMMUNICATION_LED_CONFIG_ON = 1
  • BRICKLET_RS485_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_RS485_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION = 3
procedure TBrickletRS485.SetErrorLEDConfig(const config: byte)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Error-LED.

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

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

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

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

Für config:

  • BRICKLET_RS485_ERROR_LED_CONFIG_OFF = 0
  • BRICKLET_RS485_ERROR_LED_CONFIG_ON = 1
  • BRICKLET_RS485_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_RS485_ERROR_LED_CONFIG_SHOW_ERROR = 3
function TBrickletRS485.GetErrorLEDConfig: byte
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • BRICKLET_RS485_ERROR_LED_CONFIG_OFF = 0
  • BRICKLET_RS485_ERROR_LED_CONFIG_ON = 1
  • BRICKLET_RS485_ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_RS485_ERROR_LED_CONFIG_SHOW_ERROR = 3
procedure TBrickletRS485.SetBufferConfig(const sendBufferSize: word; const receiveBufferSize: word)
Parameter:
  • sendBufferSize – Typ: word, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120
  • receiveBufferSize – Typ: word, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120

Setzt die Größe des Senden- und Empfangsbuffers. In Summe können die Buffer eine Größe von 10240 Byte (10KiB) haben, die Minimalgröße ist 1024 Byte (1KiB) für beide.

Der aktuelle Bufferinhalt geht bei einem Aufruf dieser Funktion verloren.

Der Sendenbuffer hält die Daten welche über Write übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS485 empfangen wurden aber noch nicht über Read oder OnRead Callback an ein Nutzerprogramm übertragen werden konnten.

procedure TBrickletRS485.GetBufferConfig(out sendBufferSize: word; out receiveBufferSize: word)
Ausgabeparameter:
  • sendBufferSize – Typ: word, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120
  • receiveBufferSize – Typ: word, Einheit: 1 B, Wertebereich: [210 bis 9216], Standardwert: 5120

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

procedure TBrickletRS485.GetBufferStatus(out sendBufferUsed: word; out receiveBufferUsed: word)
Ausgabeparameter:
  • sendBufferUsed – Typ: word, Einheit: 1 B, Wertebereich: [0 bis 9216]
  • receiveBufferUsed – Typ: word, Einheit: 1 B, Wertebereich: [0 bis 9216]

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

Siehe SetBufferConfig zur Konfiguration der Buffergrößen.

procedure TBrickletRS485.GetErrorCount(out overrunErrorCount: longword; out parityErrorCount: longword)
Ausgabeparameter:
  • overrunErrorCount – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • parityErrorCount – Typ: longword, Wertebereich: [0 bis 232 - 1]

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

procedure TBrickletRS485.GetModbusCommonErrorCount(out timeoutErrorCount: longword; out checksumErrorCount: longword; out frameTooBigErrorCount: longword; out illegalFunctionErrorCount: longword; out illegalDataAddressErrorCount: longword; out illegalDataValueErrorCount: longword; out slaveDeviceFailureErrorCount: longword)
Ausgabeparameter:
  • timeoutErrorCount – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • checksumErrorCount – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • frameTooBigErrorCount – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • illegalFunctionErrorCount – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • illegalDataAddressErrorCount – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • illegalDataValueErrorCount – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • slaveDeviceFailureErrorCount – Typ: longword, 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.
procedure TBrickletRS485.ModbusSlaveReportException(const requestID: byte; const exceptionCode: shortint)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: shortint, 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:

  • BRICKLET_RS485_EXCEPTION_CODE_TIMEOUT = -1
  • BRICKLET_RS485_EXCEPTION_CODE_SUCCESS = 0
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BRICKLET_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BRICKLET_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
procedure TBrickletRS485.ModbusSlaveAnswerReadCoilsRequest(const requestID: byte; const coils: array of boolean)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • coils – Typ: array of boolean

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

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

Diese Funktion muss vom OnModbusSlaveReadCoilsRequest Callback mit der Request ID des Callbacks aufgerufen werden.

function TBrickletRS485.ModbusMasterReadCoils(const slaveAddress: byte; const startingAddress: longword; const count: word): byte
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 247]
  • startingAddress – Typ: longword, Wertebereich: [1 bis 216]
  • count – Typ: word, Wertebereich: [1 bis 2000]
Rückgabe:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Coils-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 1).

  • Slave Addresss: Adresse des Modbus-Slave
  • Starting Address: Nummer der ersten zu lesenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.
  • Count: Anzahl der zu lesenden Coils.

Nach erfolgreichen Ausführen der Leseoperation gibt diese Funktion eine Request ID zurück die nicht 0 ist. Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

Falls kein Fehler auftritt, wird auch der OnModbusMasterReadCoilsResponse 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.

procedure TBrickletRS485.ModbusSlaveAnswerReadHoldingRegistersRequest(const requestID: byte; const holdingRegisters: array of word)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • holdingRegisters – Typ: array of word, Wertebereich: [0 bis 216 - 1]

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

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

Diese Funktion muss vom OnModbusSlaveReadHoldingRegistersRequest Callback mit der Request ID des Callbacks aufgerufen werden.

function TBrickletRS485.ModbusMasterReadHoldingRegisters(const slaveAddress: byte; const startingAddress: longword; const count: word): byte
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 247]
  • startingAddress – Typ: longword, Wertebereich: [1 bis 216]
  • count – Typ: word, Wertebereich: [1 bis 125]
Rückgabe:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Holding Register-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 3).

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

Nach erfolgreichem Ausführen der Leseoperation gibt diese Funktion eine Request ID zurück, die nicht 0 ist. Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

Falls kein Fehler auftritt, wird auch der OnModbusMasterReadHoldingRegistersResponse 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.

procedure TBrickletRS485.ModbusSlaveAnswerWriteSingleCoilRequest(const requestID: byte)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

  • Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom OnModbusSlaveWriteSingleCoilRequest Callback mit der Request ID des Callbacks aufgerufen werden.

function TBrickletRS485.ModbusMasterWriteSingleCoil(const slaveAddress: byte; const coilAddress: longword; const coilValue: boolean): byte
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 247]
  • coilAddress – Typ: longword, Wertebereich: [1 bis 216]
  • coilValue – Typ: boolean
Rückgabe:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine einzelne Coil eines Modbus-Slave zu schreiben (Modbus Funktionscode 5).

  • Slave Address: Addresse des anzusprechenden Modbus-Slave.
  • Coil Address: Nummer der zu schreibenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.
  • Coil Value: Zu schreibender Wert

Falls kein Fehler auftritt, wird auch der OnModbusMasterWriteSingleCoilResponse 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.

procedure TBrickletRS485.ModbusSlaveAnswerWriteSingleRegisterRequest(const requestID: byte)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

  • Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom OnModbusSlaveWriteSingleRegisterRequest Callback mit der Request ID des Callbacks aufgerufen werden.

function TBrickletRS485.ModbusMasterWriteSingleRegister(const slaveAddress: byte; const registerAddress: longword; const registerValue: word): byte
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 247]
  • registerAddress – Typ: longword, Wertebereich: [1 bis 216]
  • registerValue – Typ: word, 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 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 OnModbusMasterWriteSingleRegisterResponse 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.

procedure TBrickletRS485.ModbusSlaveAnswerWriteMultipleCoilsRequest(const requestID: byte)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

  • Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom OnModbusSlaveWriteMultipleCoilsRequest Callback mit der Request ID des Callbacks aufgerufen werden.

function TBrickletRS485.ModbusMasterWriteMultipleCoils(const slaveAddress: byte; const startingAddress: longword; const coils: array of boolean): byte
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 247]
  • startingAddress – Typ: longword, Wertebereich: [1 bis 216]
  • coils – Typ: array of boolean
Rückgabe:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine mehrere Coils eines Modbus-Slave zu schreiben (Modbus Funktionscode 15).

  • Slave Address: Addresse des anzusprechenden Modbus-Slave.
  • Starting Address: Nummer der ersten zu schreibenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Falls kein Fehler auftritt, wird auch der OnModbusMasterWriteMultipleCoilsResponse 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.

procedure TBrickletRS485.ModbusSlaveAnswerWriteMultipleRegistersRequest(const requestID: byte)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

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

  • Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom OnModbusSlaveWriteMultipleRegistersRequest Callback mit der Request ID des Callbacks aufgerufen werden.

function TBrickletRS485.ModbusMasterWriteMultipleRegisters(const slaveAddress: byte; const startingAddress: longword; const registers: array of word): byte
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 247]
  • startingAddress – Typ: longword, Wertebereich: [1 bis 216]
  • registers – Typ: array of word, 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 OnModbusMasterWriteMultipleRegistersResponse 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.

procedure TBrickletRS485.ModbusSlaveAnswerReadDiscreteInputsRequest(const requestID: byte; const discreteInputs: array of boolean)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • discreteInputs – Typ: array of boolean

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

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

Diese Funktion muss vom OnModbusSlaveReadDiscreteInputsRequest Callback mit der Request ID des Callbacks aufgerufen werden.

function TBrickletRS485.ModbusMasterReadDiscreteInputs(const slaveAddress: byte; const startingAddress: longword; const count: word): byte
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 247]
  • startingAddress – Typ: longword, Wertebereich: [1 bis 216]
  • count – Typ: word, Wertebereich: [1 bis 2000]
Rückgabe:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Discrete Inputs-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 2).

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

Falls kein Fehler auftritt, wird auch der OnModbusMasterReadDiscreteInputsResponse 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.

procedure TBrickletRS485.ModbusSlaveAnswerReadInputRegistersRequest(const requestID: byte; const inputRegisters: array of word)
Parameter:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • inputRegisters – Typ: array of word, Wertebereich: [0 bis 216 - 1]

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

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

Diese Funktion muss vom OnModbusSlaveReadInputRegistersRequest Callback mit der Request ID des Callbacks aufgerufen werden.

function TBrickletRS485.ModbusMasterReadInputRegisters(const slaveAddress: byte; const startingAddress: longword; const count: word): byte
Parameter:
  • slaveAddress – Typ: byte, Wertebereich: [0 bis 247]
  • startingAddress – Typ: longword, Wertebereich: [1 bis 216]
  • count – Typ: word, Wertebereich: [1 bis 125]
Rückgabe:
  • requestID – Typ: byte, Wertebereich: [0 bis 255]

Im Modbus-Master Modus kann diese Funktion genutzt werden, um eine Read Input-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 4).

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

Falls kein Fehler auftritt, wird auch der OnModbusMasterReadInputRegistersResponse 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.

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

procedure TBrickletRS485.SetStatusLEDConfig(const config: byte)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

  • BRICKLET_RS485_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_RS485_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_RS485_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_RS485_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletRS485.GetStatusLEDConfig: byte
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • BRICKLET_RS485_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_RS485_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_RS485_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_RS485_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletRS485.GetChipTemperature: smallint
Rückgabe:
  • temperature – Typ: smallint, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

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

procedure TBrickletRS485.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)
Ausgabeparameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
  • hardwareVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: word, 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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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

Konfigurationsfunktionen für Callbacks

procedure TBrickletRS485.EnableReadCallback

Aktiviert den OnRead Callback. Dies deaktiviert den OnFrameReadable Callback.

Im Startzustand ist der Callback deaktiviert.

procedure TBrickletRS485.DisableReadCallback

Deaktiviert den OnRead Callback.

Im Startzustand ist der Callback deaktiviert.

function TBrickletRS485.IsReadCallbackEnabled: boolean
Rückgabe:
  • enabled – Typ: boolean, Standardwert: false

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

procedure TBrickletRS485.EnableErrorCountCallback

Aktiviert den OnErrorCount Callback.

Im Startzustand ist der Callback deaktiviert.

procedure TBrickletRS485.DisableErrorCountCallback

Deaktiviert den OnErrorCount Callback.

Im Startzustand ist der Callback deaktiviert.

function TBrickletRS485.IsErrorCountCallbackEnabled: boolean
Rückgabe:
  • enabled – Typ: boolean, Standardwert: true

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

procedure TBrickletRS485.SetFrameReadableCallbackConfiguration(const frameSize: word)
Parameter:
  • frameSize – Typ: word, Einheit: 1 B, Wertebereich: [0 bis 9216], Standardwert: 0

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

Im Startzustand ist der Callback deaktiviert.

Neu in Version 2.0.5 (Plugin).

function TBrickletRS485.GetFrameReadableCallbackConfiguration: word
Rückgabe:
  • frameSize – Typ: word, Einheit: 1 B, Wertebereich: [0 bis 9216], Standardwert: 0

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

Neu in Version 2.0.5 (Plugin).

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

procedure TExample.MyCallback(sender: TBrickletRS485; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

rs485.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

Die verfügbaren Callback Properties und ihre Parametertypen 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.

property TBrickletRS485.OnRead
procedure(sender: TBrickletRS485; const message: array of char) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • message – Typ: array of char

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 nil für message ausgelöst.

property TBrickletRS485.OnErrorCount
procedure(sender: TBrickletRS485; const overrunErrorCount: longword; const parityErrorCount: longword) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • overrunErrorCount – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • parityErrorCount – Typ: longword, 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.

property TBrickletRS485.OnModbusSlaveReadCoilsRequest
procedure(sender: TBrickletRS485; const requestID: byte; const startingAddress: longword; const count: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: longword, Wertebereich: [1 bis 216]
  • count – Typ: word, Wertebereich: [1 bis 2000]

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Coils erhält. Die Parameter sind die Request ID der Anfrage, die Nummer der ersten zu lesenden Coil und die Anzahl der zu lesenden Coils. Die Nummer der ersten Coil heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Eine Antwort auf diese Anfrage kann mit der Funktion ModbusSlaveAnswerReadCoilsRequest gesendet werden.

property TBrickletRS485.OnModbusMasterReadCoilsResponse
procedure(sender: TBrickletRS485; const requestID: byte; const exceptionCode: shortint; const coils: array of boolean) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: shortint, Wertebereich: Siehe Konstanten
  • coils – Typ: array of boolean

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 nil für coils ausgelöst.

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

Für exceptionCode:

  • BRICKLET_RS485_EXCEPTION_CODE_TIMEOUT = -1
  • BRICKLET_RS485_EXCEPTION_CODE_SUCCESS = 0
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BRICKLET_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BRICKLET_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
property TBrickletRS485.OnModbusSlaveReadHoldingRegistersRequest
procedure(sender: TBrickletRS485; const requestID: byte; const startingAddress: longword; const count: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: longword, Wertebereich: [1 bis 216]
  • count – Typ: word, Wertebereich: [1 bis 125]

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Holding Registern erhält. Die Parameter sind die Request ID der Anfrage, die Nummer des ersten zu lesenden Holding Registers und die Anzahl der zu lesenden Register. Die Nummer des ersten Holding Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion ModbusSlaveAnswerReadHoldingRegistersRequest gesendet werden.

property TBrickletRS485.OnModbusMasterReadHoldingRegistersResponse
procedure(sender: TBrickletRS485; const requestID: byte; const exceptionCode: shortint; const holdingRegisters: array of word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: shortint, Wertebereich: Siehe Konstanten
  • holdingRegisters – Typ: array of word, 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 nil für holdingRegisters ausgelöst.

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

Für exceptionCode:

  • BRICKLET_RS485_EXCEPTION_CODE_TIMEOUT = -1
  • BRICKLET_RS485_EXCEPTION_CODE_SUCCESS = 0
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BRICKLET_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BRICKLET_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
property TBrickletRS485.OnModbusSlaveWriteSingleCoilRequest
procedure(sender: TBrickletRS485; const requestID: byte; const coilAddress: longword; const coilValue: boolean) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • coilAddress – Typ: longword, Wertebereich: [1 bis 216]
  • coilValue – Typ: boolean

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.

property TBrickletRS485.OnModbusMasterWriteSingleCoilResponse
procedure(sender: TBrickletRS485; const requestID: byte; const exceptionCode: shortint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: shortint, 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:

  • BRICKLET_RS485_EXCEPTION_CODE_TIMEOUT = -1
  • BRICKLET_RS485_EXCEPTION_CODE_SUCCESS = 0
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BRICKLET_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BRICKLET_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
property TBrickletRS485.OnModbusSlaveWriteSingleRegisterRequest
procedure(sender: TBrickletRS485; const requestID: byte; const registerAddress: longword; const registerValue: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • registerAddress – Typ: longword, Wertebereich: [1 bis 216]
  • registerValue – Typ: word, 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.

property TBrickletRS485.OnModbusMasterWriteSingleRegisterResponse
procedure(sender: TBrickletRS485; const requestID: byte; const exceptionCode: shortint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: shortint, 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:

  • BRICKLET_RS485_EXCEPTION_CODE_TIMEOUT = -1
  • BRICKLET_RS485_EXCEPTION_CODE_SUCCESS = 0
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BRICKLET_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BRICKLET_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
property TBrickletRS485.OnModbusSlaveWriteMultipleCoilsRequest
procedure(sender: TBrickletRS485; const requestID: byte; const startingAddress: longword; const coils: array of boolean) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: longword, Wertebereich: [1 bis 216]
  • coils – Typ: array of boolean

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 nil für coils ausgelöst.

property TBrickletRS485.OnModbusMasterWriteMultipleCoilsResponse
procedure(sender: TBrickletRS485; const requestID: byte; const exceptionCode: shortint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: shortint, 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:

  • BRICKLET_RS485_EXCEPTION_CODE_TIMEOUT = -1
  • BRICKLET_RS485_EXCEPTION_CODE_SUCCESS = 0
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BRICKLET_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BRICKLET_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
property TBrickletRS485.OnModbusSlaveWriteMultipleRegistersRequest
procedure(sender: TBrickletRS485; const requestID: byte; const startingAddress: longword; const registers: array of word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: longword, Wertebereich: [1 bis 216]
  • registers – Typ: array of word, 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 nil für registers ausgelöst.

property TBrickletRS485.OnModbusMasterWriteMultipleRegistersResponse
procedure(sender: TBrickletRS485; const requestID: byte; const exceptionCode: shortint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: shortint, 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:

  • BRICKLET_RS485_EXCEPTION_CODE_TIMEOUT = -1
  • BRICKLET_RS485_EXCEPTION_CODE_SUCCESS = 0
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BRICKLET_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BRICKLET_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
property TBrickletRS485.OnModbusSlaveReadDiscreteInputsRequest
procedure(sender: TBrickletRS485; const requestID: byte; const startingAddress: longword; const count: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: longword, Wertebereich: [1 bis 216]
  • count – Typ: word, Wertebereich: [1 bis 2000]

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Discrete Inputs erhält. Die Parameter sind die Request ID der Anfrage, die Nummer des ersten Discrete Inputs und die Anzahl der zu lesenden Discrete Inputs. Die Nummer des ersten Discrete Inputs heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Discrete Input-Nummer zwischen 1 und 65536. Die Präfixziffer 1 (für Discrete Input) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion ModbusSlaveAnswerReadDiscreteInputsRequest gesendet werden.

property TBrickletRS485.OnModbusMasterReadDiscreteInputsResponse
procedure(sender: TBrickletRS485; const requestID: byte; const exceptionCode: shortint; const discreteInputs: array of boolean) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: shortint, Wertebereich: Siehe Konstanten
  • discreteInputs – Typ: array of boolean

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 nil für discreteInputs ausgelöst.

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

Für exceptionCode:

  • BRICKLET_RS485_EXCEPTION_CODE_TIMEOUT = -1
  • BRICKLET_RS485_EXCEPTION_CODE_SUCCESS = 0
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BRICKLET_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BRICKLET_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
property TBrickletRS485.OnModbusSlaveReadInputRegistersRequest
procedure(sender: TBrickletRS485; const requestID: byte; const startingAddress: longword; const count: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • startingAddress – Typ: longword, Wertebereich: [1 bis 216]
  • count – Typ: word, Wertebereich: [1 bis 125]

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Input Registern erhält. Die Parameter sind die Request ID der Anfrage, die Nummer des ersten Input Registers und die Anzahl der zu lesenden Register. Die Nummer des ersten Input Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Input Register-Nummer zwischen 1 und 65536. Die Präfixziffer 3 (für Input Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion ModbusSlaveAnswerReadInputRegistersRequest gesendet werden.

property TBrickletRS485.OnModbusMasterReadInputRegistersResponse
procedure(sender: TBrickletRS485; const requestID: byte; const exceptionCode: shortint; const inputRegisters: array of word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • requestID – Typ: byte, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: shortint, Wertebereich: Siehe Konstanten
  • inputRegisters – Typ: array of word, 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 nil für inputRegisters ausgelöst.

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

Für exceptionCode:

  • BRICKLET_RS485_EXCEPTION_CODE_TIMEOUT = -1
  • BRICKLET_RS485_EXCEPTION_CODE_SUCCESS = 0
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_FUNCTION = 1
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_ADDRESS = 2
  • BRICKLET_RS485_EXCEPTION_CODE_ILLEGAL_DATA_VALUE = 3
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_FAILURE = 4
  • BRICKLET_RS485_EXCEPTION_CODE_ACKNOWLEDGE = 5
  • BRICKLET_RS485_EXCEPTION_CODE_SLAVE_DEVICE_BUSY = 6
  • BRICKLET_RS485_EXCEPTION_CODE_MEMORY_PARITY_ERROR = 8
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_PATH_UNAVAILABLE = 10
  • BRICKLET_RS485_EXCEPTION_CODE_GATEWAY_TARGET_DEVICE_FAILED_TO_RESPOND = 11
property TBrickletRS485.OnFrameReadable
procedure(sender: TBrickletRS485; const frameCount: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRS485
  • frameCount – Typ: word, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn mindestens ein neuer Frame an Daten verfügbar sind. Die Größe eines Frames kann mit SetFrameReadableCallbackConfiguration konfiguriert werden. Frame Count ist die Anzahl an Frames, die zum Lesen bereitstehen. Der Callback wird nur einmal pro Read Aufruf ausgelöst. Das heißt, dass wenn eine Framegröße von X Bytes konfiguriert wird, jedes Mal wenn das Callback ausgelöst wird, X Bytes mit der Read-Funktion gelesen werden können, ohne dass der Frame Count-Parameter geprüft werden muss.

Neu in Version 2.0.5 (Plugin).

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

function TBrickletRS485.GetAPIVersion: array [0..2] of byte
Ausgabeparameter:
  • apiVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, Wertebereich: [0 bis 255]

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

function TBrickletRS485.GetResponseExpected(const functionId: byte): boolean
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

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:

  • BRICKLET_RS485_FUNCTION_ENABLE_READ_CALLBACK = 3
  • BRICKLET_RS485_FUNCTION_DISABLE_READ_CALLBACK = 4
  • BRICKLET_RS485_FUNCTION_SET_RS485_CONFIGURATION = 6
  • BRICKLET_RS485_FUNCTION_SET_MODBUS_CONFIGURATION = 8
  • BRICKLET_RS485_FUNCTION_SET_MODE = 10
  • BRICKLET_RS485_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
  • BRICKLET_RS485_FUNCTION_SET_ERROR_LED_CONFIG = 14
  • BRICKLET_RS485_FUNCTION_SET_BUFFER_CONFIG = 16
  • BRICKLET_RS485_FUNCTION_ENABLE_ERROR_COUNT_CALLBACK = 19
  • BRICKLET_RS485_FUNCTION_DISABLE_ERROR_COUNT_CALLBACK = 20
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_REPORT_EXCEPTION = 24
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_COILS_REQUEST = 25
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_HOLDING_REGISTERS_REQUEST = 27
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_COIL_REQUEST = 29
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_REGISTER_REQUEST = 31
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_COILS_REQUEST = 33
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_REGISTERS_REQUEST = 35
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_DISCRETE_INPUTS_REQUEST = 37
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_INPUT_REGISTERS_REQUEST = 39
  • BRICKLET_RS485_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 59
  • BRICKLET_RS485_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_RS485_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_RS485_FUNCTION_RESET = 243
  • BRICKLET_RS485_FUNCTION_WRITE_UID = 248
procedure TBrickletRS485.SetResponseExpected(const functionId: byte; const responseExpected: boolean)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

Ä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:

  • BRICKLET_RS485_FUNCTION_ENABLE_READ_CALLBACK = 3
  • BRICKLET_RS485_FUNCTION_DISABLE_READ_CALLBACK = 4
  • BRICKLET_RS485_FUNCTION_SET_RS485_CONFIGURATION = 6
  • BRICKLET_RS485_FUNCTION_SET_MODBUS_CONFIGURATION = 8
  • BRICKLET_RS485_FUNCTION_SET_MODE = 10
  • BRICKLET_RS485_FUNCTION_SET_COMMUNICATION_LED_CONFIG = 12
  • BRICKLET_RS485_FUNCTION_SET_ERROR_LED_CONFIG = 14
  • BRICKLET_RS485_FUNCTION_SET_BUFFER_CONFIG = 16
  • BRICKLET_RS485_FUNCTION_ENABLE_ERROR_COUNT_CALLBACK = 19
  • BRICKLET_RS485_FUNCTION_DISABLE_ERROR_COUNT_CALLBACK = 20
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_REPORT_EXCEPTION = 24
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_COILS_REQUEST = 25
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_HOLDING_REGISTERS_REQUEST = 27
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_COIL_REQUEST = 29
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_SINGLE_REGISTER_REQUEST = 31
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_COILS_REQUEST = 33
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_WRITE_MULTIPLE_REGISTERS_REQUEST = 35
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_DISCRETE_INPUTS_REQUEST = 37
  • BRICKLET_RS485_FUNCTION_MODBUS_SLAVE_ANSWER_READ_INPUT_REGISTERS_REQUEST = 39
  • BRICKLET_RS485_FUNCTION_SET_FRAME_READABLE_CALLBACK_CONFIGURATION = 59
  • BRICKLET_RS485_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_RS485_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_RS485_FUNCTION_RESET = 243
  • BRICKLET_RS485_FUNCTION_WRITE_UID = 248
procedure TBrickletRS485.SetResponseExpectedAll(const responseExpected: boolean)
Parameter:
  • responseExpected – Typ: boolean

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

Interne Funktionen

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

function TBrickletRS485.SetBootloaderMode(const mode: byte): byte
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 Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

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

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

Für mode:

  • BRICKLET_RS485_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_RS485_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_RS485_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_RS485_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_RS485_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BRICKLET_RS485_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_RS485_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_RS485_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_RS485_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_RS485_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_RS485_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletRS485.GetBootloaderMode: byte
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:

  • BRICKLET_RS485_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_RS485_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_RS485_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_RS485_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_RS485_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletRS485.SetWriteFirmwarePointer(const pointer: longword)
Parameter:
  • pointer – Typ: longword, Einheit: 1 B, 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.

function TBrickletRS485.WriteFirmware(const data: array [0..63] of byte): byte
Parameter:
  • data – Typ: array [0..63] of byte, 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.

procedure TBrickletRS485.WriteUID(const uid: longword)
Parameter:
  • uid – Typ: longword, 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.

function TBrickletRS485.ReadUID: longword
Rückgabe:
  • uid – Typ: longword, 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.

Konstanten

const BRICKLET_RS485_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RS485 Bricklet zu identifizieren.

Die GetIdentity Funktion und der TIPConnection.OnEnumerate Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

const BRICKLET_RS485_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RS485 Bricklet dar.