chroom.serieel

Beschrijving

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

Machtigingen

serial

Typen

ConnectionInfo

Eigenschappen

  • bitsnelheid

    nummer optioneel

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

  • buffergrootte

    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 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 tijdens het raadplegen 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 raadplegen van het onderliggende apparaat.

  • gepauzeerd

    Booleaanse

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

  • volhardend

    Booleaanse

    Zie ConnectionOptions.persistent

  • ontvangstTimeout

    nummer

    Zie ConnectionOptions.receiveTimeout

  • verzendTimeout

    nummer

    Zie ConnectionOptions.sendTimeout

  • stopBits

    StopBits optioneel

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

ConnectionOptions

Eigenschappen

  • bitsnelheid

    nummer optioneel

    De gewenste bitsnelheid van de te openen verbinding. Voor compatibiliteit met een breed scala aan hardware moet dit getal overeenkomen met een van de meest gangbare bitsnelheden, 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 gewenste bitsnelheid ondersteunt, zelfs als de poort zelf die bitsnelheid ondersteunt. Standaard wordt 9600 doorgegeven.

  • buffergrootte

    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-hardwarestroombesturing moet worden ingeschakeld. Standaardwaarde is false.

  • dataBits

    DataBits optioneel

    Standaard wordt "eight" doorgegeven.

  • naam

    string optioneel

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

  • pariteitBit

    ParityBit optioneel

    Standaard wordt "no" doorgegeven.

  • volhardend

    boolean optioneel

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

  • ontvangstTimeout

    nummer optioneel

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

  • verzendTimeout

    nummer optioneel

    De maximale wachttijd (in milliseconden) voor het voltooien van een send voordat de callback wordt aangeroepen met een time-outfout. Indien nul, worden er geen time-outfouten voor verzenden geactiveerd. Standaardwaarde is 0.

  • stopBits

    StopBits optioneel

    Standaard wordt "one" doorgegeven.

DataBits

Enum

"zeven"

"acht"

DeviceControlSignals

Eigenschappen

  • cts

    Booleaanse

    CTS (Clear To Send)-bericht.

  • gelijkstroom

    Booleaanse

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

  • dsr

    Booleaanse

    DSR (Dataset gereed).

  • ri

    Booleaanse

    RI (Ringindicator).

DeviceInfo

Eigenschappen

  • Getoond

    string optioneel

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

  • pad

    snaar

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

  • product-ID

    nummer optioneel

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

  • leveranciers-ID

    nummer optioneel

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

HostControlSignals

Eigenschappen

  • dochter

    boolean optioneel

    DTR (Data Terminal Ready).

  • rts

    boolean optioneel

    RTS (Verzoek tot verzenden).

ParityBit

Enum

"Nee"

"vreemd"

"zelfs"

ReceiveError

Enum

"losgekoppeld"
De verbinding is verbroken.

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

"apparaat_verloren"
Waarschijnlijk is het apparaat niet verbonden met de host.

"pauze"
Het apparaat heeft een breuk gedetecteerd.

"frame_fout"
Het apparaat heeft een framingfout gedetecteerd.

"overschrijden"
Er is een tekenbufferoverloop opgetreden. Het volgende teken is verloren gegaan.

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

"pariteitsfout"
Het apparaat heeft een pariteitsfout gedetecteerd.

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

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 is verbroken.

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

"time-out"
De verzendtijd is verlopen.

"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()

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

Herstel de karakteroverdracht op een bepaalde verbinding en plaats de transmissielijn in een ononderbroken toestand.

Parameters

  • verbindings-ID

    nummer

    De id van de verbinding.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (result: boolean) => void

    • resultaat

      Booleaanse

Retourneren

  • Belofte<boolean>

    Chroom 117+

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

connect()

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

Maakt verbinding met een bepaalde seriële poort.

Parameters

  • pad

    snaar

    Het systeempad van de te openen seriële poort.

  • opties

    ConnectionOptions optioneel

    Opties voor poortconfiguratie.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (connectionInfo: ConnectionInfo) => void

Retourneren

  • Belofte< ConnectionInfo >

    Chroom 117+

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

disconnect()

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

Verbinding met een seriële poort verbroken.

Parameters

  • verbindings-ID

    nummer

    De id van de geopende verbinding.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (result: boolean) => void

    • resultaat

      Booleaanse

Retourneren

  • Belofte<boolean>

    Chroom 117+

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

flush()

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

Alle bytes in de invoer- en uitvoerbuffers van de opgegeven verbinding worden gewist.

Parameters

  • verbindings-ID

    nummer

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (result: boolean) => void

    • resultaat

      Booleaanse

Retourneren

  • Belofte<boolean>

    Chroom 117+

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

getConnections()

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

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

Parameters

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (connectionInfos: ConnectionInfo[]) => void

Retourneren

  • Belofte< ConnectionInfo []>

    Chroom 117+

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

getControlSignals()

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

Haalt de status op van besturingssignalen op een bepaalde verbinding.

Parameters

Retourneren

  • Chroom 117+

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

getDevices()

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

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

Parameters

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (ports: DeviceInfo[]) => void

Retourneren

  • Belofte< DeviceInfo []>

    Chroom 117+

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

getInfo()

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

Haalt de status van een bepaalde verbinding op.

Parameters

  • verbindings-ID

    nummer

    De id van de geopende verbinding.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (connectionInfo: ConnectionInfo) => void

Retourneren

  • Belofte< ConnectionInfo >

    Chroom 117+

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

send()

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

Schrijft gegevens naar de opgegeven verbinding.

Parameters

  • verbindings-ID

    nummer

    De id van de verbinding.

  • gegevens

    ArrayBuffer

    De te verzenden gegevens.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (sendInfo: SendInfo) => void

Retourneren

  • Belofte< SendInfo >

    Chroom 117+

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

setBreak()

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

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

Parameters

  • verbindings-ID

    nummer

    De id van de verbinding.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (result: boolean) => void

    • resultaat

      Booleaanse

Retourneren

  • Belofte<boolean>

    Chroom 117+

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

setControlSignals()

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

Stelt de status van besturingssignalen op een bepaalde verbinding in.

Parameters

  • verbindings-ID

    nummer

    De id van de verbinding.

  • De reeks signalen die naar het apparaat worden verzonden, verandert.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (result: boolean) => void

    • resultaat

      Booleaanse

Retourneren

  • Belofte<boolean>

    Chroom 117+

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

setPaused()

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

Pauzeert of hervat een open verbinding.

Parameters

  • verbindings-ID

    nummer

    De id van de geopende verbinding.

  • gepauzeerd

    Booleaanse

    Vlag die aangeeft of u wilt pauzeren of hervatten.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    () => void

Retourneren

  • Belofte<leegte>

    Chroom 117+

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

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.

  • Opties voor poortconfiguratie.

  • terugbellen

    functie optioneel

    De callback ziet er als volgt uit: 

    (result: boolean) => void

    • resultaat

      Booleaanse

Retourneren

  • Belofte<boolean>

    Chroom 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 optreedt wanneer gegevens van de verbinding zijn gelezen.

Parameters

onReceiveError

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

Gebeurtenis gegenereerd wanneer er een fout optrad terwijl de runtime wachtte op gegevens op de seriële poort. Zodra deze gebeurtenis is gegenereerd, kan de verbinding worden paused . Een "timeout" pauzeert de verbinding niet.

Parameters