Zum Hauptinhalt springen

WLAN-Konfiguration

wifi/state​

Der aktuelle WLAN-Zustand.

Beispiel
# $HOST z.B. warp-AbCd

Lesen​

curl http://$HOST/wifi/state
{
  "connection_state": 3,
  "connection_start": 10117,
  "connection_end": 0,
  "ap_state": 2,
  "ap_bssid": "C4:5B:BE:C0:FF:EE",
  "sta_ip": "10.1.2.3",
  "sta_subnet": "255.255.255.0",
  "sta_rssi": -38,
  "sta_bssid": "71:21:CE:12:F0:12"
}
NameBedeutung
connection_state
int

Zustand der Verbindung zum konfigurierten WLAN. Siehe wifi/sta_config

  • 0 - Nicht konfiguriert
  • 1 - Nicht verbunden
  • 2 - Verbinde
  • 3 - Verbunden
ap_state
int

Zustand des WLAN-Access-Points. Siehe wifi/ap_config

  • 0 - Deaktiviert
  • 1 - Aktiviert
  • 2 - Fallback inaktiv
  • 3 - Fallback aktiv
ap_bssid
string

BSSID des WLAN-Access-Points.

sta_ip
string

Aktuelle IP des Geräts im konfigurierten Netz. 0.0.0.0 falls keine Verbindung besteht.

sta_subnet
string

Aktuelle Subnetzmaske des Geräts im konfigurierten Netz. 0.0.0.0 falls keine Verbindung besteht.

sta_rssi
int

Die aktuelle Empfangsqualität. 0 falls keine Verbindung besteht, sonst negativ. Werte näher 0 entsprechen einem besseren Empfang.

sta_bssid
string

Die BSSID der Gegenstelle, zu der das Gerät verbunden ist.

connection_start
int (ms)

Zeit in Millisekunden zu der die letzte Verbindung aufgebaut wurde.

connection_end
int (ms)

Zeit in Millisekunden zu der die letzte Verbindung getrennt wurde.




wifi/scan​

Löst einen Scan nach WLANs aus. Die Scan-Ergebnisse können derzeit nur über HTTP abgefragt werden. Leerer Payload. Es muss einer der folgenden Werte übergeben werden: null, "", false, 0, [] oder {}

Beispiel
# $HOST z.B. warp-AbCd

Schreiben​

curl http://$HOST/wifi/scan -d 'null'



wifi/sta_config​

Die WLAN-Verbindungskonfiguration.

Beispiel
# $HOST z.B. warp-AbCd

Lesen​

curl http://$HOST/wifi/sta_config
{
  "enable_sta": true,
  "ssid": "Mein WLAN",
  "bssid": [12, 34, 56, 78, 90, 12],
  "bssid_lock": true,
  "passphrase": null,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0",
  "wpa_eap_config": [0, null]
}

Schreiben​

curl http://$HOST/wifi/sta_config -d '{
  "enable_sta": true,
  "ssid": "Mein WLAN",
  "bssid": [12, 34, 56, 78, 90, 12],
  "bssid_lock": true,
  "passphrase": null,
  "ip": "0.0.0.0",
  "gateway": "0.0.0.0",
  "subnet": "0.0.0.0",
  "dns": "0.0.0.0",
  "dns2": "0.0.0.0",
  "wpa_eap_config": [0, null]
}'
NameBedeutung
enable_sta
bool

Gibt an ob eine WLAN-Verbindung zum konfigurierten Netzwerk aufgebaut werden soll.

  • true - Wenn eine WLAN-Verbindung aufgebaut werden soll.
  • false - Wenn nicht.
ssid
string

SSID zu der sich verbunden werden soll.

bssid
int[6]

BSSID zu der sich verbunden werden soll. Dieser Eintrag ist optional und kann leer übergeben werden, wird aber für das bssid_lock benötigt.

bssid_lock
bool

Legt fest, ob sich nur zum WLAN mit der gesetzten BSSID verbunden werden soll. Deaktiviert lassen, falls Repeater o.Ä. verwendet werden sollen.

  • true - Verbindet sich nur zum Access Point mit der übergebenen BSSID.
  • false - Verbindet sich nur zu jedem Access Point mit der konfigurierten SSID, z.B. mit Repeatern.
enable_11b
bool

Legt fest, ob der veraltete und langsame 802.11b-Modus verwendet werden darf. Dieser verlangsamt auch andere Geräte, die zum WLAN verbunden sind, kann aber die Empfangsqualität und Robustheit der Verbindung leicht verbessern.

  • true - Erlaube Verwendung des 802.11b-Modus
  • false - Verbiete Verwendung des 802.11b-Modus
passphrase
string

Die WLAN-Passphrase. Maximal 63 Byte. Dieser Eintrag ist optional und kann leer übergeben werden, falls sich zu einem unverschlüsselten WLAN verbunden werden soll.

ip
string

IP-Adresse, die das Gerät im konfigurierten Netz verwenden soll. Dieser Eintrag und die folgenden sind optional und können als "0.0.0.0" übergeben werden, falls die automatische IP-Adressvergabe (DHCP) verwendet werden soll.

gateway
string

Gateway-Adresse, die das Gerät im konfigurierten Netz verwenden soll.

subnet
string

Subnetzmaske, die das Gerät im konfigurierten Netz verwenden soll.

dns
string

DNS-Server-Adresse, die das Gerät im konfigurierten Netz verwenden soll.

dns2
string

Alternative DNS-Server-Adresse, die das Gerät im konfigurierten Netz verwenden soll.

wpa_eap_config
Union

WPA-Enterprise-Konfiguration

null: WPA Personal




wifi/ap_config​

Die WLAN-Access-Point-Konfiguration. Achtung! Wenn der Access Point deaktiviert wird, und die WLAN-Verbindung bzw. LAN-Verbindung nicht aufgebaut werden kann, bzw. nicht konfiguriert wurde, kann der ESP nur noch durch einen Factory-Reset erreicht werden! Wir empfehlen, den Access Point immer im Fallback-Modus zu belassen.

Beispiel
# $HOST z.B. warp-AbCd

Lesen​

curl http://$HOST/wifi/ap_config
{
  "enable_ap": true,
  "ap_fallback_only": true,
  "ssid": "warp-AbCd",
  "hide_ssid": false,
  "passphrase": null,
  "channel": 0,
  "ip": "10.0.0.1",
  "gateway": "10.0.0.1",
  "subnet": "255.255.255.0"
}

Schreiben​

curl http://$HOST/wifi/ap_config -d '{
  "enable_ap": true,
  "ap_fallback_only": true,
  "ssid": "wallbox_garage",
  "hide_ssid": false,
  "passphrase": null,
  "channel": 0,
  "ip": "10.0.0.1",
  "gateway": "10.0.0.1",
  "subnet": "255.255.255.0"
}'
NameBedeutung
enable_ap
bool

Gibt an ob der Access Point aktiviert werden soll.

  • true - Der AP soll aktiviert werden. Ggfalls. nur als Fallback (siehe ap_fallback_only)
  • false - Der AP soll immer deaktiviert bleiben.
ap_fallback_only
bool

Gibt an ob der Access Point nur aktiviert werden soll, falls die WLAN- und LAN-Verbindungen nicht aufgebaut werden können. Wird ignoriert, falls enable_ap false ist.

  • true - Der AP soll nur aktiviert werden, falls die WLAN- und LAN-Verbindungen nicht aufgebaut werden können.
  • false - Der AP soll immer aktiviert bleiben.
ssid
string

SSID zu der sich verbunden werden soll.

hide_ssid
bool

true falls die SSID versteckt werden soll, ansonsten false.

passphrase
string

Die WLAN-Passphrase. Maximal 63 Byte.

channel
int

Kanal, auf dem der Access Point erreichbar sein soll. Gültige Werte sind 1 bis 13 und 0, falls beim Start ein möglichst unbelegter Kanal ausgewählt werden soll.

ip
string

IP-Adresse, die das Gerät im konfigurierten Netz verwenden soll. Dieser Eintrag und die folgenden sind optional und können als "0.0.0.0" übergeben werden, falls die automatische IP-Adressvergabe (DHCP) verwendet werden soll.

gateway
string

Gateway-Adresse, die das Gerät im konfigurierten Netz verwenden soll.

subnet
string

Subnetzmaske, die das Gerät im konfigurierten Netz verwenden soll.




wifi/scan_results​

Die WLANs, die aufgrund einer durch wifi/scan ausgelösten Suche gefunden wurden.

Beispiel
# $HOST z.B. warp-AbCd
curl http://$HOST/wifi/scan_results
[
  {
    "ssid": "Mein WLAN",
    "bssid": "0C:22:38:4E:5A:0C",
    "rssi": -43,
    "channel": 9,
    "encryption": 3
  },
  {
    "ssid": "Mein WLAN",
    "bssid": "0C:22:38:4E:5A:0D",
    "rssi": -43,
    "channel": 13,
    "encryption": 3
  },
  {
    "ssid": "Anderes WLAN",
    "bssid": "C0:FF:EE:4E:5A:0C",
    "rssi": -75,
    "channel": 1,
    "encryption": 3
  }
]

Zwei Repeater des selben WLANs haben die gleiche SSID, aber unterschiedliche BSSIDs. Durch das bssid_lock in wifi/sta_config kann eine Verbindung zu einem spezifischen Repeater erzwungen werden.

IndexBedeutung
[..]
object
NameBedeutung
ssid
string

SSID des gefundenen WLANs. Leer bei versteckten Access Points.

bssid
string

BSSID des gefundenen WLANs.

rssi
int

Die Empfangsqualität des gefundenen WLANs. Immer ein negativer Wert, wobei Werte nahe 0 eine bessere Empfangsqualität bedeuten. Siehe hier für Details

channel
int

Kanal des gefundenen WLANs.

encryption
int

Verschlüsselungsstandard des gefundenen WLANs

  • 0 - Unverschlüsselt
  • 1 - WEP
  • 2 - WPA-PSK
  • 3 - WPA2-PSK
  • 4 - WPA/WPA2-PSK
  • 5 - WPA2-Enterprise
  • 6 - Unbekannt