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

Disponibilidad

Solo en ChromeOS

Tipos

ConnectionInfo

Propiedades

  • bitrate

    number opcional

    Consulta los ConnectionOptions.bitrate. Este campo se puede omitir o puede ser impreciso si se usa una tasa de bits no estándar o si se produjo un error mientras se consultaba 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 se puede omitir si se produjo un error mientras se consultaba el dispositivo subyacente.

  • dataBits

    DataBits opcional

    Consulta los ConnectionOptions.dataBits. Este campo se puede omitir si se produjo un error mientras se consultaba el dispositivo subyacente.

  • nombre

    string

    Ver ConnectionOptions.name

  • parityBit

    ParityBit opcional

    Consulta los ConnectionOptions.parityBit. Este campo se puede omitir si se produjo un error mientras se consultaba el dispositivo subyacente.

  • detenido

    booleano

    Es una marca que indica si la conexión está bloqueada para que no se activen los eventos onReceive.

  • persistente

    booleano

    Ver ConnectionOptions.persistent

  • receiveTimeout

    número

    Ver ConnectionOptions.receiveTimeout

  • sendTimeout

    número

    Ver ConnectionOptions.sendTimeout

  • stopBits

    StopBits opcional

    Consulta los ConnectionOptions.stopBits. Este campo se puede omitir si se produjo un error mientras se consultaba el dispositivo subyacente.

ConnectionOptions

Propiedades

  • bitrate

    number opcional

    Es la tasa de bits solicitada de la conexión que se abrirá. Para lograr la compatibilidad con la gama más amplia 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 se garantiza 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

    number opcional

    Es 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 debe habilitar 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

    Es una cadena definida por la aplicación que se asocia con la conexión.

  • parityBit

    ParityBit opcional

    "no" se pasará de forma predeterminada.

  • persistente

    booleano opcional

    Es una marca que indica si la conexión debe dejarse abierta cuando se suspende la aplicación (consulta Administra el ciclo de vida de la app). El valor predeterminado es "false". Cuando se carga la aplicación, se pueden recuperar con getConnections las conexiones en serie que se abrieron anteriormente con persistent=true.

  • receiveTimeout

    number opcional

    Es la cantidad máxima de tiempo (en milisegundos) que se debe esperar para recibir datos nuevos antes de generar un evento onReceiveError con un error de "tiempo de espera agotado". 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

    number opcional

    Es la cantidad máxima de tiempo (en milisegundos) que se debe esperar para que se complete una operación send antes de llamar a la devolución de llamada con un error de "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"

"eight"

DeviceControlSignals

Propiedades

  • cts

    booleano

    CTS (Listo para enviar).

  • dcd

    booleano

    DCD (detección de portadora de datos) o RLSD (detección/señal de línea de recepción).

  • dsr

    booleano

    DSR (Data Set Ready).

  • ri

    booleano

    RI (indicador de timbre)

DeviceInfo

Propiedades

  • displayName

    string opcional

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

  • ruta de acceso

    string

    Es la ruta de acceso del sistema del dispositivo. Este se debe pasar como el argumento path a chrome.serial.connect para conectarse a este dispositivo.

  • productId

    number opcional

    Es un ID de producto USB, si se puede determinar uno para el dispositivo subyacente.

  • vendorId

    number opcional

    Un ID de proveedor de PCI o USB, si se puede determinar uno para el dispositivo subyacente.

HostControlSignals

Propiedades

  • dtr

    booleano opcional

    DTR (terminal de datos lista)

  • rts

    booleano opcional

    RTS (solicitud de envío).

ParityBit

Enum

"no"

"odd"

"even"

ReceiveError

Enum

"disconnected"
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 produjo un desbordamiento del 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 fin de archivo (EOF).

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

"system_error"
Se produjo un error del sistema y 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

"disconnected"
Se desconectó la conexión.

"pending"
Ya había un envío pendiente.

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

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

SendInfo

Propiedades

  • bytesSent

    número

    Es la cantidad de bytes enviados.

  • error

    SendError opcional

    Un código de error si se produjo un error.

StopBits

Enum

"one"

"two"

Métodos

clearBreak()

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

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

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

      booleano

Muestra

  • Promise<boolean>

    Chrome 117 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

connect()

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

Se conecta a un puerto en serie determinado.

Parámetros

  • ruta de acceso

    string

    Es 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 se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

disconnect()

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

Se desconecta de un puerto en serie.

Parámetros

  • connectionId

    número

    Es 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

      booleano

Muestra

  • Promise<boolean>

    Chrome 117 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

flush()

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

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

Parámetros

  • connectionId

    número

  • callback

    función opcional

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

    (result: boolean) => void

    • resultado

      booleano

Muestra

  • Promise<boolean>

    Chrome 117 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getConnections()

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

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 se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getControlSignals()

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

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

  • Chrome 117 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getDevices()

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

Devuelve información sobre 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 se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getInfo()

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

Recupera el estado de una conexión determinada.

Parámetros

  • connectionId

    número

    Es 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 se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

send()

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

Escribe datos en la conexión determinada.

Parámetros

  • connectionId

    número

    Es el ID de la conexión.

  • datos

    ArrayBuffer

    Son 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 se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

setBreak()

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

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 llama 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

      booleano

Muestra

  • Promise<boolean>

    Chrome 117 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

setControlSignals()

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

Establece el estado de los indicadores de control en una conexión determinada.

Parámetros

  • connectionId

    número

    Es el ID de la conexión.

  • indicadores

    HostControlSignals

    Es el conjunto de cambios de indicadores que se enviarán al dispositivo.

  • callback

    función opcional

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

    (result: boolean) => void

    • resultado

      booleano

Muestra

  • Promise<boolean>

    Chrome 117 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

setPaused()

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

Detiene o reanuda una conexión abierta.

Parámetros

  • connectionId

    número

    Es el ID de la conexión abierta.

  • detenido

    booleano

    Es una marca que indica si se debe pausar o reactivar.

  • callback

    función opcional

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

    () => void

Muestra

  • Promise<void>

    Chrome 117 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

update()

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

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

Parámetros

  • connectionId

    número

    Es 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

      booleano

Muestra

  • Promise<boolean>

    Chrome 117 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

Eventos

onReceive

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

Es el evento que se genera cuando se leen datos de 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,
)

Se genera un evento cuando se produce un error mientras el entorno de ejecución espera datos en el puerto en serie. Una vez que se genera este evento, la conexión se puede establecer en paused. Un error "timeout" no pausa la conexión.

Parámetros