chrome.serial

Descrizione

Utilizza l'API chrome.serial per leggere e scrivere su un dispositivo connesso a una porta seriale.

Autorizzazioni

serial

Tipi

ConnectionInfo

Proprietà

  • bitrate

    numero facoltativo

    Leggi i ConnectionOptions.bitrate. Questo campo potrebbe essere omesso o impreciso se viene utilizzata una velocità in bit non standard o se si è verificato un errore durante l'esecuzione di una query sul dispositivo sottostante.

  • bufferSize

    numero

    Visualizza ConnectionOptions.bufferSize

  • connectionId

    numero

    ID della connessione della porta seriale.

  • ctsFlowControl

    booleano facoltativo

    Leggi i ConnectionOptions.ctsFlowControl. Questo campo può essere omesso se si è verificato un errore durante l'esecuzione di una query sul dispositivo sottostante.

  • dataBits

    DataBits facoltativo

    Leggi i ConnectionOptions.dataBits. Questo campo può essere omesso se si è verificato un errore durante l'esecuzione di una query sul dispositivo sottostante.

  • nome

    stringa

    Visualizza ConnectionOptions.name

  • parityBit

    ParityBit facoltativo

    Leggi i ConnectionOptions.parityBit. Questo campo può essere omesso se si è verificato un errore durante l'esecuzione di una query sul dispositivo sottostante.

  • in pausa

    booleano

    Flag che indica se la connessione è bloccata dall'attivazione di eventi onReceive.

  • persistente

    booleano

    Visualizza ConnectionOptions.persistent

  • receiveTimeout

    numero

    Visualizza ConnectionOptions.receiveTimeout

  • sendTimeout

    numero

    Visualizza ConnectionOptions.sendTimeout

  • stopBits

    StopBits facoltativo

    Leggi i ConnectionOptions.stopBits. Questo campo può essere omesso se si è verificato un errore durante l'esecuzione di una query sul dispositivo sottostante.

ConnectionOptions

Proprietà

  • bitrate

    numero facoltativo

    La velocità in bit richiesta per la connessione da aprire. Per la compatibilità con la più ampia gamma di hardware, questo numero deve corrispondere a uno dei velocità in bit comunemente disponibili, ad esempio 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200. Non vi è, ovviamente, alcuna garanzia che il dispositivo collegato alla porta seriale supporterà la velocità in bit richiesta, anche se la porta stessa supporta tale velocità in bit. 9600 verrà trasmesso per impostazione predefinita.

  • bufferSize

    numero facoltativo

    La dimensione del buffer utilizzato per ricevere i dati. Il valore predefinito è 4096.

  • ctsFlowControl

    booleano facoltativo

    Flag che indica se abilitare o meno il controllo del flusso hardware RTS/CTS. Il valore predefinito è false.

  • dataBits

    DataBits facoltativo

    "eight" verrà trasmesso per impostazione predefinita.

  • nome

    stringa facoltativo

    Una stringa definita dall'applicazione da associare alla connessione.

  • parityBit

    ParityBit facoltativo

    "no" verrà trasmesso per impostazione predefinita.

  • persistente

    booleano facoltativo

    Flag che indica se la connessione deve essere lasciata aperta o meno quando l'applicazione viene sospesa (vedi Gestione del ciclo di vita delle app). Il valore predefinito è "false". Quando l'applicazione viene caricata, tutte le connessioni seriali aperte in precedenza con permanente=true possono essere recuperate con getConnections.

  • receiveTimeout

    numero facoltativo

    Il tempo massimo (in millisecondi) di attesa di nuovi dati prima di generare un evento onReceiveError con un "timeout" . Se il valore è zero, gli errori di timeout di ricezione non verranno generati per la connessione. Il valore predefinito è 0.

  • sendTimeout

    numero facoltativo

    Il tempo massimo (in millisecondi) di attesa per il completamento di un'operazione send prima di chiamare il callback con un "timeout" . Se il valore è zero, gli errori di timeout di invio non verranno attivati. Il valore predefinito è 0.

  • stopBits

    StopBits facoltativo

    "one" verrà trasmesso per impostazione predefinita.

DataBits

Enum

"sette"

"otto"

DeviceControlSignals

Proprietà

  • ct

    booleano

    CTS (Cancella per inviare).

  • dcd

    booleano

    DCD (Data Carrier Detect) o RLSD (Ricezione segnale/ Rilevamento).

  • dsr

    booleano

    DSR (set di dati pronto).

  • Ri

    booleano

    RI (Ring Indicator).

DeviceInfo

Proprietà

  • displayName

    stringa facoltativo

    Un nome visualizzato leggibile per il dispositivo sottostante, se è possibile interrogarne uno dal driver host.

  • percorso

    stringa

    Il percorso di sistema del dispositivo. Questo valore deve essere passato come argomento path a chrome.serial.connect per connettersi a questo dispositivo.

  • productId

    numero facoltativo

    Un ID prodotto USB, se è possibile determinarne uno per il dispositivo sottostante.

  • vendorId

    numero facoltativo

    Un ID fornitore PCI o USB, se è possibile determinarne uno per il dispositivo sottostante.

HostControlSignals

Proprietà

  • dtr

    booleano facoltativo

    DTR (Data Terminal Ready).

  • RTS

    booleano facoltativo

    RTS (Richiesta di invio).

ParityBit

Enum

"no"

"dispari"

"uniforme"

ReceiveError

Enum

"disconnessione"
La connessione si è disconnessa.

"timeout"
Non sono stati ricevuti dati per receiveTimeout millisecondi.

"device_lost"
Molto probabilmente il dispositivo è stato disconnesso dall'host.

"break"
Il dispositivo ha rilevato una condizione di interruzione.

"frame_error"
Il dispositivo ha rilevato un errore di inquadratura.

"overrun"
Si è verificato un superamento del buffer dei caratteri. e il carattere successivo si perde.

"buffer_overflow"
Si è verificato un overflow del buffer di input. Non c'è spazio nel buffer di input oppure è stato ricevuto un carattere dopo il carattere "fine file" (EOF).

"parity_error"
Il dispositivo ha rilevato un errore di parità.

"system_error"
Si è verificato un errore di sistema e la connessione potrebbe non essere recuperabile.

ReceiveErrorInfo

Proprietà

  • connectionId

    numero

    L'identificatore della connessione.

  • errore

    ReceiveError

    Un codice di errore che indica che cosa non ha funzionato.

ReceiveInfo

Proprietà

  • connectionId

    numero

    L'identificatore della connessione.

  • dati

    ArrayBuffer

    I dati ricevuti.

SendError

Enum

"disconnessione"
La connessione si è disconnessa.

"pending"
Un invio era già in attesa.

"timeout"
Timeout dell'invio.

"system_error"
Si è verificato un errore di sistema e la connessione potrebbe non essere recuperabile.

SendInfo

Proprietà

  • bytesSent

    numero

    Il numero di byte inviati.

  • errore

    SendError facoltativo

    Un codice di errore se si è verificato un errore.

StopBits

Enum

"uno"

"due"

Metodi

clearBreak()

Promesso Chrome 45 e versioni successive 
chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
)

Ripristina la trasmissione di caratteri su una determinata connessione e metti la linea di trasmissione in stato senza interruzione.

Parametri

  • connectionId

    numero

    ID della connessione.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (result: boolean) => void

    • risultato

      booleano

Resi

  • Promise<boolean>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

connect()

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

Si connette a una determinata porta seriale.

Parametri

  • percorso

    stringa

    Il percorso di sistema della porta seriale da aprire.

  • opzioni

    ConnectionOptions facoltativo

    Opzioni di configurazione delle porte.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (connectionInfo: ConnectionInfo) => void

Resi

  • Promise<ConnectionInfo>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

disconnect()

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

Si disconnette da una porta seriale.

Parametri

  • connectionId

    numero

    L'ID della connessione aperta.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (result: boolean) => void

    • risultato

      booleano

Resi

  • Promise<boolean>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

flush()

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

Cancella tutti i byte nei buffer di input e di output della connessione specificata.

Parametri

  • connectionId

    numero

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (result: boolean) => void

    • risultato

      booleano

Resi

  • Promise<boolean>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

getConnections()

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

Recupera l'elenco delle connessioni delle porte seriali attualmente aperte di proprietà dell'applicazione.

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (connectionInfos: ConnectionInfo[]) => void

Resi

  • Promise<ConnectionInfo[]>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

getControlSignals()

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

Recupera lo stato dei segnali di controllo su una determinata connessione.

Parametri

Resi

  • Promise<DeviceControlSignals>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

getDevices()

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

Restituisce informazioni sui dispositivi seriali disponibili nel sistema. L'elenco viene rigenerato ogni volta che viene richiamato questo metodo.

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (ports: DeviceInfo[]) => void

Resi

  • Promise<DeviceInfo[]>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

getInfo()

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

Recupera lo stato di una determinata connessione.

Parametri

  • connectionId

    numero

    L'ID della connessione aperta.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (connectionInfo: ConnectionInfo) => void

Resi

  • Promise<ConnectionInfo>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

send()

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

Scrive i dati nella connessione specificata.

Parametri

  • connectionId

    numero

    ID della connessione.

  • dati

    ArrayBuffer

    I dati da inviare.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (sendInfo: SendInfo) => void

Resi

  • Promise<SendInfo>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

setBreak()

Promesso Chrome 45 e versioni successive 
chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
)

Sospende la trasmissione di caratteri su una determinata connessione e mette la linea di trasmissione in stato di interruzione fino al richiamo di clearBreak.

Parametri

  • connectionId

    numero

    ID della connessione.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (result: boolean) => void

    • risultato

      booleano

Resi

  • Promise<boolean>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

setControlSignals()

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

Imposta lo stato dei segnali di controllo su una determinata connessione.

Parametri

  • connectionId

    numero

    ID della connessione.

  • indicatori

    HostControlSignals

    L'insieme di segnali cambia da inviare al dispositivo.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (result: boolean) => void

    • risultato

      booleano

Resi

  • Promise<boolean>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

setPaused()

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

Mette in pausa o riattiva una connessione aperta.

Parametri

  • connectionId

    numero

    L'ID della connessione aperta.

  • in pausa

    booleano

    Contrassegno per indicare se mettere in pausa o riattivare la pubblicazione.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    () => void

Resi

  • Promesso<void>

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

update()

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

Aggiorna le impostazioni delle opzioni su una connessione a porta seriale aperta.

Parametri

  • connectionId

    numero

    L'ID della connessione aperta.

  • Opzioni di configurazione delle porte.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    (result: boolean) => void

    • risultato

      booleano

Resi

  • Promise&lt;boolean&gt;

    Chrome 117 e versioni successive .

    Le promesse sono supportate solo per Manifest V3 e versioni successive, mentre le altre piattaforme devono utilizzare i callback.

Eventi

onReceive

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

Evento generato quando i dati sono stati letti dalla connessione.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto: 

    (info: ReceiveInfo) => void

onReceiveError

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

Evento generato quando si è verificato un errore mentre il runtime era in attesa di dati sulla porta seriale. Una volta generato questo evento, la connessione potrebbe essere impostata su paused. Un errore "timeout" non mette in pausa la connessione.

Parametri