chrome.bluetoothLowEnergy

Descrição

A API chrome.bluetoothLowEnergy é usada para se comunicar com dispositivos Bluetooth Smart (de baixa energia) usando o Perfil de Atributo Genérico (GATT).

Manifesto

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

"bluetooth"

Tipos

Advertisement

Chrome 47 e versões mais recentes

Propriedades

  • manufacturerData

    ManufacturerData[] opcional

    Lista de dados específicos do fabricante a serem incluídos nos campos "Dados específicos do fabricante" dos dados de publicidade.

  • serviceData

    ServiceData[] opcional

    Lista de dados de serviço a serem incluídos nos campos "Dados de serviço" dos dados de publicidade.

  • serviceUuids

    string[] opcional

    Lista de UUIDs a serem incluídos no campo "UUIDs de serviço" dos dados de publicidade. Esses UUIDs podem ser dos formatos de 16, 32 ou 128 bits.

  • solicitUuids

    string[] opcional

    Lista de UUIDs a serem incluídos no campo "Solicitar UUIDs" dos dados de publicidade. Esses UUIDs podem ser dos formatos de 16, 32 ou 128 bits.

  • Tipo de anúncio.

AdvertisementType

Chrome 47 e versões mais recentes

Tipo de anúncio. Se "broadcast" for escolhido, o tipo de anúncio enviado será ADV_NONCONN_IND, e o dispositivo será transmitido com um endereço MAC aleatório. Se definido como "peripheral", o tipo de publicidade será ADV_IND ou ADV_SCAN_IND, e o dispositivo será transmitido com o endereço MAC do adaptador Bluetooth real.

Enumeração

"broadcast"

"peripheral"

Characteristic

Propriedades

  • instanceId

    string opcional

    Retorna o identificador atribuído a essa característica. Use o ID de instância para distinguir entre as características de um periférico com o mesmo UUID e para fazer chamadas de função que recebem um identificador de característica. Presente, se a instância representar uma característica remota.

  • properties

    CharacteristicProperty[]

    As propriedades dessa característica.

  • serviço

    Serviço opcional

    O serviço GATT ao qual essa característica pertence.

  • uuid

    string

    O UUID da característica, por exemplo, 00002a37-0000-1000-8000-00805f9b34fb.

  • valor

    ArrayBuffer opcional

    O valor da característica armazenado em cache. Esse valor é atualizado quando o valor da característica é lido ou atualizado por uma notificação ou indicação.

CharacteristicProperty

Valores que representam as possíveis propriedades de uma característica. As permissões de característica são inferidas dessas propriedades. Consulte a especificação do Bluetooth 4.x para saber o significado de cada propriedade.

Enumeração

"broadcast"

"read"

"writeWithoutResponse"

"write"

"notify"

"indicar"

"authenticatedSignedWrites"

"extendedProperties"

"reliableWrite"

"writableAuxiliaries"

"encryptRead"

"encryptWrite"

"encryptAuthenticatedRead"

"encryptAuthenticatedWrite"

ConnectProperties

Propriedades

  • persistente

    booleano

    Flag que indica se uma conexão com o dispositivo é deixada aberta quando a página de eventos do aplicativo é descarregada (consulte Gerenciar o ciclo de vida do app). O valor padrão é false..

Descriptor

Propriedades

  • característica

    Característica opcional

    A característica GATT a que este descritor pertence.

  • instanceId

    string opcional

    Retorna o identificador atribuído a esse descritor. Use o ID de instância para distinguir entre descritores de um periférico com o mesmo UUID e para fazer chamadas de função que recebem um identificador de descritor. Presente, se a instância representar uma característica remota.

  • permissões

    DescriptorPermission[]

    Chrome 52 ou mais recente

    As permissões desse descritor.

  • uuid

    string

    O UUID do descritor de característica, por exemplo, 00002902-0000-1000-8000-00805f9b34fb.

  • valor

    ArrayBuffer opcional

    O valor do descritor armazenado em cache no momento. Esse valor é atualizado quando o valor do descritor é lido.

DescriptorPermission

Chrome 52 e versões mais recentes

Valores que representam as possíveis permissões de um descritor. Consulte a especificação do Bluetooth 4.x para saber o significado de cada permissão.

Enumeração

"read"

"write"

"encryptedRead"

"encryptedWrite"

"encryptedAuthenticatedRead"

"encryptedAuthenticatedWrite"

Device

Chrome 52 e versões mais recentes

Propriedades

  • endereço

    string

    O endereço do dispositivo no formato "XX:XX:XX:XX:XX:XX".

  • deviceClass

    número opcional

    A classe do dispositivo, um campo de bits definido por http://www.bluetooth.org/en-us/specification/assigned-numbers/baseband.

  • nome

    string opcional

    O nome legível do dispositivo.

ManufacturerData

Chrome 47 e versões mais recentes

Propriedades

  • dados

    number[]

  • id

    number

Notification

Chrome 52 e versões mais recentes

Propriedades

  • shouldIndicate

    booleano opcional

    Flag opcional para enviar uma indicação em vez de uma notificação.

  • valor

    ArrayBuffer

    Novo valor da característica.

NotificationProperties

Propriedades

  • persistente

    booleano

    Flag que indica se o app precisa receber notificações quando a página de eventos do aplicativo é descarregada (consulte Gerenciar o ciclo de vida do app). O valor padrão é false.

Request

Chrome 52 e versões mais recentes

Propriedades

  • dispositivo

    Dispositivo

    Dispositivo que enviou essa solicitação.

  • requestId

    number

    ID exclusivo para essa solicitação. Use esse ID ao responder a essa solicitação.

  • valor

    ArrayBuffer opcional

    Valor a ser gravado (se for uma solicitação de gravação).

Response

Chrome 52 e versões mais recentes

Propriedades

  • isError

    booleano

    Se for uma resposta de erro, esse valor precisa ser "true".

  • requestId

    number

    ID da solicitação a que esta resposta se refere.

  • valor

    ArrayBuffer opcional

    Valor da resposta. As solicitações de gravação e as respostas de erro vão ignorar esse parâmetro.

Service

Propriedades

  • deviceAddress

    string opcional

    O endereço do dispositivo do periférico remoto ao qual o serviço GATT pertence. Presente, se a instância representar um serviço remoto.

  • instanceId

    string opcional

    Retorna o identificador atribuído a esse serviço. Use o ID de instância para distinguir entre serviços de um periférico com o mesmo UUID e para fazer chamadas de função que recebem um identificador de serviço. Presente, se a instância representar um serviço remoto.

  • isPrimary

    booleano

    Indica se o tipo desse serviço é primário ou secundário.

  • uuid

    string

    O UUID do serviço, por exemplo, 0000180d-0000-1000-8000-00805f9b34fb.

ServiceData

Chrome 47 e versões mais recentes

Propriedades

  • dados

    number[]

  • uuid

    string

Métodos

connect()

Promessa 
chrome.bluetoothLowEnergy.connect(
  deviceAddress: string,
  properties?: ConnectProperties,
  callback?: function,
)

Estabelece uma conexão entre o aplicativo e o dispositivo com o endereço fornecido. Um dispositivo pode já estar conectado e os serviços GATT dele disponíveis sem chamar connect. No entanto, um app que quer acessar os serviços GATT de um dispositivo precisa chamar essa função para garantir que a conexão com o dispositivo seja mantida. Se o dispositivo não estiver conectado, todos os serviços GATT dele serão descobertos após uma chamada bem-sucedida para connect.

Parâmetros

  • deviceAddress

    string

    O endereço Bluetooth do dispositivo remoto para o qual uma conexão GATT precisa ser aberta.

  • properties

    ConnectProperties opcional

    Propriedades da conexão (opcional).

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

createCharacteristic()

Promise Chrome 52+ 
chrome.bluetoothLowEnergy.createCharacteristic(
  characteristic: Characteristic,
  serviceId: string,
  callback?: function,
)

Crie uma característica GATT hospedada localmente. Essa característica precisa ser hospedada em um serviço válido. Se o ID do serviço não for válido, o lastError será definido. Essa função só estará disponível se o app tiver as permissões bluetooth:low_energy e bluetooth:peripheral definidas como verdadeiras. A permissão de periféricos pode não estar disponível para todos os apps.

Parâmetros

  • característica

    Característica

    A característica a ser criada.

  • serviceId

    string

    ID do serviço para o qual essa característica será criada.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (characteristicId: string) => void

    • characteristicId

      string

Retorna

  • Promise<string>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

createDescriptor()

Promessa Chrome 52+ 
chrome.bluetoothLowEnergy.createDescriptor(
  descriptor: Descriptor,
  characteristicId: string,
  callback?: function,
)

Crie um descritor GATT hospedado localmente. Esse descritor precisa ser hospedado em uma característica válida. Se o ID da característica não for válido, o lastError será definido. Essa função só estará disponível se o app tiver as permissões bluetooth:low_energy e bluetooth:peripheral definidas como verdadeiras. A permissão de periféricos pode não estar disponível para todos os apps.

Parâmetros

  • descritor

    Descritor

    O descritor a ser criado.

  • characteristicId

    string

    ID da característica para a qual o descritor será criado.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (descriptorId: string) => void

    • descriptorId

      string

Retorna

  • Promise<string>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

createService()

Promessa Chrome 52+ 
chrome.bluetoothLowEnergy.createService(
  service: Service,
  callback?: function,
)

Crie um serviço GATT hospedado localmente. Esse serviço pode ser registrado para ficar disponível em um servidor GATT local. Essa função só estará disponível se o app tiver as permissões bluetooth:low_energy e bluetooth:peripheral definidas como verdadeiras. A permissão de periféricos pode não estar disponível para todos os apps.

Parâmetros

  • serviço

    Serviço

    O serviço a ser criado.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (serviceId: string) => void

    • serviceId

      string

Retorna

  • Promise<string>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

disconnect()

Promessa 
chrome.bluetoothLowEnergy.disconnect(
  deviceAddress: string,
  callback?: function,
)

Fecha a conexão do app com o dispositivo usando o endereço fornecido. Isso nem sempre vai destruir o link físico, já que pode haver outros apps com conexões abertas.

Parâmetros

  • deviceAddress

    string

    O endereço Bluetooth do dispositivo remoto.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getCharacteristic()

Promessa 
chrome.bluetoothLowEnergy.getCharacteristic(
  characteristicId: string,
  callback?: function,
)

Receba a característica GATT com o ID de instância fornecido que pertence ao serviço GATT fornecido, se a característica existir.

Parâmetros

  • characteristicId

    string

    O ID da instância da característica GATT solicitada.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: Characteristic) => void

Retorna

  • Promessa<Característica>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getCharacteristics()

Promessa 
chrome.bluetoothLowEnergy.getCharacteristics(
  serviceId: string,
  callback?: function,
)

Receba uma lista de todas as características GATT descobertas que pertencem ao serviço fornecido.

Parâmetros

  • serviceId

    string

    O ID de instância do serviço GATT cujas características serão retornadas.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: Characteristic[]) => void

Retorna

  • Promise<Characteristic[]>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getDescriptor()

Promessa 
chrome.bluetoothLowEnergy.getDescriptor(
  descriptorId: string,
  callback?: function,
)

Receba o descritor de característica GATT com o ID de instância fornecido.

Parâmetros

  • descriptorId

    string

    O ID da instância do descritor de característica GATT solicitado.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: Descriptor) => void

Retorna

  • Promise<Descriptor>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getDescriptors()

Promessa 
chrome.bluetoothLowEnergy.getDescriptors(
  characteristicId: string,
  callback?: function,
)

Receba uma lista de descritores de características GATT que pertencem à característica especificada.

Parâmetros

  • characteristicId

    string

    O ID da instância da característica GATT cujos descritores precisam ser retornados.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: Descriptor[]) => void

Retorna

  • Promise<Descriptor[]>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getIncludedServices()

Promessa 
chrome.bluetoothLowEnergy.getIncludedServices(
  serviceId: string,
  callback?: function,
)

Receba uma lista de serviços GATT incluídos pelo serviço fornecido.

Parâmetros

  • serviceId

    string

    O ID da instância do serviço GATT cujos serviços incluídos precisam ser retornados.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: Service[]) => void

Retorna

  • Promise<Service[]>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getService()

Promessa 
chrome.bluetoothLowEnergy.getService(
  serviceId: string,
  callback?: function,
)

Receba o serviço GATT com o ID da instância fornecido.

Parâmetros

  • serviceId

    string

    O ID da instância do serviço GATT solicitado.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: Service) => void

Retorna

  • Promessa<serviço>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

getServices()

Promessa 
chrome.bluetoothLowEnergy.getServices(
  deviceAddress: string,
  callback?: function,
)

Receba todos os serviços GATT que foram descobertos no dispositivo remoto com o endereço do dispositivo fornecido.

Observação:se a descoberta de serviços ainda não estiver concluída no dispositivo, essa API vai retornar um subconjunto (possivelmente vazio) de serviços. Uma solução alternativa é adicionar um atraso baseado em tempo e/ou fazer chamadas repetidamente até que o número esperado de serviços seja retornado.

Parâmetros

  • deviceAddress

    string

    O endereço Bluetooth do dispositivo remoto cujos serviços GATT precisam ser retornados.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: Service[]) => void

Retorna

  • Promise<Service[]>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

notifyCharacteristicValueChanged()

Promessa Chrome 52+ 
chrome.bluetoothLowEnergy.notifyCharacteristicValueChanged(
  characteristicId: string,
  notification: Notification,
  callback?: function,
)

Notificar um dispositivo remoto sobre um novo valor de uma característica. Se a flag shouldIndicate no objeto de notificação for verdadeira, uma indicação será enviada em vez de uma notificação. A característica precisa definir corretamente a propriedade "notify" ou "indicate" durante a criação para que essa chamada seja bem-sucedida. Essa função só estará disponível se o app tiver as permissões bluetooth:low_energy e bluetooth:peripheral definidas como verdadeiras. A permissão de periféricos pode não estar disponível para todos os apps.

Parâmetros

  • characteristicId

    string

    A característica para enviar a notificação.

  • notificação

    Notificação

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

readCharacteristicValue()

Promessa 
chrome.bluetoothLowEnergy.readCharacteristicValue(
  characteristicId: string,
  callback?: function,
)

Extrair o valor de uma característica especificada de um periférico remoto.

Parâmetros

  • characteristicId

    string

    O ID da instância da característica GATT cujo valor precisa ser lido do dispositivo remoto.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: Characteristic) => void

Retorna

  • Promessa<Característica>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

readDescriptorValue()

Promessa 
chrome.bluetoothLowEnergy.readDescriptorValue(
  descriptorId: string,
  callback?: function,
)

Extrair o valor de um descritor de característica especificado de um periférico remoto.

Parâmetros

  • descriptorId

    string

    O ID de instância do descritor de característica GATT cujo valor precisa ser lido do dispositivo remoto.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (result: Descriptor) => void

Retorna

  • Promise<Descriptor>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

registerAdvertisement()

Promessa Chrome 47 e versões mais recentes 
chrome.bluetoothLowEnergy.registerAdvertisement(
  advertisement: Advertisement,
  callback?: function,
)

Crie um anúncio e registre-o para publicidade. Para chamar essa função, o app precisa ter as permissões bluetooth:low_energy e bluetooth:peripheral definidas como "true". Além disso, essa API só está disponível para apps abertos automaticamente no modo quiosque ou ao definir a chave de linha de comando "--enable-ble-advertising-in-apps". Consulte https://developer.chrome.com/apps/manifest/bluetooth. Observação: em alguns hardwares, os modos central e periférico ao mesmo tempo são compatíveis, mas, em hardwares que não oferecem esse recurso, fazer essa chamada muda o dispositivo para o modo periférico. No caso de hardware que não oferece suporte aos modos central e periférico, a tentativa de usar o dispositivo em ambos os modos leva a um comportamento indefinido ou impede que outros aplicativos de função central se comportem corretamente, incluindo a descoberta de dispositivos Bluetooth de baixa energia.

Parâmetros

  • publicidade

    Anúncio

    O anúncio a ser veiculado.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    (advertisementId: number) => void

    • advertisementId

      number

Retorna

  • Promise<number>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

registerService()

Promessa Chrome 52+ 
chrome.bluetoothLowEnergy.registerService(
  serviceId: string,
  callback?: function,
)

Registre o serviço fornecido com o servidor GATT local. Se o ID do serviço for inválido, o lastError será definido. Essa função só estará disponível se o app tiver as permissões bluetooth:low_energy e bluetooth:peripheral definidas como verdadeiras. A permissão de periféricos pode não estar disponível para todos os apps.

Parâmetros

  • serviceId

    string

    ID exclusivo de um serviço criado.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

removeService()

Promise Chrome 52+ 
chrome.bluetoothLowEnergy.removeService(
  serviceId: string,
  callback?: function,
)

Remova o serviço especificado, cancelando o registro dele se ele estiver registrado. Se o ID do serviço for inválido, o lastError será definido. Essa função só estará disponível se o app tiver as permissões bluetooth:low_energy e bluetooth:peripheral definidas como verdadeiras. A permissão de periféricos pode não estar disponível para todos os apps.

Parâmetros

  • serviceId

    string

    ID exclusivo de um serviço registrado.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

resetAdvertising()

Promessa Chrome 61+ 
chrome.bluetoothLowEnergy.resetAdvertising(
  callback?: function,
)

Redefine a publicidade no dispositivo atual. Ele vai cancelar o registro e interromper todos os anúncios atuais.

Parâmetros

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

sendRequestResponse()

Chrome 52 ou mais recente 
chrome.bluetoothLowEnergy.sendRequestResponse(
  response: Response,
)

Envia uma resposta para uma solicitação de leitura/gravação de uma característica ou descritor. Essa função só estará disponível se o app tiver as permissões bluetooth:low_energy e bluetooth:peripheral definidas como verdadeiras. A permissão de periféricos pode não estar disponível para todos os apps.

Parâmetros

  • resposta

    Resposta

    A resposta à solicitação.

setAdvertisingInterval()

Promessa Chrome 55+ 
chrome.bluetoothLowEnergy.setAdvertisingInterval(
  minInterval: number,
  maxInterval: number,
  callback?: function,
)

Define o intervalo entre dois anúncios consecutivos. Observação: isso é o melhor esforço possível. O intervalo real pode variar de forma não trivial em relação aos intervalos solicitados. Em alguns hardwares, há um intervalo mínimo de 100 ms. Os valores mínimo e máximo não podem exceder o intervalo permitido pela especificação Bluetooth 4.2.

Parâmetros

  • minInterval

    number

    Intervalo mínimo entre anúncios (em milissegundos). Esse valor não pode ser inferior a 20 ms (de acordo com a especificação).

  • maxInterval

    number

    Intervalo máximo entre anúncios (em milissegundos). O tempo não pode ser maior que 10.240 ms (de acordo com a especificação).

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

startCharacteristicNotifications()

Promessa 
chrome.bluetoothLowEnergy.startCharacteristicNotifications(
  characteristicId: string,
  properties?: NotificationProperties,
  callback?: function,
)

Ative as notificações/indicações de valor da característica especificada. Depois de ativar, um aplicativo pode detectar notificações usando o evento onCharacteristicValueChanged.

Parâmetros

  • characteristicId

    string

    O ID da instância da característica GATT em que as notificações precisam ser ativadas.

  • properties

    NotificationProperties opcional

    Propriedades da sessão de notificação (opcional).

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

stopCharacteristicNotifications()

Promessa 
chrome.bluetoothLowEnergy.stopCharacteristicNotifications(
  characteristicId: string,
  callback?: function,
)

Desative as notificações/indicações de valor da característica especificada. Após uma chamada bem-sucedida, o app vai parar de receber notificações/indicações dessa característica.

Parâmetros

  • characteristicId

    string

    O ID de instância da característica GATT em que a sessão de notificação deste app precisa ser interrompida.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

unregisterAdvertisement()

Promessa Chrome 47 e versões mais recentes 
chrome.bluetoothLowEnergy.unregisterAdvertisement(
  advertisementId: number,
  callback?: function,
)

Desregistra um anúncio e interrompe a publicidade. Se o anúncio não for cancelado, a única maneira de interromper a publicidade é reiniciando o dispositivo.

Parâmetros

  • advertisementId

    number

    ID do anúncio a ser cancelado.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

unregisterService()

Promessa Chrome 52+ 
chrome.bluetoothLowEnergy.unregisterService(
  serviceId: string,
  callback?: function,
)

Cancelar o registro do serviço com o servidor GATT local. Se o ID do serviço for inválido, o lastError será definido. Essa função só estará disponível se o app tiver as permissões bluetooth:low_energy e bluetooth:peripheral definidas como verdadeiras. A permissão de periféricos pode não estar disponível para todos os apps.

Parâmetros

  • serviceId

    string

    ID exclusivo de um serviço registrado.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

writeCharacteristicValue()

Promessa 
chrome.bluetoothLowEnergy.writeCharacteristicValue(
  characteristicId: string,
  value: ArrayBuffer,
  callback?: function,
)

Grave o valor de uma característica especificada de um periférico remoto.

Parâmetros

  • characteristicId

    string

    O ID da instância da característica GATT cujo valor precisa ser gravado.

  • valor

    ArrayBuffer

    O valor que precisa ser enviado para a característica remota como parte da solicitação de gravação.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

writeDescriptorValue()

Promessa 
chrome.bluetoothLowEnergy.writeDescriptorValue(
  descriptorId: string,
  value: ArrayBuffer,
  callback?: function,
)

Grave o valor de um descritor de característica especificado de um periférico remoto.

Parâmetros

  • descriptorId

    string

    O ID de instância do descritor de característica GATT cujo valor precisa ser gravado.

  • valor

    ArrayBuffer

    O valor que precisa ser enviado ao descritor remoto como parte da solicitação de gravação.

  • callback

    função opcional

    O parâmetro callback tem este formato: 

    () => void

Retorna

  • Promise<void>

    Chrome 91 e versões mais recentes

    As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

Eventos

onCharacteristicReadRequest

Chrome 52 e versões mais recentes 
chrome.bluetoothLowEnergy.onCharacteristicReadRequest.addListener(
  callback: function,
)

É acionado quando um dispositivo central conectado solicita a leitura do valor de uma característica registrada no servidor GATT local. Se você não responder a essa solicitação por muito tempo, a conexão pode ser interrompida. Esse evento só está disponível se o app tiver as permissões bluetooth:low_energy e bluetooth:peripheral definidas como verdadeiras. A permissão de periféricos pode não estar disponível para todos os apps.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (request: Request, characteristicId: string) => void

onCharacteristicValueChanged

chrome.bluetoothLowEnergy.onCharacteristicValueChanged.addListener(
  callback: function,
)

É acionado quando o valor de uma característica GATT remota muda, seja como resultado de uma solicitação de leitura ou de uma notificação/indicação de mudança de valor. Esse evento só será enviado se o app tiver ativado as notificações chamando startCharacteristicNotifications.

Parâmetros

onCharacteristicWriteRequest

Chrome 52 e versões mais recentes 
chrome.bluetoothLowEnergy.onCharacteristicWriteRequest.addListener(
  callback: function,
)

É acionado quando um dispositivo central conectado solicita gravar o valor de uma característica registrada no servidor GATT local. Se você não responder a essa solicitação por muito tempo, a conexão pode ser desconectada. Esse evento só está disponível se o app tiver as permissões bluetooth:low_energy e bluetooth:peripheral definidas como verdadeiras. A permissão de periféricos pode não estar disponível para todos os apps.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (request: Request, characteristicId: string) => void

onDescriptorReadRequest

Chrome 52 e versões mais recentes 
chrome.bluetoothLowEnergy.onDescriptorReadRequest.addListener(
  callback: function,
)

É acionado quando um dispositivo central conectado solicita a leitura do valor de um descritor registrado no servidor GATT local. Se você não responder a essa solicitação por muito tempo, a conexão pode ser desconectada. Esse evento só está disponível se o app tiver as permissões bluetooth:low_energy e bluetooth:peripheral definidas como verdadeiras. A permissão de periféricos pode não estar disponível para todos os apps.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (request: Request, descriptorId: string) => void

onDescriptorValueChanged

chrome.bluetoothLowEnergy.onDescriptorValueChanged.addListener(
  callback: function,
)

É acionado quando o valor de um descritor de característica GATT remoto muda, geralmente como resultado de uma solicitação de leitura. Esse evento existe principalmente para conveniência e sempre será enviado após uma chamada bem-sucedida para readDescriptorValue.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (descriptor: Descriptor) => void

onDescriptorWriteRequest

Chrome 52 e versões mais recentes 
chrome.bluetoothLowEnergy.onDescriptorWriteRequest.addListener(
  callback: function,
)

É acionado quando um dispositivo central conectado solicita gravar o valor de um descritor registrado no servidor GATT local. Se você não responder a essa solicitação por muito tempo, a conexão pode ser desconectada. Esse evento só está disponível se o app tiver as permissões bluetooth:low_energy e bluetooth:peripheral definidas como verdadeiras. A permissão de periféricos pode não estar disponível para todos os apps.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (request: Request, descriptorId: string) => void

onServiceAdded

chrome.bluetoothLowEnergy.onServiceAdded.addListener(
  callback: function,
)

É acionado quando um novo serviço GATT é descoberto em um dispositivo remoto.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (service: Service) => void

onServiceChanged

chrome.bluetoothLowEnergy.onServiceChanged.addListener(
  callback: function,
)

É acionado quando o estado de um serviço GATT remoto muda. Isso envolve todas as características e/ou descritores que são adicionados ou removidos do serviço, bem como as notificações "ServiceChanged" do dispositivo remoto.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (service: Service) => void

onServiceRemoved

chrome.bluetoothLowEnergy.onServiceRemoved.addListener(
  callback: function,
)

É acionado quando um serviço GATT que foi descoberto anteriormente em um dispositivo remoto foi removido.

Parâmetros

  • callback

    função

    O parâmetro callback tem este formato: 

    (service: Service) => void