chrome.serial

Descripción

Usa la API de chrome.serial para leer y escribir en un dispositivo conectado a un puerto en serie.

Permisos

serial

Tipos

ConnectionInfo

Propiedades

  • bitrate

    número opcional

    Consulta los ConnectionOptions.bitrate. Este campo puede omitirse o ser inexacto si se está usando una tasa de bits no estándar o si se produce un error al realizar la consulta en el dispositivo subyacente.

  • bufferSize

    número

    Ver ConnectionOptions.bufferSize

  • connectionId

    número

    Es el ID de la conexión del puerto en serie.

  • ctsFlowControl

    booleano opcional

    Consulta los ConnectionOptions.ctsFlowControl. Este campo puede omitirse si se produce un error durante la consulta en el dispositivo subyacente.

  • dataBits

    DataBits opcional

    Consulta los ConnectionOptions.dataBits. Este campo puede omitirse si se produce un error durante la consulta en el dispositivo subyacente.

  • nombre

    string

    Ver ConnectionOptions.name

  • parityBit

    ParityBit opcional

    Consulta los ConnectionOptions.parityBit. Este campo puede omitirse si se produce un error durante la consulta en el dispositivo subyacente.

  • detenido

    boolean

    Marca que indica si se bloquea la conexión para activar eventos onRecibir.

  • persistentes

    boolean

    Ver ConnectionOptions.persistent

  • receiveTimeout

    número

    Ver ConnectionOptions.receiveTimeout

  • sendTimeout

    número

    Ver ConnectionOptions.sendTimeout

  • stopBits

    StopBits opcional

    Consulta los ConnectionOptions.stopBits. Este campo puede omitirse si se produce un error durante la consulta en el dispositivo subyacente.

ConnectionOptions

Propiedades

  • bitrate

    número opcional

    La tasa de bits solicitada de la conexión que se abrirá. Para brindar compatibilidad con el rango más amplio de hardware, este número debe coincidir con una de las tasas de bits disponibles comúnmente, como 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600 o 115200. Por supuesto, no hay garantía de que el dispositivo conectado al puerto en serie admita la tasa de bits solicitada, incluso si el puerto en sí la admite. 9600 se pasará de forma predeterminada.

  • bufferSize

    número opcional

    El tamaño del búfer que se usa para recibir datos. El valor predeterminado es 4096.

  • ctsFlowControl

    booleano opcional

    Marca que indica si se habilita o no el control de flujo de hardware RTS/CTS. La configuración predeterminada es "false".

  • dataBits

    DataBits opcional

    "eight" se pasará de forma predeterminada.

  • nombre

    string opcional

    Una cadena definida por la aplicación para asociar con la conexión.

  • parityBit

    ParityBit opcional

    "no" se pasará de forma predeterminada.

  • persistentes

    booleano opcional

    Marca que indica si la conexión debe permanecer abierta o no cuando se suspende la aplicación (consulta Administrar el ciclo de vida de la app). El valor predeterminado es "false". Cuando se carga la aplicación, cualquier conexión en serie que se abriera previamente con Persistent=true se puede recuperar con getConnections.

  • receiveTimeout

    número opcional

    La cantidad máxima de tiempo (en milisegundos) que se debe esperar a que lleguen datos nuevos antes de que se genere un evento onReceiveError con un “tiempo de espera” . Si es cero, no se generarán errores de tiempo de espera de recepción para la conexión. La configuración predeterminada es 0.

  • sendTimeout

    número opcional

    El tiempo máximo (en milisegundos) que se debe esperar a que se complete una operación send antes de llamar a la devolución de llamada con un “tiempo de espera” . Si es cero, no se activarán los errores de tiempo de espera de envío. La configuración predeterminada es 0.

  • stopBits

    StopBits opcional

    "one" se pasará de forma predeterminada.

DataBits

Enum

“seven”

“ocho”

DeviceControlSignals

Propiedades

  • cts

    boolean

    CTS (Clear to Send).

  • dcd

    boolean

    DCD (Data Carrier Detect) o RLSD (recepción de señal o detección de línea).

  • dsr

    boolean

    DSR (conjunto de datos listos).

  • ri

    boolean

    RI (indicador de anillo).

DeviceInfo

Propiedades

  • displayName

    string opcional

    Un nombre visible y legible por humanos para el dispositivo subyacente si se puede consultar uno desde el controlador del host.

  • ruta de acceso

    string

    La ruta del sistema del dispositivo. Se debe pasar como el argumento path a chrome.serial.connect para conectarse a este dispositivo.

  • productId

    número opcional

    Un ID del producto USB, si se puede determinar uno para el dispositivo subyacente.

  • vendorId

    número opcional

    Es un ID del proveedor de PCI o USB, si se puede determinar para el dispositivo subyacente.

HostControlSignals

Propiedades

  • dtr

    booleano opcional

    DTR (terminal de datos lista).

  • RT

    booleano opcional

    RTS (solicitud de envío).

ParityBit

Enum

“no”

“odd”

“incluso”

ReceiveError

Enum

"disconnect"
Se desconectó la conexión.

"timeout"
No se recibieron datos durante receiveTimeout milisegundos.

"device_lost"
Lo más probable es que el dispositivo se haya desconectado del host.

"break"
El dispositivo detectó una condición de interrupción.

"frame_error"
El dispositivo detectó un error de encuadre.

"overrun"
Se desbordó el búfer de caracteres. El siguiente carácter se pierde.

"buffer_overflow"
Se produjo un desbordamiento del búfer de entrada. No hay espacio en el búfer de entrada o se recibió un carácter después del carácter de final de archivo (EOF).

"parity_error"
El dispositivo detectó un error de paridad.

"system_error"
Se produjo un error del sistema, por lo que es posible que la conexión no se pueda recuperar.

ReceiveErrorInfo

Propiedades

  • connectionId

    número

    Es el identificador de la conexión.

  • error

    ReceiveError

    Un código de error que indica qué salió mal.

ReceiveInfo

Propiedades

  • connectionId

    número

    Es el identificador de la conexión.

  • datos

    ArrayBuffer

    Los datos recibidos.

SendError

Enum

"disconnect"
Se desconectó la conexión.

"pending"
Un envío ya estaba pendiente.

"timeout"
Se agotó el tiempo de espera del envío.

"system_error"
Se produjo un error del sistema, por lo que es posible que la conexión no se pueda recuperar.

SendInfo

Propiedades

  • bytesSent

    número

    La cantidad de bytes enviados.

  • error

    SendError opcional

    Un código de error si ocurrió un error

StopBits

Enum

“one”

“dos”

Métodos

clearBreak()

Promesa Chrome 45 y versiones posteriores .
chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
)

Restablece la transmisión de caracteres en una conexión determinada y coloca la línea de transmisión en un estado de no interrupción.

Parámetros

  • connectionId

    número

    Es el ID de la conexión.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (result: boolean) => void

    • resultado

      boolean

Muestra

  • Promise<boolean>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

connect()

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

Se conecta a un puerto en serie determinado.

Parámetros

  • ruta de acceso

    string

    La ruta de acceso del sistema del puerto en serie que se abrirá.

  • opciones

    ConnectionOptions opcional

    Opciones de configuración de puertos.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (connectionInfo: ConnectionInfo) => void

Muestra

  • Promise<ConnectionInfo>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

disconnect()

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

Se desconecta de un puerto en serie.

Parámetros

  • connectionId

    número

    El ID de la conexión abierta.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (result: boolean) => void

    • resultado

      boolean

Muestra

  • Promise<boolean>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

flush()

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

Vacía todos los bytes de los búferes de entrada y salida de la conexión en cuestión.

Parámetros

  • connectionId

    número

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (result: boolean) => void

    • resultado

      boolean

Muestra

  • Promise<boolean>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getConnections()

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

Recupera la lista de conexiones de puertos en serie abiertas actualmente que pertenecen a la aplicación.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (connectionInfos: ConnectionInfo[]) => void

Muestra

  • Promise<ConnectionInfo[]>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getControlSignals()

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

Recupera el estado de las señales de control en una conexión determinada.

Parámetros

  • connectionId

    número

    Es el ID de la conexión.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (signals: DeviceControlSignals) => void

Muestra

  • Promise<DeviceControlSignals>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getDevices()

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

Muestra información acerca de los dispositivos en serie disponibles en el sistema. La lista se vuelve a generar cada vez que se llama a este método.

Parámetros

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (ports: DeviceInfo[]) => void

Muestra

  • Promise<DeviceInfo[]>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

getInfo()

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

Recupera el estado de una conexión determinada.

Parámetros

  • connectionId

    número

    El ID de la conexión abierta.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (connectionInfo: ConnectionInfo) => void

Muestra

  • Promise<ConnectionInfo>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

send()

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

Escribe datos en la conexión dada.

Parámetros

  • connectionId

    número

    Es el ID de la conexión.

  • datos

    ArrayBuffer

    Los datos que se enviarán.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (sendInfo: SendInfo) => void

Muestra

  • Promise<SendInfo>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

setBreak()

Promesa Chrome 45 y versiones posteriores .
chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
)

Suspende la transmisión de caracteres en una conexión determinada y coloca la línea de transmisión en un estado de interrupción hasta que se llame a clearBreak.

Parámetros

  • connectionId

    número

    Es el ID de la conexión.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (result: boolean) => void

    • resultado

      boolean

Muestra

  • Promise<boolean>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

setControlSignals()

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

Establece el estado de las señales de control en una conexión determinada.

Parámetros

  • connectionId

    número

    Es el ID de la conexión.

  • indicadores

    HostControlSignals

    El conjunto de señales cambia para enviar al dispositivo.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (result: boolean) => void

    • resultado

      boolean

Muestra

  • Promise<boolean>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

setPaused()

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

Pausa o reanuda una conexión abierta.

Parámetros

  • connectionId

    número

    El ID de la conexión abierta.

  • detenido

    boolean

    Marca para indicar si se debe pausar o reanudar.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promesa<void>

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

update()

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

Actualiza la configuración de las opciones en una conexión de puerto en serie abierta.

Parámetros

  • connectionId

    número

    El ID de la conexión abierta.

  • Opciones de configuración de puertos.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (result: boolean) => void

    • resultado

      boolean

Muestra

  • Promise&lt;boolean&gt;

    Chrome 117 y versiones posteriores

    Las promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.

Eventos

onReceive

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

Evento generado cuando se leen los datos desde la conexión.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (info: ReceiveInfo) => void

onReceiveError

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

Evento generado cuando se produjo un error mientras el entorno de ejecución estaba esperando datos en el puerto en serie. Una vez que se genere este evento, la conexión se podrá establecer en paused. Un error "timeout" no pausa la conexión.

Parámetros