chrome.bluetoothSocket

Descripción

Usa la API de chrome.bluetoothSocket para enviar y recibir datos en dispositivos Bluetooth con conexiones RFCOMM y L2CAP.

Manifest

Para usar esta API, se deben declarar las siguientes claves en el manifiesto.

"bluetooth"

Tipos

AcceptError

Enum

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

"not_listening"
El socket no está escuchando.

AcceptErrorInfo

Propiedades

  • error

    AcceptError

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

  • errorMessage

    cadena

    Mensaje de error.

  • socketId

    número

    Es el identificador de socket de servidor.

AcceptInfo

Propiedades

  • clientSocketId

    número

    El identificador de socket de cliente, es decir, el identificador de socket de la conexión recién establecida. Este identificador de socket solo debe usarse con funciones del espacio de nombres chrome.bluetoothSocket. Ten en cuenta que el socket del cliente está pausado en un principio y la aplicación debe reactivarlo explícitamente para comenzar a recibir datos.

  • socketId

    número

    Es el identificador de socket de servidor.

CreateInfo

Propiedades

  • socketId

    número

    El ID del socket recién creado. Ten en cuenta que los IDs de socket creados a partir de esta API no son compatibles con los de otras APIs, como la API de [sockets.tcp](../sockets_tcp/).

ListenOptions

Propiedades

  • trabajo pendiente

    número opcional

    Longitud de la cola de escucha del socket. El valor predeterminado depende del subsistema del host del sistema operativo.

  • canal

    número opcional

    El canal RFCOMM que usa listenUsingRfcomm. Si se especifica, este canal no debe estar en uso anteriormente; de lo contrario, la llamada al método fallará. Si no se especifica, se asignará automáticamente un canal sin usar.

  • ppm

    número opcional

    El PSM de L2CAP que usa listenUsingL2cap. Si se especifica, este PSM no debe estar en uso anteriormente o la llamada al método fallará. Si no se especifica, se asignará automáticamente un PSM sin usar.

ReceiveError

Enum

"disconnected"
Se desconectó la conexión.

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

"not_connected"
No se conectó el socket.

ReceiveErrorInfo

Propiedades

  • error

    ReceiveError

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

  • errorMessage

    cadena

    Mensaje de error.

  • socketId

    número

    Es el identificador del socket.

ReceiveInfo

Propiedades

  • datos

    ArrayBuffer

    Los datos recibidos, con un tamaño máximo de bufferSize.

  • socketId

    número

    Es el identificador del socket.

SocketInfo

Propiedades

  • de la página web.

    cadena opcional

    Si el socket subyacente está conectado, contiene la dirección Bluetooth del dispositivo al que está conectado.

  • bufferSize

    número opcional

    Es el tamaño del búfer que se usa para recibir los datos. Si no se especificó ningún tamaño del búfer de forma explícita, no se proporciona el valor.

  • Conectado

    boolean

    Marca que indica si el socket está conectado a un par remoto.

  • name

    cadena opcional

    Es la cadena definida por la aplicación asociada con el socket.

  • detenido

    boolean

    Marca que indica si un socket conectado impide que el par envíe más datos o si las solicitudes de conexión de un socket de escucha se envían a través del evento onAccept o se agregan a la cola de la lista de espera de la cola de escucha. Consulta los setPaused. El valor predeterminado es "false".

  • persistentes

    boolean

    Marca que indica si el socket permanece abierto cuando se descarga la página de eventos de la aplicación (consulta SocketProperties.persistent). El valor predeterminado es "false".

  • socketId

    número

    Es el identificador del socket.

  • uuid

    cadena opcional

    Si el socket subyacente está conectado, contiene información sobre el UUID de servicio al que está conectado; de lo contrario, si el socket subyacente está escuchando, contiene información sobre el UUID de servicio en el que está escuchando.

SocketProperties

Propiedades

  • bufferSize

    número opcional

    Es el tamaño del búfer que se usa para recibir los datos. El valor predeterminado es 4,096.

  • name

    cadena opcional

    Una cadena definida por la aplicación asociada con el socket.

  • persistentes

    booleano opcional

    Marca que indica si el socket se deja abierto cuando se descarga la página del evento de la aplicación (consulta Administrar el ciclo de vida de la app). El valor predeterminado es false.. Cuando se carga la aplicación, cualquier socket que se abrió antes con Persistent=true se puede recuperar con getSockets.

Métodos

close()

Promesa 
chrome.bluetoothSocket.close(
  socketId: number,
  callback?: function,
)

Desconecta y destruye el socket. Cada socket creado debe cerrarse después de su uso. El ID del socket deja de ser válido apenas se llama a la función. Sin embargo, se garantiza que el socket solo se cerrará cuando se invoque la devolución de llamada.

Parámetros

  • socketId

    número

    Es el identificador del socket.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 91 y versiones posteriores

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

connect()

Promesa 
chrome.bluetoothSocket.connect(
  socketId: number,
  address: string,
  uuid: string,
  callback?: function,
)

Conecta el zócalo a un dispositivo Bluetooth remoto. Cuando la operación connect se completa correctamente, se generan eventos onReceive cuando se reciben datos del intercambio de tráfico. Si se produce un error de red mientras el entorno de ejecución recibe paquetes, se genera un evento onReceiveError, en cuyo momento no se generará más evento onReceive para este socket hasta que se llame al método setPaused(false).

Parámetros

  • socketId

    número

    Es el identificador del socket.

  • de la página web.

    cadena

    Es la dirección del dispositivo Bluetooth.

  • uuid

    cadena

    El UUID del servicio al que se conectará.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 91 y versiones posteriores

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

create()

Promesa 
chrome.bluetoothSocket.create(
  properties?: SocketProperties,
  callback?: function,
)

Crea un socket Bluetooth.

Parámetros

  • properties

    SocketProperties opcional

    Las propiedades del socket (opcional).

  • callback

    Función opcional

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

    (createInfo: CreateInfo)=>void

    • createInfo

      CreateInfo

      El resultado de la creación del socket.

Devuelve

  • Promise<CreateInfo>

    Chrome 91 y versiones posteriores

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

disconnect()

Promesa 
chrome.bluetoothSocket.disconnect(
  socketId: number,
  callback?: function,
)

Desconecta el socket. El identificador de socket sigue siendo válido.

Parámetros

  • socketId

    número

    Es el identificador del socket.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 91 y versiones posteriores

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

getInfo()

Promesa 
chrome.bluetoothSocket.getInfo(
  socketId: number,
  callback?: function,
)

Recupera el estado del socket determinado.

Parámetros

  • socketId

    número

    Es el identificador del socket.

  • callback

    Función opcional

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

    (socketInfo: SocketInfo)=>void

    • socketInfo

      SocketInfo

      Objeto que contiene la información del socket.

Devuelve

  • Promise<SocketInfo>

    Chrome 91 y versiones posteriores

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

getSockets()

Promesa 
chrome.bluetoothSocket.getSockets(
  callback?: function,
)

Recupera la lista de sockets actualmente abiertos que son propiedad de la aplicación.

Parámetros

  • callback

    Función opcional

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

    (sockets: SocketInfo[])=>void

Devuelve

  • Promise<SocketInfo[]>

    Chrome 91 y versiones posteriores

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

listenUsingL2cap()

Promesa 
chrome.bluetoothSocket.listenUsingL2cap(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
)

Detecta conexiones con el protocolo L2CAP.

Parámetros

  • socketId

    número

    Es el identificador del socket.

  • uuid

    cadena

    UUID del servicio en el que se escuchará.

  • Opciones

    ListenOptions opcional

    Opciones adicionales opcionales para el servicio.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 91 y versiones posteriores

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

listenUsingRfcomm()

Promesa 
chrome.bluetoothSocket.listenUsingRfcomm(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
)

Detecta conexiones con el protocolo RFCOMM.

Parámetros

  • socketId

    número

    Es el identificador del socket.

  • uuid

    cadena

    UUID del servicio en el que se escuchará.

  • Opciones

    ListenOptions opcional

    Opciones adicionales opcionales para el servicio.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 91 y versiones posteriores

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

send()

Promesa 
chrome.bluetoothSocket.send(
  socketId: number,
  data: ArrayBuffer,
  callback?: function,
)

Envía datos en el socket Bluetooth determinado.

Parámetros

  • socketId

    número

    Es el identificador del socket.

  • datos

    ArrayBuffer

    Los datos que se enviarán.

  • callback

    Función opcional

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

    (bytesSent: number)=>void

    • bytesSent

      número

      La cantidad de bytes enviados.

Devuelve

  • Promesa<number>

    Chrome 91 y versiones posteriores

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

setPaused()

Promesa 
chrome.bluetoothSocket.setPaused(
  socketId: number,
  paused: boolean,
  callback?: function,
)

Habilita o inhabilita que un socket conectado reciba mensajes de su par o un socket de escucha para aceptar nuevas conexiones. El valor predeterminado es "false". Por lo general, una aplicación usa detener un socket conectado para limitar los datos que envía su par. Cuando se pausa un socket conectado, no se genera ningún evento onReceive. Cuando se conecta un socket y se reanuda, los eventos onReceive se vuelven a generar cuando se reciben los mensajes. Cuando se pausa un socket de escucha, se aceptan nuevas conexiones hasta que su trabajo pendiente está completo y, luego, se rechazan las solicitudes de conexión adicionales. Los eventos onAccept solo se generan cuando el socket se reanuda.

Parámetros

  • socketId

    número

  • detenido

    boolean

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 91 y versiones posteriores

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

update()

Promesa 
chrome.bluetoothSocket.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
)

Actualiza las propiedades del socket.

Parámetros

  • socketId

    número

    Es el identificador del socket.

  • properties

    SocketProperties

    Las propiedades que se actualizarán.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 91 y versiones posteriores

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

Eventos

onAccept

chrome.bluetoothSocket.onAccept.addListener(
  callback: function,
)

Evento que se genera cuando se establece una conexión para un socket determinado.

Parámetros

  • callback

    la función

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

    (info: AcceptInfo)=>void

onAcceptError

chrome.bluetoothSocket.onAcceptError.addListener(
  callback: function,
)

Evento que se generó cuando se produjo un error de red mientras el entorno de ejecución esperaba nuevas conexiones en el socket determinado. Una vez que se genera este evento, el socket se establece en paused y no se generan más eventos onAccept para este socket.

Parámetros

onReceive

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

Evento generado cuando se reciben datos de un socket determinado

Parámetros

  • callback

    la función

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

    (info: ReceiveInfo)=>void

onReceiveError

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

Evento que se generó cuando se produjo un error de red mientras el entorno de ejecución estaba esperando datos en el socket. Una vez que se genera este evento, el socket se establece en paused y no se generan más eventos onReceive para este socket.

Parámetros