BOSE-โลโก้แอป BOSE Work Rest API

แอป BOSE Work Rest API ผลิตภัณฑ์

การแนะนำ

อุปกรณ์ Bose Videobar รองรับอินเทอร์เฟซการเขียนโปรแกรมแอปพลิเคชันการถ่ายโอนสถานะแบบแสดงแทน (REST API) สำหรับการจัดการและการตรวจสอบเครือข่าย คู่มือนี้ให้คำแนะนำในการเปิดใช้งานและกำหนดค่า REST API บนอุปกรณ์ Videobar และให้คำอธิบายโดยละเอียดเกี่ยวกับตัวแปรและการทำงานที่รองรับ
รายการการกำหนดค่าและการดำเนินการจะถูกจัดกลุ่มอยู่ในหมวดหมู่เหล่านี้:

  • ระบบ
  • พฤติกรรม
  • ยูเอสบี
  • เสียง
  • กล้อง
  • การสร้างเฟรมเสียง
  • บลูทูธ
  • เครือข่าย (VBl)
  • ไวไฟ
  • การวัดระยะไกล (VBl)

ส่วนการอ้างอิงคำสั่ง API ให้ข้อมูลต่อไปนี้สำหรับแต่ละอ็อบเจ็กต์:

  • ชื่อ/คำอธิบาย ชื่อของวัตถุและคำอธิบายการใช้งาน
  • การกระทำ การกระทำที่สามารถดำเนินการกับวัตถุได้ การกระทำสามารถ
  • ต้องเป็นอย่างใดอย่างหนึ่งหรือมากกว่าต่อไปนี้: รับ, ใส่, ลบ, โพสต์
  • ช่วงค่า ค่าที่ยอมรับได้สำหรับวัตถุ
  • ค่าเริ่มต้น ค่าเริ่มต้นของวัตถุ นี่คือค่าที่จะใช้หากคุณเปลี่ยนอุปกรณ์เป็นค่าเริ่มต้นจากโรงงาน
    ค่าทั้งหมดระบุเป็นสตริง

ประกาศเกี่ยวกับเครื่องหมายการค้า

  • Bose, Bose Work และ Videobar เป็นเครื่องหมายการค้าของ Bose Corporation
  • เครื่องหมายคำว่า “Bluetooth” และโลโก้เป็นเครื่องหมายการค้าจดทะเบียนของ Bluetooth SIG, Inc. และการใช้เครื่องหมายดังกล่าวโดย Bose Corporation อยู่ภายใต้การอนุญาต
  • คำว่า HDMI เป็นเครื่องหมายการค้าหรือเครื่องหมายการค้าจดทะเบียนของ HDMI Licensing Administrator, Inc.
  • เครื่องหมายการค้าอื่น ๆ ทั้งหมดเป็นทรัพย์สินของเจ้าของที่เกี่ยวข้อง

ข้อมูลความเป็นส่วนตัว

ความเป็นส่วนตัวของคุณมีความสำคัญต่อ Bose ดังนั้นเราจึงได้พัฒนา นโยบายความเป็นส่วนตัว ที่ครอบคลุมถึงวิธีการที่เราเก็บรวบรวม ใช้ เปิดเผย โอน และจัดเก็บข้อมูลส่วนบุคคลของคุณ
โปรดอ่านนโยบายความเป็นส่วนตัวนี้อย่างละเอียดเพื่อทำความเข้าใจว่าเราจัดการกับข้อมูลของคุณอย่างไร หากคุณไม่เห็นด้วยกับนโยบายความเป็นส่วนตัวนี้ โปรดอย่าใช้บริการ

การเปิดใช้งานและการกำหนดค่า REST API

หากต้องการเปิดใช้งานการเข้าถึง REST API บนอุปกรณ์ ให้ใช้แอป Bose Work Configuration แอป Bose Work Management หรือ Web UI เข้าถึงการตั้งค่าเครือข่าย > API เปิดใช้งานการเข้าถึง API และระบุชื่อผู้ใช้และรหัสผ่าน API คุณจะต้องมีข้อมูลรับรอง API เหล่านี้เพื่อใช้คำสั่ง REST API ใดๆ โปรดดูคู่มือผู้ใช้แอปพลิเคชันสำหรับข้อมูลเพิ่มเติม

ทดสอบ REST API

คุณสามารถทดสอบ Videobar REST API ได้โดยใช้ส่วนต่อประสาน Swagger OpenAPI ที่ฝังอยู่ในอุปกรณ์ หากต้องการเข้าถึงส่วนต่อประสานนี้ Videobar จะต้องเชื่อมต่อกับเครือข่าย IP ผ่านส่วนต่อประสานแบบมีสายหรือ WiFi และพีซีโฮสต์ของคุณต้องอยู่ในเครือข่ายเดียวกันหรือเครือข่ายที่สามารถเข้าถึงอุปกรณ์ผ่าน HTTPS ได้
เชื่อมต่อพีซีของคุณกับ Videobar ผ่านอินเทอร์เฟซ USB เปิดแอป Bose Work Configuration และลงชื่อเข้าใช้เพื่อเข้าถึงการควบคุมของผู้ดูแลระบบ เลือกหน้าเครือข่าย > API และคลิกลิงก์:
เอกสารประกอบ REST API (Web UI)
หากคุณไม่ได้เชื่อมต่อกับอุปกรณ์ผ่าน USB และพีซีของคุณอยู่ในเครือข่ายเดียวกัน คุณสามารถเข้าถึง REST API ผ่านเบราว์เซอร์ของคุณได้โดยเรียกดูไปที่อยู่ต่อไปนี้:
https://<videobar-ip-address>/doc-api

คำสั่ง REST API

อินเทอร์เฟซ Videobar REST API ใช้ ID คำสั่งในวิธีการ HTTP สี่วิธีที่รองรับ: รับ, ใส่, ลบ และโพสต์
ด้านล่างนี้เป็นคำอธิบายของวิธีการทั้งสี่วิธี พร้อมด้วยตารางอธิบายวิธีการที่รองรับสำหรับแต่ละคำสั่ง

รับ

วิธี "รับ" ยอมรับ ID คำสั่งเดียวหรือ ID ที่คั่นด้วยจุลภาคหลายตัว ตัวอย่างเช่นample เพื่อรับสถานะ audio.micMute คำสั่ง ID คือ 2 URL เป็นเช่นนี้:
https://192.168.1.40/api?query=2  

เนื้อหาการตอบสนองเป็นดังนี้ โดยมีค่า “O” ระบุว่าไมโครโฟนไม่ได้ถูกปิดเสียง:
{“2”: {“สถานะ”: “สำเร็จ”, “ค่า”: “0”}}

หากต้องการค้นหาค่าหลายค่า ให้คั่น ID คำสั่งหลายรายการด้วยเครื่องหมายจุลภาค ตัวอย่างเช่นampคุณสามารถค้นหา audio.micMute (ID=2) และ system.firmwareVersion (ID=l6) ได้ดังนี้:
https://192.168.1.40/api?query=2,16 

หมายเหตุ: อย่าใส่ช่องว่างระหว่าง ID หลายรายการ
ผลลัพธ์จะเป็น:
{“2”: {“สถานะ”: “สำเร็จ”, “ค่า”: “0”}, “16”: {“สถานะ”: “สำเร็จ”, “ค่า”: “1.2.13_fd6cc0e”}}

ใส่

คำสั่ง “put” จะใช้รูปแบบเนื้อหา JSON โดยที่คีย์จะเป็น “data” และค่าจะเป็นคู่ ID:value
เช่นampเพื่อตั้งค่า audio.loudspeakerVolume (ID=3) เป็น 39 เนื้อหา “https://192.168.1.40/ api” จะเป็นดังนี้:
{“ข้อมูล”:”{“3″:”39″}”}

คำตอบคือ:
{“3”: {“สถานะ”: “สำเร็จ”, “รหัส”: “0xe000”}}

นี่คืออดีตampการตั้งค่าหลายค่า:
{“ข้อมูล”:”{“2″:”1″,”3″:”70″}”}

คำตอบคือ:
{“2”: {“สถานะ”: “สำเร็จ”, “รหัส”: “0xe000”}, “3”: {“สถานะ”: “สำเร็จ”, “รหัส”: “0xe000”}}

ค่า “รหัส” การตอบสนองสามารถเป็นอย่างใดอย่างหนึ่งต่อไปนี้:

  • 0xe000 : สำเร็จ
  • 0xe001 : สำเร็จ – ไม่มีการเปลี่ยนแปลงค่า
  • 0xe002: ข้อผิดพลาด – คุณสมบัติไม่ถูกต้อง
  • 0xe003: ข้อผิดพลาด – ค่าคุณสมบัติไม่ถูกต้อง
  • 0xe004: ข้อผิดพลาด – การดำเนินการเกี่ยวกับทรัพย์สินไม่ถูกต้อง
  • 0xe005: ข้อผิดพลาด – ข้อความมีรูปแบบไม่ถูกต้อง
  • 0xe006: ข้อผิดพลาด – การเข้าถึงถูกปฏิเสธ

โพสต์

“post” คล้ายกับ “put” และใช้สำหรับการดำเนินการ เช่น การเปิด/ปิดเสียงไมโครโฟน และเพิ่ม/ลดระดับเสียงลำโพง คุณระบุ ID คำสั่งและใช้สตริงว่างสำหรับค่า
เช่นampเพื่อเพิ่มระดับเสียงลำโพงหนึ่งติ๊ก ให้ใช้ audio.loudspeakerVolumeUp (ID=4) ด้วยรูปแบบเนื้อหาเช่นนี้:
{“ข้อมูล”:”{“4″:””}”}

เนื้อหาตอบกลับคือ:
{“4”: {“สถานะ”: “สำเร็จ”, “รหัส”: “0xe000”}}
ค่า “รหัส” การตอบสนองที่เป็นไปได้จะเป็นค่าเดียวกับที่ระบุไว้สำหรับคำสั่ง PUT

ลบ

รูปแบบคำสั่ง “delete” จะคล้ายกับ “get” และเนื้อหาการตอบกลับจะคล้ายกับ “put” การใช้ delete จะตั้งค่ากลับเป็นค่าเริ่มต้น
เช่นample เพื่อตั้งค่าระดับเสียงลำโพง (ID=3) ให้เป็นค่าเริ่มต้น URL เป็นเช่นนี้:
https://192.168.1.40/api?delete=3 

เนื้อหาตอบกลับคือ: 
{“3”: {“สถานะ”: “สำเร็จ”, “รหัส”: “0xe000”}}

คุณจะต้องออกคำสั่ง “get” เพื่อดึงค่าใหม่ ซึ่งในกรณีนี้คือ 50 ตัวอย่างเช่นampเลอ:
สั่งการ:
https://192.168.1.40/api?query=3

การตอบสนอง: 
{“3”: {“สถานะ”: “สำเร็จ”, “ค่า”: “50”}}
ค่า “รหัส” การตอบสนองที่เป็นไปได้จะเหมือนกับค่าที่ระบุไว้สำหรับคำสั่ง PUT

เอกสารอ้างอิงคำสั่ง REST API ของ Videobar

ชื่อ/คำอธิบาย การกระทำ คำสั่ง ID ช่วงค่า ค่าเริ่มต้น
ระบบ.รีบูต

รีบูตระบบ

โพสต์ 32 ไม่มีข้อมูล ไม่มีข้อมูล
ระบบ.หมายเลขซีเรียล

หมายเลขซีเรียลของอุปกรณ์

รับ 10 สตริง

(17 ตัวอักษร)

โอ้โห้โห้โห้
เวอร์ชันเฟิร์มแวร์ของระบบ

เวอร์ชันของเฟิร์มแวร์ที่ทำงานบนอุปกรณ์ จะถูกตั้งค่าโดยอัตโนมัติเมื่ออัปเกรดเฟิร์มแวร์ระบบ

รับ 16 สตริง

(1-16 ตัวอักษร)

0.0.0
ระบบ.แบบจำลอง

รุ่นของอุปกรณ์นี้

รับ D6 สตริง

(1-22 ตัวอักษร)

ไม่ได้ตั้งค่า
ระบบ.ชื่อ

ชื่อของอุปกรณ์เพื่อให้สามารถระบุได้เฉพาะ

ได้รับการใส่ลบ 25 สตริง

(1-22 ตัวอักษร)

ไม่ได้ตั้งค่า
ระบบห้อง

ตำแหน่งห้องของอุปกรณ์

ได้รับการใส่ลบ 26 สตริง

(0-128 ตัวอักษร)

ไม่ได้ตั้งค่า
ระบบพื้น

ตำแหน่งที่ตั้งของอุปกรณ์

ได้รับการใส่ลบ 27 สตริง

(0-128 ตัวอักษร)

ไม่ได้ตั้งค่า
ระบบการสร้าง

ตำแหน่งที่ตั้งอาคารของอุปกรณ์

ได้รับการใส่ลบ 28 สตริง

(0-128 ตัวอักษร)

ไม่ได้ตั้งค่า
ระบบ.gpiสถานะใบ้ (วีบีแอล)

สถานะปิดเสียง GPI (เปิด/ปิด)

รับ C7 110 (รองรับใน VBl) 0
ระบบ.การครอบครองสูงสุด

จำนวนผู้ใช้งานสูงสุดของห้องต่อเครื่อง

ได้รับการใส่ลบ DF สตริง

(0-128 ตัวอักษร)

ไม่ได้ตั้งค่า
พฤติกรรม. ethernetEnabled (VBl)

เปิด/ปิดอินเทอร์เฟซอีเทอร์เน็ตของระบบ

ได้รับการใส่ลบ 38 110 (รองรับใน VBl) 1
พฤติกรรมเปิดใช้งานบลูทูธ

เปิด/ปิดระบบบลูทูธ

ได้รับการใส่ลบ 3A 110 1
พฤติกรรมเปิดใช้งาน wifi

เปิด/ปิดระบบ WiFi

ได้รับการใส่ลบ 3B 110 1
พฤติกรรม.hdmiEnabled (VBl)

เปิด/ปิด HDMI

ได้รับการใส่ลบ C9 110 (รองรับใน VBl) 0
สถานะการเชื่อมต่อ usb

สถานะการเชื่อมต่อสาย USB; 0 เมื่อตัดการเชื่อมต่อ

รับ 36 110 0
สถานะการโทรผ่าน usb

สถานะการโทรจากโฮสต์ที่เชื่อมต่อกับพอร์ต USB ของระบบ

รับ 37 110 0
เสียง.ไมค์ปิดเสียง

ปิดเสียง/เปิดเสียงไมโครโฟนของระบบ

ได้รับการใส่ 2 110 0
เสียง.ไมค์ ปิดเสียง สลับ

สลับสถานะปิดเสียงของไมโครโฟนของระบบ

โพสต์ 15 ไม่มีข้อมูล ไม่มีข้อมูล
ชื่อ/คำอธิบาย การกระทำ คำสั่ง ID ช่วงค่า ค่าเริ่มต้น
เสียง.ลำโพงปิดเสียง

ปิด/เปิดเสียงลำโพงของระบบ

โพสต์ 34 ไม่มีข้อมูล ไม่มีข้อมูล
เสียง.ลำโพงปิดเสียงสลับ

สลับสถานะปิดเสียงของลำโพงระบบ

โพสต์ 34 ไม่มีข้อมูล ไม่มีข้อมูล
เสียง.ลำโพงระดับเสียง

ตั้งค่าระดับเสียงลำโพงของระบบ

ได้รับการใส่ลบ 3 0-100 50
เสียง.ลำโพงเพิ่มระดับเสียง

เพิ่มระดับเสียงลำโพงระบบหนึ่งขั้น

โพสต์ 4 ไม่มีข้อมูล ไม่มีข้อมูล
เสียง.ลำโพงลดระดับเสียง

ลดระดับเสียงลำโพงระบบลงหนึ่งขั้น

โพสต์ 5 ไม่มีข้อมูล ไม่มีข้อมูล
กล้องซูม

ค่าการซูมของกล้องในปัจจุบัน

ได้รับการใส่ลบ 6 1-10 1
กล้องแพน

ค่าการแพนกล้องปัจจุบัน

ได้รับการใส่ลบ 7 -10-10 0
กล้องเอียง

ค่าการเอียงของกล้องในปัจจุบัน

ได้รับการใส่ลบ 8 -10-10 0
กล้องซูมเข้า

ซูมกล้องเข้าหนึ่งขั้น

โพสต์ 9 ไม่มีข้อมูล ไม่มีข้อมูล
กล้อง.ซูมออก

ซูมกล้องออกหนึ่งขั้น

โพสต์ OA ไม่มีข้อมูล ไม่มีข้อมูล
กล้องแพน ซ้าย

แพนกล้องไปทางซ้ายหนึ่งก้าว

โพสต์ OB ไม่มีข้อมูล ไม่มีข้อมูล
กล้องแพน ขวา

แพนกล้องไปทางขวาหนึ่งก้าว

โพสต์ oc ไม่มีข้อมูล ไม่มีข้อมูล
กล้องเอียงขึ้น

เอียงกล้องขึ้นหนึ่งขั้น

โพสต์ OD ไม่มีข้อมูล ไม่มีข้อมูล
กล้องเอียงลง

เอียงกล้องลงหนึ่งขั้น

โพสต์ OE ไม่มีข้อมูล ไม่มีข้อมูล
กล้อง.บ้านพรีเซ็ต

การตั้งค่ากล้องหน้าแรกตามลำดับการแพนเอียงซูม

ได้รับการใส่ลบ 56

0 01
กล้อง.พรีเซ็ตแรก

กล้องจะถูกตั้งค่าไว้ล่วงหน้าเป็นลำดับการแพนเอียงและซูม

ได้รับการใส่ลบ 57

0 01
กล้อง.วินาทีที่ตั้งไว้ล่วงหน้า

ตั้งค่ากล้องวินาทีไว้ล่วงหน้าในการแพนเอียงและซูม

ได้รับการใส่ลบ 58

0 01
กล้อง.บันทึกPresetHome

บันทึกค่า PTZ ปัจจุบันที่ตั้งไว้ล่วงหน้าลงในหน้าหลัก

โพสต์ 12 ไม่มีข้อมูล ไม่มีข้อมูล
กล้อง.บันทึกPresetFirst

บันทึกค่า PTZ ปัจจุบันลงในค่าที่ตั้งไว้ล่วงหน้าแรก

โพสต์ 17 ไม่มีข้อมูล ไม่มีข้อมูล
กล้อง.บันทึกค่าที่ตั้งล่วงหน้าวินาที

บันทึกค่า PTZ ปัจจุบันลงในค่าที่ตั้งไว้ล่วงหน้าครั้งที่สอง

โพสต์ 18 ไม่มีข้อมูล ไม่มีข้อมูล
ชื่อ/คำอธิบาย การกระทำ คำสั่ง ID ช่วงค่า ค่าเริ่มต้น
กล้อง.ใช้ แอ็คทีฟพรีเซต

ใช้การตั้งค่าล่วงหน้าที่ใช้งานอยู่กับการตั้งค่า PTZ

โพสต์ OF ไม่มีข้อมูล ไม่มีข้อมูล
กล้องใช้งานอยู่ พรีเซ็ต

นี่คือการตั้งค่าล่วงหน้าที่ใช้งานอยู่ โปรดทราบว่าเมื่อกล้องเริ่มทำงานหรือรีสตาร์ท การตั้งค่าล่วงหน้าที่ใช้งานอยู่จะถูกตั้งค่าเป็นหน้าแรก

ได้รับการใส่ลบ 13 11213 1
สถานะกล้อง

สถานะกล้อง เมื่อใช้งาน กล้องจะสตรีมวิดีโอ เมื่อไม่ได้ใช้งาน กล้องจะไม่สตรีม เมื่ออัปเกรด กล้องจะอัปเกรดเฟิร์มแวร์

รับ 60 กำลังใช้งานอยู่ฉันกำลังไม่ใช้งานฉันกำลังอัปเกรด ไม่ทำงาน
สถานะการจัดเฟรมอัตโนมัติ

เปิด/ปิดคุณสมบัติการจัดเฟรมอัตโนมัติของกล้อง

ได้รับการใส่ลบ 19 110 0
สถานะการจับคู่บลูทูธ

สลับสถานะการจับคู่จากเปิด/ปิดเป็นปิด/เปิด

โพสต์ C6 ไม่มีข้อมูล ไม่มีข้อมูล
สถานะการจับคู่บลูทูธ

สถานะการจับคู่บลูทูธ สถานะเปิดจะอนุญาตให้จับคู่กับอุปกรณ์ได้ในระยะเวลาที่กำหนด เมื่อช่วงเวลาการจับคู่สิ้นสุดลง สถานะจะเปลี่ยนเป็นปิด

ได้รับการใส่ 14 110 0
สถานะบลูทูธ

สถานะ Bluetooth และ BLE สถานะเปิดจะระบุว่า Bluetooth และ BLE เปิดอยู่ สถานะปิดจะระบุว่า Bluetooth และ BLE ปิดอยู่

รับ 67 110 0
บลูทูธจับคู่

ชื่ออุปกรณ์ที่จับคู่

รับ 6A สตริง

(0-128 ตัวอักษร)

ไม่ได้ตั้งค่า
บลูทูธเชื่อมต่อ

สถานะการเชื่อมต่ออุปกรณ์ที่จับคู่

รับ 6B 110 0
สถานะสตรีมบลูทูธ

สถานะการสตรีมของบลูทูธ

รับ C2 110 0
สถานะการโทรบลูทูธ

สถานะการโทรบลูทูธ

รับ 6C 110 0
บลูทูธ.ตัดการเชื่อมต่อ

ตัดการเชื่อมต่ออุปกรณ์บลูทูธ

โพสต์ E4 11213 ไม่มีข้อมูล
เครือข่าย.dhcpState

สถานะ DHCP เมื่อสถานะ DHCP เปิดอยู่ เครือข่ายจะถูกกำหนดค่าผ่าน DHCP เมื่อสถานะ DHCP ปิดอยู่ ค่าคงที่จะถูกใช้

ได้รับการใส่ลบ 74 110 1
เครือข่าย.ip (VBl)

ที่อยู่ IP แบบคงที่เมื่อสถานะ DHCP ปิดอยู่

ได้รับการใส่ลบ 75   (รองรับใน VBl) 0.0.0.0
สถานะเครือข่าย (VBl)

สถานะของโมดูลอีเธอร์เน็ต

รับ 7F ความล้มเหลวของการทำงาน!

การกำหนดค่าการเชื่อมโยงฉันพร้อมแล้ว

ตัดการเชื่อมต่อ! ออนไลน์

(รองรับใน VBl) พร้อมใช้งาน
ชื่อ/คำอธิบาย การกระทำ คำสั่ง ID ช่วงค่า ค่าเริ่มต้น
เครือข่าย.แมค (วีบีแอล)

ที่อยู่ MAC ของอินเทอร์เฟซ LAN

รับ 80   (รองรับใน VBl) 00:00:00:00:00:00
สถานะ wifi.dhcp

สถานะ DHCP เมื่อสถานะ DHCP เปิดอยู่ WiFi จะถูกกำหนดค่าผ่าน DHCP เมื่อสถานะ DHCP ปิดอยู่ ค่าคงที่จะถูกใช้

ได้รับการใส่ลบ Al 110 1
ไวไฟ.ไอพี

ที่อยู่ IP แบบคงที่เมื่อสถานะ DHCP ปิดอยู่

ได้รับการใส่ลบ A2   0.0.0.0
ไวไฟ.แมค

ที่อยู่ MAC ของอินเทอร์เฟซ WiFi

รับ AC   00:00:00:00:00:00
รัฐไวไฟ

สถานะของโมดูล WiFi

รับ BO ความล้มเหลวของการทำงาน!

การกำหนดค่าการเชื่อมโยงฉันพร้อมแล้ว

ตัดการเชื่อมต่อ! ออนไลน์

ว่างงาน
การตรวจวัดระยะไกล จำนวนคน (วีบีแอล)

จำนวนคนที่นับโดยอัลกอริธึมการจัดเฟรมอัตโนมัติของกล้อง

ได้รับการใส่ลบ DA 0-99 (รองรับใน VBl) 0
การตรวจวัดระยะไกล ผู้คน ปัจจุบัน (วีบีแอล)

เป็นจริงเมื่อมีการตรวจจับบุคคลใด ๆ โดยอัลกอริธึมการจัดเฟรมอัตโนมัติของกล้อง

ได้รับการใส่ลบ DC 110 (รองรับใน VBl) 0

เอกสาร / แหล่งข้อมูล

แอป BOSE Work Rest API [พีดีเอฟ] คู่มือการใช้งาน
การทำงาน, Rest API, แอป, แอป Work Rest API

อ้างอิง

ฝากความคิดเห็น

ที่อยู่อีเมลของคุณจะไม่ถูกเผยแพร่ ช่องที่ต้องกรอกข้อมูลมีเครื่องหมาย *