Ruby - Remote Switch Bricklet

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

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
rs = BrickletRemoteSwitch.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, BrickletRemoteSwitch::SWITCH_TO_ON

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

API

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

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

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

remote_switch = BrickletRemoteSwitch.new 'YOUR_DEVICE_UID', ipcon

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

BrickletRemoteSwitch#switch_socket(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

Diese Funktion ist veraltet und wurde durch #switch_socket_a ersetzt.

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

Für switch_to:

  • BrickletRemoteSwitch::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch::SWITCH_TO_ON = 1
BrickletRemoteSwitch#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 Schaltanforderungen 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:

  • BrickletRemoteSwitch::SWITCHING_STATE_READY = 0
  • BrickletRemoteSwitch::SWITCHING_STATE_BUSY = 1
BrickletRemoteSwitch#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:

  • BrickletRemoteSwitch::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch::SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

BrickletRemoteSwitch#switch_socket_b(address, unit, switch_to) → nil
Parameter:
  • address – Typ: int, Wertebereich: [0 bis 226 - 1]
  • 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:

  • BrickletRemoteSwitch::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch::SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

BrickletRemoteSwitch#dim_socket_b(address, unit, dim_value) → nil
Parameter:
  • address – Typ: int, Wertebereich: [0 bis 226 - 1]
  • 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.

Neu in Version 2.0.1 (Plugin).

BrickletRemoteSwitch#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:

  • BrickletRemoteSwitch::SWITCH_TO_OFF = 0
  • BrickletRemoteSwitch::SWITCH_TO_ON = 1

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

BrickletRemoteSwitch#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 Schalt-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.

BrickletRemoteSwitch#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.

BrickletRemoteSwitch#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 'h', '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

BrickletRemoteSwitch#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.register_callback BrickletRemoteSwitch::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.

BrickletRemoteSwitch::CALLBACK_SWITCHING_DONE
Callback-Parameter:
  • keine Parameter

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

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.

BrickletRemoteSwitch#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.

BrickletRemoteSwitch#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:

  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET = 1
  • BrickletRemoteSwitch::FUNCTION_SET_REPEATS = 4
  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET_A = 6
  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET_B = 7
  • BrickletRemoteSwitch::FUNCTION_DIM_SOCKET_B = 8
  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET_C = 9
BrickletRemoteSwitch#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:

  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET = 1
  • BrickletRemoteSwitch::FUNCTION_SET_REPEATS = 4
  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET_A = 6
  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET_B = 7
  • BrickletRemoteSwitch::FUNCTION_DIM_SOCKET_B = 8
  • BrickletRemoteSwitch::FUNCTION_SWITCH_SOCKET_C = 9
BrickletRemoteSwitch#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

BrickletRemoteSwitch::DEVICE_IDENTIFIER

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

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

BrickletRemoteSwitch::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet dar.