SerialPort: open() Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Hinweis: Diese Funktion ist in Dedicated Web Workers verfügbar.

Die open() Methode der SerialPort Schnittstelle gibt ein Promise zurück, das erfüllt wird, wenn der Port geöffnet wird. Standardmäßig wird der Port mit 8 Datenbits, 1 Stoppbit und ohne Paritätsprüfung geöffnet. Der baudRate-Parameter ist erforderlich.

Syntax

js
open(options)

Parameter

options

Ein Objekt mit einem der folgenden Werte:

baudRate

Ein positiver, nicht nullwertiger Wert, der die Baudrate angibt, mit der die serielle Kommunikation hergestellt werden soll.

bufferSize Optional

Ein nicht signierter langer Ganzzahlwert, der die Größe der zu etablierenden Lese- und Schreibpuffer angibt. Wenn nicht übergeben, beträgt die Vorgabe 255.

dataBits Optional

Ein Ganzzahlwert von 7 oder 8, der die Anzahl der Datenbits pro Rahmen angibt. Wenn nicht übergeben, beträgt die Vorgabe 8.

flowControl Optional

Der Flusskontrolltyp, entweder "none" oder "hardware". Der Standardwert ist "none".

parity Optional

Der Paritätsmodus, entweder "none", "even" oder "odd". Der Standardwert ist "none".

stopBits Optional

Ein Ganzzahlwert von 1 oder 2, der die Anzahl der Stoppbits am Ende des Rahmens angibt. Wenn nicht übergeben, beträgt die Vorgabe 1.

Rückgabewert

Ein Promise.

Ausnahmen

InvalidStateError DOMException

Wird zurückgegeben, wenn der Port bereits geöffnet ist.

NetworkError DOMException

Wird zurückgegeben, wenn der Versuch, den Port zu öffnen, fehlschlägt.

Beispiele

Bevor eine Kommunikation über einen seriellen Port erfolgen kann, muss dieser geöffnet werden. Das Öffnen des Ports ermöglicht es der Seite, die notwendigen Parameter festzulegen, die steuern, wie Daten übertragen und empfangen werden. Entwickler sollten die Dokumentation des Geräts, mit dem sie sich verbinden, für die geeigneten Parameter überprüfen.

js
await port.open({ baudRate: 9600 /* pick your baud rate */ });

Spezifikationen

Specification
Web Serial API
# dom-serialport-open

Browser-Kompatibilität