Ruby - Remote Switch Bricklet 2.0

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Switch Socket

Download (example_switch_socket.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_remote_switch_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Remote Switch Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
rs = BrickletRemoteSwitchV2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# 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.switch_socket_a 17, 1, BrickletRemoteSwitchV2::SWITCH_TO_ON

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

Remote Callback

Download (example_remote_callback.rb)

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

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_remote_switch_v2'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Remote Switch Bricklet 2.0

ipcon = IPConnection.new # Create IP connection
rs = BrickletRemoteSwitchV2.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# 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.set_remote_configuration BrickletRemoteSwitchV2::REMOTE_TYPE_A, 1, true

# Register remote status a callback
rs.register_callback(BrickletRemoteSwitchV2::CALLBACK_REMOTE_STATUS_A) do |house_code,
                                                                           receiver_code,
                                                                           switch_to,
                                                                           repeats|
  puts "House Code: #{house_code}"
  puts "Receiver Code: #{receiver_code}"

  if switch_to == BrickletRemoteSwitchV2::SWITCH_TO_OFF
    puts "Switch To: Off"
  elsif switch_to == BrickletRemoteSwitchV2::SWITCH_TO_ON
    puts "Switch To: On"
  end

  puts "Repeats: #{repeats}"
  puts ''
end

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

API

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

BrickletRemoteSwitchV2::new(uid, ipcon) → remote_switch_v2
Parameter:
  • uid – Typ: str
  • ipcon – Typ: IPConnection
Rückgabe:
  • remote_switch_v2 – Typ: BrickletRemoteSwitchV2

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

remote_switch_v2 = BrickletRemoteSwitchV2.new 'YOUR_DEVICE_UID', ipcon

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

BrickletRemoteSwitchV2#get_switching_state → int
Rückgabe:
  • state – Typ: int, 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 #set_repeats.

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

Für state:

  • BrickletRemoteSwitchV2::SWITCHING_STATE_READY = 0
  • BrickletRemoteSwitchV2::SWITCHING_STATE_BUSY = 1
BrickletRemoteSwitchV2#switch_socket_a(house_code, receiver_code, switch_to) → nil
Parameter:
  • house_code – Typ: int, Wertebereich: [0 bis 31]
  • receiver_code – Typ: int, Wertebereich: [0 bis 31]
  • switch_to – Typ: int, 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.

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

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
BrickletRemoteSwitchV2#switch_socket_b(address, unit, switch_to) → nil
Parameter:
  • address – Typ: int, Wertebereich: [0 bis 67108863]
  • unit – Typ: int, Wertebereich: [0 bis 15, 255]
  • switch_to – Typ: int, 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.

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

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
BrickletRemoteSwitchV2#dim_socket_b(address, unit, dim_value) → nil
Parameter:
  • address – Typ: int, Wertebereich: [0 bis 67108863]
  • unit – Typ: int, Wertebereich: [0 bis 15, 255]
  • dim_value – Typ: int, 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.

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

BrickletRemoteSwitchV2#switch_socket_c(system_code, device_code, switch_to) → nil
Parameter:
  • system_code – Typ: chr, Wertebereich: ['A' bis 'P']
  • device_code – Typ: int, Wertebereich: [1 bis 16]
  • switch_to – Typ: int, 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.

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

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
BrickletRemoteSwitchV2#set_remote_configuration(remote_type, minimum_repeats, callback_enabled) → nil
Parameter:
  • remote_type – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: A
  • minimum_repeats – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 2
  • callback_enabled – Typ: bool, Standardwert: false

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

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

Für remote_type:

  • BrickletRemoteSwitchV2::REMOTE_TYPE_A = 0
  • BrickletRemoteSwitchV2::REMOTE_TYPE_B = 1
  • BrickletRemoteSwitchV2::REMOTE_TYPE_C = 2
BrickletRemoteSwitchV2#get_remote_configuration → [int, int, bool]
Rückgabe-Array:
  • 0: remote_type – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: A
  • 1: minimum_repeats – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 2
  • 2: callback_enabled – Typ: bool, Standardwert: false

Gibt die Konfiguration zurück wie von #set_remote_configuration gesetzt.

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

Für remote_type:

  • BrickletRemoteSwitchV2::REMOTE_TYPE_A = 0
  • BrickletRemoteSwitchV2::REMOTE_TYPE_B = 1
  • BrickletRemoteSwitchV2::REMOTE_TYPE_C = 2
BrickletRemoteSwitchV2#get_remote_status_a → [int, int, int, int]
Rückgabe-Array:
  • 0: house_code – Typ: int, Wertebereich: [0 bis 31]
  • 1: receiver_code – Typ: int, Wertebereich: [0 bis 31]
  • 2: switch_to – Typ: int, Wertebereich: Siehe Konstanten
  • 3: repeats – Typ: int, 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 #set_remote_configuration und ::CALLBACK_REMOTE_STATUS_A Callback.

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

Für switch_to:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
BrickletRemoteSwitchV2#get_remote_status_b → [int, int, int, int, int]
Rückgabe-Array:
  • 0: address – Typ: int, Wertebereich: [0 bis 67108863]
  • 1: unit – Typ: int, Wertebereich: [0 bis 15]
  • 2: switch_to – Typ: int, Wertebereich: Siehe Konstanten
  • 3: dim_value – Typ: int, Wertebereich: [0 bis 255]
  • 4: repeats – Typ: int, 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 #set_remote_configuration und ::CALLBACK_REMOTE_STATUS_B Callback.

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

Für switch_to:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
BrickletRemoteSwitchV2#get_remote_status_c → [chr, int, int, int]
Rückgabe-Array:
  • 0: system_code – Typ: chr, Wertebereich: ['A' bis 'P']
  • 1: device_code – Typ: int, Wertebereich: [1 bis 16]
  • 2: switch_to – Typ: int, Wertebereich: Siehe Konstanten
  • 3: repeats – Typ: int, 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 #set_remote_configuration und ::CALLBACK_REMOTE_STATUS_C Callback.

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

Für switch_to:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1

Fortgeschrittene Funktionen

BrickletRemoteSwitchV2#set_repeats(repeats) → nil
Parameter:
  • repeats – Typ: int, Wertebereich: [0 bis 255], Standardwert: 5

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.

BrickletRemoteSwitchV2#get_repeats → int
Rückgabe:
  • repeats – Typ: int, Wertebereich: [0 bis 255], Standardwert: 5

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

BrickletRemoteSwitchV2#get_spitfp_error_count → [int, int, int, int]
Rückgabe-Array:
  • 0: error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 1: error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 2: error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 3: error_count_overflow – Typ: int, 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.

BrickletRemoteSwitchV2#set_bootloader_mode(mode) → int
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: int, 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:

  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_OK = 0
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletRemoteSwitchV2::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletRemoteSwitchV2#get_bootloader_mode → int
Rückgabe:
  • mode – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für mode:

  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletRemoteSwitchV2::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletRemoteSwitchV2#set_write_firmware_pointer(pointer) → nil
Parameter:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für #write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

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

BrickletRemoteSwitchV2#write_firmware(data) → int
Parameter:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von #set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

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

BrickletRemoteSwitchV2#set_status_led_config(config) → nil
Parameter:
  • config – Typ: int, 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:

  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_ON = 1
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletRemoteSwitchV2#get_status_led_config → int
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_OFF = 0
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_ON = 1
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletRemoteSwitchV2::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletRemoteSwitchV2#get_chip_temperature → int
Rückgabe:
  • temperature – Typ: int, 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.

BrickletRemoteSwitchV2#reset → nil

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletRemoteSwitchV2#write_uid(uid) → nil
Parameter:
  • uid – Typ: int, 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.

BrickletRemoteSwitchV2#read_uid → int
Rückgabe:
  • uid – Typ: int, 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.

BrickletRemoteSwitchV2#get_identity → [str, str, chr, [int, ...], [int, ...], int]
Rückgabe-Array:
  • 0: uid – Typ: str, Länge: bis zu 8
  • 1: connected_uid – Typ: str, Länge: bis zu 8
  • 2: position – Typ: chr, Wertebereich: ['a' bis 'i', 'z']
  • 3: hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • 4: firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • 5: device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Die Position 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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

BrickletRemoteSwitchV2#register_callback(callback_id) { |param [, ...]| block } → nil
Parameter:
  • callback_id – Typ: int

Registriert den block für die gegebene callback_id.

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

Callbacks

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

remote_switch_v2.register_callback BrickletRemoteSwitchV2::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

BrickletRemoteSwitchV2::CALLBACK_SWITCHING_DONE
Callback-Parameter:
  • keine Parameter

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

BrickletRemoteSwitchV2::CALLBACK_REMOTE_STATUS_A
Callback-Parameter:
  • house_code – Typ: int, Wertebereich: [0 bis 31]
  • receiver_code – Typ: int, Wertebereich: [0 bis 31]
  • switch_to – Typ: int, Wertebereich: Siehe Konstanten
  • repeats – Typ: int, 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 #set_remote_configuration. 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 switch_to:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
BrickletRemoteSwitchV2::CALLBACK_REMOTE_STATUS_B
Callback-Parameter:
  • address – Typ: int, Wertebereich: [0 bis 67108863]
  • unit – Typ: int, Wertebereich: [0 bis 15, 255]
  • switch_to – Typ: int, Wertebereich: Siehe Konstanten
  • dim_value – Typ: int, Wertebereich: [0 bis 255]
  • repeats – Typ: int, 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 #set_remote_configuration. 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 switch_to:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1
BrickletRemoteSwitchV2::CALLBACK_REMOTE_STATUS_C
Callback-Parameter:
  • system_code – Typ: chr, Wertebereich: ['A' bis 'P']
  • device_code – Typ: int, Wertebereich: [1 bis 16]
  • switch_to – Typ: int, Wertebereich: Siehe Konstanten
  • repeats – Typ: int, 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 #set_remote_configuration. 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 switch_to:

  • BrickletRemoteSwitchV2::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitchV2::SWITCH_TO_ON = 1

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.

BrickletRemoteSwitchV2#get_api_version → [int, ...]
Rückgabe-Array:
  • 0: api_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]

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.

BrickletRemoteSwitchV2#get_response_expected(function_id) → bool
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – Typ: bool

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

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

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

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

Für function_id:

  • BrickletRemoteSwitchV2::FUNCTION_SET_REPEATS = 3
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_A = 5
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_B = 6
  • BrickletRemoteSwitchV2::FUNCTION_DIM_SOCKET_B = 7
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_C = 8
  • BrickletRemoteSwitchV2::FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • BrickletRemoteSwitchV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRemoteSwitchV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRemoteSwitchV2::FUNCTION_RESET = 243
  • BrickletRemoteSwitchV2::FUNCTION_WRITE_UID = 248
BrickletRemoteSwitchV2#set_response_expected(function_id, response_expected) → nil
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool

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

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

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

Für function_id:

  • BrickletRemoteSwitchV2::FUNCTION_SET_REPEATS = 3
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_A = 5
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_B = 6
  • BrickletRemoteSwitchV2::FUNCTION_DIM_SOCKET_B = 7
  • BrickletRemoteSwitchV2::FUNCTION_SWITCH_SOCKET_C = 8
  • BrickletRemoteSwitchV2::FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • BrickletRemoteSwitchV2::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletRemoteSwitchV2::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletRemoteSwitchV2::FUNCTION_RESET = 243
  • BrickletRemoteSwitchV2::FUNCTION_WRITE_UID = 248
BrickletRemoteSwitchV2#set_response_expected_all(response_expected) → nil
Parameter:
  • response_expected – Typ: bool

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

Konstanten

BrickletRemoteSwitchV2::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Remote Switch Bricklet 2.0 zu identifizieren.

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

BrickletRemoteSwitchV2::DEVICE_DISPLAY_NAME

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