chrome.serial

شرح

از chrome.serial API برای خواندن و نوشتن در دستگاه متصل به درگاه سریالی استفاده کنید.

اجازه‌ها

serial

دردسترس بودن

فقط ChromeOS

انواع

ConnectionInfo

مشخصات

  • نرخ بیت

    شماره اختیاری

    ConnectionOptions.bitrate را ببینید. اگر از نرخ بیت غیراستاندارد استفاده شود یا اگر هنگام پرسمان از دستگاه اصلی خطایی رخ دهد، ممکن است این فیلد حذف شود یا نادرست باشد.

  • bufferSize

    شماره

    مشاهده ConnectionOptions.bufferSize

  • connectionId

    شماره

    شناسه اتصال درگاه سریال.

  • ctsFlowControl

    بولی اختیاری

    ConnectionOptions.ctsFlowControl را ببینید. اگر هنگام پرسمان دستگاه اصلی خطایی رخ دهد، ممکن است این فیلد حذف شود.

  • dataBits

    DataBits اختیاری

    ConnectionOptions.dataBits را ببینید. اگر هنگام پرسمان دستگاه اصلی خطایی رخ دهد، ممکن است این فیلد حذف شود.

  • نام

    رشته

    مشاهده ConnectionOptions.name

  • parityBit

    ParityBit اختیاری

    ConnectionOptions.parityBit را ببینید. اگر هنگام پرسمان دستگاه اصلی خطایی رخ دهد، ممکن است این فیلد حذف شود.

  • موقتاً متوقف‌شده

    بولی

    پرچمی که نشان می‌دهد آیا اتصال از راه‌اندازی رویدادهای onReceive مسدود شده است یا نه.

  • دائمی

    بولی

    مشاهده ConnectionOptions.persistent

  • receiveTimeout

    شماره

    مشاهده ConnectionOptions.receiveTimeout

  • sendTimeout

    شماره

    مشاهده ConnectionOptions.sendTimeout

  • stopBits

    StopBits اختیاری

    ConnectionOptions.stopBits را ببینید. اگر هنگام پرسمان دستگاه اصلی خطایی رخ دهد، ممکن است این فیلد حذف شود.

ConnectionOptions

مشخصات

  • نرخ بیت

    شماره اختیاری

    نرخ بیت درخواستی اتصال برای باز شدن. برای سازگاری با گسترده‌ترین طیف سخت‌افزار، این عدد باید با یکی از نرخ‌های بیت رایج مطابقت داشته باشد، مانند ۱۱۰، ۳۰۰، ۱۲۰۰، ۲۴۰۰، ۴۸۰۰، ۹۶۰۰، ۱۴۴۰۰، ۱۹۲۰۰، ۳۸۴۰۰، ۵۷۶۰۰، ۱۱۵۲۰۰. البته هیچ تضمینی وجود ندارد که دستگاه متصل به درگاه سریال از نرخ بیت درخواستی پشتیبانی کند، حتی اگر خود درگاه از آن نرخ بیت پشتیبانی کند. 9600 به‌طور پیش‌فرض رد خواهد شد.

  • bufferSize

    شماره اختیاری

    اندازه میان‌گیری که برای دریافت داده استفاده می‌شود. مقدار پیش‌فرض ۴۰۹۶ است.

  • ctsFlowControl

    بولی اختیاری

    پرچمی که نشان می‌دهد آیا کنترل جریان سخت‌افزاری RTS/CTS فعال شود یا نه. پیش‌فرض: نادرست.

  • dataBits

    DataBits اختیاری

    "eight" به‌طور پیش‌فرض رد خواهد شد.

  • نام

    رشته اختیاری

    رشته‌ای تعریف‌شده توسط برنامه برای مرتبط کردن با اتصال.

  • parityBit

    ParityBit اختیاری

    "no" به‌طور پیش‌فرض رد خواهد شد.

  • دائمی

    بولی اختیاری

    پرچمی که نشان می‌دهد وقتی برنامه تعلیق می‌شود، اتصال باید باز بماند یا نه (به مدیریت چرخه حیات برنامه مراجعه کنید). مقدار پیش‌فرض «نادرست» است. وقتی برنامه بار می‌شود، هر اتصال سریالی که قبلاً با persistent=true باز شده است می‌تواند با getConnections واکشی شود.

  • receiveTimeout

    شماره اختیاری

    حداکثر زمان (به میلی‌ثانیه) برای انتظار برای داده‌های جدید قبل‌از ایجاد رویداد onReceiveError با خطای «مهلت تمام شد». اگر صفر باشد، خطاهای پایان مهلت دریافت برای اتصال مطرح نخواهد شد. پیش‌فرض ۰ است.

  • sendTimeout

    شماره اختیاری

    حداکثر زمان (به میلی‌ثانیه) برای انتظار جهت تکمیل عملیات send قبل‌از فراخوانی تماس برگشتی با خطای «مهلت تمام شد». اگر صفر باشد، خطاهای پایان مهلت ارسال راه‌اندازی نخواهد شد. پیش‌فرض ۰ است.

  • stopBits

    StopBits اختیاری

    "one" به‌طور پیش‌فرض رد خواهد شد.

DataBits

شمارشی

«seven»

«eight»

DeviceControlSignals

مشخصات

  • عدد

    بولی

    CTS (آماده برای ارسال).

  • dcd

    بولی

    DCD (تشخیص حامل داده) یا RLSD (تشخیص/ سیگنال خط دریافت).

  • dsr

    بولی

    DSR (مجموعه داده آماده است).

  • ri

    بولی

    RI (نشانگر زنگ).

DeviceInfo

مشخصات

  • displayName

    رشته اختیاری

    نام نمایشی قابل‌خواندن برای انسان برای دستگاه اصلی، اگر بتوان آن را از درایور میزبان درخواست کرد.

  • مسیر

    رشته

    مسیر سیستم دستگاه. این باید به‌عنوان آرگومان path به chrome.serial.connect ارسال شود تا به این دستگاه متصل شود.

  • productId

    شماره اختیاری

    شناسه محصول USB، اگر بتوان آن را برای دستگاه اصلی تعیین کرد.

  • vendorId

    شماره اختیاری

    شناسه فروشنده PCI یا USB، اگر بتوان آن را برای دستگاه اصلی تعیین کرد.

HostControlSignals

مشخصات

  • dtr

    بولی اختیاری

    DTR (پایانه داده آماده است).

  • rts

    بولی اختیاری

    RTS (درخواست ارسال).

ParityBit

شمارشی

«نه»

«odd»

«even»

ReceiveError

شمارشی

«قطع شد»
اتصال قطع شد.

«timeout»
هیچ داده‌ای برای receiveTimeout میلی‌ثانیه دریافت نشده است.

«device_lost»
احتمالاً اتصال دستگاه از میزبان قطع شده است.

«break»
دستگاه شرایط وقفه را شناسایی کرد.

"frame_error"
دستگاه خطای قاب‌بندی شناسایی کرد.

«سرریز»
سرریز میان‌گیر نویسه رخ داده است. نویسه بعدی گم شده است.

«buffer_overflow»
سرریز میان‌گیر ورودی رخ داده است. یا فضایی در میان‌گیر ورودی وجود ندارد یا نویسه‌ای پس‌از نویسه پایان فایل (EOF) دریافت شده است.

«parity_error»
دستگاه خطای توازن تشخیص داد.

«system_error»
خطای سیستم رخ داد و ممکن است اتصال قابل‌بازیابی نباشد.

ReceiveErrorInfo

مشخصات

  • connectionId

    شماره

    شناسه اتصال.

  • خطا

    ReceiveError

    کد خطایی که نشان می‌دهد مشکل چیست.

ReceiveInfo

مشخصات

  • connectionId

    شماره

    شناسه اتصال.

  • داده

    ArrayBuffer

    داده‌ها دریافت شد.

SendError

شمارشی

«قطع شد»
اتصال قطع شد.

«درحال انتظار»
ارسال ازقبل درحال انتظار بود.

"timeout"
زمان ارسال به‌پایان رسید.

«system_error»
خطای سیستم رخ داد و ممکن است اتصال قابل‌بازیابی نباشد.

SendInfo

مشخصات

  • bytesSent

    شماره

    تعداد بایت‌های ارسال‌شده.

  • خطا

    SendError اختیاری

    کد خطا درصورت بروز خطا.

StopBits

شمارشی

«یک»

«two»

روش‌ها

clearBreak()

Promise Chrome نسخه ۴۵ و بالاتر 
chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
): Promise<boolean>

انتقال نویسه را در اتصال داده‌شده بازیابی می‌کند و خط انتقال را در حالت بدون وقفه قرار می‌دهد.

پارامترها

  • connectionId

    شماره

    شناسه اتصال.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: boolean) => void

    • نتیجه

      بولی

بازگشتی‌ها

  • Promise<boolean>

    Chrome نسخه ۱۱۷ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

connect()

قول 
chrome.serial.connect(
  path: string,
  options?: ConnectionOptions,
  callback?: function,
): Promise<ConnectionInfo>

به درگاه سریال داده‌شده متصل می‌شود.

پارامترها

  • مسیر

    رشته

    مسیر سیستم درگاه سریال برای باز کردن.

  • گزینه‌ها

    ConnectionOptions اختیاری

    گزینه‌های پیکربندی درگاه.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (connectionInfo: ConnectionInfo) => void

بازگشتی‌ها

  • Promise<ConnectionInfo>

    Chrome نسخه ۱۱۷ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

disconnect()

قول 
chrome.serial.disconnect(
  connectionId: number,
  callback?: function,
): Promise<boolean>

اتصال را از درگاه سریال قطع می‌کند.

پارامترها

  • connectionId

    شماره

    شناسه اتصال بازشده.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: boolean) => void

    • نتیجه

      بولی

بازگشتی‌ها

  • Promise<boolean>

    Chrome نسخه ۱۱۷ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

flush()

قول 
chrome.serial.flush(
  connectionId: number,
  callback?: function,
): Promise<boolean>

همه بایت‌ها را در میانگیرهای ورودی و خروجی اتصال داده‌شده پاک می‌کند.

پارامترها

  • connectionId

    شماره

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: boolean) => void

    • نتیجه

      بولی

بازگشتی‌ها

  • Promise<boolean>

    Chrome نسخه ۱۱۷ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getConnections()

قول 
chrome.serial.getConnections(
  callback?: function,
): Promise<ConnectionInfo[]>

فهرست اتصالات درگاه سری بازشده کنونی را که متعلق به برنامه است بازیابی می‌کند.

پارامترها

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (connectionInfos: ConnectionInfo[]) => void

بازگشتی‌ها

  • Promise<ConnectionInfo[]>

    Chrome نسخه ۱۱۷ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getControlSignals()

قول 
chrome.serial.getControlSignals(
  connectionId: number,
  callback?: function,
): Promise<DeviceControlSignals>

وضعیت سیگنال‌های کنترل را در اتصال مشخص‌شده بازیابی می‌کند.

پارامترها

  • connectionId

    شماره

    شناسه اتصال.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (signals: DeviceControlSignals) => void

بازگشتی‌ها

  • Chrome نسخه ۱۱۷ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getDevices()

قول 
chrome.serial.getDevices(
  callback?: function,
): Promise<DeviceInfo[]>

اطلاعات مربوط به دستگاه‌های سریال موجود در سیستم را برمی‌گرداند. هربار که این روش فراخوانده می‌شود، فهرست دوباره تولید می‌شود.

پارامترها

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (ports: DeviceInfo[]) => void

بازگشتی‌ها

  • Promise<DeviceInfo[]>

    Chrome نسخه ۱۱۷ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

getInfo()

قول 
chrome.serial.getInfo(
  connectionId: number,
  callback?: function,
): Promise<ConnectionInfo>

وضعیت اتصال داده‌شده را بازیابی می‌کند.

پارامترها

  • connectionId

    شماره

    شناسه اتصال بازشده.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (connectionInfo: ConnectionInfo) => void

بازگشتی‌ها

  • Promise<ConnectionInfo>

    Chrome نسخه ۱۱۷ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

send()

قول 
chrome.serial.send(
  connectionId: number,
  data: ArrayBuffer,
  callback?: function,
): Promise<SendInfo>

داده‌ها را در اتصال ارائه‌شده می‌نویسد.

پارامترها

  • connectionId

    شماره

    شناسه اتصال.

  • داده

    ArrayBuffer

    داده‌هایی که باید ارسال شود.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (sendInfo: SendInfo) => void

بازگشتی‌ها

  • Promise<SendInfo>

    Chrome نسخه ۱۱۷ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

setBreak()

Promise Chrome نسخه ۴۵ و بالاتر 
chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
): Promise<boolean>

انتقال نویسه را در اتصال داده‌شده تعلیق می‌کند و خط انتقال را در حالت وقفه قرار می‌دهد تا زمانی که clearBreak فراخوانی شود.

پارامترها

  • connectionId

    شماره

    شناسه اتصال.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: boolean) => void

    • نتیجه

      بولی

بازگشتی‌ها

  • Promise<boolean>

    Chrome نسخه ۱۱۷ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

setControlSignals()

قول 
chrome.serial.setControlSignals(
  connectionId: number,
  signals: HostControlSignals,
  callback?: function,
): Promise<boolean>

وضعیت سیگنال‌های کنترل را در اتصال داده‌شده تنظیم می‌کند.

پارامترها

  • connectionId

    شماره

    شناسه اتصال.

  • نشان‌ها

    HostControlSignals

    مجموعه تغییرات سیگنال برای ارسال به دستگاه.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: boolean) => void

    • نتیجه

      بولی

بازگشتی‌ها

  • Promise<boolean>

    Chrome نسخه ۱۱۷ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

setPaused()

قول 
chrome.serial.setPaused(
  connectionId: number,
  paused: boolean,
  callback?: function,
): Promise<void>

اتصال باز را موقتاً متوقف یا از توقف موقت خارج می‌کند.

پارامترها

  • connectionId

    شماره

    شناسه اتصال بازشده.

  • موقتاً متوقف‌شده

    بولی

    پرچم نشان‌دهنده اینکه آیا باید موقتاً متوقف شود یا از توقف موقت خارج شود.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    () => void

بازگشتی‌ها

  • Promise<void>

    Chrome نسخه ۱۱۷ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

update()

قول 
chrome.serial.update(
  connectionId: number,
  options: ConnectionOptions,
  callback?: function,
): Promise<boolean>

تنظیمات گزینه را در اتصال درگاه سریال باز به‌روز کنید.

پارامترها

  • connectionId

    شماره

    شناسه اتصال بازشده.

  • گزینه‌ها

    ConnectionOptions

    گزینه‌های پیکربندی درگاه.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به‌صورت زیر است: 

    (result: boolean) => void

    • نتیجه

      بولی

بازگشتی‌ها

  • Promise<boolean>

    Chrome نسخه ۱۱۷ و بالاتر

    ‫Promises فقط برای «مانیفست نسخه ۳» و نسخه‌های جدیدتر پشتیبانی می‌شود، پلاتفرم‌های دیگر باید از callbacks استفاده کنند.

رویدادها

onReceive

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

رویداد زمانی ایجاد می‌شود که داده‌ها از اتصال خوانده شده باشند.

پارامترها

  • تماس برگشتی

    عملکرد

    پارامتر callback به‌صورت زیر است: 

    (info: ReceiveInfo) => void

onReceiveError

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

رویداد زمانی ایجاد می‌شود که خطایی رخ دهد درحالی‌که زمان اجرا منتظر داده در درگاه سریال است. وقتی این رویداد مطرح شد، اتصال ممکن است روی paused تنظیم شود. خطای "timeout" اتصال را موقتاً متوقف نمی‌کند.

پارامترها