Software / API Bindings / MQTT / API Referenz und Beispiele / Bricks / Master Brick

MQTT - Master Brick¶

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Stack Status¶

Download (example-stack-status.txt)

# Change XXYYZZ to the UID of your Master Brick

setup:
    # Get current stack voltage
    subscribe to tinkerforge/response/master_brick/XXYYZZ/get_stack_voltage
    publish '' to tinkerforge/request/master_brick/XXYYZZ/get_stack_voltage

    # Get current stack current
    subscribe to tinkerforge/response/master_brick/XXYYZZ/get_stack_current
    publish '' to tinkerforge/request/master_brick/XXYYZZ/get_stack_current

API¶

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen¶

request/master_brick/<UID>/get_stack_voltage¶

Anfrage:	keine Nutzdaten
Antwort:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 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.

request/master_brick/<UID>/get_stack_current¶

Anfrage:	keine Nutzdaten
Antwort:	current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 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¶

request/master_brick/<UID>/set_extension_type¶

Anfrage:	extension – Typ: int, Wertebereich: [0 bis 1] exttype – Typ: int, Wertebereich: Siehe Symbole
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für exttype:

"chibi" = 1
"rs485" = 2
"wifi" = 3
"ethernet" = 4
"wifi2" = 5

request/master_brick/<UID>/get_extension_type¶

Anfrage:	extension – Typ: int, Wertebereich: [0 bis 1]
Antwort:	exttype – Typ: int, Wertebereich: Siehe Symbole

Gibt den Typ der angegebenen Extension zurück, wie von request/master_brick/<UID>/set_extension_type gesetzt.

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

Für exttype:

"chibi" = 1
"rs485" = 2
"wifi" = 3
"ethernet" = 4
"wifi2" = 5

request/master_brick/<UID>/is_chibi_present¶

Anfrage:	keine Nutzdaten
Antwort:	present – Typ: bool

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

request/master_brick/<UID>/set_chibi_address¶

Anfrage:	address – Typ: int, Wertebereich: [1 bis 255]
Antwort:	keine Antwort

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.

request/master_brick/<UID>/get_chibi_address¶

Anfrage:	keine Nutzdaten
Antwort:	address – Typ: int, Wertebereich: [1 bis 255]

Gibt die Adresse zurück, wie von request/master_brick/<UID>/set_chibi_address gesetzt.

request/master_brick/<UID>/set_chibi_master_address¶

Anfrage:	address – Typ: int, Wertebereich: [1 bis 255]
Antwort:	keine Antwort

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.

request/master_brick/<UID>/get_chibi_master_address¶

Anfrage:	keine Nutzdaten
Antwort:	address – Typ: int, Wertebereich: [1 bis 255]

Gibt die Adresse zurück, wie von request/master_brick/<UID>/set_chibi_master_address gesetzt.

request/master_brick/<UID>/set_chibi_slave_address¶

Anfrage:	num – Typ: int, Wertebereich: [0 bis 254] address – Typ: int, Wertebereich: [0 bis 255]
Antwort:	keine Antwort

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.

request/master_brick/<UID>/get_chibi_slave_address¶

Anfrage:	num – Typ: int, Wertebereich: [0 bis 254]
Antwort:	address – Typ: int, Wertebereich: [0 bis 255]

Gibt die Slave Adresse für eine Adressnummerierung (mittels num Parameter) zurück, wie von request/master_brick/<UID>/set_chibi_slave_address gesetzt.

request/master_brick/<UID>/get_chibi_signal_strength¶

Anfrage:	keine Nutzdaten
Antwort:	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.

request/master_brick/<UID>/get_chibi_error_log¶

Anfrage:	keine Nutzdaten
Antwort:	underrun – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] crc_error – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] no_ack – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] overflow – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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.

request/master_brick/<UID>/set_chibi_frequency¶

Anfrage:	frequency – Typ: int, Wertebereich: Siehe Symbole
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für frequency:

"oqpsk_868_mhz" = 0
"oqpsk_915_mhz" = 1
"oqpsk_780_mhz" = 2
"bpsk40_915_mhz" = 3

request/master_brick/<UID>/get_chibi_frequency¶

Anfrage:	keine Nutzdaten
Antwort:	frequency – Typ: int, Wertebereich: Siehe Symbole

Gibt den Frequenzbereich zurück, wie von request/master_brick/<UID>/set_chibi_frequency gesetzt.

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

Für frequency:

"oqpsk_868_mhz" = 0
"oqpsk_915_mhz" = 1
"oqpsk_780_mhz" = 2
"bpsk40_915_mhz" = 3

request/master_brick/<UID>/set_chibi_channel¶

Anfrage:	channel – Typ: int, Wertebereich: ?
Antwort:	keine Antwort

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.

request/master_brick/<UID>/get_chibi_channel¶

Anfrage:	keine Nutzdaten
Antwort:	channel – Typ: int, Wertebereich: ?

Gibt den Kanal zurück, wie von request/master_brick/<UID>/set_chibi_channel gesetzt.

request/master_brick/<UID>/is_rs485_present¶

Anfrage:	keine Nutzdaten
Antwort:	present – Typ: bool

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

request/master_brick/<UID>/set_rs485_address¶

Anfrage:	address – Typ: int, Wertebereich: [0 bis 255]
Antwort:	keine Antwort

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.

request/master_brick/<UID>/get_rs485_address¶

Anfrage:	keine Nutzdaten
Antwort:	address – Typ: int, Wertebereich: [0 bis 255]

Gibt die Adresse zurück, wie von request/master_brick/<UID>/set_rs485_address gesetzt.

request/master_brick/<UID>/set_rs485_slave_address¶

Anfrage:	num – Typ: int, Wertebereich: [0 bis 255] address – Typ: int, Wertebereich: [0 bis 255]
Antwort:	keine Antwort

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.

request/master_brick/<UID>/get_rs485_slave_address¶

Anfrage:	num – Typ: int, Wertebereich: [0 bis 255]
Antwort:	address – Typ: int, Wertebereich: [0 bis 255]

Gibt die Slave Adresse für eine Adressnummerierung (mittels num Parameter) zurück, wie von request/master_brick/<UID>/set_rs485_slave_address gesetzt.

request/master_brick/<UID>/get_rs485_error_log¶

Anfrage:	keine Nutzdaten
Antwort:	crc_error – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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.

request/master_brick/<UID>/set_rs485_configuration¶

Anfrage:	speed – Typ: int, Einheit: 1 Bd, Wertebereich: [0 bis 2³² - 1] parity – Typ: char, Wertebereich: Siehe Symbole stopbits – Typ: int, Wertebereich: [1 bis 2]
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für parity:

"none" = "n"
"even" = "e"
"odd" = "o"

request/master_brick/<UID>/get_rs485_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	speed – Typ: int, Einheit: 1 Bd, Wertebereich: [0 bis 2³² - 1] parity – Typ: char, Wertebereich: Siehe Symbole stopbits – Typ: int, Wertebereich: [1 bis 2]

Gibt die Schnittstellenkonfiguration zurück, wie von request/master_brick/<UID>/set_rs485_configuration gesetzt.

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

Für parity:

"none" = "n"
"even" = "e"
"odd" = "o"

request/master_brick/<UID>/is_wifi_present¶

Anfrage:	keine Nutzdaten
Antwort:	present – Typ: bool

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

request/master_brick/<UID>/set_wifi_configuration¶

Anfrage:	ssid – Typ: string, Länge: bis zu 32 connection – Typ: int, Wertebereich: Siehe Symbole 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 2¹⁶ - 1], Standardwert: 4223
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für connection:

"dhcp" = 0
"static_ip" = 1
"access_point_dhcp" = 2
"access_point_static_ip" = 3
"ad_hoc_dhcp" = 4
"ad_hoc_static_ip" = 5

request/master_brick/<UID>/get_wifi_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	ssid – Typ: string, Länge: bis zu 32 connection – Typ: int, Wertebereich: Siehe Symbole 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 2¹⁶ - 1], Standardwert: 4223

Gibt die Konfiguration zurück, wie von request/master_brick/<UID>/set_wifi_configuration gesetzt.

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

Für connection:

"dhcp" = 0
"static_ip" = 1
"access_point_dhcp" = 2
"access_point_static_ip" = 3
"ad_hoc_dhcp" = 4
"ad_hoc_static_ip" = 5

request/master_brick/<UID>/set_wifi_encryption¶

Anfrage:

Anfrage:	encryption – Typ: int, Wertebereich: Siehe Symbole key – Typ: string, Länge: bis zu 50 key_index – Typ: int, Wertebereich: [1 bis 4] eap_options – Typ: int, Wertebereich: Siehe Symbole 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]
Antwort:	keine Antwort

encryption – Typ: int, Wertebereich: Siehe Symbole
key – Typ: string, Länge: bis zu 50
key_index – Typ: int, Wertebereich: [1 bis 4]
eap_options – Typ: int, Wertebereich: Siehe Symbole
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]

Antwort:

keine Antwort

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 request/master_brick/<UID>/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 request/master_brick/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für encryption:

"wpa_wpa2" = 0
"wpa_enterprise" = 1
"wep" = 2
"no_encryption" = 3

Für eap_options:

"outer_auth_eap_fast" = 0
"outer_auth_eap_tls" = 1
"outer_auth_eap_ttls" = 2
"outer_auth_eap_peap" = 3
"inner_auth_eap_mschap" = 0
"inner_auth_eap_gtc" = 4
"cert_type_ca_cert" = 0
"cert_type_client_cert" = 8
"cert_type_private_key" = 16

request/master_brick/<UID>/get_wifi_encryption¶

Anfrage:

keine Nutzdaten

Antwort:

encryption – Typ: int, Wertebereich: Siehe Symbole
key – Typ: string, Länge: bis zu 50
key_index – Typ: int, Wertebereich: [1 bis 4]
eap_options – Typ: int, Wertebereich: Siehe Symbole
ca_certificate_length – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
client_certificate_length – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
private_key_length – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die Verschlüsselungseinstellungen zurück, wie von request/master_brick/<UID>/set_wifi_encryption gesetzt.

Bemerkung

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

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

Für encryption:

"wpa_wpa2" = 0
"wpa_enterprise" = 1
"wep" = 2
"no_encryption" = 3

Für eap_options:

"outer_auth_eap_fast" = 0
"outer_auth_eap_tls" = 1
"outer_auth_eap_ttls" = 2
"outer_auth_eap_peap" = 3
"inner_auth_eap_mschap" = 0
"inner_auth_eap_gtc" = 4
"cert_type_ca_cert" = 0
"cert_type_client_cert" = 8
"cert_type_private_key" = 16

request/master_brick/<UID>/get_wifi_status¶

Anfrage:

keine Nutzdaten

Antwort:

mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
bssid – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
channel – Typ: int, Wertebereich: ?
rssi – Typ: int, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
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]
rx_count – Typ: int, Wertebereich: [0 bis 2³² - 1]
tx_count – Typ: int, Wertebereich: [0 bis 2³² - 1]
state – Typ: int, Wertebereich: Siehe Symbole

Gibt den Status der WIFI Extension zurück. state wird automatisch aktualisiert, alle anderen Parameter werden nur beim Starten und nach jedem Aufruf von request/master_brick/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für state:

"disassociated" = 0
"associated" = 1
"associating" = 2
"error" = 3
"not_initialized_yet" = 255

request/master_brick/<UID>/refresh_wifi_status¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Aktualisiert den WLAN Status (siehe request/master_brick/<UID>/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.

request/master_brick/<UID>/set_wifi_certificate¶

Anfrage:	index – Typ: int, Wertebereich: [0 bis 1311, 10000 bis 11311, 20000 bis 24319, 65534 bis 2¹⁶ - 1] data – Typ: [int, ...], Länge: 32, Wertebereich: [0 bis 255] data_length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 32]
Antwort:	keine Antwort

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.

request/master_brick/<UID>/get_wifi_certificate¶

Anfrage:	index – Typ: int, Wertebereich: [0 bis 1311, 10000 bis 11311, 20000 bis 24319, 65534 bis 2¹⁶ - 1]
Antwort:	data – Typ: [int, ...], Länge: 32, Wertebereich: [0 bis 255] data_length – Typ: int, Wertebereich: [0 bis 32]

Gibt das Zertifikat für einen Index zurück, wie von request/master_brick/<UID>/set_wifi_certificate gesetzt.

request/master_brick/<UID>/set_wifi_power_mode¶

Anfrage:	mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für mode:

"full_speed" = 0
"low_power" = 1

request/master_brick/<UID>/get_wifi_power_mode¶

Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt den Stromsparmodus zurück, wie von request/master_brick/<UID>/set_wifi_power_mode gesetzt.

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

Für mode:

"full_speed" = 0
"low_power" = 1

request/master_brick/<UID>/get_wifi_buffer_info¶

Anfrage:	keine Nutzdaten
Antwort:	overflow – Typ: int, Wertebereich: [0 bis 2³² - 1] low_watermark – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 1500] 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.

request/master_brick/<UID>/set_wifi_regulatory_domain¶

Anfrage:	domain – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für domain:

"channel_1to11" = 0
"channel_1to13" = 1
"channel_1to14" = 2

request/master_brick/<UID>/get_wifi_regulatory_domain¶

Anfrage:	keine Nutzdaten
Antwort:	domain – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1

Gibt den Geltungsbereich zurück, wie von request/master_brick/<UID>/set_wifi_regulatory_domain gesetzt.

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

Für domain:

"channel_1to11" = 0
"channel_1to13" = 1
"channel_1to14" = 2

request/master_brick/<UID>/get_usb_voltage¶

Anfrage:	keine Nutzdaten
Antwort:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

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

request/master_brick/<UID>/set_long_wifi_key¶

Anfrage:	key – Typ: string, Länge: bis zu 64
Antwort:	keine Antwort

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 request/master_brick/<UID>/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).

request/master_brick/<UID>/get_long_wifi_key¶

Anfrage:	keine Nutzdaten
Antwort:	key – Typ: string, Länge: bis zu 64

Gibt den Verschlüsselungsschlüssel zurück, wie von request/master_brick/<UID>/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).

request/master_brick/<UID>/set_wifi_hostname¶

Anfrage:	hostname – Typ: string, Länge: bis zu 16
Antwort:	keine Antwort

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).

request/master_brick/<UID>/get_wifi_hostname¶

Anfrage:	keine Nutzdaten
Antwort:	hostname – Typ: string, Länge: bis zu 16

Gibt den Hostnamen zurück, wie von request/master_brick/<UID>/set_wifi_hostname gesetzt.

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

Neu in Version 2.0.5 (Firmware).

request/master_brick/<UID>/is_ethernet_present¶

Anfrage:	keine Nutzdaten
Antwort:	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).

request/master_brick/<UID>/set_ethernet_configuration¶

Anfrage:	connection – Typ: int, Wertebereich: Siehe Symbole 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 2¹⁶ - 1], Standardwert: 4223
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für connection:

"dhcp" = 0
"static_ip" = 1

Neu in Version 2.1.0 (Firmware).

request/master_brick/<UID>/get_ethernet_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	connection – Typ: int, Wertebereich: Siehe Symbole 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 2¹⁶ - 1], Standardwert: 4223

Gibt die Konfiguration zurück, wie von request/master_brick/<UID>/set_ethernet_configuration gesetzt.

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

Für connection:

"dhcp" = 0
"static_ip" = 1

Neu in Version 2.1.0 (Firmware).

request/master_brick/<UID>/get_ethernet_status¶

Anfrage:

keine Nutzdaten

Antwort:

mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
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]
rx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
tx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
hostname – Typ: string, 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).

request/master_brick/<UID>/set_ethernet_hostname¶

Anfrage:	hostname – Typ: string, Länge: bis zu 32
Antwort:	keine Antwort

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 request/master_brick/<UID>/get_ethernet_status herausgefunden werden.

Neu in Version 2.1.0 (Firmware).

request/master_brick/<UID>/set_ethernet_mac_address¶

Anfrage:	mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
Antwort:	keine Antwort

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 request/master_brick/<UID>/get_ethernet_status wieder ausgelesen werden.

Neu in Version 2.1.0 (Firmware).

request/master_brick/<UID>/set_ethernet_websocket_configuration¶

Anfrage:	sockets – Typ: int, Wertebereich: [0 bis 7], Standardwert: 3 port – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 4280
Antwort:	keine Antwort

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).

request/master_brick/<UID>/get_ethernet_websocket_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	sockets – Typ: int, Wertebereich: [0 bis 7], Standardwert: 3 port – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 4280

Gibt die Konfiguration zurück, wie von request/master_brick/<UID>/set_ethernet_configuration gesetzt.

Neu in Version 2.2.0 (Firmware).

request/master_brick/<UID>/set_ethernet_authentication_secret¶

Anfrage:	secret – Typ: string, Länge: bis zu 64, Standardwert: ""
Antwort:	keine Antwort

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).

request/master_brick/<UID>/get_ethernet_authentication_secret¶

Anfrage:	keine Nutzdaten
Antwort:	secret – Typ: string, Länge: bis zu 64, Standardwert: ""

Gibt das Authentifizierungsgeheimnis zurück, wie von request/master_brick/<UID>/set_ethernet_authentication_secret gesetzt.

Neu in Version 2.2.0 (Firmware).

request/master_brick/<UID>/set_wifi_authentication_secret¶

Anfrage:	secret – Typ: string, Länge: bis zu 64, Standardwert: ""
Antwort:	keine Antwort

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).

request/master_brick/<UID>/get_wifi_authentication_secret¶

Anfrage:	keine Nutzdaten
Antwort:	secret – Typ: string, Länge: bis zu 64, Standardwert: ""

Gibt das Authentifizierungsgeheimnis zurück, wie von request/master_brick/<UID>/set_wifi_authentication_secret gesetzt.

Neu in Version 2.2.0 (Firmware).

request/master_brick/<UID>/get_connection_type¶

Anfrage:	keine Nutzdaten
Antwort:	connection_type – Typ: int, Wertebereich: Siehe Symbole

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

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

Für connection_type:

"none" = 0
"usb" = 1
"spi_stack" = 2
"chibi" = 3
"rs485" = 4
"wifi" = 5
"ethernet" = 6
"wifi2" = 7

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/is_wifi2_present¶

Anfrage:	keine Nutzdaten
Antwort:	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).

request/master_brick/<UID>/start_wifi2_bootloader¶

Anfrage:	keine Nutzdaten
Antwort:	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 request/master_brick/<UID>/write_wifi2_serial_port und request/master_brick/<UID>/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 request/master_brick/<UID>/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).

request/master_brick/<UID>/write_wifi2_serial_port¶

Anfrage:	data – Typ: [int, ...], Länge: 60, Wertebereich: [0 bis 255] length – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 60]
Antwort:	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 request/master_brick/<UID>/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).

request/master_brick/<UID>/read_wifi2_serial_port¶

Anfrage:	length – Typ: int, Wertebereich: [0 bis 255]
Antwort:	data – Typ: [int, ...], Länge: 60, Wertebereich: [0 bis 60] 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 request/master_brick/<UID>/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).

request/master_brick/<UID>/set_wifi2_authentication_secret¶

Anfrage:	secret – Typ: string, Länge: bis zu 64
Antwort:	keine Antwort

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 request/master_brick/<UID>/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).

request/master_brick/<UID>/get_wifi2_authentication_secret¶

Anfrage:	keine Nutzdaten
Antwort:	secret – Typ: string, Länge: bis zu 64

Gibt das WLAN-Authentifizierungsgeheimnis zurück, wie von request/master_brick/<UID>/set_wifi2_authentication_secret gesetzt.

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/set_wifi2_configuration¶

Anfrage:

port – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 4223
websocket_port – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 4280
website_port – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 80
phy_mode – Typ: int, Wertebereich: Siehe Symbole
sleep_mode – Typ: int, Wertebereich: [0 bis 255]
website – Typ: int, Wertebereich: [0 bis 255]

Antwort:

keine Antwort

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.

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

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

Für phy_mode:

"b" = 0
"g" = 1
"n" = 2

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/get_wifi2_configuration¶

Anfrage:

keine Nutzdaten

Antwort:

port – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 4223
websocket_port – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 4280
website_port – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 80
phy_mode – Typ: int, Wertebereich: Siehe Symbole
sleep_mode – Typ: int, Wertebereich: [0 bis 255]
website – Typ: int, Wertebereich: [0 bis 255]

Gibt die allgemeine Konfiguration zurück, wie von request/master_brick/<UID>/set_wifi2_configuration gesetzt.

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

Für phy_mode:

"b" = 0
"g" = 1
"n" = 2

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/get_wifi2_status¶

Anfrage:

keine Nutzdaten

Antwort:

client_enabled – Typ: bool
client_status – Typ: int, Wertebereich: Siehe Symbole
client_ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
client_subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
client_gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
client_mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
client_rx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
client_tx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
client_rssi – Typ: int, Wertebereich: [-128 bis 127]
ap_enabled – Typ: bool
ap_ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
ap_subnet_mask – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
ap_gateway – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
ap_mac_address – Typ: [int, ...], Länge: 6, Wertebereich: [0 bis 255]
ap_rx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
ap_tx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
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 Symbole sind für diese Funktion verfügbar:

Für client_status:

"idle" = 0
"connecting" = 1
"wrong_password" = 2
"no_ap_found" = 3
"connect_failed" = 4
"got_ip" = 5
"unknown" = 255

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/set_wifi2_client_configuration¶

Anfrage:

enable – Typ: bool, Standardwert: true
ssid – Typ: string, 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]

Antwort:

keine Antwort

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.

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

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/get_wifi2_client_configuration¶

Anfrage:

keine Nutzdaten

Antwort:

enable – Typ: bool, Standardwert: true
ssid – Typ: string, 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]

Gibt die Client Konfiguration zurück, wie von request/master_brick/<UID>/set_wifi2_client_configuration gesetzt.

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/set_wifi2_client_hostname¶

Anfrage:	hostname – Typ: string, Länge: bis zu 32
Antwort:	keine Antwort

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.

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

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/get_wifi2_client_hostname¶

Anfrage:	keine Nutzdaten
Antwort:	hostname – Typ: string, Länge: bis zu 32

Gibt den Client Hostnamen zurück, wie von request/master_brick/<UID>/set_wifi2_client_hostname gesetzt.

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/set_wifi2_client_password¶

Anfrage:	password – Typ: string, Länge: bis zu 64
Antwort:	keine Antwort

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

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

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/get_wifi2_client_password¶

Anfrage:	keine Nutzdaten
Antwort:	password – Typ: string, Länge: bis zu 64

Gibt das Client-Passwort zurück, wie von request/master_brick/<UID>/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).

request/master_brick/<UID>/set_wifi2_ap_configuration¶

Anfrage:

enable – Typ: bool, Standardwert: true
ssid – Typ: string, 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 Symbole, 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]

Antwort:

keine Antwort

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 request/master_brick/<UID>/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.

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

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

Für encryption:

"open" = 0
"wep" = 1
"wpa_psk" = 2
"wpa2_psk" = 3
"wpa_wpa2_psk" = 4

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/get_wifi2_ap_configuration¶

Anfrage:

keine Nutzdaten

Antwort:

enable – Typ: bool, Standardwert: true
ssid – Typ: string, 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 Symbole, 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]

Gibt die Access-Point-Konfiguration zurück, wie von request/master_brick/<UID>/set_wifi2_ap_configuration gesetzt.

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

Für encryption:

"open" = 0
"wep" = 1
"wpa_psk" = 2
"wpa2_psk" = 3
"wpa_wpa2_psk" = 4

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/set_wifi2_ap_password¶

Anfrage:	password – Typ: string, Länge: bis zu 64
Antwort:	keine Antwort

Setzt das Access-Point-Passwort (mindestens 8 und bis zu 63 Zeichen) für den eingestellten Verschlüsselungsmodus, siehe request/master_brick/<UID>/set_wifi2_ap_configuration.

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

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/get_wifi2_ap_password¶

Anfrage:	keine Nutzdaten
Antwort:	password – Typ: string, Länge: bis zu 64

Gibt das Access-Point-Passwort zurück, wie von request/master_brick/<UID>/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).

request/master_brick/<UID>/save_wifi2_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	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).

request/master_brick/<UID>/get_wifi2_firmware_version¶

Anfrage:	keine Nutzdaten
Antwort:	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).

request/master_brick/<UID>/enable_wifi2_status_led¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/disable_wifi2_status_led¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/is_wifi2_status_led_enabled¶

Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: true

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

Neu in Version 2.4.0 (Firmware).

request/master_brick/<UID>/set_wifi2_mesh_configuration¶

Anfrage:

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: string, Länge: bis zu 16
gateway_ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
gateway_port – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Antwort:

keine Antwort

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 request/master_brick/<UID>/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.

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

Neu in Version 2.4.2 (Firmware).

request/master_brick/<UID>/get_wifi2_mesh_configuration¶

Anfrage:

keine Nutzdaten

Antwort:

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: string, Länge: bis zu 16
gateway_ip – Typ: [int, ...], Länge: 4, Wertebereich: [0 bis 255]
gateway_port – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Benötigt WIFI Extension 2.0 Firmware 2.1.0.

Gibt das Mesh Konfiguration zurück, wie von request/master_brick/<UID>/set_wifi2_mesh_configuration gesetzt.

Neu in Version 2.4.2 (Firmware).

request/master_brick/<UID>/set_wifi2_mesh_router_ssid¶

Anfrage:	ssid – Typ: string, Länge: bis zu 32
Antwort:	keine Antwort

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.

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

Neu in Version 2.4.2 (Firmware).

request/master_brick/<UID>/get_wifi2_mesh_router_ssid¶

Anfrage:	keine Nutzdaten
Antwort:	ssid – Typ: string, Länge: bis zu 32

Benötigt WIFI Extension 2.0 Firmware 2.1.0.

Gibt das Mesh-Router-SSID zurück, wie von request/master_brick/<UID>/set_wifi2_mesh_router_ssid gesetzt.

Neu in Version 2.4.2 (Firmware).

request/master_brick/<UID>/set_wifi2_mesh_router_password¶

Anfrage:	password – Typ: string, Länge: bis zu 64
Antwort:	keine Antwort

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.

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

Neu in Version 2.4.2 (Firmware).

request/master_brick/<UID>/get_wifi2_mesh_router_password¶

Anfrage:	keine Nutzdaten
Antwort:	password – Typ: string, Länge: bis zu 64

Benötigt WIFI Extension 2.0 Firmware 2.1.0.

Gibt das Mesh-Router-Password zurück, wie von request/master_brick/<UID>/set_wifi2_mesh_router_password gesetzt.

Neu in Version 2.4.2 (Firmware).

request/master_brick/<UID>/get_wifi2_mesh_common_status¶

Anfrage:	keine Nutzdaten
Antwort:	status – Typ: int, Wertebereich: Siehe Symbole root_node – Typ: bool root_candidate – Typ: bool connected_nodes – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1] rx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1] tx_count – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 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 Symbole sind für diese Funktion verfügbar:

Für status:

"disabled" = 0
"wifi_connecting" = 1
"got_ip" = 2
"mesh_local" = 3
"mesh_online" = 4
"ap_available" = 5
"ap_setup" = 6
"leaf_available" = 7

Neu in Version 2.4.2 (Firmware).

request/master_brick/<UID>/get_wifi2_mesh_client_status¶

Anfrage:	keine Nutzdaten
Antwort:	hostname – Typ: string, 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]

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).

request/master_brick/<UID>/get_wifi2_mesh_ap_status¶

Anfrage:	keine Nutzdaten
Antwort:	ssid – Typ: string, 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]

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).

request/master_brick/<UID>/set_spitfp_baudrate_config¶

Anfrage:	enable_dynamic_baudrate – Typ: bool, Standardwert: true minimum_dynamic_baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000
Antwort:	keine Antwort

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 request/master_brick/<UID>/set_spitfp_baudrate. gesetzt werden. Falls die dynamische Baudrate nicht aktiviert ist, wird die Baudrate wie von request/master_brick/<UID>/set_spitfp_baudrate gesetzt statisch verwendet.

Neu in Version 2.4.6 (Firmware).

request/master_brick/<UID>/get_spitfp_baudrate_config¶

Anfrage:	keine Nutzdaten
Antwort:	enable_dynamic_baudrate – Typ: bool, Standardwert: true minimum_dynamic_baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 400000

Gibt die Baudratenkonfiguration zurück, siehe request/master_brick/<UID>/set_spitfp_baudrate_config.

Neu in Version 2.4.6 (Firmware).

request/master_brick/<UID>/get_send_timeout_count¶

Anfrage:	communication_method – Typ: int, Wertebereich: Siehe Symbole
Antwort:	timeout_count – Typ: int, Wertebereich: [0 bis 2³² - 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 Symbole sind für diese Funktion verfügbar:

Für communication_method:

"none" = 0
"usb" = 1
"spi_stack" = 2
"chibi" = 3
"rs485" = 4
"wifi" = 5
"ethernet" = 6
"wifi_v2" = 7

Neu in Version 2.4.3 (Firmware).

request/master_brick/<UID>/set_spitfp_baudrate¶

Anfrage:	bricklet_port – Typ: char, Wertebereich: ["a" bis "d"] baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000
Antwort:	keine Antwort

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 request/master_brick/<UID>/get_spitfp_error_count) kann die Baudrate verringert werden.

Wenn das Feature der dynamische Baudrate aktiviert ist, setzt diese Funktion die maximale Baudrate (siehe request/master_brick/<UID>/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).

request/master_brick/<UID>/get_spitfp_baudrate¶

Anfrage:	bricklet_port – Typ: char, Wertebereich: ["a" bis "d"]
Antwort:	baudrate – Typ: int, Einheit: 1 Bd, Wertebereich: [400000 bis 2000000], Standardwert: 1400000

Gibt die Baudrate für einen Bricklet Port zurück, siehe request/master_brick/<UID>/set_spitfp_baudrate.

Neu in Version 2.4.3 (Firmware).

request/master_brick/<UID>/get_spitfp_error_count¶

Anfrage:	bricklet_port – Typ: char, Wertebereich: ["a" bis "d"]
Antwort:	error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: int, Wertebereich: [0 bis 2³² - 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).

request/master_brick/<UID>/enable_status_led¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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).

request/master_brick/<UID>/disable_status_led¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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).

request/master_brick/<UID>/is_status_led_enabled¶

Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: true

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

Neu in Version 2.3.2 (Firmware).

request/master_brick/<UID>/get_chip_temperature¶

Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int, Einheit: 1/10 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 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.

request/master_brick/<UID>/reset¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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.

request/master_brick/<UID>/get_identity¶

Anfrage:

keine Nutzdaten

Antwort:

uid – Typ: string, Länge: bis zu 8
connected_uid – Typ: string, Länge: bis zu 8
position – Typ: char, Wertebereich: ["0" bis "8"]
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]

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]

device_identifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
_display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Master.

Konfigurationsfunktionen für Callbacks¶

request/master_brick/<UID>/set_stack_current_callback_period¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der register/master_brick/<UID>/stack_current Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/master_brick/<UID>/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).

request/master_brick/<UID>/get_stack_current_callback_period¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/master_brick/<UID>/set_stack_current_callback_period gesetzt

Neu in Version 2.0.5 (Firmware).

request/master_brick/<UID>/set_stack_voltage_callback_period¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der register/master_brick/<UID>/stack_voltage Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/master_brick/<UID>/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).

request/master_brick/<UID>/get_stack_voltage_callback_period¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/master_brick/<UID>/set_stack_voltage_callback_period gesetzt

Neu in Version 2.0.5 (Firmware).

request/master_brick/<UID>/set_usb_voltage_callback_period¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der register/master_brick/<UID>/usb_voltage Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/master_brick/<UID>/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).

request/master_brick/<UID>/get_usb_voltage_callback_period¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/master_brick/<UID>/set_usb_voltage_callback_period gesetzt

Neu in Version 2.0.5 (Firmware).

request/master_brick/<UID>/set_stack_current_callback_threshold¶

Anfrage:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert für den register/master_brick/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für option:

"off" = "x"
"outside" = "o"
"inside" = "i"
"smaller" = "<"
"greater" = ">"

Neu in Version 2.0.5 (Firmware).

request/master_brick/<UID>/get_stack_current_callback_threshold¶

Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/master_brick/<UID>/set_stack_current_callback_threshold gesetzt.

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

Für option:

"off" = "x"
"outside" = "o"
"inside" = "i"
"smaller" = "<"
"greater" = ">"

Neu in Version 2.0.5 (Firmware).

request/master_brick/<UID>/set_stack_voltage_callback_threshold¶

Anfrage:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert für den register/master_brick/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für option:

"off" = "x"
"outside" = "o"
"inside" = "i"
"smaller" = "<"
"greater" = ">"

Neu in Version 2.0.5 (Firmware).

request/master_brick/<UID>/get_stack_voltage_callback_threshold¶

Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/master_brick/<UID>/set_stack_voltage_callback_threshold gesetzt.

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

Für option:

"off" = "x"
"outside" = "o"
"inside" = "i"
"smaller" = "<"
"greater" = ">"

Neu in Version 2.0.5 (Firmware).

request/master_brick/<UID>/set_usb_voltage_callback_threshold¶

Anfrage:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert für den register/master_brick/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für option:

"off" = "x"
"outside" = "o"
"inside" = "i"
"smaller" = "<"
"greater" = ">"

Neu in Version 2.0.5 (Firmware).

request/master_brick/<UID>/get_usb_voltage_callback_threshold¶

Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/master_brick/<UID>/set_usb_voltage_callback_threshold gesetzt.

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

Für option:

"off" = "x"
"outside" = "o"
"inside" = "i"
"smaller" = "<"
"greater" = ">"

Neu in Version 2.0.5 (Firmware).

request/master_brick/<UID>/set_debounce_period¶

Anfrage:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Antwort:	keine Antwort

Setzt die Periode mit welcher die Schwellwert Callbacks

register/master_brick/<UID>/stack_current_reached,
register/master_brick/<UID>/stack_voltage_reached,
register/master_brick/<UID>/usb_voltage_reached

ausgelöst werden, wenn die Schwellwerte

request/master_brick/<UID>/set_stack_current_callback_threshold,
request/master_brick/<UID>/set_stack_voltage_callback_threshold,
request/master_brick/<UID>/set_usb_voltage_callback_threshold

weiterhin erreicht bleiben.

Neu in Version 2.0.5 (Firmware).

request/master_brick/<UID>/get_debounce_period¶

Anfrage:	keine Nutzdaten
Antwort:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von request/master_brick/<UID>/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 dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

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.

register/master_brick/<UID>/stack_current¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/master_brick/<UID>/stack_current[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/master_brick/<UID>/stack_current[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/master_brick/<UID>/set_stack_current_callback_period, ausgelöst. Der Payload des Callbacks ist die Stromstärke des Sensors.

Der register/master_brick/<UID>/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).

register/master_brick/<UID>/stack_voltage¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/master_brick/<UID>/stack_voltage[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/master_brick/<UID>/stack_voltage[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/master_brick/<UID>/set_stack_voltage_callback_period, ausgelöst. Der Payload des Callbacks ist die Spannung des Sensors.

Der register/master_brick/<UID>/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).

register/master_brick/<UID>/usb_voltage¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/master_brick/<UID>/usb_voltage[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/master_brick/<UID>/usb_voltage[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/master_brick/<UID>/set_usb_voltage_callback_period, ausgelöst. Der Payload des Callbacks ist die USB Spannung.

Der register/master_brick/<UID>/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 oder neuer.

Neu in Version 2.0.5 (Firmware).

register/master_brick/<UID>/stack_current_reached¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/master_brick/<UID>/stack_current_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/master_brick/<UID>/stack_current_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/master_brick/<UID>/set_stack_current_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist der Stromverbrauch des Stapels.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/master_brick/<UID>/set_debounce_period gesetzt, ausgelöst.

Neu in Version 2.0.5 (Firmware).

register/master_brick/<UID>/stack_voltage_reached¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/master_brick/<UID>/stack_voltage_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/master_brick/<UID>/stack_voltage_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/master_brick/<UID>/set_stack_voltage_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die Spannung des Stapels.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/master_brick/<UID>/set_debounce_period gesetzt, ausgelöst.

Neu in Version 2.0.5 (Firmware).

register/master_brick/<UID>/usb_voltage_reached¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/master_brick/<UID>/usb_voltage_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/master_brick/<UID>/usb_voltage_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/master_brick/<UID>/set_usb_voltage_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die Spannung des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/master_brick/<UID>/set_debounce_period gesetzt, ausgelöst.

Neu in Version 2.0.5 (Firmware).

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.

request/master_brick/<UID>/set_bricklet_xmc_flash_config¶

Anfrage:	config – Typ: int, Wertebereich: [0 bis 2³² - 1] parameter1 – Typ: int, Wertebereich: [0 bis 2³² - 1] parameter2 – Typ: int, Wertebereich: [0 bis 2³² - 1] data – Typ: [int, ...], Länge: 52, Wertebereich: [0 bis 255]
Antwort:	return_value – Typ: int, Wertebereich: [0 bis 2³² - 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).

request/master_brick/<UID>/set_bricklet_xmc_flash_data¶

Anfrage:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:	return_data – Typ: int, Wertebereich: [0 bis 2³² - 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).

request/master_brick/<UID>/set_bricklets_enabled¶

Anfrage:	bricklets_enabled – Typ: bool
Antwort:	keine Antwort

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).

request/master_brick/<UID>/get_bricklets_enabled¶

Anfrage:	keine Nutzdaten
Antwort:	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).

request/master_brick/<UID>/get_protocol1_bricklet_name¶

Anfrage:	port – Typ: char, Wertebereich: ["a" bis "d"]
Antwort:	protocol_version – Typ: int, Wertebereich: [0 bis 255] 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] name – Typ: string, 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.

request/master_brick/<UID>/write_bricklet_plugin¶

Anfrage:	port – Typ: char, Wertebereich: ["a" bis "d"] offset – Typ: int, Wertebereich: [0 bis 255] chunk – Typ: [int, ...], Länge: 32, Wertebereich: [0 bis 255]
Antwort:	keine Antwort

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.

request/master_brick/<UID>/read_bricklet_plugin¶

Anfrage:	port – Typ: char, Wertebereich: ["a" bis "d"] offset – Typ: int, Wertebereich: [0 bis 255]
Antwort:	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.