chrome.bluetoothSocket

Descrição

Use a API chrome.bluetoothSocket para enviar e receber dados para dispositivos Bluetooth usando conexões RFCOMM e L2CAP.

Manifesto

As chaves a seguir precisam ser declaradas no manifesto para usar essa API.

"bluetooth"

Tipos

AcceptError

Enumeração

"system_error"
Ocorreu um erro de sistema e a conexão pode ser irrecuperável.

"not_listening"
O soquete não está detectando.

AcceptErrorInfo

Propriedades

  • Um código de erro indicando o que deu errado.

  • errorMessage

    string

    A mensagem de erro.

  • socketId

    number

    O identificador de soquete do servidor.

AcceptInfo

Propriedades

  • clientSocketId

    number

    O identificador de soquete do cliente, ou seja, o identificador de soquete da conexão recém-estabelecida. Esse identificador de soquete só pode ser usado com funções do namespace chrome.bluetoothSocket. Observe que o soquete do cliente é inicialmente pausado e precisa ser retomado explicitamente pelo aplicativo para começar a receber dados.

  • socketId

    number

    O identificador de soquete do servidor.

CreateInfo

Propriedades

  • socketId

    number

    O ID do soquete recém-criado. Os IDs de soquete criados com base nessa API não são compatíveis com os de outras APIs, como a API [sockets.tcp](../sockets_tcp/).

ListenOptions

Propriedades

  • lista de pendências

    número opcional

    Comprimento da fila de detecção do soquete. O valor padrão depende do subsistema host do sistema operacional.

  • canal

    número opcional

    O canal RFCOMM usado por listenUsingRfcomm. Se especificado, este canal não pode estar em uso anteriormente, ou a chamada do método falhará. Quando não é especificado, um canal não usado é alocado automaticamente.

  • psm

    número opcional

    O PSM L2CAP usado por listenUsingL2cap. Se especificado, este PSM não pode estar em uso anteriormente ou a chamada do método falhar. Quando não for especificado, um PSM não usado será alocado automaticamente.

ReceiveError

Enumeração

"dislinked"
A conexão foi desconectada.

"system_error"
Ocorreu um erro de sistema e a conexão pode ser irrecuperável.

"not_Connected"
O soquete não foi conectado.

ReceiveErrorInfo

Propriedades

  • Um código de erro indicando o que deu errado.

  • errorMessage

    string

    A mensagem de erro.

  • socketId

    number

    O identificador do soquete.

ReceiveInfo

Propriedades

  • dados

    Buffer de matriz

    Os dados recebidos, com um tamanho máximo de bufferSize.

  • socketId

    number

    O identificador do soquete.

SocketInfo

Propriedades

  • endereço

    string opcional

    Se o soquete subjacente estiver conectado, contém o endereço Bluetooth do dispositivo a que ele está conectado.

  • bufferSize

    número opcional

    O tamanho do buffer usado para receber dados. Se nenhum tamanho de buffer tiver sido especificado explicitamente, o valor não será fornecido.

  • conectado

    booleano

    Sinalizador que indica se o soquete está conectado a um peer remoto.

  • nome

    string opcional

    String definida pelo aplicativo associada ao soquete.

  • pausado

    booleano

    Sinalização que indica se um soquete conectado impede que o peering envie mais dados ou se as solicitações de conexão em um soquete de detecção são despachadas pelo evento onAccept ou enfileiradas no backlog da fila de detecção. Consulte os setPaused. O valor padrão é "false".

  • persistente

    booleano

    Sinalização que indica se o soquete permanece aberto quando a página de eventos do aplicativo é descarregada (consulte SocketProperties.persistent). O valor padrão é "false".

  • socketId

    number

    O identificador do soquete.

  • uuid

    string opcional

    Se o soquete subjacente estiver conectado, contém informações sobre o UUID de serviço ao qual ele está conectado. Caso contrário, se o soquete subjacente estiver detectando, contém informações sobre o UUID de serviço que está detectando.

SocketProperties

Propriedades

  • bufferSize

    número opcional

    O tamanho do buffer usado para receber dados. O valor padrão é 4096.

  • nome

    string opcional

    Uma string definida pelo aplicativo associada ao soquete.

  • persistente

    booleano opcional

    Sinalização que indica se o soquete é deixado aberto quando a página de eventos do aplicativo é descarregada (consulte Gerenciar o ciclo de vida do app). O valor padrão é false.. Quando o aplicativo é carregado, todos os soquetes abertos anteriormente com persistent=true podem ser buscados com getSockets.

Métodos

close()

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

Desconecta e destrói o soquete. Cada soquete criado precisa ser fechado após o uso. O ID do soquete não será mais válido assim que a função for chamada. No entanto, o soquete será fechado somente quando o callback for invocado.

Parâmetros

  • socketId

    number

    O identificador do soquete.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

connect()

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

Conecta o soquete a um dispositivo Bluetooth remoto. Quando a operação connect é concluída com êxito, os eventos onReceive são gerados quando os dados são recebidos do peering. Se ocorrer um erro de rede enquanto o ambiente de execução estiver recebendo pacotes, um evento onReceiveError será gerado. Depois disso, nenhum evento onReceive será gerado para o soquete até que o método setPaused(false) seja chamado.

Parâmetros

  • socketId

    number

    O identificador do soquete.

  • endereço

    string

    O endereço do dispositivo Bluetooth.

  • uuid

    string

    O UUID do serviço a ser conectado.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

create()

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

Cria um soquete Bluetooth.

Parâmetros

  • properties

    SocketProperties opcional

    Propriedades do soquete (opcional).

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      Resultado da criação do soquete.

Retorna

  • Promise&lt;CreateInfo&gt;

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

disconnect()

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

Desconecta o soquete. O identificador do soquete continua válido.

Parâmetros

  • socketId

    number

    O identificador do soquete.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getInfo()

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

Recupera o estado do soquete especificado.

Parâmetros

  • socketId

    number

    O identificador do soquete.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      Objeto que contém as informações do soquete.

Retorna

  • Promise&lt;SocketInfo&gt;

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getSockets()

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

Recupera a lista de soquetes abertos no momento de propriedade do aplicativo.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (sockets: SocketInfo[]) => void

Retorna

  • Promise&lt;SocketInfo[]&gt;

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

listenUsingL2cap()

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

Detecte conexões usando o protocolo L2CAP.

Parâmetros

  • socketId

    number

    O identificador do soquete.

  • uuid

    string

    UUID de serviço a ser detectado.

  • opções

    ListenOptions opcional

    Opções adicionais opcionais do serviço.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

listenUsingRfcomm()

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

Detecte conexões usando o protocolo RFCOMM.

Parâmetros

  • socketId

    number

    O identificador do soquete.

  • uuid

    string

    UUID de serviço a ser detectado.

  • opções

    ListenOptions opcional

    Opções adicionais opcionais do serviço.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

send()

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

Envia dados no soquete Bluetooth fornecido.

Parâmetros

  • socketId

    number

    O identificador do soquete.

  • dados

    Buffer de matriz

    Os dados a serem enviados.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    (bytesSent: number) => void

    • bytesSent

      number

      O número de bytes enviados.

Retorna

  • Promise&lt;number&gt;

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

setPaused()

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

Ativa ou desativa um soquete conectado para receber mensagens de seu par ou um soquete de escuta aceitar novas conexões. O valor padrão é "false". A pausa de um soquete conectado normalmente é usada por um aplicativo para limitar os dados enviados por seu par. Quando um soquete conectado é pausado, nenhum evento onReceive é gerado. Quando um soquete é conectado e retomado, os eventos onReceive são gerados novamente quando as mensagens são recebidas. Quando um soquete de detecção é pausado, novas conexões são aceitas até que o backlog esteja cheio. Em seguida, solicitações de conexão adicionais são recusadas. Os eventos onAccept são gerados apenas quando o soquete é retomado.

Parâmetros

  • socketId

    number

  • pausado

    booleano

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

update()

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

Atualiza as propriedades do soquete.

Parâmetros

  • socketId

    number

    O identificador do soquete.

  • properties

    SocketProperties

    As propriedades a serem atualizadas.

  • callback

    função opcional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 91 ou versões mais recentes

    As promessas só têm suporte no Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

Eventos

onAccept

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

Evento gerado quando uma conexão é estabelecida para um determinado soquete.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (info: AcceptInfo) => void

onAcceptError

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

Evento gerado quando um erro de rede ocorreu enquanto o ambiente de execução aguardava novas conexões no soquete especificado. Quando esse evento for gerado, o soquete será definido como paused e nenhum outro evento onAccept será gerado para ele.

Parâmetros

onReceive

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

Evento gerado quando os dados forem recebidos para um determinado soquete.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (info: ReceiveInfo) => void

onReceiveError

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

Evento gerado quando ocorreu um erro de rede enquanto o ambiente de execução aguardava dados no soquete. Quando esse evento for gerado, o soquete será definido como paused e nenhum outro evento onReceive será gerado para ele.

Parâmetros