Ruby - Master Brick

Dies ist die Beschreibung der Ruby API Bindings für den Master Brick. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Master Brick 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).

Stack Status

Download (example_stack_status.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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/brick_master'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XXYYZZ' # Change XXYYZZ to the UID of your Master Brick

ipcon = IPConnection.new # Create IP connection
master = BrickMaster.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Get current stack voltage
stack_voltage = master.get_stack_voltage
puts "Stack Voltage: #{stack_voltage/1000.0} V"

# Get current stack current
stack_current = master.get_stack_current
puts "Stack Current: #{stack_current/1000.0} A"

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

API

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

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

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

master = BrickMaster.new 'YOUR_DEVICE_UID', ipcon

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

BrickMaster#get_stack_voltage → int
Rückgabe:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die Spannung des Stapels zurück. Diese Spannung wird über den Stapel verteilt und kann zum Beispiel über eine Step-Down oder Step-Up Power Supply eingespeist werden.

Bemerkung

Es ist mit dieser Funktion nicht möglich, Spannungen, die per PoE oder USB eingespeist werden, zu messen.

BrickMaster#get_stack_current → int
Rückgabe:
  • current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Gibt den Stromverbrauch des Stapels zurück. Der angegebene Strom bezieht sich auf den Stromverbrauch der am Stapel angeschlossenen Verbraucher. Die Speisung kann z.B. über eine Step-Down oder Step-Up Power Supply erfolgen.

Bemerkung

Es ist mit dieser Funktion nicht möglich, den Stromverbrauch über PoE oder USB zu messen.

Fortgeschrittene Funktionen

BrickMaster#set_extension_type(extension, exttype) → nil
Parameter:
  • extension – Typ: int, Wertebereich: [0 bis 1]
  • exttype – Typ: int, Wertebereich: Siehe Konstanten

Schreibt den Typ der Extension in den EEPROM der angegebenen Extension. Die Extension kann entweder 0 oder 1 sein (0 ist die untere, 1 die obere, wenn nur eine Extension verfügbar ist, ist 0 zu verwenden)

Mögliche Extensiontypen:

Typ Beschreibung
1 Chibi
2 RS485
3 WIFI
4 Ethernet
5 WIFI 2.0

Der Typ der Extension ist schon gesetzt beim Erwerb der Extension und kann über den Brick Viewer gesetzt werden. Daher ist es unwahrscheinlich, dass diese Funktion benötigt wird.

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

Für exttype:

  • BrickMaster::EXTENSION_TYPE_CHIBI = 1
  • BrickMaster::EXTENSION_TYPE_RS485 = 2
  • BrickMaster::EXTENSION_TYPE_WIFI = 3
  • BrickMaster::EXTENSION_TYPE_ETHERNET = 4
  • BrickMaster::EXTENSION_TYPE_WIFI2 = 5
BrickMaster#get_extension_type(extension) → int
Parameter:
  • extension – Typ: int, Wertebereich: [0 bis 1]
Rückgabe:
  • exttype – Typ: int, Wertebereich: Siehe Konstanten

Gibt den Typ der angegebenen Extension zurück, wie von #set_extension_type gesetzt.

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

Für exttype:

  • BrickMaster::EXTENSION_TYPE_CHIBI = 1
  • BrickMaster::EXTENSION_TYPE_RS485 = 2
  • BrickMaster::EXTENSION_TYPE_WIFI = 3
  • BrickMaster::EXTENSION_TYPE_ETHERNET = 4
  • BrickMaster::EXTENSION_TYPE_WIFI2 = 5
BrickMaster#is_chibi_present → bool
Rückgabe:
  • present – Typ: bool

Gibt true zurück, wenn der Master Brick an Position 0 im Stapel und eine Chibi Extension verfügbar ist.

BrickMaster#set_chibi_address(address) → nil
Parameter:
  • address – Typ: int, Wertebereich: [1 bis 255]

Setzt die zugehörige Adresse der Chibi Extension.

Es ist möglich die Adresse mit dem Brick Viewer zu setzen und diese wird im EEPROM der Chibi Extension abgespeichert. Ein Setzen bei jedem Start ist daher nicht notwendig.

BrickMaster#get_chibi_address → int
Rückgabe:
  • address – Typ: int, Wertebereich: [1 bis 255]

Gibt die Adresse zurück, wie von #set_chibi_address gesetzt.

BrickMaster#set_chibi_master_address(address) → nil
Parameter:
  • address – Typ: int, Wertebereich: [1 bis 255]

Setzt die Adresse des Chibi Master. Diese Adresse wird verwendet wenn die Chibi Extension als Slave verwendet wird (z.B. wenn keine USB-Verbindung besteht).

Es ist möglich die Adresse mit dem Brick Viewer zu setzen und diese wird im EEPROM der Chibi Extension abgespeichert. Ein Setzen bei jedem Start ist daher nicht notwendig.

BrickMaster#get_chibi_master_address → int
Rückgabe:
  • address – Typ: int, Wertebereich: [1 bis 255]

Gibt die Adresse zurück, wie von #set_chibi_master_address gesetzt.

BrickMaster#set_chibi_slave_address(num, address) → nil
Parameter:
  • num – Typ: int, Wertebereich: [0 bis 254]
  • address – Typ: int, Wertebereich: [0 bis 255]

Setzt bis zu 254 Slave Adressen. 0 hat eine besondere Bedeutung, sie wird zur Terminierung der Liste verwendet und ist nicht als normale Slave Adresse erlaubt. Die Adressnummerierung (mittels num Parameter) muss aufsteigend ab 0 erfolgen. Beispiel: Wenn die Chibi Extension im Master Modus verwendet wird (z.B. wenn der Stapel eine USB-Verbindung hat) und es soll mit drei weiteren Chibi Stapeln kommuniziert werden, mit den Adressen 17, 23 und 42, sollten die Aufrufe (0, 17), (1, 23), (2, 42) und (3, 0) sein. Der letzte Aufruf mit (3, 0) dient der Terminierung der Liste und zeigt an, dass die Chibi Slave Adressliste in diesem Fall 3 Einträge beinhaltet.

Es ist möglich die Adressen mit dem Brick Viewer zu setzen, dieser kümmert sich dann um korrekte Adressnummerierung und Terminierung der Liste.

Die Slave Adresse werden im EEPROM der Chibi Extension abgespeichert. Ein Setzen bei jedem Start ist daher nicht notwendig.

BrickMaster#get_chibi_slave_address(num) → int
Parameter:
  • num – Typ: int, Wertebereich: [0 bis 254]
Rückgabe:
  • address – Typ: int, Wertebereich: [0 bis 255]

Gibt die Slave Adresse für eine Adressnummerierung (mittels num Parameter) zurück, wie von #set_chibi_slave_address gesetzt.

BrickMaster#get_chibi_signal_strength → int
Rückgabe:
  • signal_strength – Typ: int, Einheit: 1 dB, Wertebereich: [0 bis 255]

Gibt die Signalstärke in dBm zurück. Die Aktualisierung der Signalstärke wird bei jedem Empfang eines Paketes durchgeführt.

BrickMaster#get_chibi_error_log → [int, int, int, int]
Rückgabe-Array:
  • 0: underrun – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 1: crc_error – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 2: no_ack – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 3: overflow – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt folgende Fehlerzähler der Chibi Kommunikation zurück: Underrun, CRC Fehler, kein ACK und Overflow. Bei Anstieg dieser Fehlerzähler ist es wahrscheinlich, dass entweder die Entfernung zwischen zwei Chibi Stapeln zu groß wird oder Störungen vorliegen.

BrickMaster#set_chibi_frequency(frequency) → nil
Parameter:
  • frequency – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Chibi Frequenzbereich der Chibi Extension. Mögliche Werte sind:

Typ Beschreibung
0 OQPSK 868MHz (Europe)
1 OQPSK 915MHz (US)
2 OQPSK 780MHz (China)
3 BPSK40 915MHz

Es ist möglich den Frequenzbereich mit dem Brick Viewer zu setzen und dieser wird im EEPROM der Chibi Extension abgespeichert. Ein Setzen bei jedem Start ist daher nicht notwendig.

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

Für frequency:

  • BrickMaster::CHIBI_FREQUENCY_OQPSK_868_MHZ = 0
  • BrickMaster::CHIBI_FREQUENCY_OQPSK_915_MHZ = 1
  • BrickMaster::CHIBI_FREQUENCY_OQPSK_780_MHZ = 2
  • BrickMaster::CHIBI_FREQUENCY_BPSK40_915_MHZ = 3
BrickMaster#get_chibi_frequency → int
Rückgabe:
  • frequency – Typ: int, Wertebereich: Siehe Konstanten

Gibt den Frequenzbereich zurück, wie von #set_chibi_frequency gesetzt.

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

Für frequency:

  • BrickMaster::CHIBI_FREQUENCY_OQPSK_868_MHZ = 0
  • BrickMaster::CHIBI_FREQUENCY_OQPSK_915_MHZ = 1
  • BrickMaster::CHIBI_FREQUENCY_OQPSK_780_MHZ = 2
  • BrickMaster::CHIBI_FREQUENCY_BPSK40_915_MHZ = 3
BrickMaster#set_chibi_channel(channel) → nil
Parameter:
  • channel – Typ: int, Wertebereich: ?

Setzt den verwendeten Kanal der Chibi Extension. Die möglichen Kanäle sind abhängig vom verwendeten Frequenzbereich:

Frequenzbereich Mögliche Kanäle
OQPSK 868MHz (Europe) 0
OQPSK 915MHz (US) 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
OQPSK 780MHz (China) 0, 1, 2, 3
BPSK40 915MHz 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

Es ist möglich den Kanal mit dem Brick Viewer zu setzen und dieser wird im EEPROM der Chibi Extension abgespeichert. Ein Setzen bei jedem Start ist daher nicht notwendig.

BrickMaster#get_chibi_channel → int
Rückgabe:
  • channel – Typ: int, Wertebereich: ?

Gibt den Kanal zurück, wie von #set_chibi_channel gesetzt.

BrickMaster#is_rs485_present → bool
Rückgabe:
  • present – Typ: bool

Gibt true zurück, wenn der Master Brick an Position 0 im Stapel und eine RS485 Extension verfügbar ist.

BrickMaster#set_rs485_address(address) → nil
Parameter:
  • address – Typ: int, Wertebereich: [0 bis 255]

Setzt die zugehörige Adresse (0-255) der RS485 Extension.

Um eine RS485 Extension als RS485 Master (z.B. verbunden mit einem PC über USB) zu betreiben muss die Adresse auf 0 gesetzt werden.

Es ist möglich die Adresse mit dem Brick Viewer zu setzen und diese wird im EEPROM der RS485 Extension abgespeichert. Ein Setzen bei jedem Start ist daher nicht notwendig.

BrickMaster#get_rs485_address → int
Rückgabe:
  • address – Typ: int, Wertebereich: [0 bis 255]

Gibt die Adresse zurück, wie von #set_rs485_address gesetzt.

BrickMaster#set_rs485_slave_address(num, address) → nil
Parameter:
  • num – Typ: int, Wertebereich: [0 bis 255]
  • address – Typ: int, Wertebereich: [0 bis 255]

Setzt bis zu 255 Slave Adressen. Gültige Adressen sind 1-255. 0 hat eine besondere Bedeutung, sie wird zur Terminierung der Liste verwendet und ist nicht als normale Slave Adresse erlaubt. Die Adressnummerierung (mittels num Parameter) muss aufsteigend ab 0 erfolgen. Beispiel: Wenn die RS485 Extension im Master Modus verwendet wird (z.B. wenn der Stapel eine USB-Verbindung hat) und es soll mit drei weiteren RS485 Stapeln kommuniziert werden, mit den Adressen 17, 23 und 42, sollten die Aufrufe (0, 17), (1, 23), (2, 42) und (3, 0) sein. Der letzte Aufruf mit (3, 0) dient der Terminierung der Liste und zeigt an, dass die RS485 Slave Adressliste in diesem Fall 3 Einträge beinhaltet.

Es ist möglich die Adressen mit dem Brick Viewer zu setzen, dieser kümmert sich dann um korrekte Adressnummerierung und Terminierung der Liste.

Die Slave Adresse werden im EEPROM der RS485 Extension abgespeichert. Ein Setzen bei jedem Start ist daher nicht notwendig.

BrickMaster#get_rs485_slave_address(num) → int
Parameter:
  • num – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • address – Typ: int, Wertebereich: [0 bis 255]

Gibt die Slave Adresse für eine Adressnummerierung (mittels num Parameter) zurück, wie von #set_rs485_slave_address gesetzt.

BrickMaster#get_rs485_error_log → int
Rückgabe:
  • crc_error – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt den CRC Fehlerzähler der RS485 Kommunikation zurück. Wenn dieser Zähler ansteigt ist es wahrscheinlich, dass der Abstand zwischen zwei RS485-Teilnehmern zu groß ist oder es Störungen gibt.

BrickMaster#set_rs485_configuration(speed, parity, stopbits) → nil
Parameter:
  • speed – Typ: int, Einheit: 1 Bd, Wertebereich: [0 bis 232 - 1]
  • parity – Typ: chr, Wertebereich: Siehe Konstanten
  • stopbits – Typ: int, Wertebereich: [1 bis 2]

Setzt die Schnittstellenkonfiguration der RS485 Extension. Der Master Brick versucht die vorgegebene Baudrate so genau wie möglich zu erreichen. Die maximale empfohlene Baudrate ist 2000000 (2MBd). Mögliche Werte für die Parität sind 'n' (keine), 'e' (gerade) und 'o' (ungerade).

Wenn die RS485 Kommunikation instabil ist (verlorene Nachrichten etc.), sollte zuerst die Baudrate verringert werden. Sehr lange Busleitungen (z.B. 1km) sollten möglichst Werte im Bereich von 100000 (100kBd) verwenden.

Die Werte sind im EEPROM gespeichert und werden nur beim Start angewandt. Dass bedeutet, der Master Brick muss nach einer Konfiguration neu gestartet werden.

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

Für parity:

  • BrickMaster::RS485_PARITY_NONE = 'n'
  • BrickMaster::RS485_PARITY_EVEN = 'e'
  • BrickMaster::RS485_PARITY_ODD = 'o'
BrickMaster#get_rs485_configuration → [int, chr, int]
Rückgabe-Array:
  • 0: speed – Typ: int, Einheit: 1 Bd, Wertebereich: [0 bis 232 - 1]
  • 1: parity – Typ: chr, Wertebereich: Siehe Konstanten
  • 2: stopbits – Typ: int, Wertebereich: [1 bis 2]

Gibt die Schnittstellenkonfiguration zurück, wie von #set_rs485_configuration gesetzt.

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

Für parity:

  • BrickMaster::RS485_PARITY_NONE = 'n'
  • BrickMaster::RS485_PARITY_EVEN = 'e'
  • BrickMaster::RS485_PARITY_ODD = 'o'
BrickMaster#is_wifi_present → bool
Rückgabe:
  • present – Typ: bool

Gibt true zurück, wenn der Master Brick an Position 0 im Stapel und eine WIFI Extension verfügbar ist.

BrickMaster#set_wifi_configuration(ssid, connection, ip, subnet_mask, gateway, port) → nil
Parameter:
  • ssid – Typ: str, Länge: bis zu 32
  • connection – Typ: int, Wertebereich: Siehe Konstanten
  • ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • port – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 4223

Setzt die Konfiguration der WIFI Extension. Die ssid darf eine maximale Länge von 32 Zeichen haben. Mögliche Werte für connection sind:

Wert Beschreibung
0 DHCP
1 Statische IP
2 Access Point: DHCP
3 Access Point: Statische IP
4 Ad Hoc: DHCP
5 Ad Hoc: Statische IP

Wenn connection auf eine der statische IP Optionen gesetzt wird, dann müssen ip, subnet_mask und gateway als ein Array der Größe 4 angegeben werden. Dabei ist das erste Element im Array das niederwertigste Byte. Falls connection auf eine der DHCP Optionen gesetzt ist, werden ip, subnet_mask und gateway ignoriert.

Der letzte Parameter ist der Port auf den das Anwendungsprogramm sich verbindet.

Die Werte sind im EEPROM gespeichert und werden nur beim Start angewandt. Dass bedeutet, der Master Brick muss nach einer Konfiguration neu gestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die WIFI Extension zu konfigurieren.

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

Für connection:

  • BrickMaster::WIFI_CONNECTION_DHCP = 0
  • BrickMaster::WIFI_CONNECTION_STATIC_IP = 1
  • BrickMaster::WIFI_CONNECTION_ACCESS_POINT_DHCP = 2
  • BrickMaster::WIFI_CONNECTION_ACCESS_POINT_STATIC_IP = 3
  • BrickMaster::WIFI_CONNECTION_AD_HOC_DHCP = 4
  • BrickMaster::WIFI_CONNECTION_AD_HOC_STATIC_IP = 5
BrickMaster#get_wifi_configuration → [str, int, [int, ...], [int, ...], [int, ...], int]
Rückgabe-Array:
  • 0: ssid – Typ: str, Länge: bis zu 32
  • 1: connection – Typ: int, Wertebereich: Siehe Konstanten
  • 2: ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 3: subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 4: gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 5: port – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 4223

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

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

Für connection:

  • BrickMaster::WIFI_CONNECTION_DHCP = 0
  • BrickMaster::WIFI_CONNECTION_STATIC_IP = 1
  • BrickMaster::WIFI_CONNECTION_ACCESS_POINT_DHCP = 2
  • BrickMaster::WIFI_CONNECTION_ACCESS_POINT_STATIC_IP = 3
  • BrickMaster::WIFI_CONNECTION_AD_HOC_DHCP = 4
  • BrickMaster::WIFI_CONNECTION_AD_HOC_STATIC_IP = 5
BrickMaster#set_wifi_encryption(encryption, key, key_index, eap_options, ca_certificate_length, client_certificate_length, private_key_length) → nil
Parameter:
  • encryption – Typ: int, Wertebereich: Siehe Konstanten
  • key – Typ: str, Länge: bis zu 50
  • key_index – Typ: int, Wertebereich: [1 bis 4]
  • eap_options – Typ: int, Wertebereich: Siehe Konstanten
  • ca_certificate_length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 1312]
  • client_certificate_length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 1312]
  • private_key_length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 4320]

Setzt die Verschlüsselung der WIFI Extension. Der erste Parameter ist der Typ der Verschlüsselung. Mögliche Werte sind:

Wert Beschreibung
0 WPA/WPA2
1 WPA Enterprise (EAP-FAST, EAP-TLS, EAP-TTLS, PEAP)
2 WEP
3 Keine Verschlüsselung

Der key hat eine maximale Länge von 50 Zeichen und wird benutzt falls encryption auf 0 oder 2 (WPA/WPA2 oder WEP) gesetzt ist. Andernfalls wird dieser Parameter ignoriert.

Für WPA/WPA2 muss der Schlüssel mindestens 8 Zeichen lang sein. Wenn ein Schlüssel mit mehr als 50 Zeichen gesetzt werden soll, kann #set_long_wifi_key genutzt werden.

Für WEP muss der Schlüssel entweder 10 oder 26 hexadezimale Zeichen lang sein. Es ist möglich den key_index zu setzen (1-4). Fall der key_index unbekannt ist, ist er wahrscheinlich 1.

Wenn WPA Enterprise als encryption gewählt wird, müssen eap_options und die Länge der Zertifikate gesetzt werden. Die Zertifikate selbst können mit #set_wifi_certificate übertragen werden. Die eap_options bestehen aus Outer Authentication (Bits 1-2), Inner Authentication (Bit 3) und Certificate Type (Bits 4-5):

Option Bits Beschreibung
Outer Authentication 1-2 0=EAP-FAST, 1=EAP-TLS, 2=EAP-TTLS, 3=EAP-PEAP
Inner Authentication 3 0=EAP-MSCHAP, 1=EAP-GTC
Certificate Type 4-5 0=CA Certificate, 1=Client Certificate, 2=Private Key

Beispiel für EAP-TTLS + EAP-GTC + Private Key: option = 2 | (1 << 2) | (2 << 3).

Die Werte sind im EEPROM gespeichert und werden nur beim Start angewandt. Das bedeutet der Master Brick muss nach einer Konfiguration neu gestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die WLAN Verschlüsselung zu konfigurieren.

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

Für encryption:

  • BrickMaster::WIFI_ENCRYPTION_WPA_WPA2 = 0
  • BrickMaster::WIFI_ENCRYPTION_WPA_ENTERPRISE = 1
  • BrickMaster::WIFI_ENCRYPTION_WEP = 2
  • BrickMaster::WIFI_ENCRYPTION_NO_ENCRYPTION = 3

Für eap_options:

  • BrickMaster::WIFI_EAP_OPTION_OUTER_AUTH_EAP_FAST = 0
  • BrickMaster::WIFI_EAP_OPTION_OUTER_AUTH_EAP_TLS = 1
  • BrickMaster::WIFI_EAP_OPTION_OUTER_AUTH_EAP_TTLS = 2
  • BrickMaster::WIFI_EAP_OPTION_OUTER_AUTH_EAP_PEAP = 3
  • BrickMaster::WIFI_EAP_OPTION_INNER_AUTH_EAP_MSCHAP = 0
  • BrickMaster::WIFI_EAP_OPTION_INNER_AUTH_EAP_GTC = 4
  • BrickMaster::WIFI_EAP_OPTION_CERT_TYPE_CA_CERT = 0
  • BrickMaster::WIFI_EAP_OPTION_CERT_TYPE_CLIENT_CERT = 8
  • BrickMaster::WIFI_EAP_OPTION_CERT_TYPE_PRIVATE_KEY = 16
BrickMaster#get_wifi_encryption → [int, str, int, int, int, int, int]
Rückgabe-Array:
  • 0: encryption – Typ: int, Wertebereich: Siehe Konstanten
  • 1: key – Typ: str, Länge: bis zu 50
  • 2: key_index – Typ: int, Wertebereich: [1 bis 4]
  • 3: eap_options – Typ: int, Wertebereich: Siehe Konstanten
  • 4: ca_certificate_length – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 5: client_certificate_length – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 6: private_key_length – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Verschlüsselungseinstellungen zurück, wie von #set_wifi_encryption gesetzt.

Bemerkung

Seit Master Brick Firmware Version 2.4.4 wird der Schlüssel nicht mehr zurückgegeben.

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

Für encryption:

  • BrickMaster::WIFI_ENCRYPTION_WPA_WPA2 = 0
  • BrickMaster::WIFI_ENCRYPTION_WPA_ENTERPRISE = 1
  • BrickMaster::WIFI_ENCRYPTION_WEP = 2
  • BrickMaster::WIFI_ENCRYPTION_NO_ENCRYPTION = 3

Für eap_options:

  • BrickMaster::WIFI_EAP_OPTION_OUTER_AUTH_EAP_FAST = 0
  • BrickMaster::WIFI_EAP_OPTION_OUTER_AUTH_EAP_TLS = 1
  • BrickMaster::WIFI_EAP_OPTION_OUTER_AUTH_EAP_TTLS = 2
  • BrickMaster::WIFI_EAP_OPTION_OUTER_AUTH_EAP_PEAP = 3
  • BrickMaster::WIFI_EAP_OPTION_INNER_AUTH_EAP_MSCHAP = 0
  • BrickMaster::WIFI_EAP_OPTION_INNER_AUTH_EAP_GTC = 4
  • BrickMaster::WIFI_EAP_OPTION_CERT_TYPE_CA_CERT = 0
  • BrickMaster::WIFI_EAP_OPTION_CERT_TYPE_CLIENT_CERT = 8
  • BrickMaster::WIFI_EAP_OPTION_CERT_TYPE_PRIVATE_KEY = 16
BrickMaster#get_wifi_status → [[int, ...], [int, ...], int, int, [int, ...], [int, ...], [int, ...], int, int, int]
Rückgabe-Array:
  • 0: mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
  • 1: bssid – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
  • 2: channel – Typ: int, Wertebereich: ?
  • 3: rssi – Typ: int, Wertebereich: [-215 bis 215 - 1]
  • 4: ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 5: subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 6: gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 7: rx_count – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 8: tx_count – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 9: state – Typ: int, Wertebereich: Siehe Konstanten

Gibt den Status der WIFI Extension zurück. state wird automatisch aktualisiert, alle anderen Parameter werden nur beim Starten und nach jedem Aufruf von #refresh_wifi_status aktualisiert.

Mögliche Werte für state sind:

State Beschreibung
0 Getrennt
1 Verbunden
2 Verbindung wird aufgebaut
3 Fehler
255 Noch nicht initialisiert

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

Für state:

  • BrickMaster::WIFI_STATE_DISASSOCIATED = 0
  • BrickMaster::WIFI_STATE_ASSOCIATED = 1
  • BrickMaster::WIFI_STATE_ASSOCIATING = 2
  • BrickMaster::WIFI_STATE_ERROR = 3
  • BrickMaster::WIFI_STATE_NOT_INITIALIZED_YET = 255
BrickMaster#refresh_wifi_status → nil

Aktualisiert den WLAN Status (siehe #get_wifi_status). Um den Status vom WLAN Modul zu lesen, muss der Master Brick vom Datenmodus in den Kommandomodus und wieder zurück wechseln. Dieser Wechsel und das eigentliche Auslesen ist leider zeitaufwändig. Dass heißt, es dauert ein paar ms bis der Stapel mit aufgesteckter WIFI Extension wieder reagiert nachdem die Funktion aufgerufen wurde.

BrickMaster#set_wifi_certificate(index, data, data_length) → nil
Parameter:
  • index – Typ: int, Wertebereich: [0 bis 1311, 10000 bis 11311, 20000 bis 24319, 65534 bis 216 - 1]
  • data – Typ: [int, ...], Länge: 32, Wertebereich: [0 bis 255]
  • data_length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 32]

Diese Funktion kann benutzt werden um sowohl das Zertifikat als auch Benutzername und Passwort für WPA Enterprise zu setzen. Für den Benutzernamen muss Index 0xFFFF und für das Password Index 0xFFFE genutzt werden. Die maximale Länge für beide ist 32.

Das Zertifikat wird in Chunks der Größe 32 geschrieben und der Index gibt den Index des Chunk an. data_length sollte fast immer auf 32 gesetzt werden. Nur beim letzten Chunk ist eine Länge ungleich 32 möglich.

Der Startindex für CA Certificate ist 0, für Client Certificate 10000 und für Private Key 20000. Die Maximalen Dateigrößen sind jeweils 1312, 1312 und 4320 Byte.

Die Werte sind im EEPROM gespeichert und werden nur beim Start angewandt. Das bedeutet der Master Brick muss nach einer Konfiguration neu gestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die Zertifikate, Benutzernamen und Passwort zu konfigurieren.

BrickMaster#get_wifi_certificate(index) → [[int, ...], int]
Parameter:
  • index – Typ: int, Wertebereich: [0 bis 1311, 10000 bis 11311, 20000 bis 24319, 65534 bis 216 - 1]
Rückgabe-Array:
  • 0: data – Typ: [int, ...], Länge: 32, Wertebereich: [0 bis 255]
  • 1: data_length – Typ: int, Wertebereich: [0 bis 32]

Gibt das Zertifikat für einen Index zurück, wie von #set_wifi_certificate gesetzt.

BrickMaster#set_wifi_power_mode(mode) → nil
Parameter:
  • mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den Stromsparmodus für die WIFI Extension. Mögliche Werte sind:

Mode Beschreibung
0 Full Speed (hoher Stromverbrauch, hoher Durchsatz)
1 Low Power (geringer Stromverbrauch, geringer Durchsatz)

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

Für mode:

  • BrickMaster::WIFI_POWER_MODE_FULL_SPEED = 0
  • BrickMaster::WIFI_POWER_MODE_LOW_POWER = 1
BrickMaster#get_wifi_power_mode → int
Rückgabe:
  • mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den Stromsparmodus zurück, wie von #set_wifi_power_mode gesetzt.

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

Für mode:

  • BrickMaster::WIFI_POWER_MODE_FULL_SPEED = 0
  • BrickMaster::WIFI_POWER_MODE_LOW_POWER = 1
BrickMaster#get_wifi_buffer_info → [int, int, int]
Rückgabe-Array:
  • 0: overflow – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 1: low_watermark – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 1500]
  • 2: used – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 1500]

Gibt Informationen über denn WLAN Empfangsbuffer zurück. Der WLAN Empfangsbuffer hat eine maximale Größe von 1500 Byte und falls zu viele Daten übertragen werden, kann er überlaufen.

Die Rückgabewerte sind die Anzahl der Overflows, die Low-Watermark (d.h. die kleinste Anzahl an Byte die je noch frei waren im Buffer) und die Anzahl der im Moment verwendeten Bytes im Buffer.

Es sollte immer versucht werden den Buffer leer zu halten, andernfalls ist mit einer permanenten Latenz zu rechnen. Eine gute Daumenregel ist, nicht mehr als 1000 Nachrichten pro Sekunde zu verschicken.

Dabei sollten am besten nie mehr als 50 Nachrichten auf einmal ohne Pausen gesendet werden.

BrickMaster#set_wifi_regulatory_domain(domain) → nil
Parameter:
  • domain – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Setzt den Geltungsbereich der WIFI Extension. Mögliche Werte sind:

Geltungsbereich Beschreibung
0 FCC: Kanal 1-11 (N/S Amerika, Australien, Neuseeland)
1 ETSI: Kanal 1-13 (Europa, Mittlerer Osten, Afrika)
2 TELEC: Kanal 1-14 (Japan)

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

Für domain:

  • BrickMaster::WIFI_DOMAIN_CHANNEL_1TO11 = 0
  • BrickMaster::WIFI_DOMAIN_CHANNEL_1TO13 = 1
  • BrickMaster::WIFI_DOMAIN_CHANNEL_1TO14 = 2
BrickMaster#get_wifi_regulatory_domain → int
Rückgabe:
  • domain – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 1

Gibt den Geltungsbereich zurück, wie von #set_wifi_regulatory_domain gesetzt.

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

Für domain:

  • BrickMaster::WIFI_DOMAIN_CHANNEL_1TO11 = 0
  • BrickMaster::WIFI_DOMAIN_CHANNEL_1TO13 = 1
  • BrickMaster::WIFI_DOMAIN_CHANNEL_1TO14 = 2
BrickMaster#get_usb_voltage → int
Rückgabe:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die USB Spannung zurück. Funktioniert nicht mit Hardware Version 2.1.

BrickMaster#set_long_wifi_key(key) → nil
Parameter:
  • key – Typ: str, Länge: bis zu 64

Setzt einen langen WLAN Schlüssel (bis zu 63 Zeichen, mindestens 8 Zeichen) für WPA Verschlüsselung. Dieser Schlüssel wird genutzt, wenn der Schlüssel in #set_wifi_encryption auf "-" gesetzt wird. Im alten Protokoll war ein Payload der Größe 63 nicht möglich, dadurch wurde die maximale Schlüssellänge auf 50 gesetzt.

Mit dem neuen Protokoll ist die volle Schlüssellänge möglich. Da wir keine API brechen wollten, wurde diese Funktion zusätzlich hinzugefügt.

Neu in Version 2.0.2 (Firmware).

BrickMaster#get_long_wifi_key → str
Rückgabe:
  • key – Typ: str, Länge: bis zu 64

Gibt den Verschlüsselungsschlüssel zurück, wie von #set_long_wifi_key gesetzt.

Bemerkung

Seit Master Brick Firmware Version 2.4.4 wird der Schlüssel nicht mehr zurückgegeben.

Neu in Version 2.0.2 (Firmware).

BrickMaster#set_wifi_hostname(hostname) → nil
Parameter:
  • hostname – Typ: str, Länge: bis zu 16

Setzt den Hostnamen der WIFI Extension. Der Hostname wird von Access Points als Hostname in der DHCP Client Tabelle angezeigt.

Das Setzen eines leeren Strings stellt den voreingestellten Hostnamen wieder her.

Neu in Version 2.0.5 (Firmware).

BrickMaster#get_wifi_hostname → str
Rückgabe:
  • hostname – Typ: str, Länge: bis zu 16

Gibt den Hostnamen zurück, wie von #set_wifi_hostname gesetzt.

Ein leerer String bedeutet, dass der voreingestellte Hostname genutzt wird.

Neu in Version 2.0.5 (Firmware).

BrickMaster#is_ethernet_present → bool
Rückgabe:
  • present – Typ: bool

Gibt true zurück, wenn der Master Brick an Position 0 im Stapel und eine Ethernet Extension verfügbar ist.

Neu in Version 2.1.0 (Firmware).

BrickMaster#set_ethernet_configuration(connection, ip, subnet_mask, gateway, port) → nil
Parameter:
  • connection – Typ: int, Wertebereich: Siehe Konstanten
  • ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • port – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 4223

Setzt die Konfiguration der Ethernet Extension. Mögliche Werte für connection sind:

Wert Beschreibung
0 DHCP
1 Statische IP

Wenn connection auf die statische IP Option gesetzt wird, dann müssen ip, subnet_mask und gateway als ein Array der Größe 4 angegeben werden. Dabei ist das erste Element im Array das niederwertigste Byte. Falls connection auf die DHCP Option gesetzt ist, werden ip, subnet_mask und gateway ignoriert.

Der letzte Parameter ist der Port auf den das Anwendungsprogramm sich verbindet.

Die Werte sind im EEPROM gespeichert und werden nur beim Start angewandt. Das bedeutet der Master Brick muss nach einer Konfiguration neu gestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die Ethernet Extension zu konfigurieren.

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

Für connection:

  • BrickMaster::ETHERNET_CONNECTION_DHCP = 0
  • BrickMaster::ETHERNET_CONNECTION_STATIC_IP = 1

Neu in Version 2.1.0 (Firmware).

BrickMaster#get_ethernet_configuration → [int, [int, ...], [int, ...], [int, ...], int]
Rückgabe-Array:
  • 0: connection – Typ: int, Wertebereich: Siehe Konstanten
  • 1: ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 2: subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 3: gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 4: port – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 4223

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

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

Für connection:

  • BrickMaster::ETHERNET_CONNECTION_DHCP = 0
  • BrickMaster::ETHERNET_CONNECTION_STATIC_IP = 1

Neu in Version 2.1.0 (Firmware).

BrickMaster#get_ethernet_status → [[int, ...], [int, ...], [int, ...], [int, ...], int, int, str]
Rückgabe-Array:
  • 0: mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
  • 1: ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 2: subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 3: gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 4: rx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • 5: tx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • 6: hostname – Typ: str, Länge: bis zu 32

Gibt den Status der Ethernet Extension zurück.

mac_address, ip, subnet_mask und gateway werden als Array übergeben. Das erste Element des Arrays ist das niederwertigste Byte.

rx_count und tx_count sind die Anzahl der Bytes die seit dem letzten Neustart empfangen/gesendet wurden.

hostname ist der aktuell genutzte Hostname.

Neu in Version 2.1.0 (Firmware).

BrickMaster#set_ethernet_hostname(hostname) → nil
Parameter:
  • hostname – Typ: str, Länge: bis zu 32

Setzt den Hostnamen der Ethernet Extension. Der Hostname wird von Access Points als Hostname in der DHCP Client Tabelle angezeigt.

Das setzen eines leeren Strings stellt den voreingestellten Hostnamen wieder her.

Der aktuelle Hostname kann mit #get_ethernet_status herausgefunden werden.

Neu in Version 2.1.0 (Firmware).

BrickMaster#set_ethernet_mac_address(mac_address) → nil
Parameter:
  • mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]

Setzt die MAC Adresse der Ethernet Extension. Die Ethernet Extension sollte mit einer vorkonfigurierten MAC Adresse ausgeliefert werden. Diese MAC Adresse steht auch auf einem Aufkleber auf der Ethernet Extension.

Die MAC Adresse kann mit #get_ethernet_status wieder ausgelesen werden.

Neu in Version 2.1.0 (Firmware).

BrickMaster#set_ethernet_websocket_configuration(sockets, port) → nil
Parameter:
  • sockets – Typ: int, Wertebereich: [0 bis 7], Standardwert: 3
  • port – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 4280

Setzt die Ethernet WebSocket-Konfiguration. Der erste Parameter setzt die Anzahl der Socket-Verbindungen die für WebSockets reserviert werden. Der mögliche Wertebereich ist 0-7. Die Verbindungen werden zwischen den normalen Sockets und den WebSockets aufgeteilt. Beispiel: Wenn die Socket-Verbindungen auf 3 gesetzt werden, stehen 3 WebSockets und 4 normale Sockets zur Verfügung.

Der zweite Parameter ist der Port für die WebSocket-Verbindungen. Der Port kann nicht der gleiche sein wie der Port des normalen Sockets.

Die Werte sind im EEPROM gespeichert und werden nur beim Start angewandt. Das bedeutet der Master Brick muss nach einer Konfiguration neu gestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die Ethernet Extension zu konfigurieren.

Neu in Version 2.2.0 (Firmware).

BrickMaster#get_ethernet_websocket_configuration → [int, int]
Rückgabe-Array:
  • 0: sockets – Typ: int, Wertebereich: [0 bis 7], Standardwert: 3
  • 1: port – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 4280

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

Neu in Version 2.2.0 (Firmware).

BrickMaster#set_ethernet_authentication_secret(secret) → nil
Parameter:
  • secret – Typ: str, Länge: bis zu 64, Standardwert: ''

Setzt das Authentifizierungsgeheimnis. Das Geheimnis ist ein String aus bis zu 64 Buchstaben. Ein leerer String deaktiviert die Authentifizierung.

Für mehr Informationen zur Authentifizierung siehe das dazugehörige Tutorial.

Das Authentifizierungsgehemnis wird im EEPROM gespeichert und nur beim Start angewandt. Das bedeutet der Master Brick muss nach einer Konfiguration neu gestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die Authentifizierung der Ethernet Extension einzurichten.

Der Standardwert ist ein leerer String (Authentifizierung deaktiviert).

Neu in Version 2.2.0 (Firmware).

BrickMaster#get_ethernet_authentication_secret → str
Rückgabe:
  • secret – Typ: str, Länge: bis zu 64, Standardwert: ''

Gibt das Authentifizierungsgeheimnis zurück, wie von #set_ethernet_authentication_secret gesetzt.

Neu in Version 2.2.0 (Firmware).

BrickMaster#set_wifi_authentication_secret(secret) → nil
Parameter:
  • secret – Typ: str, Länge: bis zu 64, Standardwert: ''

Setzt das Authentifizierungsgeheimnis. Das Geheimnis ist ein String aus bis zu 64 Buchstaben. Ein leerer String deaktiviert die Authentifizierung.

Für mehr Informationen zur Authentifizierung siehe das dazugehörige Tutorial.

Das Authentifizierungsgehemnis wird im EEPROM gespeichert und nur beim Start angewandt. Das bedeutet der Master Brick muss nach einer Konfiguration neu gestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die Authentifizierung der WIFI Extension einzurichten.

Der Standardwert ist ein leerer String (Authentifizierung deaktiviert).

Neu in Version 2.2.0 (Firmware).

BrickMaster#get_wifi_authentication_secret → str
Rückgabe:
  • secret – Typ: str, Länge: bis zu 64, Standardwert: ''

Gibt das Authentifizierungsgeheimnis zurück, wie von #set_wifi_authentication_secret gesetzt.

Neu in Version 2.2.0 (Firmware).

BrickMaster#get_connection_type → int
Rückgabe:
  • connection_type – Typ: int, Wertebereich: Siehe Konstanten

Gibt den Typ der Verbingung zurück, über welche diese Funktion aufgerufen wurde.

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

Für connection_type:

  • BrickMaster::CONNECTION_TYPE_NONE = 0
  • BrickMaster::CONNECTION_TYPE_USB = 1
  • BrickMaster::CONNECTION_TYPE_SPI_STACK = 2
  • BrickMaster::CONNECTION_TYPE_CHIBI = 3
  • BrickMaster::CONNECTION_TYPE_RS485 = 4
  • BrickMaster::CONNECTION_TYPE_WIFI = 5
  • BrickMaster::CONNECTION_TYPE_ETHERNET = 6
  • BrickMaster::CONNECTION_TYPE_WIFI2 = 7

Neu in Version 2.4.0 (Firmware).

BrickMaster#is_wifi2_present → bool
Rückgabe:
  • present – Typ: bool

Gibt true zurück, wenn der Master Brick an Position 0 im Stapel und eine WIFI Extension 2.0 verfügbar ist.

Neu in Version 2.4.0 (Firmware).

BrickMaster#start_wifi2_bootloader → int
Rückgabe:
  • result – Typ: int, Wertebereich: [-128 bis 127]

Startet den Bootloader der WIFI Extension 2.0. Gibt bei Erfolg 0 zurück. Danach können die #write_wifi2_serial_port und #read_wifi2_serial_port Funktionen zur Kommunikation mit dem Bootloader verwendet werden, um eine neue Firmware zu flashen.

Der Bootloader sollte nur über eine USB Verbindung gestartet werden. Er kann nicht über eine WIFI2 Verbindung gestartet werden, siehe die #get_connection_type Funktion.

Wir empfehlen den Brick Viewer zu verwenden, um die Firmware der WIFI Extension 2.0 zu aktualisieren.

Neu in Version 2.4.0 (Firmware).

BrickMaster#write_wifi2_serial_port(data, length) → int
Parameter:
  • data – Typ: [int, ...], Länge: 60, Wertebereich: [0 bis 255]
  • length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 60]
Rückgabe:
  • result – Typ: int, Wertebereich: [-128 bis 127]

Schreibt bis zu 60 Bytes (Anzahl zu schreibender Bytes mit length angeben) auf die serielle Schnittstelle des Bootloaders der WIFI Extension 2.0. Gibt bei Erfolg 0 zurück.

Bevor diese Funktion genutzt werden kann muss der Bootloader mit der #start_wifi2_bootloader Funktion gestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die Firmware der WIFI Extension 2.0 zu aktualisieren.

Neu in Version 2.4.0 (Firmware).

BrickMaster#read_wifi2_serial_port(length) → [[int, ...], int]
Parameter:
  • length – Typ: int, Wertebereich: [0 bis 255]
Rückgabe-Array:
  • 0: data – Typ: [int, ...], Länge: 60, Wertebereich: [0 bis 60]
  • 1: result – Typ: int, Wertebereich: [0 bis 255]

Liest bis zu 60 Bytes (Anzahl zu lesender Bytes mit length angegeben) von der seriellen Schnittstelle des Bootloaders der WIFI Extension 2.0. Gibt die Anzahl der wirklich gelesenen Bytes zurück.

Bevor diese Funktion genutzt werden kann muss der Bootloader mit der #start_wifi2_bootloader Funktion gestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die Firmware der WIFI Extension 2.0 zu aktualisieren.

Neu in Version 2.4.0 (Firmware).

BrickMaster#set_wifi2_authentication_secret(secret) → nil
Parameter:
  • secret – Typ: str, Länge: bis zu 64

Setzt das WLAN-Authentifizierungsgeheimnis. Das Geheimnis ist ein String aus bis zu 64 Buchstaben. Ein leerer String deaktiviert die Authentifizierung. Der Standardwert ist ein leerer String (Authentifizierung deaktiviert).

Für mehr Informationen zur Authentifizierung siehe das dazugehörige Tutorial.

Um Konfigurationsänderungen für die WIFI Extension 2.0 zu übernehmen muss die #save_wifi2_configuration Funktion aufgerufen und der Master Brick danach neugestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die WIFI Extension 2.0 zu konfigurieren.

Neu in Version 2.4.0 (Firmware).

BrickMaster#get_wifi2_authentication_secret → str
Rückgabe:
  • secret – Typ: str, Länge: bis zu 64

Gibt das WLAN-Authentifizierungsgeheimnis zurück, wie von #set_wifi2_authentication_secret gesetzt.

Neu in Version 2.4.0 (Firmware).

BrickMaster#set_wifi2_configuration(port, websocket_port, website_port, phy_mode, sleep_mode, website) → nil
Parameter:
  • port – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 4223
  • websocket_port – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 4280
  • website_port – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 80
  • phy_mode – Typ: int, Wertebereich: Siehe Konstanten
  • sleep_mode – Typ: int, Wertebereich: [0 bis 255]
  • website – Typ: int, Wertebereich: [0 bis 255]

Setzt die allgemeine Konfiguration der WIFI Extension 2.0.

Der port Parameter setzt die Portnummer auf die sich das Anwendungsprogramm verbindet.

Der websocket_port Parameter setzt die WebSocket-Portnummer auf die sich das JavaScript Anwendungsprogramm verbindet.

Der website_port Parameter setzt die Portnummer für die Webseite der WIFI Extension 2.0.

Der phy_mode Parameter setzt den zu verwendenden WLAN-Modus. Mögliche Werte sinf B, G und N.

Die sleep_mode und website Parameter werden momentan nicht verwendet.

Um Konfigurationsänderungen für die WIFI Extension 2.0 zu übernehmen muss die #save_wifi2_configuration Funktion aufgerufen und der Master Brick danach neugestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die WIFI Extension 2.0 zu konfigurieren.

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

Für phy_mode:

  • BrickMaster::WIFI2_PHY_MODE_B = 0
  • BrickMaster::WIFI2_PHY_MODE_G = 1
  • BrickMaster::WIFI2_PHY_MODE_N = 2

Neu in Version 2.4.0 (Firmware).

BrickMaster#get_wifi2_configuration → [int, int, int, int, int, int]
Rückgabe-Array:
  • 0: port – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 4223
  • 1: websocket_port – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 4280
  • 2: website_port – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 80
  • 3: phy_mode – Typ: int, Wertebereich: Siehe Konstanten
  • 4: sleep_mode – Typ: int, Wertebereich: [0 bis 255]
  • 5: website – Typ: int, Wertebereich: [0 bis 255]

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

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

Für phy_mode:

  • BrickMaster::WIFI2_PHY_MODE_B = 0
  • BrickMaster::WIFI2_PHY_MODE_G = 1
  • BrickMaster::WIFI2_PHY_MODE_N = 2

Neu in Version 2.4.0 (Firmware).

BrickMaster#get_wifi2_status → [bool, int, [int, ...], [int, ...], [int, ...], [int, ...], int, int, int, bool, [int, ...], [int, ...], [int, ...], [int, ...], int, int, int]
Rückgabe-Array:
  • 0: client_enabled – Typ: bool
  • 1: client_status – Typ: int, Wertebereich: Siehe Konstanten
  • 2: client_ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 3: client_subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 4: client_gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 5: client_mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
  • 6: client_rx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • 7: client_tx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • 8: client_rssi – Typ: int, Wertebereich: [-128 bis 127]
  • 9: ap_enabled – Typ: bool
  • 10: ap_ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 11: ap_subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 12: ap_gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 13: ap_mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
  • 14: ap_rx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • 15: ap_tx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • 16: ap_connected_count – Typ: int, Wertebereich: [0 bis 255]

Gibt den Client und Access Point Status der WIFI Extension 2.0 zurück.

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

Für client_status:

  • BrickMaster::WIFI2_CLIENT_STATUS_IDLE = 0
  • BrickMaster::WIFI2_CLIENT_STATUS_CONNECTING = 1
  • BrickMaster::WIFI2_CLIENT_STATUS_WRONG_PASSWORD = 2
  • BrickMaster::WIFI2_CLIENT_STATUS_NO_AP_FOUND = 3
  • BrickMaster::WIFI2_CLIENT_STATUS_CONNECT_FAILED = 4
  • BrickMaster::WIFI2_CLIENT_STATUS_GOT_IP = 5
  • BrickMaster::WIFI2_CLIENT_STATUS_UNKNOWN = 255

Neu in Version 2.4.0 (Firmware).

BrickMaster#set_wifi2_client_configuration(enable, ssid, ip, subnet_mask, gateway, mac_address, bssid) → nil
Parameter:
  • enable – Typ: bool, Standardwert: true
  • ssid – Typ: str, Länge: bis zu 32
  • ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
  • bssid – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]

Setzt die Client-spezifische Konfiguration der WIFI Extension 2.0.

Der enable Parameter aktiviert oder deaktiviert den Client-Teil der WIFI Extension 2.0. Der Standardwert ist true.

Der ssid Parameter die SSID (bis zu 32 Zeichen) des Access Points zu dem die WLAN Verbindung hergestellt werden soll.

Wenn die ip, subnet_mask und gateway Parameter alle auf Null gesetzt sind, dann wird DHCP verwendet. Andernfalls kann mit diese drei Parametern eine statische IP Adresse eingestellt werden. Die Standardeinstellung ist DHCP.

Wenn der mac_address Parameter auf Null gesetzt ist, dann wird die voreingestellt MAC Adresse verwendet. Andernfalls kann mit diesem Parameter eine eigene MAC Adresse eingestellt werden.

Wenn der bssid Parameter auf Null gesetzt ist, dann verbindet sich die WIFI Extension 2.0 mit einem Access Point wenn die eingestellt SSID übereinstimmt. Andernfalls kann dieses Parameter verwendet werden, damit sich die WIFI Extension 2.0 nur dann mit einem Access Point verbindet, wenn SSID und BSSID übereinstimmen.

Um Konfigurationsänderungen für die WIFI Extension 2.0 zu übernehmen muss die #save_wifi2_configuration Funktion aufgerufen und der Master Brick danach neugestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die WIFI Extension 2.0 zu konfigurieren.

Neu in Version 2.4.0 (Firmware).

BrickMaster#get_wifi2_client_configuration → [bool, str, [int, ...], [int, ...], [int, ...], [int, ...], [int, ...]]
Rückgabe-Array:
  • 0: enable – Typ: bool, Standardwert: true
  • 1: ssid – Typ: str, Länge: bis zu 32
  • 2: ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 3: subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 4: gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 5: mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
  • 6: bssid – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]

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

Neu in Version 2.4.0 (Firmware).

BrickMaster#set_wifi2_client_hostname(hostname) → nil
Parameter:
  • hostname – Typ: str, Länge: bis zu 32

Setzt den Client Hostnamen (bis zu 32 Zeichen) der WIFI Extension 2.0. Der Hostname wird von Access Points als Hostname in der DHCP Client Tabelle angezeigt.

Um Konfigurationsänderungen für die WIFI Extension 2.0 zu übernehmen muss die #save_wifi2_configuration Funktion aufgerufen und der Master Brick danach neugestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die WIFI Extension 2.0 zu konfigurieren.

Neu in Version 2.4.0 (Firmware).

BrickMaster#get_wifi2_client_hostname → str
Rückgabe:
  • hostname – Typ: str, Länge: bis zu 32

Gibt den Client Hostnamen zurück, wie von #set_wifi2_client_hostname gesetzt.

Neu in Version 2.4.0 (Firmware).

BrickMaster#set_wifi2_client_password(password) → nil
Parameter:
  • password – Typ: str, Länge: bis zu 64

Setzt das Client-Passwort (bis zu 63 Zeichen) für WPA/WPA2 Verschlüsselung.

Um Konfigurationsänderungen für die WIFI Extension 2.0 zu übernehmen muss die #save_wifi2_configuration Funktion aufgerufen und der Master Brick danach neugestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die WIFI Extension 2.0 zu konfigurieren.

Neu in Version 2.4.0 (Firmware).

BrickMaster#get_wifi2_client_password → str
Rückgabe:
  • password – Typ: str, Länge: bis zu 64

Gibt das Client-Passwort zurück, wie von #set_wifi2_client_password gesetzt.

Bemerkung

Seit WIFI Extension 2.0 Firmware Version 2.1.3 wird das Passwort nicht mehr zurückgegeben.

Neu in Version 2.4.0 (Firmware).

BrickMaster#set_wifi2_ap_configuration(enable, ssid, ip, subnet_mask, gateway, encryption, hidden, channel, mac_address) → nil
Parameter:
  • enable – Typ: bool, Standardwert: true
  • ssid – Typ: str, Länge: bis zu 32
  • ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255], Standardwert: [0, 0, 0, 0]
  • subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • encryption – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4
  • hidden – Typ: bool, Standardwert: false
  • channel – Typ: int, Wertebereich: [0 bis 255], Standardwert: 1
  • mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]

Setzt die Access-Point-spezifische Konfiguration der WIFI Extension 2.0.

Der enable Parameter aktiviert oder deaktiviert den Access-Point-Teil der WIFI Extension 2.0. Der Standardwert ist true.

Der ssid Parameter die SSID (bis zu 32 Zeichen) des Access Points.

Wenn die ip, subnet_mask und gateway Parameter alle auf Null gesetzt sind, dann wird ein DHCP Server aktiviert. Andernfalls kann mit diese drei Parametern eine statische IP Adresse eingestellt werden. Die Standardeinstellung ist DHCP.

Der encryption Parameter legt den Verschlüsselungsmodus fest. Mögliche Werte sind Open (keine Verschlüsselung), WEP oder WPA/WPA2 PSK. Mit der #set_wifi2_ap_password Kann das Verschlüsselungspasswort gesetzt werden.

Der hidden Parameter legt fest, oder der Access Point seine SSID versteckt oder zeigt.

Der channel Parameter gibt den Kanal (1 to 13) des Access Points and.

Wenn der mac_address Parameter auf Null gesetzt ist, dann wird die voreingestellt MAC Adresse verwendet. Andernfalls kann mit diesem Parameter eine eigene MAC Adresse eingestellt werden.

Um Konfigurationsänderungen für die WIFI Extension 2.0 zu übernehmen muss die #save_wifi2_configuration Funktion aufgerufen und der Master Brick danach neugestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die WIFI Extension 2.0 zu konfigurieren.

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

Für encryption:

  • BrickMaster::WIFI2_AP_ENCRYPTION_OPEN = 0
  • BrickMaster::WIFI2_AP_ENCRYPTION_WEP = 1
  • BrickMaster::WIFI2_AP_ENCRYPTION_WPA_PSK = 2
  • BrickMaster::WIFI2_AP_ENCRYPTION_WPA2_PSK = 3
  • BrickMaster::WIFI2_AP_ENCRYPTION_WPA_WPA2_PSK = 4

Neu in Version 2.4.0 (Firmware).

BrickMaster#get_wifi2_ap_configuration → [bool, str, [int, ...], [int, ...], [int, ...], int, bool, int, [int, ...]]
Rückgabe-Array:
  • 0: enable – Typ: bool, Standardwert: true
  • 1: ssid – Typ: str, Länge: bis zu 32
  • 2: ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255], Standardwert: [0, 0, 0, 0]
  • 3: subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 4: gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 5: encryption – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 4
  • 6: hidden – Typ: bool, Standardwert: false
  • 7: channel – Typ: int, Wertebereich: [0 bis 255], Standardwert: 1
  • 8: mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]

Gibt die Access-Point-Konfiguration zurück, wie von #set_wifi2_ap_configuration gesetzt.

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

Für encryption:

  • BrickMaster::WIFI2_AP_ENCRYPTION_OPEN = 0
  • BrickMaster::WIFI2_AP_ENCRYPTION_WEP = 1
  • BrickMaster::WIFI2_AP_ENCRYPTION_WPA_PSK = 2
  • BrickMaster::WIFI2_AP_ENCRYPTION_WPA2_PSK = 3
  • BrickMaster::WIFI2_AP_ENCRYPTION_WPA_WPA2_PSK = 4

Neu in Version 2.4.0 (Firmware).

BrickMaster#set_wifi2_ap_password(password) → nil
Parameter:
  • password – Typ: str, Länge: bis zu 64

Setzt das Access-Point-Passwort (mindestens 8 und bis zu 63 Zeichen) für den eingestellten Verschlüsselungsmodus, siehe #set_wifi2_ap_configuration.

Um Konfigurationsänderungen für die WIFI Extension 2.0 zu übernehmen muss die #save_wifi2_configuration Funktion aufgerufen und der Master Brick danach neugestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die WIFI Extension 2.0 zu konfigurieren.

Neu in Version 2.4.0 (Firmware).

BrickMaster#get_wifi2_ap_password → str
Rückgabe:
  • password – Typ: str, Länge: bis zu 64

Gibt das Access-Point-Passwort zurück, wie von #set_wifi2_ap_password gesetzt.

Bemerkung

Seit WIFI Extension 2.0 Firmware Version 2.1.3 wird das Passwort nicht mehr zurückgegeben.

Neu in Version 2.4.0 (Firmware).

BrickMaster#save_wifi2_configuration → int
Rückgabe:
  • result – Typ: int, Wertebereich: [0 bis 255]

Alle Konfigurationsfunktionen der WIFI Extension 2.0 ändern die Werte nicht dauerhaft. Nach einer Konfiguration muss diese Funktion aufgerufen werden, um die Werte dauerhaft zu speichern.

Die Werte sind im EEPROM gespeichert und werden nur beim Start angewandt. Das bedeutet der Master Brick muss nach einer Konfiguration neu gestartet werden.

Neu in Version 2.4.0 (Firmware).

BrickMaster#get_wifi2_firmware_version → [int, ...]
Rückgabe-Array:
  • 0: 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]

Gibt die aktuelle Version der WIFI Extension 2.0 Firmware zurück.

Neu in Version 2.4.0 (Firmware).

BrickMaster#enable_wifi2_status_led → nil

Aktiviert die grüne Status LED der WIFI Extension 2.0.

Neu in Version 2.4.0 (Firmware).

BrickMaster#disable_wifi2_status_led → nil

Deaktiviert die grüne Status LED der WIFI Extension 2.0.

Neu in Version 2.4.0 (Firmware).

BrickMaster#is_wifi2_status_led_enabled → bool
Rückgabe:
  • enabled – Typ: bool

Gibt true zurück falls die grüne Status LED der WIFI Extension 2.0 aktiviert ist.

Neu in Version 2.4.0 (Firmware).

BrickMaster#set_wifi2_mesh_configuration(enable, root_ip, root_subnet_mask, root_gateway, router_bssid, group_id, group_ssid_prefix, gateway_ip, gateway_port) → nil
Parameter:
  • enable – Typ: bool, Standardwert: false
  • root_ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255], Standardwert: [0, 0, 0, 0]
  • root_subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • root_gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • router_bssid – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
  • group_id – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
  • group_ssid_prefix – Typ: str, Länge: bis zu 16
  • gateway_ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • gateway_port – Typ: int, Wertebereich: [0 bis 216 - 1]

Benötigt WIFI Extension 2.0 Firmware 2.1.0.

Set die Mesh-Konfiguration der WIFI Extension 2.0.

Der enable Parameter aktiviert oder deaktiviert den Mesh-Teil der WIFI Extension 2.0. Der Mesh-Teil kann nicht zusammen mit dem Client- und Access-Point-Teil aktiviert werden.

Wenn die root_ip, root_subnet_mask und root_gateway Parameter alle auf Null gesetzt sind, dann wird DHCP verwendet. Andernfalls kann mit diese drei Parametern eine statische IP Adresse eingestellt werden. Die Standardeinstellung ist DHCP.

Wenn der router_bssid Parameter auf Null gesetzt ist, dann verbindet sich die WIFI Extension 2.0 mit einem Access Point wenn die eingestellt SSID übereinstimmt, siehe #set_wifi2_mesh_router_ssid. Andernfalls kann dieses Parameter verwendet werden, damit sich die WIFI Extension 2.0 nur dann mit einem Access Point verbindet, wenn SSID und BSSID übereinstimmen. Die BSSID kann auch verwendet werden, um eine Verbindung mit einer verstecken SSID herzustellen.

Die group_id und group_ssid_prefix Parameter identifizieren in bestimmtes Mesh-Netzwerk und alle WIFI Extension 2.0 mit der gleichen Gruppeneinstellung gehören um gleichen Mesh-Netzwerk.

Die gateway_ip und gateway_port Parameter geben an, wie der Mesh-Gateway (brickd) erreicht werden kann.

Um Konfigurationsänderungen für die WIFI Extension 2.0 zu übernehmen muss die #save_wifi2_configuration Funktion aufgerufen und der Master Brick danach neugestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die WIFI Extension 2.0 zu konfigurieren.

Neu in Version 2.4.2 (Firmware).

BrickMaster#get_wifi2_mesh_configuration → [bool, [int, ...], [int, ...], [int, ...], [int, ...], [int, ...], str, [int, ...], int]
Rückgabe-Array:
  • 0: enable – Typ: bool, Standardwert: false
  • 1: root_ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255], Standardwert: [0, 0, 0, 0]
  • 2: root_subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 3: root_gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 4: router_bssid – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
  • 5: group_id – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
  • 6: group_ssid_prefix – Typ: str, Länge: bis zu 16
  • 7: gateway_ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 8: gateway_port – Typ: int, Wertebereich: [0 bis 216 - 1]

Benötigt WIFI Extension 2.0 Firmware 2.1.0.

Gibt das Mesh Konfiguration zurück, wie von #set_wifi2_mesh_configuration gesetzt.

Neu in Version 2.4.2 (Firmware).

BrickMaster#set_wifi2_mesh_router_ssid(ssid) → nil
Parameter:
  • ssid – Typ: str, Länge: bis zu 32

Benötigt WIFI Extension 2.0 Firmware 2.1.0.

Setzt die Mesh-Router-SSID der WIFI Extension 2.0. Diese wird verwendet um den Mesh Router festzulegen.

Zu beachten ist, dass zwar 32 Zeichen als SSID übergeben werden können, aber im Moment davon nur die ersten 31 Zeichen genutzt werden bedingt durch einen Bug in der verwendeten Mesh-Bibliothek.

Um Konfigurationsänderungen für die WIFI Extension 2.0 zu übernehmen muss die #save_wifi2_configuration Funktion aufgerufen und der Master Brick danach neugestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die WIFI Extension 2.0 zu konfigurieren.

Neu in Version 2.4.2 (Firmware).

BrickMaster#get_wifi2_mesh_router_ssid → str
Rückgabe:
  • ssid – Typ: str, Länge: bis zu 32

Benötigt WIFI Extension 2.0 Firmware 2.1.0.

Gibt das Mesh-Router-SSID zurück, wie von #set_wifi2_mesh_router_ssid gesetzt.

Neu in Version 2.4.2 (Firmware).

BrickMaster#set_wifi2_mesh_router_password(password) → nil
Parameter:
  • password – Typ: str, Länge: bis zu 64

Benötigt WIFI Extension 2.0 Firmware 2.1.0.

Setzt das Mesh-Router-Passwort (bis zu 64 Zeichen) für WPA/WPA2 Verschlüsselung. Das Password wird für die Verbindung zum Mesh Router verwendet.

Um Konfigurationsänderungen für die WIFI Extension 2.0 zu übernehmen muss die #save_wifi2_configuration Funktion aufgerufen und der Master Brick danach neugestartet werden.

Wir empfehlen den Brick Viewer zu verwenden, um die WIFI Extension 2.0 zu konfigurieren.

Neu in Version 2.4.2 (Firmware).

BrickMaster#get_wifi2_mesh_router_password → str
Rückgabe:
  • password – Typ: str, Länge: bis zu 64

Benötigt WIFI Extension 2.0 Firmware 2.1.0.

Gibt das Mesh-Router-Password zurück, wie von #set_wifi2_mesh_router_password gesetzt.

Neu in Version 2.4.2 (Firmware).

BrickMaster#get_wifi2_mesh_common_status → [int, bool, bool, int, int, int]
Rückgabe-Array:
  • 0: status – Typ: int, Wertebereich: Siehe Konstanten
  • 1: root_node – Typ: bool
  • 2: root_candidate – Typ: bool
  • 3: connected_nodes – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 4: rx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
  • 5: tx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Benötigt WIFI Extension 2.0 Firmware 2.1.0.

Gibt den allgemeinen Mesh-Status der WIFI Extension 2.0 zurück.

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

Für status:

  • BrickMaster::WIFI2_MESH_STATUS_DISABLED = 0
  • BrickMaster::WIFI2_MESH_STATUS_WIFI_CONNECTING = 1
  • BrickMaster::WIFI2_MESH_STATUS_GOT_IP = 2
  • BrickMaster::WIFI2_MESH_STATUS_MESH_LOCAL = 3
  • BrickMaster::WIFI2_MESH_STATUS_MESH_ONLINE = 4
  • BrickMaster::WIFI2_MESH_STATUS_AP_AVAILABLE = 5
  • BrickMaster::WIFI2_MESH_STATUS_AP_SETUP = 6
  • BrickMaster::WIFI2_MESH_STATUS_LEAF_AVAILABLE = 7

Neu in Version 2.4.2 (Firmware).

BrickMaster#get_wifi2_mesh_client_status → [str, [int, ...], [int, ...], [int, ...], [int, ...]]
Rückgabe-Array:
  • 0: hostname – Typ: str, Länge: bis zu 32
  • 1: ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 2: subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 3: gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 4: mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]

Benötigt WIFI Extension 2.0 Firmware 2.1.0.

Gibt den Mesh-Client-Status der WIFI Extension 2.0 zurück.

Neu in Version 2.4.2 (Firmware).

BrickMaster#get_wifi2_mesh_ap_status → [str, [int, ...], [int, ...], [int, ...], [int, ...]]
Rückgabe-Array:
  • 0: ssid – Typ: str, Länge: bis zu 32
  • 1: ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 2: subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 3: gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
  • 4: mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]

Benötigt WIFI Extension 2.0 Firmware 2.1.0.

Gibt den Mesh-AP-Status der WIFI Extension 2.0 zurück.

Neu in Version 2.4.2 (Firmware).

BrickMaster#set_spitfp_baudrate_config(enable_dynamic_baudrate, minimum_dynamic_baudrate) → nil
Parameter:
  • enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • minimum_dynamic_baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Das SPITF-Protokoll kann mit einer dynamischen Baudrate genutzt werden. Wenn die dynamische Baudrate aktiviert ist, versucht der Brick die Baudrate anhand des Datenaufkommens zwischen Brick und Bricklet anzupassen.

Die Baudrate wird exponentiell erhöht wenn viele Daten gesendet/empfangen werden und linear verringert wenn wenig Daten gesendet/empfangen werden.

Diese Vorgehensweise verringert die Baudrate in Anwendungen wo nur wenig Daten ausgetauscht werden müssen (z.B. eine Wetterstation) und erhöht die Robustheit. Wenn immer viele Daten ausgetauscht werden (z.B. Thermal Imaging Bricklet), wird die Baudrate automatisch erhöht.

In Fällen wo wenige Daten all paar Sekunden so schnell wie Möglich übertragen werden sollen (z.B. RS485 Bricklet mit hoher Baudrate aber kleinem Payload) kann die dynamische Baudrate zum maximieren der Performance ausgestellt werden.

Die maximale Baudrate kann pro Port mit der Funktion #set_spitfp_baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von #set_spitfp_baudrate gesetzt statisch verwendet.

Neu in Version 2.4.6 (Firmware).

BrickMaster#get_spitfp_baudrate_config → [bool, int]
Rückgabe-Array:
  • 0: enable_dynamic_baudrate – Typ: bool, Standardwert: true
  • 1: minimum_dynamic_baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Gibt die Baudratenkonfiguration zurück, siehe #set_spitfp_baudrate_config.

Neu in Version 2.4.6 (Firmware).

BrickMaster#get_send_timeout_count(communication_method) → int
Parameter:
  • communication_method – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • timeout_count – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt den Timeout-Zähler für die verschiedenen Kommunikationsmöglichkeiten zurück

Die Kommunikationsmöglichkeiten 0-2 stehen auf allen Bricks zur verfügung, 3-7 nur auf Master Bricks.

Diese Funktion ist hauptsächlich zum debuggen während der Entwicklung gedacht. Im normalen Betrieb sollten alle Zähler fast immer auf 0 stehen bleiben.

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

Für communication_method:

  • BrickMaster::COMMUNICATION_METHOD_NONE = 0
  • BrickMaster::COMMUNICATION_METHOD_USB = 1
  • BrickMaster::COMMUNICATION_METHOD_SPI_STACK = 2
  • BrickMaster::COMMUNICATION_METHOD_CHIBI = 3
  • BrickMaster::COMMUNICATION_METHOD_RS485 = 4
  • BrickMaster::COMMUNICATION_METHOD_WIFI = 5
  • BrickMaster::COMMUNICATION_METHOD_ETHERNET = 6
  • BrickMaster::COMMUNICATION_METHOD_WIFI_V2 = 7

Neu in Version 2.4.3 (Firmware).

BrickMaster#set_spitfp_baudrate(bricklet_port, baudrate) → nil
Parameter:
  • bricklet_port – Typ: chr, Wertebereich: ['a' bis 'd']
  • baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Setzt die Baudrate eines spezifischen Bricklet Ports .

Für einen höheren Durchsatz der Bricklets kann die Baudrate erhöht werden. Wenn der Fehlerzähler auf Grund von lokaler Störeinstrahlung hoch ist (siehe #get_spitfp_error_count) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe #set_spitfp_baudrate_config).

EMV Tests werden mit der Standardbaudrate durchgeführt. Falls eine CE-Kompatibilität o.ä. in der Anwendung notwendig ist empfehlen wir die Baudrate nicht zu ändern.

Neu in Version 2.4.3 (Firmware).

BrickMaster#get_spitfp_baudrate(bricklet_port) → int
Parameter:
  • bricklet_port – Typ: chr, Wertebereich: ['a' bis 'd']
Rückgabe:
  • baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Gibt die Baudrate für einen Bricklet Port zurück, siehe #set_spitfp_baudrate.

Neu in Version 2.4.3 (Firmware).

BrickMaster#get_spitfp_error_count(bricklet_port) → [int, int, int, int]
Parameter:
  • bricklet_port – Typ: chr, Wertebereich: ['a' bis 'd']
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 Bricks auftreten. Jedes Bricklet hat eine ähnliche Funktion welche die Fehler auf Brickletseite ausgibt.

Neu in Version 2.4.3 (Firmware).

BrickMaster#enable_status_led → nil

Aktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.2 (Firmware).

BrickMaster#disable_status_led → nil

Deaktiviert die Status LED.

Die Status LED ist die blaue LED neben dem USB-Stecker. Wenn diese aktiviert ist, ist sie an und sie flackert wenn Daten transferiert werden. Wenn sie deaktiviert ist, ist sie immer aus.

Der Standardzustand ist aktiviert.

Neu in Version 2.3.2 (Firmware).

BrickMaster#is_status_led_enabled → bool
Rückgabe:
  • enabled – Typ: bool, Standardwert: true

Gibt true zurück wenn die Status LED aktiviert ist, false sonst.

Neu in Version 2.3.2 (Firmware).

BrickMaster#get_chip_temperature → int
Rückgabe:
  • temperature – Typ: int, Einheit: 1/10 °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 Genauigkeit von ±15%. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickMaster#reset → nil

Ein Aufruf dieser Funktion setzt den Brick zurück. Befindet sich der Brick innerhalb eines Stapels wird der gesamte Stapel zurück gesetzt.

Nach dem Zurücksetzen ist es notwendig neue Geräteobjekte zu erzeugen, Funktionsaufrufe auf bestehende führt zu undefiniertem Verhalten.

BrickMaster#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: ['0' bis '8']
  • 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 der Brick verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist die Position im Stack von '0' (unterster Brick) bis '8' (oberster Brick).

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

Konfigurationsfunktionen für Callbacks

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

BrickMaster#set_stack_current_callback_period(period) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der ::CALLBACK_STACK_CURRENT Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der ::CALLBACK_STACK_CURRENT Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

Neu in Version 2.0.5 (Firmware).

BrickMaster#get_stack_current_callback_period → int
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von #set_stack_current_callback_period gesetzt

Neu in Version 2.0.5 (Firmware).

BrickMaster#set_stack_voltage_callback_period(period) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der ::CALLBACK_STACK_VOLTAGE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der ::CALLBACK_STACK_VOLTAGE Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

Neu in Version 2.0.5 (Firmware).

BrickMaster#get_stack_voltage_callback_period → int
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von #set_stack_voltage_callback_period gesetzt

Neu in Version 2.0.5 (Firmware).

BrickMaster#set_usb_voltage_callback_period(period) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der ::CALLBACK_USB_VOLTAGE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der ::CALLBACK_USB_VOLTAGE Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

Neu in Version 2.0.5 (Firmware).

BrickMaster#get_usb_voltage_callback_period → int
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von #set_usb_voltage_callback_period gesetzt

Neu in Version 2.0.5 (Firmware).

BrickMaster#set_stack_current_callback_threshold(option, min, max) → nil
Parameter:
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den ::CALLBACK_STACK_CURRENT_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Stromstärke außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Stromstärke innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Stromstärke kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Stromstärke größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • BrickMaster::THRESHOLD_OPTION_OFF = 'x'
  • BrickMaster::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickMaster::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickMaster::THRESHOLD_OPTION_SMALLER = '<'
  • BrickMaster::THRESHOLD_OPTION_GREATER = '>'

Neu in Version 2.0.5 (Firmware).

BrickMaster#get_stack_current_callback_threshold → [chr, int, int]
Rückgabe-Array:
  • 0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 1: min – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • 2: max – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von #set_stack_current_callback_threshold gesetzt.

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

Für option:

  • BrickMaster::THRESHOLD_OPTION_OFF = 'x'
  • BrickMaster::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickMaster::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickMaster::THRESHOLD_OPTION_SMALLER = '<'
  • BrickMaster::THRESHOLD_OPTION_GREATER = '>'

Neu in Version 2.0.5 (Firmware).

BrickMaster#set_stack_voltage_callback_threshold(option, min, max) → nil
Parameter:
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den ::CALLBACK_STACK_VOLTAGE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Spannung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Spannung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Spannung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Spannung größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • BrickMaster::THRESHOLD_OPTION_OFF = 'x'
  • BrickMaster::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickMaster::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickMaster::THRESHOLD_OPTION_SMALLER = '<'
  • BrickMaster::THRESHOLD_OPTION_GREATER = '>'

Neu in Version 2.0.5 (Firmware).

BrickMaster#get_stack_voltage_callback_threshold → [chr, int, int]
Rückgabe-Array:
  • 0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 1: min – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • 2: max – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von #set_stack_voltage_callback_threshold gesetzt.

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

Für option:

  • BrickMaster::THRESHOLD_OPTION_OFF = 'x'
  • BrickMaster::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickMaster::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickMaster::THRESHOLD_OPTION_SMALLER = '<'
  • BrickMaster::THRESHOLD_OPTION_GREATER = '>'

Neu in Version 2.0.5 (Firmware).

BrickMaster#set_usb_voltage_callback_threshold(option, min, max) → nil
Parameter:
  • option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den ::CALLBACK_USB_VOLTAGE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Spannung außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Spannung innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Spannung kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Spannung größer als der min Wert ist (max wird ignoriert)

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

Für option:

  • BrickMaster::THRESHOLD_OPTION_OFF = 'x'
  • BrickMaster::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickMaster::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickMaster::THRESHOLD_OPTION_SMALLER = '<'
  • BrickMaster::THRESHOLD_OPTION_GREATER = '>'

Neu in Version 2.0.5 (Firmware).

BrickMaster#get_usb_voltage_callback_threshold → [chr, int, int]
Rückgabe-Array:
  • 0: option – Typ: chr, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • 1: min – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • 2: max – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von #set_usb_voltage_callback_threshold gesetzt.

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

Für option:

  • BrickMaster::THRESHOLD_OPTION_OFF = 'x'
  • BrickMaster::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickMaster::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickMaster::THRESHOLD_OPTION_SMALLER = '<'
  • BrickMaster::THRESHOLD_OPTION_GREATER = '>'

Neu in Version 2.0.5 (Firmware).

BrickMaster#set_debounce_period(debounce) → nil
Parameter:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Neu in Version 2.0.5 (Firmware).

BrickMaster#get_debounce_period → int
Rückgabe:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von #set_debounce_period gesetzt.

Neu in Version 2.0.5 (Firmware).

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:

master.register_callback BrickMaster::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.

BrickMaster::CALLBACK_STACK_CURRENT
Callback-Parameter:
  • current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_stack_current_callback_period, ausgelöst. Der Parameter ist die Stromstärke des Sensors.

Der ::CALLBACK_STACK_CURRENT Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

Neu in Version 2.0.5 (Firmware).

BrickMaster::CALLBACK_STACK_VOLTAGE
Callback-Parameter:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_stack_voltage_callback_period, ausgelöst. Der Parameter ist die Spannung des Sensors.

Der ::CALLBACK_STACK_VOLTAGE Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

Neu in Version 2.0.5 (Firmware).

BrickMaster::CALLBACK_USB_VOLTAGE
Callback-Parameter:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit #set_usb_voltage_callback_period, ausgelöst. Der Parameter ist die USB Spannung.

Der ::CALLBACK_USB_VOLTAGE Callback wird nur ausgelöst, wenn sich die USB Spannung seit der letzten Auslösung geändert hat.

Funktioniert nicht mit Hardware Version 2.1.

Neu in Version 2.0.5 (Firmware).

BrickMaster::CALLBACK_STACK_CURRENT_REACHED
Callback-Parameter:
  • current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_stack_current_callback_threshold gesetzt, erreicht wird. Der Parameter ist der Stromverbrauch des Stapels.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit #set_debounce_period gesetzt, ausgelöst.

Neu in Version 2.0.5 (Firmware).

BrickMaster::CALLBACK_STACK_VOLTAGE_REACHED
Callback-Parameter:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_stack_voltage_callback_threshold gesetzt, erreicht wird. Der Parameter ist die Spannung des Stapels.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit #set_debounce_period gesetzt, ausgelöst.

Neu in Version 2.0.5 (Firmware).

BrickMaster::CALLBACK_USB_VOLTAGE_REACHED
Callback-Parameter:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von #set_usb_voltage_callback_threshold gesetzt, erreicht wird. Der Parameter ist die Spannung des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit #set_debounce_period gesetzt, ausgelöst.

Neu in Version 2.0.5 (Firmware).

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.

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

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

  • BrickMaster::FUNCTION_SET_EXTENSION_TYPE = 3
  • BrickMaster::FUNCTION_SET_CHIBI_ADDRESS = 6
  • BrickMaster::FUNCTION_SET_CHIBI_MASTER_ADDRESS = 8
  • BrickMaster::FUNCTION_SET_CHIBI_SLAVE_ADDRESS = 10
  • BrickMaster::FUNCTION_SET_CHIBI_FREQUENCY = 14
  • BrickMaster::FUNCTION_SET_CHIBI_CHANNEL = 16
  • BrickMaster::FUNCTION_SET_RS485_ADDRESS = 19
  • BrickMaster::FUNCTION_SET_RS485_SLAVE_ADDRESS = 21
  • BrickMaster::FUNCTION_SET_RS485_CONFIGURATION = 24
  • BrickMaster::FUNCTION_SET_WIFI_CONFIGURATION = 27
  • BrickMaster::FUNCTION_SET_WIFI_ENCRYPTION = 29
  • BrickMaster::FUNCTION_REFRESH_WIFI_STATUS = 32
  • BrickMaster::FUNCTION_SET_WIFI_CERTIFICATE = 33
  • BrickMaster::FUNCTION_SET_WIFI_POWER_MODE = 35
  • BrickMaster::FUNCTION_SET_WIFI_REGULATORY_DOMAIN = 38
  • BrickMaster::FUNCTION_SET_LONG_WIFI_KEY = 41
  • BrickMaster::FUNCTION_SET_WIFI_HOSTNAME = 43
  • BrickMaster::FUNCTION_SET_STACK_CURRENT_CALLBACK_PERIOD = 45
  • BrickMaster::FUNCTION_SET_STACK_VOLTAGE_CALLBACK_PERIOD = 47
  • BrickMaster::FUNCTION_SET_USB_VOLTAGE_CALLBACK_PERIOD = 49
  • BrickMaster::FUNCTION_SET_STACK_CURRENT_CALLBACK_THRESHOLD = 51
  • BrickMaster::FUNCTION_SET_STACK_VOLTAGE_CALLBACK_THRESHOLD = 53
  • BrickMaster::FUNCTION_SET_USB_VOLTAGE_CALLBACK_THRESHOLD = 55
  • BrickMaster::FUNCTION_SET_DEBOUNCE_PERIOD = 57
  • BrickMaster::FUNCTION_SET_ETHERNET_CONFIGURATION = 66
  • BrickMaster::FUNCTION_SET_ETHERNET_HOSTNAME = 69
  • BrickMaster::FUNCTION_SET_ETHERNET_MAC_ADDRESS = 70
  • BrickMaster::FUNCTION_SET_ETHERNET_WEBSOCKET_CONFIGURATION = 71
  • BrickMaster::FUNCTION_SET_ETHERNET_AUTHENTICATION_SECRET = 73
  • BrickMaster::FUNCTION_SET_WIFI_AUTHENTICATION_SECRET = 75
  • BrickMaster::FUNCTION_SET_WIFI2_AUTHENTICATION_SECRET = 82
  • BrickMaster::FUNCTION_SET_WIFI2_CONFIGURATION = 84
  • BrickMaster::FUNCTION_SET_WIFI2_CLIENT_CONFIGURATION = 87
  • BrickMaster::FUNCTION_SET_WIFI2_CLIENT_HOSTNAME = 89
  • BrickMaster::FUNCTION_SET_WIFI2_CLIENT_PASSWORD = 91
  • BrickMaster::FUNCTION_SET_WIFI2_AP_CONFIGURATION = 93
  • BrickMaster::FUNCTION_SET_WIFI2_AP_PASSWORD = 95
  • BrickMaster::FUNCTION_ENABLE_WIFI2_STATUS_LED = 99
  • BrickMaster::FUNCTION_DISABLE_WIFI2_STATUS_LED = 100
  • BrickMaster::FUNCTION_SET_WIFI2_MESH_CONFIGURATION = 102
  • BrickMaster::FUNCTION_SET_WIFI2_MESH_ROUTER_SSID = 104
  • BrickMaster::FUNCTION_SET_WIFI2_MESH_ROUTER_PASSWORD = 106
  • BrickMaster::FUNCTION_SET_BRICKLETS_ENABLED = 113
  • BrickMaster::FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickMaster::FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickMaster::FUNCTION_ENABLE_STATUS_LED = 238
  • BrickMaster::FUNCTION_DISABLE_STATUS_LED = 239
  • BrickMaster::FUNCTION_RESET = 243
  • BrickMaster::FUNCTION_WRITE_BRICKLET_PLUGIN = 246
BrickMaster#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:

  • BrickMaster::FUNCTION_SET_EXTENSION_TYPE = 3
  • BrickMaster::FUNCTION_SET_CHIBI_ADDRESS = 6
  • BrickMaster::FUNCTION_SET_CHIBI_MASTER_ADDRESS = 8
  • BrickMaster::FUNCTION_SET_CHIBI_SLAVE_ADDRESS = 10
  • BrickMaster::FUNCTION_SET_CHIBI_FREQUENCY = 14
  • BrickMaster::FUNCTION_SET_CHIBI_CHANNEL = 16
  • BrickMaster::FUNCTION_SET_RS485_ADDRESS = 19
  • BrickMaster::FUNCTION_SET_RS485_SLAVE_ADDRESS = 21
  • BrickMaster::FUNCTION_SET_RS485_CONFIGURATION = 24
  • BrickMaster::FUNCTION_SET_WIFI_CONFIGURATION = 27
  • BrickMaster::FUNCTION_SET_WIFI_ENCRYPTION = 29
  • BrickMaster::FUNCTION_REFRESH_WIFI_STATUS = 32
  • BrickMaster::FUNCTION_SET_WIFI_CERTIFICATE = 33
  • BrickMaster::FUNCTION_SET_WIFI_POWER_MODE = 35
  • BrickMaster::FUNCTION_SET_WIFI_REGULATORY_DOMAIN = 38
  • BrickMaster::FUNCTION_SET_LONG_WIFI_KEY = 41
  • BrickMaster::FUNCTION_SET_WIFI_HOSTNAME = 43
  • BrickMaster::FUNCTION_SET_STACK_CURRENT_CALLBACK_PERIOD = 45
  • BrickMaster::FUNCTION_SET_STACK_VOLTAGE_CALLBACK_PERIOD = 47
  • BrickMaster::FUNCTION_SET_USB_VOLTAGE_CALLBACK_PERIOD = 49
  • BrickMaster::FUNCTION_SET_STACK_CURRENT_CALLBACK_THRESHOLD = 51
  • BrickMaster::FUNCTION_SET_STACK_VOLTAGE_CALLBACK_THRESHOLD = 53
  • BrickMaster::FUNCTION_SET_USB_VOLTAGE_CALLBACK_THRESHOLD = 55
  • BrickMaster::FUNCTION_SET_DEBOUNCE_PERIOD = 57
  • BrickMaster::FUNCTION_SET_ETHERNET_CONFIGURATION = 66
  • BrickMaster::FUNCTION_SET_ETHERNET_HOSTNAME = 69
  • BrickMaster::FUNCTION_SET_ETHERNET_MAC_ADDRESS = 70
  • BrickMaster::FUNCTION_SET_ETHERNET_WEBSOCKET_CONFIGURATION = 71
  • BrickMaster::FUNCTION_SET_ETHERNET_AUTHENTICATION_SECRET = 73
  • BrickMaster::FUNCTION_SET_WIFI_AUTHENTICATION_SECRET = 75
  • BrickMaster::FUNCTION_SET_WIFI2_AUTHENTICATION_SECRET = 82
  • BrickMaster::FUNCTION_SET_WIFI2_CONFIGURATION = 84
  • BrickMaster::FUNCTION_SET_WIFI2_CLIENT_CONFIGURATION = 87
  • BrickMaster::FUNCTION_SET_WIFI2_CLIENT_HOSTNAME = 89
  • BrickMaster::FUNCTION_SET_WIFI2_CLIENT_PASSWORD = 91
  • BrickMaster::FUNCTION_SET_WIFI2_AP_CONFIGURATION = 93
  • BrickMaster::FUNCTION_SET_WIFI2_AP_PASSWORD = 95
  • BrickMaster::FUNCTION_ENABLE_WIFI2_STATUS_LED = 99
  • BrickMaster::FUNCTION_DISABLE_WIFI2_STATUS_LED = 100
  • BrickMaster::FUNCTION_SET_WIFI2_MESH_CONFIGURATION = 102
  • BrickMaster::FUNCTION_SET_WIFI2_MESH_ROUTER_SSID = 104
  • BrickMaster::FUNCTION_SET_WIFI2_MESH_ROUTER_PASSWORD = 106
  • BrickMaster::FUNCTION_SET_BRICKLETS_ENABLED = 113
  • BrickMaster::FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
  • BrickMaster::FUNCTION_SET_SPITFP_BAUDRATE = 234
  • BrickMaster::FUNCTION_ENABLE_STATUS_LED = 238
  • BrickMaster::FUNCTION_DISABLE_STATUS_LED = 239
  • BrickMaster::FUNCTION_RESET = 243
  • BrickMaster::FUNCTION_WRITE_BRICKLET_PLUGIN = 246
BrickMaster#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.

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.

BrickMaster#set_bricklet_xmc_flash_config(config, parameter1, parameter2, data) → [int, [int, ...]]
Parameter:
  • config – Typ: int, Wertebereich: [0 bis 232 - 1]
  • parameter1 – Typ: int, Wertebereich: [0 bis 232 - 1]
  • parameter2 – Typ: int, Wertebereich: [0 bis 232 - 1]
  • data – Typ: [int, ...], Länge: 52, Wertebereich: [0 bis 255]
Rückgabe-Array:
  • 0: return_value – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 1: return_data – Typ: [int, ...], Länge: 60, Wertebereich: [0 bis 255]

Diese Funktion wird Tinkerforge-Intern genutzt um initial den Bootstrapper und Bootloader auf Bricklets zu flashen.

Falls die Notwendigkeit besteht einen Bootstrapper/Bootloader zu flashen (zum Beispiel weil ein eigenes Bricklet entwickelet wurde) bitte nicht diese Funktion direkt benutzen.

Dafür kann unser Open Source Flash/Test-Tool genutzt werden: https://github.com/Tinkerforge/flash-test

Neu in Version 2.5.0 (Firmware).

BrickMaster#set_bricklet_xmc_flash_data(data) → int
Parameter:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • return_data – Typ: int, Wertebereich: [0 bis 232 - 1]

Diese Funktion wird Tinkerforge-Intern genutzt um initial den Bootstrapper und Bootloader auf Bricklets zu flashen.

Falls die Notwendigkeit besteht einen Bootstrapper/Bootloader zu flashen (zum Beispiel weil ein eigenes Bricklet entwickelet wurde) bitte nicht diese Funktion direkt benutzen.

Dafür kann unser Open Source Flash/Test-Tool genutzt werden: https://github.com/Tinkerforge/flash-test

Neu in Version 2.5.0 (Firmware).

BrickMaster#set_bricklets_enabled(bricklets_enabled) → nil
Parameter:
  • bricklets_enabled – Typ: bool

Diese Funktion ist nur nur Master Brick Hardware Version >= 3.0 verfügbar.

Aktiviert/Deaktiviert alle vier Bricklets wenn auf true/false gesetzt.

Wenn die Bricklets deaktiviert werden, wird die Stromversorgung zu den Bricklets getrennt. Die Bricklets verlieren dabei ihre aktuelle konfiguration.

Neu in Version 2.5.0 (Firmware).

BrickMaster#get_bricklets_enabled → bool
Rückgabe:
  • bricklets_enabled – Typ: bool

Gibt true zurück wenn die Bricklets aktiviert sind und false wenn sie deaktiviert sind.

Neu in Version 2.5.0 (Firmware).

BrickMaster#get_protocol1_bricklet_name(port) → [int, [int, ...], str]
Parameter:
  • port – Typ: chr, Wertebereich: ['a' bis 'd']
Rückgabe-Array:
  • 0: protocol_version – Typ: int, Wertebereich: [0 bis 255]
  • 1: 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]
  • 2: name – Typ: str, Länge: bis zu 40

Gibt die Firmware und Protokoll Version und den Namen des Bricklets für einen gegebenen Port zurück.

Der einzige Zweck dieser Funktion ist es, automatischen Flashen von Bricklet v1.x.y Plugins zu ermöglichen.

BrickMaster#write_bricklet_plugin(port, offset, chunk) → nil
Parameter:
  • port – Typ: chr, Wertebereich: ['a' bis 'd']
  • offset – Typ: int, Wertebereich: [0 bis 255]
  • chunk – Typ: [int, ...], Länge: 32, Wertebereich: [0 bis 255]

Schreibt 32 Bytes Firmware auf das Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden an die Position offset * 32 geschrieben.

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

BrickMaster#read_bricklet_plugin(port, offset) → [int, ...]
Parameter:
  • port – Typ: chr, Wertebereich: ['a' bis 'd']
  • offset – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:
  • chunk – Typ: [int, ...], Länge: 32, Wertebereich: [0 bis 255]

Liest 32 Bytes Firmware vom Bricklet, dass am gegebenen Port angeschlossen ist. Die Bytes werden ab der Position offset * 32 gelesen.

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

Konstanten

BrickMaster::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um einen Master Brick 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.

BrickMaster::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Master Brick dar.