chroom.serieel

Beschrijving

Gebruik de chrome.serial API om gegevens te lezen van en te schrijven naar een apparaat dat is aangesloten op een seriële poort.

Toestemmingen

serial

Beschikbaarheid

alleen ChromeOS

Soorten

ConnectionInfo

Eigenschappen

  • bitrate

    nummer optioneel

    Zie ConnectionOptions.bitrate . Dit veld kan ontbreken of onjuist zijn als een niet-standaard bitrate wordt gebruikt, of als er een fout is opgetreden tijdens het opvragen van de gegevens van het onderliggende apparaat.

  • bufferSize

    nummer

    Zie ConnectionOptions.bufferSize

  • verbindings-ID

    nummer

    De ID van de seriële poortverbinding.

  • ctsFlowControl

    boolean optioneel

    Zie ConnectionOptions.ctsFlowControl . Dit veld kan worden weggelaten als er een fout is opgetreden tijdens het opvragen van het onderliggende apparaat.

  • dataBits

    DataBits optioneel

    Zie ConnectionOptions.dataBits . Dit veld kan worden weggelaten als er een fout is opgetreden tijdens het opvragen van het onderliggende apparaat.

  • naam

    snaar

    Zie ConnectionOptions.name

  • pariteitsbit

    Pariteitsbit optioneel

    Zie ConnectionOptions.parityBit . Dit veld kan worden weggelaten als er een fout is opgetreden tijdens het opvragen van het onderliggende apparaat.

  • pauzeerde

    booleaans

    Vlag die aangeeft of de verbinding is geblokkeerd voor het verzenden van onReceive-gebeurtenissen.

  • volhardend

    booleaans

    Zie ConnectionOptions.persistent

  • ontvangstTimeout

    nummer

    Zie ConnectionOptions.receiveTimeout

  • verzendTime-out

    nummer

    Zie ConnectionOptions.sendTimeout

  • stopBits

    StopBits optioneel

    Zie ConnectionOptions.stopBits . Dit veld kan worden weggelaten als er een fout is opgetreden tijdens het opvragen van het onderliggende apparaat.

ConnectionOptions

Eigenschappen

  • bitrate

    nummer optioneel

    De gevraagde bitrate voor de te openen verbinding. Voor compatibiliteit met een zo breed mogelijk scala aan hardware moet dit getal overeenkomen met een van de gangbare bitrates, zoals 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200. Er is uiteraard geen garantie dat het apparaat dat op de seriële poort is aangesloten de gevraagde bitrate ondersteunt, zelfs als de poort zelf die bitrate ondersteunt. Standaard wordt 9600 doorgegeven.

  • bufferSize

    nummer optioneel

    De grootte van de buffer die wordt gebruikt om gegevens te ontvangen. De standaardwaarde is 4096.

  • ctsFlowControl

    boolean optioneel

    Vlag die aangeeft of RTS/CTS-hardwareflowcontrol al dan niet moet worden ingeschakeld. Standaard is dit 'false'.

  • dataBits

    DataBits optioneel

    "eight" wordt standaard doorgegeven.

  • naam

    string optioneel

    Een door de applicatie gedefinieerde tekenreeks die aan de verbinding moet worden gekoppeld.

  • pariteitsbit

    Pariteitsbit optioneel

    "no" wordt standaard doorgegeven.

  • volhardend

    boolean optioneel

    Vlag die aangeeft of de verbinding open moet blijven wanneer de applicatie wordt onderbroken (zie Levenscyclus van de applicatie beheren ). De standaardwaarde is "false". Wanneer de applicatie wordt geladen, kunnen alle seriële verbindingen die eerder met persistent=true zijn geopend, worden opgehaald met getConnections .

  • ontvangstTimeout

    nummer optioneel

    De maximale wachttijd (in milliseconden) voor nieuwe gegevens voordat een onReceiveError -gebeurtenis met een "timeout"-fout wordt gegenereerd. Indien nul, worden er geen timeout-fouten gegenereerd voor de verbinding. De standaardwaarde is 0.

  • verzendTime-out

    nummer optioneel

    De maximale wachttijd (in milliseconden) voordat een verzendbewerking is voltooid en de send -functie wordt aangeroepen met een "timeout"-fout. Indien nul, worden er geen timeout-fouten bij het verzenden gegenereerd. De standaardwaarde is 0.

  • stopBits

    StopBits optioneel

    "one" wordt standaard doorgegeven.

DataBits

Enum

"zeven"

"acht"

DeviceControlSignals

Eigenschappen

  • cts

    booleaans

    CTS (Clear To Send).

  • dcd

    booleaans

    DCD (Data Carrier Detect) of RLSD (Receive Line Signal/Detect).

  • dsr

    booleaans

    DSR (Data Set Ready).

  • ri

    booleaans

    RI (Ring Indicator).

DeviceInfo

Eigenschappen

  • displayweergave

    string optioneel

    Een voor mensen leesbare weergavenaam voor het onderliggende apparaat, indien deze kan worden opgevraagd bij het hoststuurprogramma.

  • pad

    snaar

    Het systeempad van het apparaat. Dit moet als path worden doorgegeven aan chrome.serial.connect om verbinding te maken met dit apparaat.

  • productId

    nummer optioneel

    Een USB-product-ID, indien deze kan worden vastgesteld voor het betreffende apparaat.

  • leveranciers-ID

    nummer optioneel

    Een PCI- of USB-vendor-ID, indien deze kan worden vastgesteld voor het betreffende apparaat.

HostControlSignals

Eigenschappen

  • dtr

    boolean optioneel

    DTR (Data Terminal Ready).

  • rts

    boolean optioneel

    RTS (Request To Send).

ParityBit

Enum

"Nee"

"vreemd"

"zelfs"

ReceiveError

Enum

"losgekoppeld"
De verbinding werd verbroken.

"time-out"
Er zijn gedurende receiveTimeout milliseconden geen gegevens ontvangen.

"apparaat_verloren"
Het apparaat was hoogstwaarschijnlijk losgekoppeld van de host.

"pauze"
Het apparaat heeft een onderbreking geconstateerd.

"frame_error"
Het apparaat heeft een kaderfout gedetecteerd.

"overlopen"
Er is een bufferoverloop opgetreden. Het volgende teken gaat verloren.

"buffer_overflow"
Er is een bufferoverloop opgetreden. Er is geen ruimte meer in de invoerbuffer, of er is een teken ontvangen na het einde-van-bestand-teken (EOF).

"pariteitsfout"
Het apparaat heeft een pariteitsfout gedetecteerd.

"systeemfout"
Er is een systeemfout opgetreden en de verbinding is mogelijk niet meer te herstellen.

ReceiveErrorInfo

Eigenschappen

  • verbindings-ID

    nummer

    De verbindings-ID.

  • Een foutcode die aangeeft wat er mis is gegaan.

ReceiveInfo

Eigenschappen

  • verbindings-ID

    nummer

    De verbindings-ID.

  • gegevens

    ArrayBuffer

    De ontvangen gegevens.

SendError

Enum

"losgekoppeld"
De verbinding werd verbroken.

"in behandeling"
Er stond al een verzending in de wacht.

"time-out"
Het verzenden is mislukt vanwege een time-out.

"systeemfout"
Er is een systeemfout opgetreden en de verbinding is mogelijk niet meer te herstellen.

SendInfo

Eigenschappen

  • bytesSent

    nummer

    Het aantal verzonden bytes.

  • fout

    SendError optioneel

    Een foutcode als er een fout is opgetreden.

StopBits

Enum

"een"

"twee"

Methoden

clearBreak()

Promise Chrome 45+
chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
): Promise<boolean>

Herstel de tekenoverdracht op een bepaalde verbinding en plaats de transmissielijn in een niet-onderbroken toestand.

Parameters

  • verbindings-ID

    nummer

    Het ID van de verbinding.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: boolean) => void

    • resultaat

      booleaans

Retourneert

  • Belofte<boolean>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

connect()

Belofte
chrome.serial.connect(
  path: string,
  options?: ConnectionOptions,
  callback?: function,
): Promise<ConnectionInfo>

Maakt verbinding met een opgegeven seriële poort.

Parameters

  • pad

    snaar

    Het systeempad van de seriële poort die geopend moet worden.

  • opties

    Verbindingsopties optioneel

    Configuratieopties voor de poort.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (connectionInfo: ConnectionInfo) => void

Retourneert

  • Promise< ConnectionInfo >

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

disconnect()

Belofte
chrome.serial.disconnect(
  connectionId: number,
  callback?: function,
): Promise<boolean>

Verbreekt de verbinding met een seriële poort.

Parameters

  • verbindings-ID

    nummer

    De ID van de geopende verbinding.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: boolean) => void

    • resultaat

      booleaans

Retourneert

  • Belofte<boolean>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

flush()

Belofte
chrome.serial.flush(
  connectionId: number,
  callback?: function,
): Promise<boolean>

Maakt alle bytes in de invoer- en uitvoerbuffers van de betreffende verbinding leeg.

Parameters

  • verbindings-ID

    nummer

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: boolean) => void

    • resultaat

      booleaans

Retourneert

  • Belofte<boolean>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getConnections()

Belofte
chrome.serial.getConnections(
  callback?: function,
): Promise<ConnectionInfo[]>

Geeft een overzicht van de momenteel geopende seriële poortverbindingen die door de applicatie worden beheerd.

Parameters

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (connectionInfos: ConnectionInfo[]) => void

Retourneert

  • Promise< ConnectionInfo []>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getControlSignals()

Belofte
chrome.serial.getControlSignals(
  connectionId: number,
  callback?: function,
): Promise<DeviceControlSignals>

Geeft de status van de stuursignalen op een bepaalde verbinding weer.

Parameters

Retourneert

  • Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getDevices()

Belofte
chrome.serial.getDevices(
  callback?: function,
): Promise<DeviceInfo[]>

Geeft informatie over de beschikbare seriële apparaten op het systeem. De lijst wordt telkens opnieuw gegenereerd wanneer deze methode wordt aangeroepen.

Parameters

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (ports: DeviceInfo[]) => void

Retourneert

  • Promise< DeviceInfo []>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getInfo()

Belofte
chrome.serial.getInfo(
  connectionId: number,
  callback?: function,
): Promise<ConnectionInfo>

Geeft de status van een bepaalde verbinding weer.

Parameters

  • verbindings-ID

    nummer

    De ID van de geopende verbinding.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (connectionInfo: ConnectionInfo) => void

Retourneert

  • Promise< ConnectionInfo >

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

send()

Belofte
chrome.serial.send(
  connectionId: number,
  data: ArrayBuffer,
  callback?: function,
): Promise<SendInfo>

Schrijft gegevens naar de opgegeven verbinding.

Parameters

  • verbindings-ID

    nummer

    Het ID van de verbinding.

  • gegevens

    ArrayBuffer

    De te verzenden gegevens.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (sendInfo: SendInfo) => void

Retourneert

  • Promise< SendInfo >

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

setBreak()

Promise Chrome 45+
chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
): Promise<boolean>

Onderbreekt de tekenoverdracht op een bepaalde verbinding en plaatst de transmissielijn in een onderbroken toestand totdat de functie clearBreak wordt aangeroepen.

Parameters

  • verbindings-ID

    nummer

    Het ID van de verbinding.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: boolean) => void

    • resultaat

      booleaans

Retourneert

  • Belofte<boolean>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

setControlSignals()

Belofte
chrome.serial.setControlSignals(
  connectionId: number,
  signals: HostControlSignals,
  callback?: function,
): Promise<boolean>

Stelt de status van de stuursignalen op een bepaalde verbinding in.

Parameters

  • verbindings-ID

    nummer

    Het ID van de verbinding.

  • De reeks signaalwijzigingen die naar het apparaat moeten worden verzonden.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: boolean) => void

    • resultaat

      booleaans

Retourneert

  • Belofte<boolean>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

setPaused()

Belofte
chrome.serial.setPaused(
  connectionId: number,
  paused: boolean,
  callback?: function,
): Promise<void>

Hiermee kunt u een open verbinding pauzeren of hervatten.

Parameters

  • verbindings-ID

    nummer

    De ID van de geopende verbinding.

  • pauzeerde

    booleaans

    Vlag om aan te geven of de weergave gepauzeerd of hervat moet worden.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

update()

Belofte
chrome.serial.update(
  connectionId: number,
  options: ConnectionOptions,
  callback?: function,
): Promise<boolean>

Werk de optie-instellingen bij op een open seriële poortverbinding.

Parameters

  • verbindings-ID

    nummer

    De ID van de geopende verbinding.

  • Configuratieopties voor de poort.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: boolean) => void

    • resultaat

      booleaans

Retourneert

  • Belofte<boolean>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

Evenementen

onReceive

chrome.serial.onReceive.addListener(
  callback: function,
)

Deze gebeurtenis wordt geactiveerd wanneer er gegevens van de verbinding zijn gelezen.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (info: ReceiveInfo) => void

onReceiveError

chrome.serial.onReceiveError.addListener(
  callback: function,
)

Deze gebeurtenis wordt geactiveerd wanneer er een fout optreedt terwijl de runtime wacht op gegevens via de seriële poort. Zodra deze gebeurtenis is geactiveerd, kan de verbinding worden paused . Een "timeout" -fout pauzeert de verbinding niet.

Parameters