chrome.serial

Beschrijving

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

Rechten

serial

Beschikbaarheid

Alleen ChromeOS

Typen

ConnectionInfo

Eigenschappen

  • bitrate

    number optioneel

    Zie ConnectionOptions.bitrate. Dit veld kan worden weggelaten of onnauwkeurig zijn als er een niet-standaard bitsnelheid wordt gebruikt of als er een fout is opgetreden bij het opvragen van het onderliggende apparaat.

  • bufferSize

    getal

    ConnectionOptions.bufferSize bekijken

  • connectionId

    getal

    De ID van de seriële poortverbinding.

  • ctsFlowControl

    booleaans optioneel

    Zie ConnectionOptions.ctsFlowControl. Dit veld kan worden weggelaten als er een fout is opgetreden bij het uitvoeren van een query op het onderliggende apparaat.

  • dataBits

    DataBits optioneel

    Zie ConnectionOptions.dataBits. Dit veld kan worden weggelaten als er een fout is opgetreden bij het uitvoeren van een query op het onderliggende apparaat.

  • name

    tekenreeks

    ConnectionOptions.name bekijken

  • parityBit

    ParityBit optioneel

    Zie ConnectionOptions.parityBit. Dit veld kan worden weggelaten als er een fout is opgetreden bij het uitvoeren van een query op het onderliggende apparaat.

  • onderbroken

    booleaans

    Markering die aangeeft of de verbinding is geblokkeerd voor het activeren van onReceive-gebeurtenissen.

  • persistent

    booleaans

    ConnectionOptions.persistent bekijken

  • receiveTimeout

    getal

    ConnectionOptions.receiveTimeout bekijken

  • sendTimeout

    getal

    ConnectionOptions.sendTimeout bekijken

  • stopBits

    StopBits optioneel

    Zie ConnectionOptions.stopBits. Dit veld kan worden weggelaten als er een fout is opgetreden bij het uitvoeren van een query op het onderliggende apparaat.

ConnectionOptions

Eigenschappen

  • bitrate

    number optioneel

    De gevraagde bitsnelheid van de verbinding die moet worden geopend. Voor compatibiliteit met de breedste reeks hardware moet dit getal overeenkomen met een van de algemeen beschikbare bitsnelheden, zoals 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200. Er is natuurlijk geen garantie dat het apparaat dat is verbonden met de seriële poort, de gevraagde bitsnelheid ondersteunt, zelfs niet als de poort zelf die bitsnelheid ondersteunt. 9600 wordt standaard doorgegeven.

  • bufferSize

    number optioneel

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

  • ctsFlowControl

    booleaans optioneel

    Markering die aangeeft of RTS/CTS-hardwarestroombeheer moet worden aangezet. De standaard is onwaar.

  • dataBits

    DataBits optioneel

    "eight" wordt standaard doorgegeven.

  • name

    tekenreeks optioneel

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

  • parityBit

    ParityBit optioneel

    "no" wordt standaard doorgegeven.

  • persistent

    booleaans optioneel

    Markering die aangeeft of de verbinding open moet blijven als de app wordt opgeschort (zie App-levenscyclus beheren). De standaardwaarde is false. Als de app is geladen, kunnen alle seriële verbindingen die eerder zijn geopend met persistent=true, worden opgehaald met getConnections.

  • receiveTimeout

    number optioneel

    De maximale tijd (in milliseconden) die moet worden gewacht op nieuwe gegevens voordat een onReceiveError-gebeurtenis met een time-outfout wordt geactiveerd. Als je 0 invoert, worden er geen time-outfouten voor de verbinding gegenereerd. De standaardwaarde is 0.

  • sendTimeout

    number optioneel

    De maximale tijd (in milliseconden) die moet worden gewacht tot een send-bewerking is afgerond voordat de callback wordt aangeroepen met een time-outfout. Als u 0 invoert, worden er geen time-outfouten voor verzenden geactiveerd. De standaardwaarde is 0.

  • stopBits

    StopBits optioneel

    "one" wordt standaard doorgegeven.

DataBits

Enum

"seven"

"eight"

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

  • displayName

    tekenreeks optioneel

    Een voor mensen leesbare weergavenaam voor het onderliggende apparaat als deze kan worden opgevraagd via het hoststuurprogramma.

  • pad

    tekenreeks

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

  • productId

    number optioneel

    Een USB-product-ID als deze kan worden bepaald voor het onderliggende apparaat.

  • vendorId

    number optioneel

    Een PCI- of USB-leveranciers-ID als deze kan worden bepaald voor het onderliggende apparaat.

HostControlSignals

Eigenschappen

  • dtr

    booleaans optioneel

    DTR (Data Terminal Ready).

  • rts

    booleaans optioneel

    RTS (Request To Send).

ParityBit

Enum

"no"

"odd"

"even"

ReceiveError

Enum

"disconnected"
De verbinding is verbroken.

timeout
Er zijn gedurende receiveTimeout milliseconden geen gegevens ontvangen.

"device_lost"
De verbinding tussen het apparaat en de host is waarschijnlijk verbroken.

break
Het apparaat heeft een onderbrekingsvoorwaarde waargenomen.

"frame_error"
Het apparaat heeft een framefout gedetecteerd.

"overrun"
Er is een overschrijding van de tekenbuffer opgetreden. Het volgende personage is verloren.

buffer_overflow
Er is een overloop van de invoerbuffer opgetreden. Er is geen ruimte in de invoerbuffer of er is een teken ontvangen na het teken voor het einde van het bestand (EOF).

parity_error
Het apparaat heeft een pariteitsfout gedetecteerd.

system_error
Er is een systeemfout opgetreden en de verbinding kan misschien niet worden hersteld.

ReceiveErrorInfo

Eigenschappen

  • connectionId

    getal

    De verbindings-ID.

  • Een foutcode die aangeeft wat er is misgegaan.

ReceiveInfo

Eigenschappen

  • connectionId

    getal

    De verbindings-ID.

  • gegevens

    ArrayBuffer

    De ontvangen gegevens.

SendError

Enum

disconnected
De verbinding is verbroken.

"pending"
Er is al een verzending in behandeling.

timeout
Er is een time-out opgetreden bij het sturen.

system_error
Er is een systeemfout opgetreden en de verbinding kan misschien niet worden hersteld.

SendInfo

Eigenschappen

  • bytesSent

    getal

    Het aantal verstuurde bytes.

  • fout

    SendError optioneel

    Een foutcode als er een fout is opgetreden.

StopBits

Enum

"one"

"two"

Methoden

clearBreak()

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

Herstel de tekenoverdracht op een bepaalde verbinding en zet de overdrachtsregel in een niet-onderbroken status.

Parameters

  • connectionId

    getal

    De ID van de verbinding.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (result: boolean) => void

    • resultaat

      booleaans

Retourzendingen

  • Promise<boolean>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

connect()

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

Maakt verbinding met een bepaalde seriële poort.

Parameters

  • pad

    tekenreeks

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

  • opties

    ConnectionOptions optioneel

    Opties voor poortconfiguratie.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (connectionInfo: ConnectionInfo) => void

Retourzendingen

  • Promise<ConnectionInfo>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

disconnect()

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

Verbreekt de verbinding met een seriële poort.

Parameters

  • connectionId

    getal

    De ID van de geopende verbinding.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (result: boolean) => void

    • resultaat

      booleaans

Retourzendingen

  • Promise<boolean>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

flush()

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

Wist alle bytes in de invoer- en uitvoerbuffers van de gegeven verbinding.

Parameters

  • connectionId

    getal

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (result: boolean) => void

    • resultaat

      booleaans

Retourzendingen

  • Promise<boolean>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getConnections()

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

Haalt de lijst op met momenteel geopende seriële poortverbindingen die eigendom zijn van de app.

Parameters

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (connectionInfos: ConnectionInfo[]) => void

Retourzendingen

  • Promise<ConnectionInfo[]>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getControlSignals()

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

Haalt de status van besturingssignalen op een bepaalde verbinding op.

Parameters

Retourzendingen

  • Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getDevices()

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

Retourneert informatie over beschikbare seriële apparaten op het systeem. De lijst wordt opnieuw gegenereerd elke keer dat deze methode wordt aangeroepen.

Parameters

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (ports: DeviceInfo[]) => void

Retourzendingen

  • Promise<DeviceInfo[]>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getInfo()

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

Haalt de status van een bepaalde verbinding op.

Parameters

  • connectionId

    getal

    De ID van de geopende verbinding.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (connectionInfo: ConnectionInfo) => void

Retourzendingen

  • Promise<ConnectionInfo>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

send()

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

Schrijft gegevens naar de opgegeven verbinding.

Parameters

  • connectionId

    getal

    De ID van de verbinding.

  • gegevens

    ArrayBuffer

    De gegevens die je wilt sturen.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (sendInfo: SendInfo) => void

Retourzendingen

  • Promise<SendInfo>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

setBreak()

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

Onderbreekt de overdracht van tekens via een bepaalde verbinding en plaatst de overdrachtsregel in een onderbrekingsstatus totdat clearBreak wordt aangeroepen.

Parameters

  • connectionId

    getal

    De ID van de verbinding.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (result: boolean) => void

    • resultaat

      booleaans

Retourzendingen

  • Promise<boolean>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

setControlSignals()

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

Hiermee stel je de status van bedieningssignalen voor een bepaalde verbinding in.

Parameters

  • connectionId

    getal

    De ID van de verbinding.

  • De set signaalwijzigingen die naar het apparaat moet worden gestuurd.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (result: boolean) => void

    • resultaat

      booleaans

Retourzendingen

  • Promise<boolean>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

setPaused()

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

Onderbreekt of hervat een open verbinding.

Parameters

  • connectionId

    getal

    De ID van de geopende verbinding.

  • onderbroken

    booleaans

    Markering om aan te geven of je wilt onderbreken of hervatten.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

update()

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

De optie-instellingen updaten voor een open seriële poortverbinding.

Parameters

  • connectionId

    getal

    De ID van de geopende verbinding.

  • Opties voor poortconfiguratie.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (result: boolean) => void

    • resultaat

      booleaans

Retourzendingen

  • Promise<boolean>

    Chrome 117+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

Evenementen

onReceive

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

Gebeurtenis die wordt geactiveerd als er gegevens zijn gelezen uit de verbinding.

Parameters

onReceiveError

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

Gebeurtenis die wordt geactiveerd als er een fout optreedt terwijl de runtime wacht op gegevens op de seriële poort. Nadat deze gebeurtenis is geactiveerd, kan de verbinding worden ingesteld op paused. Een "timeout"-fout onderbreekt de verbinding niet.

Parameters