Delphi/Lazarus - Remote Switch Bricklet 2.0

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das Remote Switch Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Remote Switch Bricklet 2.0 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).

Switch Socket

Download (ExampleSwitchSocket.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
program ExampleSwitchSocket;

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

uses
  SysUtils, IPConnection, BrickletRemoteSwitchV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    rs: TBrickletRemoteSwitchV2;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  rs := TBrickletRemoteSwitchV2.Create(UID, ipcon);

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

  { Switch on a type A socket with house code 17 and receiver code 1.
    House code 17 is 10001 in binary (least-significant bit first)
    and means that the DIP switches 1 and 5 are on and 2-4 are off.
    Receiver code 1 is 10000 in binary (least-significant bit first)
    and means that the DIP switch A is on and B-E are off. }
  rs.SwitchSocketA(17, 1, BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON);

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

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

Remote Callback

Download (ExampleRemoteCallback.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 ExampleRemoteCallback;

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

uses
  SysUtils, IPConnection, BrickletRemoteSwitchV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    rs: TBrickletRemoteSwitchV2;
  public
    procedure RemoteStatusACB(sender: TBrickletRemoteSwitchV2; const houseCode: byte;
                              const receiverCode: byte; const switchTo: byte;
                              const repeats: word);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for remote status a callback }
procedure TExample.RemoteStatusACB(sender: TBrickletRemoteSwitchV2; const houseCode: byte;
                                   const receiverCode: byte; const switchTo: byte;
                                   const repeats: word);
begin
  WriteLn(Format('House Code: %d', [houseCode]));
  WriteLn(Format('Receiver Code: %d', [receiverCode]));

  if (switchTo = BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF) then begin
    WriteLn('Switch To: Off');
  end
  else if (switchTo = BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON) then begin
    WriteLn('Switch To: On');
  end;

  WriteLn(Format('Repeats: %d', [repeats]));
  WriteLn('');
end;

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

  { Create device object }
  rs := TBrickletRemoteSwitchV2.Create(UID, ipcon);

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

  { Configure to receive from remote type A with minimum repeats set to 1 and enable callback }
  rs.SetRemoteConfiguration(BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_A, 1, true);

  { Register remote status a callback to procedure RemoteStatusACB }
  rs.OnRemoteStatusA := {$ifdef FPC}@{$endif}RemoteStatusACB;

  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 TBrickletRemoteSwitchV2.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • remoteSwitchV2 – Typ: TBrickletRemoteSwitchV2

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

remoteSwitchV2 := TBrickletRemoteSwitchV2.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletRemoteSwitchV2.GetSwitchingState: byte
Rückgabe:
  • state – Typ: byte, Wertebereich: Siehe Konstanten

Gibt den aktuellen Zustand des Schaltens zurück. Wenn der aktuell Zustand busy (beschäftigt) ist, sendet das Bricklet gerade einen Code um eine Steckdose zu schalten. Weitere Aufrufe der Switch Socket Funktionen werden ignoriert bis der Zustand auf ready (fertig) wechselt.

Die Länge des Schaltvorgangs ist abhängig von der Anzahl der Wiederholungen, siehe SetRepeats.

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

Für state:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCHING_STATE_READY = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCHING_STATE_BUSY = 1
procedure TBrickletRemoteSwitchV2.SwitchSocketA(const houseCode: byte; const receiverCode: byte; const switchTo: byte)
Parameter:
  • houseCode – Typ: byte, Wertebereich: [0 bis 255]
  • receiverCode – Typ: byte, Wertebereich: [0 bis 255]
  • switchTo – Typ: byte, Wertebereich: Siehe Konstanten

Um eine Typ A Steckdose zu schalten muss der Housecode, Receivercode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Der House- und Receivercode hat einen Wertebereich von 0 bis 31 (5Bit).

Eine detaillierte Beschreibung wie man den House- und Receivercode herausfinden kann gibt es hier.

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

Für switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
procedure TBrickletRemoteSwitchV2.SwitchSocketB(const address: longword; const unit: byte; const switchTo: byte)
Parameter:
  • address – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: byte, Wertebereich: [0 bis 255]
  • switchTo – Typ: byte, Wertebereich: Siehe Konstanten

Um eine Typ B Steckdose zu schalten muss die Adresse und Unit sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Die Adresse hat einen Wertebereich von 0 bis 67108863 (26Bit) und die Unit hat einen Wertebereich von 0 bis 15 (4Bit). Um alle Geräte mit der selben Adresse zu schalten kann die Unit auf 255 gesetzt werden.

Eine detaillierte Beschreibung wie man Adresse und Unit einer Steckdose anlernen kann gibt es hier.

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

Für switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
procedure TBrickletRemoteSwitchV2.DimSocketB(const address: longword; const unit: byte; const dimValue: byte)
Parameter:
  • address – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: byte, Wertebereich: [0 bis 255]
  • dimValue – Typ: byte, Wertebereich: [0 bis 255]

Um eine Typ B Dimmer zu steuern muss die Adresse und Unit sowie der Dimmwert auf der Dimmer gesetzt werden soll übergeben werden.

Die Adresse hat einen Wertebereich von 0 bis 67108863 (26Bit), die Unit und der Dimmwert haben einen Wertebereich von 0 bis 15 (4Bit).

Eine detaillierte Beschreibung wie man Adresse und Unit einem Dimmer anlernen kann gibt es hier.

procedure TBrickletRemoteSwitchV2.SwitchSocketC(const systemCode: char; const deviceCode: byte; const switchTo: byte)
Parameter:
  • systemCode – Typ: char
  • deviceCode – Typ: byte, Wertebereich: [0 bis 255]
  • switchTo – Typ: byte, Wertebereich: Siehe Konstanten

Um eine Typ C Steckdose zu schalten muss der Systemcode, Gerätecode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Der Systemcode hat einen Wertebereich von 'A' bis 'P' (4Bit) und der Gerätecode hat einen Wertebereich von 1 bis 16 (4Bit).

Eine detaillierte Beschreibung wie man den System- und Gerätecode herausfinden kann gibt es hier.

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

Für switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
procedure TBrickletRemoteSwitchV2.SetRemoteConfiguration(const remoteType: byte; const minimumRepeats: word; const callbackEnabled: boolean)
Parameter:
  • remoteType – Typ: byte, Wertebereich: Siehe Konstanten
  • minimumRepeats – Typ: word, Wertebereich: [0 bis 216 - 1]
  • callbackEnabled – Typ: boolean

Setzt die Konfiguration für das Empfangen von Daten von Fernbedienungen der Typen A, B und C.

  • Remote Type: A, B oder C abhängig vom Typ der Fernbedienung die empfangen werden soll.
  • Minimum Repeats: Die Mindestanzahl an wiederholten Datenpaketen bevor der Callback ausgelöst wird (falls aktiviert).
  • Callback Enabled: Aktiviert/Deaktivert den Callback (siehe OnRemoteStatusA Callback, OnRemoteStatusB Callback und OnRemoteStatusC Callback).

Der Standardwert ist ('A', 2, false).

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

Für remoteType:

  • BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_A = 0
  • BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_B = 1
  • BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_C = 2
procedure TBrickletRemoteSwitchV2.GetRemoteConfiguration(out remoteType: byte; out minimumRepeats: word; out callbackEnabled: boolean)
Ausgabeparameter:
  • remoteType – Typ: byte, Wertebereich: Siehe Konstanten
  • minimumRepeats – Typ: word, Wertebereich: [0 bis 216 - 1]
  • callbackEnabled – Typ: boolean

Gibt die Konfiguration zurück wie von SetRemoteConfiguration gesetzt.

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

Für remoteType:

  • BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_A = 0
  • BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_B = 1
  • BRICKLET_REMOTE_SWITCH_V2_REMOTE_TYPE_C = 2
procedure TBrickletRemoteSwitchV2.GetRemoteStatusA(out houseCode: byte; out receiverCode: byte; out switchTo: byte; out repeats: word)
Ausgabeparameter:
  • houseCode – Typ: byte, Wertebereich: [0 bis 255]
  • receiverCode – Typ: byte, Wertebereich: [0 bis 255]
  • switchTo – Typ: byte, Wertebereich: Siehe Konstanten
  • repeats – Typ: word, Wertebereich: [0 bis 216 - 1]

Gibt den Housecode, Receivercode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ A Fernbedienung zurück.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit dem angegebenen House/Receivercode auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe SetRemoteConfiguration und OnRemoteStatusA Callback.

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

Für switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
procedure TBrickletRemoteSwitchV2.GetRemoteStatusB(out address: longword; out unit: byte; out switchTo: byte; out dimValue: byte; out repeats: word)
Ausgabeparameter:
  • address – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: byte, Wertebereich: [0 bis 255]
  • switchTo – Typ: byte, Wertebereich: Siehe Konstanten
  • dimValue – Typ: byte, Wertebereich: [0 bis 255]
  • repeats – Typ: word, Wertebereich: [0 bis 216 - 1]

Gibt die Address (eindeutig für jede Fernbedienung), Unit (Knopfnummer), Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ B Fernbedienung zurück.

Falls die Fernbedienung Dimmen unterstützt, dann wie der Dimmwert anstatt des Schaltzustandes verwendet.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit der angegebenen Address/Unit auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe SetRemoteConfiguration und OnRemoteStatusB Callback.

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

Für switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
procedure TBrickletRemoteSwitchV2.GetRemoteStatusC(out systemCode: char; out deviceCode: byte; out switchTo: byte; out repeats: word)
Ausgabeparameter:
  • systemCode – Typ: char
  • deviceCode – Typ: byte, Wertebereich: [0 bis 255]
  • switchTo – Typ: byte, Wertebereich: Siehe Konstanten
  • repeats – Typ: word, Wertebereich: [0 bis 216 - 1]

Gibt die Systemcode, Gerätecode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ C Fernbedienung zurück.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit der angegebenen System/Gerätecode auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe SetRemoteConfiguration und OnRemoteStatusC Callback.

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

Für switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

Fortgeschrittene Funktionen

procedure TBrickletRemoteSwitchV2.SetRepeats(const repeats: byte)
Parameter:
  • repeats – Typ: byte, Wertebereich: [0 bis 255]

Setzt die Anzahl der Wiederholungen die verwendet werden um einen Code zu senden wenn eine der Switch Socket Funktionen aufgerufen wird. Die Wiederholungen korrespondieren zu der Zeit die eine Taste auf der Fernbedienung gedrückt wird.

Einige Dimmer werden über die Länge des Tastendrucks kontrolliert, dies kann simuliert werden indem man die Anzahl der Wiederholungen inkrementiert.

Der Standardwert ist 5.

function TBrickletRemoteSwitchV2.GetRepeats: byte
Rückgabe:
  • repeats – Typ: byte, Wertebereich: [0 bis 255]

Gibt die Anzahl der Wiederholungen zurück, wie von SetRepeats gesetzt.

function TBrickletRemoteSwitchV2.GetAPIVersion: array [0..2] of byte
Rückgabe:
  • apiVersion – Typ: array [0..2] of byte, 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.

function TBrickletRemoteSwitchV2.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_REMOTE_SWITCH_V2_FUNCTION_SET_REPEATS = 3
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_A = 5
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_B = 6
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_DIM_SOCKET_B = 7
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_C = 8
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_RESET = 243
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletRemoteSwitchV2.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_REMOTE_SWITCH_V2_FUNCTION_SET_REPEATS = 3
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_A = 5
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_B = 6
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_DIM_SOCKET_B = 7
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SWITCH_SOCKET_C = 8
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_RESET = 243
  • BRICKLET_REMOTE_SWITCH_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletRemoteSwitchV2.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.

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

function TBrickletRemoteSwitchV2.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 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:

  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletRemoteSwitchV2.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_REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_REMOTE_SWITCH_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletRemoteSwitchV2.SetWriteFirmwarePointer(const pointer: longword)
Parameter:
  • pointer – Typ: longword, 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 TBrickletRemoteSwitchV2.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 TBrickletRemoteSwitchV2.SetStatusLEDConfig(const config: byte)
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:

  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletRemoteSwitchV2.GetStatusLEDConfig: byte
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:

  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_REMOTE_SWITCH_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletRemoteSwitchV2.GetChipTemperature: smallint
Rückgabe:
  • temperature – Typ: smallint, 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.

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

procedure TBrickletRemoteSwitchV2.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
  • hardwareVersion – Typ: array [0..2] of byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: array [0..2] of 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 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.

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: TBrickletRemoteSwitchV2; const param: word);
begin
  WriteLn(param);
end;

remoteSwitchV2.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 TBrickletRemoteSwitchV2.OnSwitchingDone
procedure(sender: TBrickletRemoteSwitchV2) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRemoteSwitchV2

Dieser Callback wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe GetSwitchingState.

property TBrickletRemoteSwitchV2.OnRemoteStatusA
procedure(sender: TBrickletRemoteSwitchV2; const houseCode: byte; const receiverCode: byte; const switchTo: byte; const repeats: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRemoteSwitchV2
  • houseCode – Typ: byte, Wertebereich: [0 bis 255]
  • receiverCode – Typ: byte, Wertebereich: [0 bis 255]
  • switchTo – Typ: byte, Wertebereich: Siehe Konstanten
  • repeats – Typ: word, Wertebereich: [0 bis 216 - 1]

Gibt den Housecode, Receivercode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ A Fernbedienung zurück.

Die Wiederholungen ist die Anzahl empfangener identischer Datenpakete. Je länger der Knopf auf der Fernbedienung gedrückt wird, desto höher die Anzahl der Wiederholungen. Der Callback wird bei jeder Wiederholung ausgelöst.

Der Callback muss zuerst aktiviert werden mittels SetRemoteConfiguration. Die Mindestanzahl an Wiederholungen die konfiguriert werden kann ist die Anzahl an Wiederholungen die empfangen worden sein muss bevor der Callback das erste mal ausgelöst wird.

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

Für switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
property TBrickletRemoteSwitchV2.OnRemoteStatusB
procedure(sender: TBrickletRemoteSwitchV2; const address: longword; const unit: byte; const switchTo: byte; const dimValue: byte; const repeats: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRemoteSwitchV2
  • address – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: byte, Wertebereich: [0 bis 255]
  • switchTo – Typ: byte, Wertebereich: Siehe Konstanten
  • dimValue – Typ: byte, Wertebereich: [0 bis 255]
  • repeats – Typ: word, Wertebereich: [0 bis 216 - 1]

Gibt die Address (eindeutig für jede Fernbedienung), Unit (Knopfnummer), Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ B Fernbedienung zurück.

Die Wiederholungen ist die Anzahl empfangener identischer Datenpakete. Je länger der Knopf auf der Fernbedienung gedrückt wird, desto höher die Anzahl der Wiederholungen. Der Callback wird bei jeder Wiederholung ausgelöst.

Der Callback muss zuerst aktiviert werden mittels SetRemoteConfiguration. Die Mindestanzahl an Wiederholungen die konfiguriert werden kann ist die Anzahl an Wiederholungen die empfangen worden sein muss bevor der Callback das erste mal ausgelöst wird.

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

Für switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1
property TBrickletRemoteSwitchV2.OnRemoteStatusC
procedure(sender: TBrickletRemoteSwitchV2; const systemCode: char; const deviceCode: byte; const switchTo: byte; const repeats: word) of object;
Callback-Parameter:
  • sender – Typ: TBrickletRemoteSwitchV2
  • systemCode – Typ: char
  • deviceCode – Typ: byte, Wertebereich: [0 bis 255]
  • switchTo – Typ: byte, Wertebereich: Siehe Konstanten
  • repeats – Typ: word, Wertebereich: [0 bis 216 - 1]

Gibt die Systemcode, Gerätecode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ C Fernbedienung zurück.

Die Wiederholungen ist die Anzahl empfangener identischer Datenpakete. Je länger der Knopf auf der Fernbedienung gedrückt wird, desto höher die Anzahl der Wiederholungen. Der Callback wird bei jeder Wiederholung ausgelöst.

Der Callback muss zuerst aktiviert werden mittels SetRemoteConfiguration. Die Mindestanzahl an Wiederholungen die konfiguriert werden kann ist die Anzahl an Wiederholungen die empfangen worden sein muss bevor der Callback das erste mal ausgelöst wird.

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

Für switchTo:

  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_OFF = 0
  • BRICKLET_REMOTE_SWITCH_V2_SWITCH_TO_ON = 1

Konstanten

const BRICKLET_REMOTE_SWITCH_V2_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Remote Switch Bricklet 2.0 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_REMOTE_SWITCH_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet 2.0 dar.