chrome.serial

الوصف

يمكنك استخدام واجهة برمجة تطبيقات chrome.serial للقراءة من جهاز متصل بمنفذ تسلسلي والكتابة فيه.

الأذونات

serial

الأنواع

ConnectionInfo

أماكن إقامة

  • bitrate

    الرقم اختياري

    يمكنك الاطّلاع على ConnectionOptions.bitrate. قد يتم حذف هذا الحقل أو عدم دقته في حال استخدام معدل نقل بيانات غير عادي، أو إذا حدث خطأ أثناء إجراء طلب بحث عن الجهاز الأساسي.

  • bufferSize

    الرقم

    عرض ConnectionOptions.bufferSize

  • connectionId

    الرقم

    رقم تعريف اتصال المنفذ التسلسلي

  • ctsFlowControl

    منطقية اختيارية

    يمكنك الاطّلاع على ConnectionOptions.ctsFlowControl. قد يتم حذف هذا الحقل في حال حدوث خطأ أثناء إجراء طلب بحث عن الجهاز الأساسي.

  • dataBits

    DataBits اختيارية

    يمكنك الاطّلاع على ConnectionOptions.dataBits. قد يتم حذف هذا الحقل في حال حدوث خطأ أثناء إجراء طلب بحث عن الجهاز الأساسي.

  • اسم

    سلسلة

    عرض ConnectionOptions.name

  • parityBit

    ParityBit اختيارية

    يمكنك الاطّلاع على ConnectionOptions.parityBit. قد يتم حذف هذا الحقل في حال حدوث خطأ أثناء إجراء طلب بحث عن الجهاز الأساسي.

  • متوقف مؤقتًا

    boolean

    علامة تشير إلى حظر الاتصال من تنشيط أحداث onReceived

  • ثابت

    boolean

    عرض ConnectionOptions.persistent

  • receiveTimeout

    الرقم

    عرض ConnectionOptions.receiveTimeout

  • sendTimeout

    الرقم

    عرض ConnectionOptions.sendTimeout

  • stopBits

    StopBits اختيارية

    يمكنك الاطّلاع على ConnectionOptions.stopBits. قد يتم حذف هذا الحقل في حال حدوث خطأ أثناء إجراء طلب بحث عن الجهاز الأساسي.

ConnectionOptions

أماكن إقامة

  • bitrate

    الرقم اختياري

    معدل نقل البيانات المطلوب للاتصال المراد فتحه. بالنسبة إلى التوافق مع أوسع نطاق من الأجهزة، يجب أن يتطابق هذا الرقم مع أحد معدلات نقل البيانات الشائعة، مثل 110 أو 300 أو 1200 أو 2400 أو 4800 أو 9600 أو 14400 أو 19200 أو 38400 أو 57600 أو 115200. بالطبع، ليس هناك ما يضمن أن الجهاز المتصل بالمنفذ التسلسلي سيتوافق مع معدل نقل البيانات المطلوب، حتى إذا كان المنفذ نفسه يتيح معدل نقل البيانات هذا. سيتم تمرير 9600 تلقائيًا.

  • bufferSize

    الرقم اختياري

    حجم المخزن المؤقت المستخدم لاستقبال البيانات. القيمة التلقائية هي 4096.

  • ctsFlowControl

    منطقية اختيارية

    علامة تشير إلى تفعيل ميزة التحكّم في تدفق أجهزة "المراسلة النصية في الوقت الفعلي (RTS)/CTS" أم لا يكون الإعداد التلقائي بالقيمة "خطأ".

  • dataBits

    DataBits اختيارية

    سيتم تمرير "eight" تلقائيًا.

  • اسم

    سلسلة اختيارية

    سلسلة يحددها التطبيق لربطها بالاتصال.

  • parityBit

    ParityBit اختيارية

    سيتم تمرير "no" تلقائيًا.

  • ثابت

    منطقية اختيارية

    علامة تشير إلى ما إذا كان يجب ترك الاتصال مفتوحًا عند تعليق التطبيق أم لا (راجِع إدارة مراحل نشاط التطبيق). القيمة التلقائية هي "false". عند تحميل التطبيق، يمكن استرجاع أي اتصالات تسلسلية تم فتحها سابقًا باستخدام persistent=true باستخدام getConnections.

  • receiveTimeout

    الرقم اختياري

    الحد الأقصى لمقدار الوقت (بالمللي ثانية) لانتظار البيانات الجديدة قبل رفع حدث onReceiveError مع ظهور خطأ "المهلة" إذا كانت القيمة صفرًا، لن يتم إظهار أخطاء انتهاء المهلة الخاصة بالاتصال. يكون الإعداد التلقائي بالقيمة 0.

  • sendTimeout

    الرقم اختياري

    الحد الأقصى لمقدار الوقت (بالمللي ثانية) المطلوب إكماله حتى تكتمل عملية send قبل عرض رسالة الخطأ "مهلة" لمعاودة الاتصال. وفي حال كانت القيمة صفرًا، لن تظهر أخطاء مهلة الإرسال. يكون الإعداد التلقائي بالقيمة 0.

  • stopBits

    StopBits اختيارية

    سيتم تمرير "one" تلقائيًا.

DataBits

التعداد

DeviceControlSignals

أماكن إقامة

  • cts

    boolean

    CTS (محو الإرسال).

  • DCD

    boolean

    DCD (رصد مشغّل البيانات) أو RLSD (اكتشاف إشارة الخط أو رصده)

  • DSR

    boolean

    DSR (مجموعة البيانات جاهزة).

  • ري

    boolean

    RI (مؤشر الرنين).

DeviceInfo

أماكن إقامة

  • displayName

    سلسلة اختيارية

    اسم عرض يمكن لشخص عادي قراءته للجهاز الأساسي في حال كان من الممكن طلبه من برنامج تشغيل المضيف.

  • المسار

    سلسلة

    مسار نظام الجهاز يجب ضبط هذا الإعداد كوسيطة path إلى chrome.serial.connect للاتصال بهذا الجهاز.

  • productId

    الرقم اختياري

    معرّف منتج USB إذا كان من الممكن تحديد معرّف للجهاز الأساسي.

  • vendorId

    الرقم اختياري

    تمثّل هذه السمة معرّف مورّد منفذ USB أو منفذ USB في حال إمكانية تحديد واحد للجهاز الأساسي.

HostControlSignals

أماكن إقامة

  • dtr

    منطقية اختيارية

    DTR (محطة بيانات جاهزة)

  • RTS

    منطقية اختيارية

    طلب الإرسال (RTS)

ParityBit

التعداد

ReceiveError

التعداد

"تم قطع الاتصال"
تم قطع الاتصال.

"timeout"
لم يتم استلام أي بيانات منذ receiveTimeout ملي ثانية.

"device_lost"
من المرجّح أن يكون الجهاز غير متصل بالمضيف.

"break"
رصد الجهاز حالة تعطُّل.

"frame_error"
رصد الجهاز خطأً في الإطارات.

"تجاوز"
حدث تجاوز المخزن المؤقت للأحرف. يتم فقدان الحرف التالي.

"buffer_overflow"
حدث فائض سعة المخزن المؤقت للإدخال. إما أنه لا يوجد مساحة في المخزن المؤقت للإدخال، أو أنه تم استلام حرف بعد حرف نهاية الملف (EOF).

"parity_error"
رصد الجهاز خطأ تكافؤ.

"system_error"
حدث خطأ في النظام وقد يكون الاتصال غير قابل للاسترداد.

ReceiveErrorInfo

أماكن إقامة

  • connectionId

    الرقم

    مُعرّف الاتصال.

  • خطأ

    ReceiveError

    رمز خطأ يشير إلى الخطأ الذي حدث.

ReceiveInfo

أماكن إقامة

  • connectionId

    الرقم

    مُعرّف الاتصال.

  • البيانات

    ArrayBuffer

    البيانات التي تم استلامها.

SendError

التعداد

"تم قطع الاتصال"
تم قطع الاتصال.

"pending"
سبق أن تم إرسال الطلب.

"timeout"
انتهت مهلة الإرسال.

"system_error"
حدث خطأ في النظام وقد يكون الاتصال غير قابل للاسترداد.

SendInfo

أماكن إقامة

  • bytesSent

    الرقم

    عدد وحدات بايت التي تم إرسالها.

  • خطأ

    SendError اختياري

    رمز خطأ في حال حدوث خطأ.

StopBits

التعداد

"one"

الطُرق

clearBreak()

الوعد Chrome 45 والإصدارات الأحدث 
chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
)

استعادة نقل الأحرف على اتصال معيَّن ووضع خط النقل في حالة غير ثابتة

المَعلمات

  • connectionId

    الرقم

    رقم تعريف الاتصال.

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (result: boolean)=>void

    • نتيجة

      boolean

المرتجعات

  • Promise<boolean>

    Chrome 117 والإصدارات الأحدث

    لا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

connect()

وعد 
chrome.serial.connect(
  path: string,
  options?: ConnectionOptions,
  callback?: function,
)

الاتصال بمنفذ تسلسلي محدّد

المَعلمات

  • المسار

    سلسلة

    مسار النظام للمنفذ التسلسلي المراد فتحه

  • الخيارات

    ConnectionOptions اختيارية

    خيارات ضبط المنفذ

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (connectionInfo: ConnectionInfo)=>void

المرتجعات

  • Promise<ConnectionInfo>

    Chrome 117 والإصدارات الأحدث

    لا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

disconnect()

وعد 
chrome.serial.disconnect(
  connectionId: number,
  callback?: function,
)

يتم قطع الاتصال بمنفذ تسلسلي.

المَعلمات

  • connectionId

    الرقم

    رقم تعريف الاتصال المفتوح.

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (result: boolean)=>void

    • نتيجة

      boolean

المرتجعات

  • Promise<boolean>

    Chrome 117 والإصدارات الأحدث

    لا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

flush()

وعد 
chrome.serial.flush(
  connectionId: number,
  callback?: function,
)

يتم محو كل وحدات البايت في المخازن المؤقتة للمدخل والإخراج للاتصال المعني.

المَعلمات

  • connectionId

    الرقم

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (result: boolean)=>void

    • نتيجة

      boolean

المرتجعات

  • Promise<boolean>

    Chrome 117 والإصدارات الأحدث

    لا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

getConnections()

وعد 
chrome.serial.getConnections(
  callback?: function,
)

يسترد قائمة اتصالات المنافذ التسلسلية المفتوحة حاليًا التي يملكها التطبيق.

المَعلمات

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (connectionInfos: ConnectionInfo[])=>void

المرتجعات

  • Promise<ConnectionInfo[]>

    Chrome 117 والإصدارات الأحدث

    لا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

getControlSignals()

وعد 
chrome.serial.getControlSignals(
  connectionId: number,
  callback?: function,
)

يسترد حالة إشارات التحكم في اتصال معين.

المَعلمات

  • connectionId

    الرقم

    رقم تعريف الاتصال.

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (signals: DeviceControlSignals)=>void

المرتجعات

  • Chrome 117 والإصدارات الأحدث

    لا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

getDevices()

وعد 
chrome.serial.getDevices(
  callback?: function,
)

عرض معلومات عن الأجهزة التسلسلية المتاحة على النظام وتتم إعادة إنشاء القائمة في كل مرة يتم فيها استدعاء هذه الطريقة.

المَعلمات

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (ports: DeviceInfo[])=>void

المرتجعات

  • Promise<DeviceInfo[]>

    Chrome 117 والإصدارات الأحدث

    لا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

getInfo()

وعد 
chrome.serial.getInfo(
  connectionId: number,
  callback?: function,
)

يستعيد حالة اتصال معين.

المَعلمات

  • connectionId

    الرقم

    رقم تعريف الاتصال المفتوح.

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (connectionInfo: ConnectionInfo)=>void

المرتجعات

  • Promise<ConnectionInfo>

    Chrome 117 والإصدارات الأحدث

    لا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

send()

وعد 
chrome.serial.send(
  connectionId: number,
  data: ArrayBuffer,
  callback?: function,
)

يكتب البيانات إلى الاتصال المحدد.

المَعلمات

  • connectionId

    الرقم

    رقم تعريف الاتصال.

  • البيانات

    ArrayBuffer

    البيانات المطلوب إرسالها.

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (sendInfo: SendInfo)=>void

المرتجعات

  • Promise<SendInfo>

    Chrome 117 والإصدارات الأحدث

    لا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

setBreak()

الوعد Chrome 45 والإصدارات الأحدث 
chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
)

يعلّق انتقال الأحرف على اتصال معين ويضع خط النقل في حالة فاصل إلى أن يتم استدعاء clearBreak.

المَعلمات

  • connectionId

    الرقم

    رقم تعريف الاتصال.

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (result: boolean)=>void

    • نتيجة

      boolean

المرتجعات

  • Promise<boolean>

    Chrome 117 والإصدارات الأحدث

    لا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

setControlSignals()

وعد 
chrome.serial.setControlSignals(
  connectionId: number,
  signals: HostControlSignals,
  callback?: function,
)

تحدد حالة إشارات التحكم في اتصال معين.

المَعلمات

  • connectionId

    الرقم

    رقم تعريف الاتصال.

  • إشارات

    HostControlSignals

    تتغير مجموعة الإشارات لإرسالها إلى الجهاز.

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (result: boolean)=>void

    • نتيجة

      boolean

المرتجعات

  • Promise<boolean>

    Chrome 117 والإصدارات الأحدث

    لا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

setPaused()

وعد 
chrome.serial.setPaused(
  connectionId: number,
  paused: boolean,
  callback?: function,
)

إيقاف اتصال مفتوح مؤقتًا أو إلغاء الإيقاف المؤقت

المَعلمات

  • connectionId

    الرقم

    رقم تعريف الاتصال المفتوح.

  • متوقف مؤقتًا

    boolean

    علامة للإشارة إلى ما إذا كنت تريد الإيقاف المؤقت أو إلغاء الإيقاف المؤقت.

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    ()=>void

المرتجعات

  • Promise<void>

    Chrome 117 والإصدارات الأحدث

    لا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

update()

وعد 
chrome.serial.update(
  connectionId: number,
  options: ConnectionOptions,
  callback?: function,
)

يمكنك تعديل إعدادات الخيار عند اتصال منفذ تسلسلي مفتوح.

المَعلمات

  • connectionId

    الرقم

    رقم تعريف الاتصال المفتوح.

  • الخيارات

    ConnectionOptions

    خيارات ضبط المنفذ

  • معاودة الاتصال

    الدالة اختيارية

    تبدو معلَمة callback على النحو التالي: 

    (result: boolean)=>void

    • نتيجة

      boolean

المرتجعات

  • Promise<boolean>

    Chrome 117 والإصدارات الأحدث

    لا تتوفّر الوعود إلا في الإصدار 3 من Manifest V3 والإصدارات الأحدث، وتحتاج الأنظمة الأساسية الأخرى إلى استخدام عمليات معاودة الاتصال.

فعاليات

onReceive

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

تم رفع الحدث عند قراءة بيانات من عملية الربط.

المَعلمات

  • معاودة الاتصال

    الوظيفة

    تبدو معلَمة callback على النحو التالي: 

    (info: ReceiveInfo)=>void

onReceiveError

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

تم رفع الحدث عند حدوث خطأ أثناء انتظار وقت التشغيل للبيانات على المنفذ التسلسلي. بعد زيادة هذا الحدث، يمكن ضبط عملية الربط على "paused". لا يؤدي خطأ "timeout" إلى إيقاف الاتصال مؤقتًا.

المَعلمات

  • معاودة الاتصال

    الوظيفة

    تبدو معلَمة callback على النحو التالي: 

    (info: ReceiveErrorInfo)=>void