chroom.serieel

Beschrijving

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

Rechten

serial

Soorten

ConnectionInfo

Eigenschappen

  • bitsnelheid

    nummer optioneel

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

  • buffer grootte

    nummer

    Zie ConnectionOptions.bufferSize

  • verbindingId

    nummer

    De id van de seriële poortverbinding.

  • ctsFlowControl

    Booleaans 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

  • pariteitBit

    ParityBit optioneel

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

  • gepauzeerd

    Booleaans

    Vlag die aangeeft of de verbinding geen onReceive-gebeurtenissen kan activeren.

  • volhardend

    Booleaans

    Zie ConnectionOptions.persistent

  • ontvangTime-out

    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

  • bitsnelheid

    nummer optioneel

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

  • buffer grootte

    nummer optioneel

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

  • ctsFlowControl

    Booleaans optioneel

    Vlag die aangeeft of RTS/CTS-hardwarestroomcontrole wel of niet moet worden ingeschakeld. Standaard ingesteld op false.

  • dataBits

    DataBits optioneel

    "eight" wordt standaard doorgegeven.

  • naam

    tekenreeks optioneel

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

  • pariteitBit

    ParityBit optioneel

    "no" wordt standaard doorgegeven.

  • volhardend

    Booleaans optioneel

    Vlag die aangeeft of de verbinding wel of niet open moet blijven wanneer de applicatie wordt opgeschort (zie App-levenscyclus beheren ). De standaardwaarde is 'false'. Wanneer de applicatie is geladen, kunnen alle seriële verbindingen die eerder zijn geopend met persistent=true worden opgehaald met getConnections .

  • ontvangTime-out

    nummer optioneel

    De maximale hoeveelheid tijd (in milliseconden) die moet worden gewacht op nieuwe gegevens voordat een onReceiveError gebeurtenis wordt gegenereerd met een 'time-out'-fout. Als deze nul is, worden er geen time-outfouten bij ontvangst gegenereerd voor de verbinding. Standaard ingesteld op 0.

  • verzendTime-out

    nummer optioneel

    De maximale hoeveelheid tijd (in milliseconden) die moet worden gewacht totdat een send is voltooid voordat de callback wordt aangeroepen met een 'time-out'-fout. Als deze nul is, worden er geen time-outfouten voor verzending geactiveerd. Standaard ingesteld op 0.

  • stopBits

    StopBits optioneel

    "one" wordt standaard doorgegeven.

DataBits

Enum

"zeven"

"acht"

DeviceControlSignals

Eigenschappen

  • cts

    Booleaans

    CTS (duidelijk om te verzenden).

  • dcd

    Booleaans

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

  • dsr

    Booleaans

    DSR (gegevensset gereed).

  • Ri

    Booleaans

    RI (ringindicator).

DeviceInfo

Eigenschappen

  • Weergavenaam

    tekenreeks optioneel

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

  • pad

    snaar

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

  • Product-ID

    nummer optioneel

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

  • verkopers ID

    nummer optioneel

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

HostControlSignals

Eigenschappen

  • dochter

    Booleaans optioneel

    DTR (Gereed voor dataterminal).

  • rts

    Booleaans optioneel

    RTS (verzoek om te verzenden).

ParityBit

Enum

"Nee"

"vreemd"

"zelfs"

ReceiveError

Enum

"losgekoppeld"
De verbinding werd verbroken.

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

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

"pauze"
Het apparaat heeft een breukconditie gedetecteerd.

"framefout"
Het apparaat heeft een framefout gedetecteerd.

"overspoeld"
Er heeft zich een karakterbufferoverschrijding voorgedaan. Het volgende personage is verloren.

"buffer_overflow"
Er heeft zich een invoerbufferoverloop voorgedaan. Er is geen ruimte in de invoerbuffer, of er is een teken ontvangen na het EOF-teken (end-of-file).

"pariteitsfout"
Het apparaat heeft een pariteitsfout gedetecteerd.

"systeemfout"
Er is een systeemfout opgetreden en de verbinding kan mogelijk niet worden hersteld.

ReceiveErrorInfo

Eigenschappen

  • verbindingId

    nummer

    De verbindings-ID.

  • Een foutcode die aangeeft wat er mis is gegaan.

ReceiveInfo

Eigenschappen

  • verbindingId

    nummer

    De verbindings-ID.

  • gegevens

    ArrayBuffer

    De ontvangen gegevens.

SendError

Enum

"losgekoppeld"
De verbinding werd verbroken.

"in behandeling"
Er was al een verzending in behandeling.

"time-out"
Er is een time-out opgetreden bij het verzenden.

"systeemfout"
Er is een systeemfout opgetreden en de verbinding kan mogelijk niet worden hersteld.

SendInfo

Eigenschappen

  • bytesVerzonden

    nummer

    Het aantal verzonden bytes.

  • fout

    SendError optioneel

    Een foutcode als er een fout is opgetreden.

StopBits

Enum

"een"

"twee"

Methoden

clearBreak()

BeloofChrome 45+
chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
)

Herstel de tekenoverdracht op een bepaalde verbinding en plaats de transmissielijn in een ononderbroken staat.

Parameters

  • verbindingId

    nummer

    Het ID van de verbinding.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: boolean)=>void

    • resultaat

      Booleaans

Geeft terug

  • Beloof<boolean>

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

connect()

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

Maakt verbinding met een bepaalde seriële poort.

Parameters

  • pad

    snaar

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

  • opties

    Verbindingsopties optioneel

    Poortconfiguratieopties.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (connectionInfo: ConnectionInfo)=>void

Geeft terug

  • Beloof < Verbindingsinfo >

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

disconnect()

Belofte
chrome.serial.disconnect(
  connectionId: number,
  callback?: function,
)

De verbinding met een seriële poort wordt verbroken.

Parameters

  • verbindingId

    nummer

    Het ID van de geopende verbinding.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: boolean)=>void

    • resultaat

      Booleaans

Geeft terug

  • Beloof<boolean>

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

flush()

Belofte
chrome.serial.flush(
  connectionId: number,
  callback?: function,
)

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

Parameters

  • verbindingId

    nummer

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: boolean)=>void

    • resultaat

      Booleaans

Geeft terug

  • Beloof<boolean>

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getConnections()

Belofte
chrome.serial.getConnections(
  callback?: function,
)

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

Parameters

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (connectionInfos: ConnectionInfo[])=>void

Geeft terug

  • Beloof < Verbindingsinfo []>

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getControlSignals()

Belofte
chrome.serial.getControlSignals(
  connectionId: number,
  callback?: function,
)

Haalt de status van besturingssignalen op een bepaalde verbinding op.

Parameters

Geeft terug

  • Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getDevices()

Belofte
chrome.serial.getDevices(
  callback?: function,
)

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

Parameters

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (ports: DeviceInfo[])=>void

Geeft terug

  • Beloof < Apparaatinfo []>

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

getInfo()

Belofte
chrome.serial.getInfo(
  connectionId: number,
  callback?: function,
)

Haalt de status van een bepaalde verbinding op.

Parameters

  • verbindingId

    nummer

    Het ID van de geopende verbinding.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (connectionInfo: ConnectionInfo)=>void

Geeft terug

  • Beloof < Verbindingsinfo >

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

send()

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

Schrijft gegevens naar de opgegeven verbinding.

Parameters

  • verbindingId

    nummer

    Het ID van de verbinding.

  • gegevens

    ArrayBuffer

    De gegevens die moeten worden verzonden.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (sendInfo: SendInfo)=>void

Geeft terug

  • Beloof < SendInfo >

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

setBreak()

BeloofChrome 45+
chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
)

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

Parameters

  • verbindingId

    nummer

    Het ID van de verbinding.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: boolean)=>void

    • resultaat

      Booleaans

Geeft terug

  • Beloof<boolean>

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

setControlSignals()

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

Stelt de status in van besturingssignalen op een bepaalde verbinding.

Parameters

  • verbindingId

    nummer

    Het ID van de verbinding.

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

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: boolean)=>void

    • resultaat

      Booleaans

Geeft terug

  • Beloof<boolean>

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

setPaused()

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

Pauzeert of hervat een open verbinding.

Parameters

  • verbindingId

    nummer

    Het ID van de geopende verbinding.

  • gepauzeerd

    Booleaans

    Vlag om aan te geven of u wilt pauzeren of hervatten.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    ()=>void

Geeft terug

  • Beloof <nietig>

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

update()

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

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

Parameters

  • verbindingId

    nummer

    Het ID van de geopende verbinding.

  • Poortconfiguratieopties.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (result: boolean)=>void

    • resultaat

      Booleaans

Geeft terug

  • Beloof<boolean>

    Chroom 117+

    Beloften worden alleen ondersteund voor Manifest V3 en hoger, andere platforms moeten callbacks gebruiken.

Evenementen

onReceive

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

Gebeurtenis die optreedt wanneer gegevens uit de verbinding zijn gelezen.

Parameters

  • Bel terug

    functie

    De callback parameter ziet er als volgt uit: 

    (info: ReceiveInfo)=>void

onReceiveError

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

Gebeurtenis opgetreden toen er een fout optrad terwijl de runtime wachtte op gegevens op de seriële poort. Zodra deze gebeurtenis zich voordoet, kan de verbinding op paused worden gezet. Een "timeout" -fout onderbreekt de verbinding niet.

Parameters