Descripción
Usa la API de chrome.bluetoothSocket
para enviar y recibir datos a dispositivos Bluetooth mediante conexiones RFCOMM y L2CAP.
Manifiesto
Tipos
AcceptError
Enum
"system_error"
Se produjo un error del sistema, por lo que es posible que la conexión no se pueda recuperar.
"not_listening"
El socket no escucha.
AcceptErrorInfo
Propiedades
-
error
Un código de error que indica qué salió mal.
-
errorMessage
string
Mensaje de error.
-
socketId
número
Es el identificador del socket de servidor.
AcceptInfo
Propiedades
-
clientSocketId
número
El identificador de socket del 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 se detiene inicialmente y la aplicación debe reanudarlo de forma explícita para comenzar a recibir datos. -
socketId
número
Es el identificador del 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 IDs de socket creados a partir de otras APIs, como la API de
[
sockets.tcp](../sockets_tcp/)
.
ListenOptions
Propiedades
-
tareas pendientes
número opcional
Longitud de la cola de escucha del socket. El valor predeterminado depende del subsistema de host del sistema operativo.
-
canal
número opcional
El canal RFCOMM que usa
listenUsingRfcomm
. Si se especifica, este canal no debe estar en uso antes o la llamada de método fallará. Si no se especifica, se asignará automáticamente un canal sin usar. -
PSM
número opcional
El PSM L2CAP que usa
listenUsingL2cap
. Si se especifica, este PSM no debe estar en uso antes o la llamada de método falla. Si no se especifica, se asignará automáticamente un PSM sin usar.
ReceiveError
Enum
"disconnect"
Se desconectó la conexión.
"system_error"
Se produjo un error del sistema, por lo que es posible que la conexión no se pueda recuperar.
"not_Connected"
El enchufe no se conectó.
ReceiveErrorInfo
Propiedades
-
error
Un código de error que indica qué salió mal.
-
errorMessage
string
Mensaje de error.
-
socketId
número
El identificador del socket.
ReceiveInfo
Propiedades
-
datos
ArrayBuffer
Los datos recibidos, con un tamaño máximo de
bufferSize
. -
socketId
número
El identificador del socket.
SocketInfo
Propiedades
-
dirección
string opcional
Si el socket subyacente está conectado, contiene la dirección de Bluetooth del dispositivo al que está conectado.
-
bufferSize
número opcional
El tamaño del búfer que se usa para recibir 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.
-
nombre
string opcional
Cadena definida por la aplicación asociada al socket.
-
detenido
boolean
Marca que indica si un socket conectado impide que su par envíe más datos o si las solicitudes de conexión en un socket de escucha se envían a través del evento
onAccept
o se ponen en cola en el trabajo pendiente de la cola de escucha. Consulta lossetPaused
. 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
El identificador del socket.
-
uuid
string 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 escucha.
SocketProperties
Propiedades
-
bufferSize
número opcional
El tamaño del búfer que se usa para recibir datos. El valor predeterminado es 4096.
-
nombre
string opcional
Una cadena definida por la aplicación asociada al socket.
-
persistentes
booleano opcional
Marca que indica si el socket queda abierto cuando se descarga la página de eventos de la aplicación (consulta Administra el ciclo de vida de la app). El valor predeterminado es
false.
. Cuando se carga la aplicación, cualquier socket abierto previamente con Persistent=true se puede recuperar congetSockets
.
Métodos
close()
chrome.bluetoothSocket.close(
socketId: number,
callback?: function,
)
Desconecta y destruye el enchufe. Cada socket creado debe cerrarse después de su uso. El ID del socket ya no es válido en cuanto se llama a la función. Sin embargo, se garantiza que el socket se cerrará solo cuando se invoque la devolución de llamada.
Parámetros
-
socketId
número
El identificador del socket.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Muestra
-
Promesa<void>
Chrome 91 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
connect()
chrome.bluetoothSocket.connect(
socketId: number,
address: string,
uuid: string,
callback?: function,
)
Conecta el enchufe a un dispositivo Bluetooth remoto. Cuando la operación connect
se completa correctamente, se generan eventos onReceive
cuando se reciben datos del par. Si se produce un error de red mientras el entorno de ejecución recibe paquetes, se genera un evento onReceiveError
, momento en el que no se generarán más eventos onReceive
para este socket hasta que se llame al método setPaused(false)
.
Parámetros
-
socketId
número
El identificador del socket.
-
dirección
string
Es la dirección del dispositivo Bluetooth.
-
uuid
string
El UUID del servicio al que se conectará.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Muestra
-
Promesa<void>
Chrome 91 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
create()
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
El resultado de la creación del socket.
-
Muestra
-
Promise<CreateInfo>
Chrome 91 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
disconnect()
chrome.bluetoothSocket.disconnect(
socketId: number,
callback?: function,
)
Desconecta el enchufe. El identificador del socket sigue siendo válido.
Parámetros
-
socketId
número
El identificador del socket.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Muestra
-
Promesa<void>
Chrome 91 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
getInfo()
chrome.bluetoothSocket.getInfo(
socketId: number,
callback?: function,
)
Recupera el estado de un socket determinado.
Parámetros
-
socketId
número
El identificador del socket.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:(socketInfo: SocketInfo) => void
-
socketInfo
Objeto que contiene la información del socket.
-
Muestra
-
Promise<SocketInfo>
Chrome 91 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
getSockets()
chrome.bluetoothSocket.getSockets(
callback?: function,
)
Recupera la lista de sockets abiertos actualmente que pertenecen a la aplicación.
Parámetros
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:(sockets: SocketInfo[]) => void
-
enchufes
-
Muestra
-
Promise<SocketInfo[]>
Chrome 91 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
listenUsingL2cap()
chrome.bluetoothSocket.listenUsingL2cap(
socketId: number,
uuid: string,
options?: ListenOptions,
callback?: function,
)
Detecta conexiones que utilicen el protocolo L2CAP.
Parámetros
-
socketId
número
El identificador del socket.
-
uuid
string
UUID de servicio para escuchar.
-
opciones
ListenOptions opcional.
Son las opciones adicionales y opcionales para el servicio.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Muestra
-
Promesa<void>
Chrome 91 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
listenUsingRfcomm()
chrome.bluetoothSocket.listenUsingRfcomm(
socketId: number,
uuid: string,
options?: ListenOptions,
callback?: function,
)
Detecta conexiones mediante el protocolo RFCOMM.
Parámetros
-
socketId
número
El identificador del socket.
-
uuid
string
UUID de servicio para escuchar.
-
opciones
ListenOptions opcional.
Son las opciones adicionales y opcionales para el servicio.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Muestra
-
Promesa<void>
Chrome 91 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
send()
chrome.bluetoothSocket.send(
socketId: number,
data: ArrayBuffer,
callback?: function,
)
Envía datos en el socket Bluetooth determinado.
Parámetros
-
socketId
número
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.
-
Muestra
-
Promise<number>
Chrome 91 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
setPaused()
chrome.bluetoothSocket.setPaused(
socketId: number,
paused: boolean,
callback?: function,
)
Habilita o inhabilita un socket conectado para que no reciba mensajes de su par o que un socket de escucha acepte nuevas conexiones. El valor predeterminado es "false". Por lo general, una aplicación utiliza la pausa de un socket conectado para limitar los datos que envía su intercambio de tráfico. Cuando se detiene 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 mensajes. Cuando se pausa un socket de escucha, se aceptan nuevas conexiones hasta que se completan todas las tareas pendientes y, luego, se rechazan las solicitudes de conexión adicionales. Los eventos onAccept
solo se generan cuando se reanuda el socket.
Parámetros
-
socketId
número
-
detenido
boolean
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Muestra
-
Promesa<void>
Chrome 91 y versiones posterioresLas promesas solo son compatibles con Manifest V3 y versiones posteriores; otras plataformas deben usar devoluciones de llamada.
update()
chrome.bluetoothSocket.update(
socketId: number,
properties: SocketProperties,
callback?: function,
)
Actualiza las propiedades del socket.
Parámetros
-
socketId
número
El identificador del socket.
-
properties
Las propiedades que se actualizarán.
-
callback
función opcional
El parámetro
callback
se ve de la siguiente manera:() => void
Muestra
-
Promesa<void>
Chrome 91 y versiones posterioresLas 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 generado cuando se establece una conexión para un socket determinado.
Parámetros
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(info: AcceptInfo) => void
-
información
-
onAcceptError
chrome.bluetoothSocket.onAcceptError.addListener(
callback: function,
)
Evento generado cuando se produjo un error de red mientras el entorno de ejecución estaba esperando 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
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(info: AcceptErrorInfo) => void
-
información
-
onReceive
chrome.bluetoothSocket.onReceive.addListener(
callback: function,
)
Evento generado cuando se reciben los datos de un socket determinado.
Parámetros
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(info: ReceiveInfo) => void
-
información
-
onReceiveError
chrome.bluetoothSocket.onReceiveError.addListener(
callback: function,
)
Evento generado 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
-
callback
función
El parámetro
callback
se ve de la siguiente manera:(info: ReceiveErrorInfo) => void
-
información
-