chrome.bluetoothSocket

Beschrijving

Gebruik de chrome.bluetoothSocket API om gegevens te sturen naar en te krijgen van bluetooth-apparaten via RFCOMM- en L2CAP-verbindingen.

Beschikbaarheid

Alleen ChromeOS

Manifest

De volgende sleutels moeten in het manifest worden gedefinieerd om deze API te gebruiken.

"bluetooth"

Typen

AcceptError

Enum

system_error
Er is een systeemfout opgetreden en de verbinding kan misschien niet worden hersteld.

not_listening
De socket luistert niet.

AcceptErrorInfo

Eigenschappen

  • Een foutcode die aangeeft wat er is misgegaan.

  • errorMessage

    tekenreeks

    De foutmelding.

  • socketId

    getal

    De serversocket-ID.

AcceptInfo

Eigenschappen

  • clientSocketId

    getal

    De clientsocket-ID, d.w.z. de socket-ID van de nieuwe verbinding. Deze socket-ID mag alleen worden gebruikt met functies uit de naamruimte chrome.bluetoothSocket. De clientsocket is in eerste instantie onderbroken en moet expliciet worden hervat door de app om gegevens te ontvangen.

  • socketId

    getal

    De serversocket-ID.

CreateInfo

Eigenschappen

  • socketId

    getal

    De ID van de nieuwe socket. Socket-ID's die zijn gemaakt via deze API, zijn niet compatibel met socket-ID's die zijn gemaakt via andere API's, zoals de API [sockets.tcp](../sockets_tcp/).

ListenOptions

Eigenschappen

  • backlog

    number optioneel

    De lengte van de luisterwachtrij van de socket. De standaardwaarde is afhankelijk van het hostsubsysteem van het besturingssysteem.

  • kanaal

    number optioneel

    Het RFCOMM-kanaal dat wordt gebruikt door listenUsingRfcomm. Als je dit opgeeft, mag dit kanaal niet eerder zijn gebruikt, anders mislukt de methodeaanroep. Als je niets opgeeft, wordt er automatisch een ongebruikt kanaal toegewezen.

  • psm

    number optioneel

    De L2CAP PSM die wordt gebruikt door listenUsingL2cap. Als deze PSM is ingevoerd, mag deze niet eerder zijn gebruikt, anders mislukt de methodeaanroep. Als je niets opgeeft, wordt er automatisch een ongebruikte PSM toegewezen.

ReceiveError

Enum

disconnected
De verbinding is verbroken.

system_error
Er is een systeemfout opgetreden en de verbinding kan misschien niet worden hersteld.

not_connected
De socket is niet verbonden.

ReceiveErrorInfo

Eigenschappen

  • Een foutcode die aangeeft wat er is misgegaan.

  • errorMessage

    tekenreeks

    De foutmelding.

  • socketId

    getal

    De socket-ID.

ReceiveInfo

Eigenschappen

  • gegevens

    ArrayBuffer

    De ontvangen gegevens, met een maximale grootte van bufferSize.

  • socketId

    getal

    De socket-ID.

SocketInfo

Eigenschappen

  • adres

    tekenreeks optioneel

    Als de onderliggende socket is verbonden, bevat deze het bluetooth-adres van het apparaat waarmee deze is verbonden.

  • bufferSize

    number optioneel

    De grootte van de buffer die wordt gebruikt om gegevens te ontvangen. Als er geen buffergrootte expliciet is ingevoerd, wordt de waarde niet verstrekt.

  • verbonden

    booleaans

    Markering die aangeeft of de socket is verbonden met een externe peer.

  • name

    tekenreeks optioneel

    Door de app gedefinieerde tekenreeks die aan de socket is gekoppeld.

  • onderbroken

    booleaans

    Markering die aangeeft of een verbonden socket voorkomt dat de peer meer gegevens stuurt of dat verbindingsverzoeken op een luisterende socket worden verzonden via de gebeurtenis onAccept of in de wachtrij worden geplaatst in de backlog van de luisterwachtrij. Zie setPaused. De standaardwaarde is false.

  • persistent

    booleaans

    Markering die aangeeft of de socket open blijft als de gebeurtenispagina van de app wordt verwijderd (zie SocketProperties.persistent). De standaardwaarde is 'false'.

  • socketId

    getal

    De socket-ID.

  • uuid

    tekenreeks optioneel

    Als de onderliggende socket is verbonden, bevat deze informatie over de service-UUID waarmee deze is verbonden. Als de onderliggende socket luistert, bevat deze informatie over de service-UUID waarnaar deze luistert.

SocketProperties

Eigenschappen

  • bufferSize

    number optioneel

    De grootte van de buffer die wordt gebruikt om gegevens te ontvangen. De standaardwaarde is 4096.

  • name

    tekenreeks optioneel

    Een door de app gedefinieerde tekenreeks die aan de socket is gekoppeld.

  • persistent

    booleaans optioneel

    Markering die aangeeft of de socket open blijft als de gebeurtenispagina van de app wordt verwijderd (zie App-levenscyclus beheren). De standaardwaarde is false.. Als de app wordt geladen, kunnen alle sockets die eerder zijn geopend met persistent=true, worden opgehaald met getSockets.

Methoden

close()

Promise 
chrome.bluetoothSocket.close(
  socketId: number,
  callback?: function,
): Promise<void>

Verbreekt de verbinding en vernietigt de socket. Elke gemaakte socket moet na gebruik worden gesloten. De socket-ID is niet meer geldig zodra de functie wordt aangeroepen. De socket wordt gegarandeerd pas gesloten als de callback wordt aangeroepen.

Parameters

  • socketId

    getal

    De socket-ID.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

connect()

Promise 
chrome.bluetoothSocket.connect(
  socketId: number,
  address: string,
  uuid: string,
  callback?: function,
): Promise<void>

Verbindt de socket met een extern bluetooth-apparaat. Als de bewerking connect is afgerond, worden er onReceive gebeurtenissen geactiveerd als er gegevens worden ontvangen van de peer. Als er een netwerkfout optreedt terwijl de runtime pakketten ontvangt, wordt er een onReceiveError-gebeurtenis geactiveerd. Er wordt dan geen onReceive-gebeurtenis meer geactiveerd voor deze socket totdat de setPaused(false)-methode wordt aangeroepen.

Parameters

  • socketId

    getal

    De socket-ID.

  • adres

    tekenreeks

    Het adres van het bluetooth-apparaat.

  • uuid

    tekenreeks

    De UUID van de service waarmee verbinding moet worden gemaakt.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

create()

Promise 
chrome.bluetoothSocket.create(
  properties?: SocketProperties,
  callback?: function,
): Promise<CreateInfo>

Maakt een bluetooth-socket.

Parameters

  • property's

    SocketProperties optioneel

    De socket-eigenschappen (optioneel).

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      Het resultaat van het maken van de socket.

Retourzendingen

  • Promise<CreateInfo>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

disconnect()

Promise 
chrome.bluetoothSocket.disconnect(
  socketId: number,
  callback?: function,
): Promise<void>

Verbreekt de verbinding met de socket. De socket-ID blijft geldig.

Parameters

  • socketId

    getal

    De socket-ID.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getInfo()

Promise 
chrome.bluetoothSocket.getInfo(
  socketId: number,
  callback?: function,
): Promise<SocketInfo>

Haalt de status van de aangegeven socket op.

Parameters

  • socketId

    getal

    De socket-ID.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      Object met de socketinformatie.

Retourzendingen

  • Promise<SocketInfo>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

getSockets()

Promise 
chrome.bluetoothSocket.getSockets(
  callback?: function,
): Promise<SocketInfo[]>

Haalt de lijst op met momenteel geopende sockets die eigendom zijn van de app.

Parameters

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (sockets: SocketInfo[]) => void

    • netwerkverbindingen

      SocketInfo[]

      Matrix van object met socketinformatie.

Retourzendingen

  • Promise<SocketInfo[]>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

listenUsingL2cap()

Promise 
chrome.bluetoothSocket.listenUsingL2cap(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
): Promise<void>

Luisteren naar verbindingen via het L2CAP-protocol.

Parameters

  • socketId

    getal

    De socket-ID.

  • uuid

    tekenreeks

    Service-UUID om naar te luisteren.

  • opties

    ListenOptions optioneel

    Optionele aanvullende opties voor de service.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

listenUsingRfcomm()

Promise 
chrome.bluetoothSocket.listenUsingRfcomm(
  socketId: number,
  uuid: string,
  options?: ListenOptions,
  callback?: function,
): Promise<void>

Luisteren naar verbindingen via het RFCOMM-protocol.

Parameters

  • socketId

    getal

    De socket-ID.

  • uuid

    tekenreeks

    Service-UUID om naar te luisteren.

  • opties

    ListenOptions optioneel

    Optionele aanvullende opties voor de service.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

send()

Promise 
chrome.bluetoothSocket.send(
  socketId: number,
  data: ArrayBuffer,
  callback?: function,
): Promise<number>

Stuurt gegevens via de aangegeven bluetooth-socket.

Parameters

  • socketId

    getal

    De socket-ID.

  • gegevens

    ArrayBuffer

    De gegevens die je wilt sturen.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    (bytesSent: number) => void

    • bytesSent

      getal

      Het aantal verstuurde bytes.

Retourzendingen

  • Promise<number>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

setPaused()

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

Hiermee zet je aan of uit dat een verbonden socket berichten van de peer krijgt of dat een luisterende socket nieuwe verbindingen accepteert. De standaardwaarde is false. Een app gebruikt de optie om een verbonden socket te onderbreken meestal om gegevens te beperken die door de peer worden gestuurd. Als een verbonden socket wordt onderbroken, wordt er geen onReceive-gebeurtenis geactiveerd. Als een socket is verbonden en de pauze is opgeheven, worden onReceive-gebeurtenissen opnieuw geactiveerd als er berichten worden ontvangen. Als een luistersocket wordt onderbroken, worden nieuwe verbindingen geaccepteerd totdat de backlog vol is. Daarna worden aanvullende verbindingsverzoeken geweigerd. onAccept-gebeurtenissen worden alleen geactiveerd als de socket wordt hervat.

Parameters

  • socketId

    getal

  • onderbroken

    booleaans

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

update()

Promise 
chrome.bluetoothSocket.update(
  socketId: number,
  properties: SocketProperties,
  callback?: function,
): Promise<void>

Updatet de socket-eigenschappen.

Parameters

  • socketId

    getal

    De socket-ID.

  • property's

    SocketProperties

    De eigenschappen die je wilt updaten.

  • callback

    functie optioneel

    De parameter callback ziet er zo uit: 

    () => void

Retourzendingen

  • Promise<void>

    Chrome 91+

    Promises worden alleen ondersteund voor Manifest V3 en hoger. Andere platforms moeten callbacks gebruiken.

Evenementen

onAccept

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

Gebeurtenis die wordt geactiveerd als er een verbinding is gemaakt voor een bepaalde socket.

Parameters

  • callback

    functie

    De parameter callback ziet er zo uit: 

    (info: AcceptInfo) => void

onAcceptError

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

Gebeurtenis die wordt geactiveerd als er een netwerkfout optreedt terwijl de runtime wacht op nieuwe verbindingen op de aangegeven socket. Nadat deze gebeurtenis is geactiveerd, wordt de socket ingesteld op paused en worden er geen onAccept-gebeurtenissen meer geactiveerd voor deze socket.

Parameters

onReceive

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

Gebeurtenis die wordt geactiveerd wanneer gegevens zijn ontvangen voor een bepaalde socket.

Parameters

onReceiveError

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

Gebeurtenis die wordt geactiveerd als er een netwerkfout optreedt terwijl de runtime wacht op gegevens op de socket. Nadat deze gebeurtenis is geactiveerd, wordt de socket ingesteld op paused en worden er geen onReceive-gebeurtenissen meer geactiveerd voor deze socket.

Parameters