chrome.bluetoothSocket

คำอธิบาย

ใช้ chrome.bluetoothSocket API เพื่อส่งและรับข้อมูลไปยังอุปกรณ์บลูทูธโดยใช้การเชื่อมต่อ RFCOMM และ L2CAP

ความพร้อมใช้งาน

ChromeOS เท่านั้น

ไฟล์ Manifest

ต้องประกาศคีย์ต่อไปนี้ในไฟล์ Manifest เพื่อใช้ API นี้

"bluetooth"

ประเภท

AcceptError

ค่าแจกแจง

"system_error"
เกิดข้อผิดพลาดของระบบและการเชื่อมต่ออาจกู้คืนไม่ได้

"not_listening"
ซ็อกเก็ตไม่ฟัง

AcceptErrorInfo

พร็อพเพอร์ตี้

  • ข้อผิดพลาด

    AcceptError

    รหัสข้อผิดพลาดที่ระบุสิ่งที่ผิดพลาด

  • errorMessage

    สตริง

    ข้อความแสดงข้อผิดพลาด

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ตเซิร์ฟเวอร์

AcceptInfo

พร็อพเพอร์ตี้

  • clientSocketId

    ตัวเลข

    ตัวระบุซ็อกเก็ตไคลเอ็นต์ เช่น ตัวระบุซ็อกเก็ตของการเชื่อมต่อที่สร้างขึ้นใหม่ ควรใช้ตัวระบุซ็อกเก็ตนี้กับฟังก์ชันจากเนมสเปซ chrome.bluetoothSocket เท่านั้น โปรดทราบว่าซ็อกเก็ตไคลเอ็นต์จะหยุดชั่วคราวในตอนแรก และแอปพลิเคชันต้องยกเลิกการหยุดชั่วคราวอย่างชัดแจ้งเพื่อเริ่มรับข้อมูล

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ตเซิร์ฟเวอร์

CreateInfo

พร็อพเพอร์ตี้

  • socketId

    ตัวเลข

    รหัสของซ็อกเก็ตที่สร้างใหม่ โปรดทราบว่ารหัสซ็อกเก็ตที่สร้างจาก API นี้ใช้ร่วมกับรหัสซ็อกเก็ตที่สร้างจาก API อื่นๆ ไม่ได้ เช่น [sockets.tcp](../sockets_tcp/) API

ListenOptions

พร็อพเพอร์ตี้

  • งานค้าง

    number ไม่บังคับ

    ความยาวของคิวการฟังของซ็อกเก็ต ค่าเริ่มต้นจะขึ้นอยู่กับระบบย่อยของโฮสต์ของระบบปฏิบัติการ

  • ช่อง

    number ไม่บังคับ

    แชแนล RFCOMM ที่ listenUsingRfcomm ใช้ หากระบุ ช่องนี้ต้องไม่เคยใช้มาก่อน มิฉะนั้นการเรียกใช้เมธอดจะล้มเหลว หากไม่ได้ระบุ ระบบจะจัดสรรช่องที่ไม่ได้ใช้โดยอัตโนมัติ

  • psm

    number ไม่บังคับ

    L2CAP PSM ที่ listenUsingL2cap ใช้ หากระบุไว้ PSM นี้ต้องไม่เคยใช้มาก่อน มิฉะนั้นการเรียกใช้เมธอดจะดำเนินการไม่สำเร็จ หากไม่ได้ระบุ ระบบจะจัดสรร PSM ที่ไม่ได้ใช้โดยอัตโนมัติ

ReceiveError

ค่าแจกแจง

"disconnected"
การเชื่อมต่อถูกตัด

"system_error"
เกิดข้อผิดพลาดของระบบและการเชื่อมต่ออาจกู้คืนไม่ได้

"not_connected"
ไม่ได้เชื่อมต่อซ็อกเก็ต

ReceiveErrorInfo

พร็อพเพอร์ตี้

  • ข้อผิดพลาด

    ReceiveError

    รหัสข้อผิดพลาดที่ระบุสิ่งที่ผิดพลาด

  • errorMessage

    สตริง

    ข้อความแสดงข้อผิดพลาด

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ต

ReceiveInfo

พร็อพเพอร์ตี้

  • เพิ่มเติม

    ArrayBuffer

    ข้อมูลที่ได้รับ โดยมีขนาดสูงสุด bufferSize

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ต

SocketInfo

พร็อพเพอร์ตี้

  • ที่อยู่

    สตริง ไม่บังคับ

    หากซ็อกเก็ตที่สำคัญเชื่อมต่ออยู่ จะมีที่อยู่บลูทูธของอุปกรณ์ที่เชื่อมต่ออยู่

  • bufferSize

    number ไม่บังคับ

    ขนาดของบัฟเฟอร์ที่ใช้รับข้อมูล หากไม่ได้ระบุขนาดบัฟเฟอร์ไว้อย่างชัดเจน ระบบจะไม่ระบุค่า

  • เชื่อมต่อแล้ว

    บูลีน

    การแจ้งที่ระบุว่าซ็อกเก็ตเชื่อมต่อกับเพียร์ระยะไกลหรือไม่

  • name

    สตริง ไม่บังคับ

    สตริงที่แอปพลิเคชันกำหนดซึ่งเชื่อมโยงกับซ็อกเก็ต

  • หยุดชั่วคราว

    บูลีน

    แฟล็กที่ระบุว่าซ็อกเก็ตที่เชื่อมต่อบล็อกเพียร์ไม่ให้ส่งข้อมูลเพิ่มเติมหรือไม่ หรือคำขอการเชื่อมต่อในซ็อกเก็ตที่รอรับการเชื่อมต่อถูกส่งผ่านเหตุการณ์ onAccept หรือจัดคิวในคิวรอรับการเชื่อมต่อ ดู setPaused ค่าเริ่มต้นคือ "false"

  • ถาวร

    บูลีน

    แฟล็กที่ระบุว่าซ็อกเก็ตยังคงเปิดอยู่หรือไม่เมื่อยกเลิกการโหลดหน้าเหตุการณ์ของแอปพลิเคชัน (ดู SocketProperties.persistent) ค่าเริ่มต้นคือ "false"

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ต

  • uuid

    สตริง ไม่บังคับ

    หากซ็อกเก็ตที่สำคัญเชื่อมต่ออยู่ จะมีข้อมูลเกี่ยวกับ UUID ของบริการที่เชื่อมต่ออยู่ มิฉะนั้น หากซ็อกเก็ตที่สำคัญกำลังฟังอยู่ จะมีข้อมูลเกี่ยวกับ UUID ของบริการที่กำลังฟังอยู่

SocketProperties

พร็อพเพอร์ตี้

  • bufferSize

    number ไม่บังคับ

    ขนาดของบัฟเฟอร์ที่ใช้รับข้อมูล ค่าเริ่มต้นคือ 4096

  • name

    สตริง ไม่บังคับ

    สตริงที่แอปพลิเคชันกำหนดซึ่งเชื่อมโยงกับซ็อกเก็ต

  • ถาวร

    บูลีน ไม่บังคับ

    แฟล็กที่ระบุว่าซ็อกเก็ตเปิดอยู่หรือไม่เมื่อยกเลิกการโหลดหน้าเหตุการณ์ของแอปพลิเคชัน (ดูจัดการวงจรของแอป) ค่าเริ่มต้นคือ false. เมื่อโหลดแอปพลิเคชันแล้ว คุณจะดึงข้อมูลซ็อกเก็ตที่เปิดไว้ก่อนหน้านี้ด้วย persistent=true ได้โดยใช้ getSockets

เมธอด

close()

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

ยกเลิกการเชื่อมต่อและทำลายซ็อกเก็ต ควรปิดซ็อกเก็ตแต่ละรายการที่สร้างขึ้นหลังการใช้งาน รหัสซ็อกเก็ตจะใช้ไม่ได้อีกต่อไปทันทีที่มีการเรียกใช้ฟังก์ชัน อย่างไรก็ตาม ระบบจะรับประกันว่าซ็อกเก็ตจะปิดก็ต่อเมื่อมีการเรียกใช้ Callback เท่านั้น

พารามิเตอร์

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ต

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    Chrome 91 ขึ้นไป

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

connect()

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

เชื่อมต่อซ็อกเก็ตกับอุปกรณ์บลูทูธระยะไกล เมื่อการดำเนินการ connect เสร็จสมบูรณ์ ระบบจะสร้างเหตุการณ์ onReceive เมื่อได้รับข้อมูลจากเพียร์ หากเกิดข้อผิดพลาดเกี่ยวกับเครือข่ายขณะที่รันไทม์กำลังรับแพ็กเก็ต ระบบจะสร้างเหตุการณ์ onReceiveError ขึ้น ซึ่งจะไม่มีการสร้างเหตุการณ์ onReceive เพิ่มเติมสำหรับซ็อกเก็ตนี้จนกว่าจะมีการเรียกใช้เมธอด setPaused(false)

พารามิเตอร์

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ต

  • ที่อยู่

    สตริง

    ที่อยู่ของอุปกรณ์บลูทูธ

  • uuid

    สตริง

    UUID ของบริการที่จะเชื่อมต่อ

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    Chrome 91 ขึ้นไป

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

create()

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

สร้างซ็อกเก็ตบลูทูธ

พารามิเตอร์

  • พร็อพเพอร์ตี้

    SocketProperties ไม่บังคับ

    พร็อพเพอร์ตี้ซ็อกเก็ต (ไม่บังคับ)

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (createInfo: CreateInfo) => void

    • createInfo

      CreateInfo

      ผลลัพธ์ของการสร้างซ็อกเก็ต

การคืนสินค้า

  • Promise<CreateInfo>

    Chrome 91 ขึ้นไป

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

disconnect()

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

ยกเลิกการเชื่อมต่อซ็อกเก็ต ตัวระบุซ็อกเก็ตจะยังคงใช้ได้อยู่

พารามิเตอร์

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ต

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    Chrome 91 ขึ้นไป

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

getInfo()

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

ดึงข้อมูลสถานะของซ็อกเก็ตที่ระบุ

พารามิเตอร์

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ต

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (socketInfo: SocketInfo) => void

    • socketInfo

      SocketInfo

      ออบเจ็กต์ที่มีข้อมูลซ็อกเก็ต

การคืนสินค้า

  • Promise<SocketInfo>

    Chrome 91 ขึ้นไป

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

getSockets()

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

ดึงข้อมูลรายการซ็อกเก็ตที่เปิดอยู่ซึ่งเป็นของแอปพลิเคชัน

พารามิเตอร์

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (sockets: SocketInfo[]) => void

    • ซ็อกเก็ต

      SocketInfo[]

      อาร์เรย์ของออบเจ็กต์ที่มีข้อมูลซ็อกเก็ต

การคืนสินค้า

  • Promise<SocketInfo[]>

    Chrome 91 ขึ้นไป

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

listenUsingL2cap()

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

รอฟังการเชื่อมต่อโดยใช้โปรโตคอล L2CAP

พารามิเตอร์

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ต

  • uuid

    สตริง

    UUID ของบริการที่จะฟัง

  • ตัวเลือก

    ListenOptions ไม่บังคับ

    ตัวเลือกเพิ่มเติมที่ไม่บังคับสำหรับบริการ

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    Chrome 91 ขึ้นไป

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

listenUsingRfcomm()

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

รอฟังการเชื่อมต่อโดยใช้โปรโตคอล RFCOMM

พารามิเตอร์

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ต

  • uuid

    สตริง

    UUID ของบริการที่จะฟัง

  • ตัวเลือก

    ListenOptions ไม่บังคับ

    ตัวเลือกเพิ่มเติมที่ไม่บังคับสำหรับบริการ

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    Chrome 91 ขึ้นไป

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

send()

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

ส่งข้อมูลในซ็อกเก็ตบลูทูธที่ระบุ

พารามิเตอร์

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ต

  • เพิ่มเติม

    ArrayBuffer

    ข้อมูลที่จะส่ง

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (bytesSent: number) => void

    • bytesSent

      ตัวเลข

      จำนวนไบต์ที่ส่ง

การคืนสินค้า

  • Promise<number>

    Chrome 91 ขึ้นไป

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

setPaused()

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

เปิดหรือปิดใช้ซ็อกเก็ตที่เชื่อมต่อจากการรับข้อความจากเพียร์ หรือซ็อกเก็ตที่รอรับการเชื่อมต่อใหม่ ค่าเริ่มต้นคือ "false" โดยปกติแล้วแอปพลิเคชันจะใช้การหยุดซ็อกเก็ตที่เชื่อมต่อชั่วคราวเพื่อควบคุมปริมาณข้อมูลที่ส่งโดยแอปพลิเคชันเทียบเท่า เมื่อซ็อกเก็ตที่เชื่อมต่อหยุดชั่วคราว ระบบจะไม่สร้างเหตุการณ์ onReceive เมื่อเชื่อมต่อซ็อกเก็ตและยกเลิกการหยุดชั่วคราว เหตุการณ์ onReceive จะเกิดขึ้นอีกครั้งเมื่อได้รับข้อความ เมื่อซ็อกเก็ตการฟังหยุดชั่วคราว ระบบจะยอมรับการเชื่อมต่อใหม่จนกว่างานค้างจะเต็ม จากนั้นจะปฏิเสธคำขอเชื่อมต่อเพิ่มเติม ระบบจะสร้างเหตุการณ์ onAccept เฉพาะเมื่อซ็อกเก็ตไม่ได้หยุดชั่วคราว

พารามิเตอร์

  • socketId

    ตัวเลข

  • หยุดชั่วคราว

    บูลีน

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    Chrome 91 ขึ้นไป

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

update()

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

อัปเดตพร็อพเพอร์ตี้ของซ็อกเก็ต

พารามิเตอร์

  • socketId

    ตัวเลข

    ตัวระบุซ็อกเก็ต

  • พร็อพเพอร์ตี้

    SocketProperties

    พร็อพเพอร์ตี้ที่จะอัปเดต

  • callback

    function ไม่บังคับ

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    () => void

การคืนสินค้า

  • Promise<void>

    Chrome 91 ขึ้นไป

    ระบบรองรับ Promise สำหรับ Manifest V3 ขึ้นไปเท่านั้น แพลตฟอร์มอื่นๆ ต้องใช้ Callback

กิจกรรม

onAccept

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

เหตุการณ์ที่เกิดขึ้นเมื่อมีการสร้างการเชื่อมต่อสำหรับซ็อกเก็ตที่กำหนด

พารามิเตอร์

  • callback

    ฟังก์ชัน

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (info: AcceptInfo) => void

onAcceptError

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

เหตุการณ์ที่เกิดขึ้นเมื่อเกิดข้อผิดพลาดเกี่ยวกับเครือข่ายขณะที่รันไทม์กำลังรอการเชื่อมต่อใหม่ในซ็อกเก็ตที่ระบุ เมื่อเหตุการณ์นี้เกิดขึ้น ระบบจะตั้งค่าซ็อกเก็ตเป็น paused และจะไม่มีเหตุการณ์ onAccept เกิดขึ้นอีกสำหรับซ็อกเก็ตนี้

พารามิเตอร์

  • callback

    ฟังก์ชัน

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (info: AcceptErrorInfo) => void

onReceive

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

เหตุการณ์ที่เกิดขึ้นเมื่อได้รับข้อมูลสำหรับซ็อกเก็ตที่ระบุ

พารามิเตอร์

  • callback

    ฟังก์ชัน

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (info: ReceiveInfo) => void

onReceiveError

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

เหตุการณ์ที่เกิดขึ้นเมื่อเกิดข้อผิดพลาดเกี่ยวกับเครือข่ายขณะที่รันไทม์กำลังรอข้อมูลในซ็อกเก็ต เมื่อเหตุการณ์นี้เกิดขึ้น ระบบจะตั้งค่าซ็อกเก็ตเป็น paused และจะไม่มีเหตุการณ์ onReceive เกิดขึ้นอีกสำหรับซ็อกเก็ตนี้

พารามิเตอร์

  • callback

    ฟังก์ชัน

    พารามิเตอร์ callback จะมีลักษณะดังนี้ 

    (info: ReceiveErrorInfo) => void