chrome.serial

توضیحات

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

مجوزها

serial

در دسترس بودن

فقط سیستم عامل کروم

انواع

ConnectionInfo

خواص

  • bitrate

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

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

  • اندازه بافر

    شماره

    به ConnectionOptions.bufferSize مراجعه کنید

  • شناسه اتصال

    شماره

    شناسه اتصال پورت سریال.

  • کنترل جریان cts

    بولی اختیاری

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

  • بیت‌های داده

    بیت‌های داده اختیاری

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

  • نام

    رشته

    به ConnectionOptions.name مراجعه کنید

  • بیت برابری

    بیت برابری اختیاری

    See ConnectionOptions.parityBit . This field may be omitted if an error occurred while querying the underlying device.

  • مکث کرد

    بولی

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

  • مداوم

    بولی

    به ConnectionOptions.persistent مراجعه کنید

  • دریافت تایم اوت

    شماره

    به ConnectionOptions.receiveTimeout مراجعه کنید

  • ارسال تایم اوت

    شماره

    به ConnectionOptions.sendTimeout مراجعه کنید

  • استاپ‌بیتس

    StopBits optional

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

ConnectionOptions

خواص

  • بیت ریت

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

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

  • اندازه بافر

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

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

  • کنترل جریان cts

    بولی اختیاری

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

  • بیت‌های داده

    بیت‌های داده اختیاری

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

  • نام

    رشته اختیاری

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

  • بیت برابری

    بیت برابری اختیاری

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

  • مداوم

    بولی اختیاری

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

  • دریافت تایم اوت

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

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

  • ارسال تایم اوت

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

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

  • استاپ‌بیتس

    StopBits اختیاری است

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

DataBits

شمارشی

«هفت»

«هشت»

DeviceControlSignals

خواص

  • سی تی اس

    بولی

    CTS (Clear To Send).

  • دی سی دی

    بولی

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

  • دی‌اس‌آر

    بولی

    DSR (آماده برای مجموعه داده).

  • ری

    بولی

    RI (نشانگر حلقه).

DeviceInfo

خواص

  • نام نمایش

    رشته اختیاری

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

  • مسیر

    رشته

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

  • شناسه محصول

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

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

  • شناسه فروشنده

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

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

HostControlSignals

خواص

  • دی تی آر

    بولی اختیاری

    DTR (آماده برای ترمینال داده).

  • rts

    بولی اختیاری

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

ParityBit

شمارشی

«نه»

"عجیب"

«حتی»

ReceiveError

شمارشی

"قطع ارتباط"
ارتباط قطع شد.

"مهلت زمانی"
هیچ داده‌ای برای receiveTimeout به میلی‌ثانیه دریافت نشده است.

"دستگاه_گم_شده"
به احتمال زیاد دستگاه از میزبان جدا شده است.

"شکستن"
The device detected a break condition.

"خطای قاب"
دستگاه خطای فریم‌بندی را تشخیص داد.

"تجاوز کردن"
یک سرریز کاراکتر-بافر رخ داده است. کاراکتر بعدی از دست رفته است.

"سرریز_بافر"
سرریز بافر ورودی رخ داده است. یا در بافر ورودی جایی وجود ندارد، یا یک کاراکتر پس از کاراکتر انتهای فایل (EOF) دریافت شده است.

"خطای برابری"
دستگاه خطای برابری را تشخیص داد.

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

ReceiveErrorInfo

خواص

  • شناسه اتصال

    شماره

    شناسه اتصال.

  • An error code indicating what went wrong.

ReceiveInfo

خواص

  • شناسه اتصال

    شماره

    شناسه اتصال.

  • داده‌ها

    آرایه بافر

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

SendError

شمارشی

"قطع ارتباط"
ارتباط قطع شد.

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

"مهلت زمانی"
مهلت ارسال تمام شد.

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

SendInfo

خواص

  • بایت‌های ارسالی

    شماره

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

  • خطا

    خطای ارسال اختیاری

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

StopBits

شمارشی

«یک»

«دو»

روش‌ها

clearBreak()

Promise Chrome 45+
chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
): Promise<boolean>

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

پارامترها

  • شناسه اتصال

    شماره

    شناسه اتصال.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (result: boolean) => void

    • نتیجه

      بولی

بازگشت‌ها

  • قول <boolean>

    کروم ۱۱۷+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

connect()

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

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

پارامترها

  • مسیر

    رشته

    مسیر سیستمی پورت سریال که باید باز شود.

  • گزینه‌ها

    گزینه‌های اتصال اختیاری

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (connectionInfo: ConnectionInfo) => void

بازگشت‌ها

  • کروم ۱۱۷+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

disconnect()

وعده
chrome.serial.disconnect(
  connectionId: number,
  callback?: function,
): Promise<boolean>

از پورت سریال جدا می‌شود.

پارامترها

  • شناسه اتصال

    شماره

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (result: boolean) => void

    • نتیجه

      boolean

بازگشت‌ها

  • قول <boolean>

    کروم ۱۱۷+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

flush()

وعده
chrome.serial.flush(
  connectionId: number,
  callback?: function,
): Promise<boolean>

Flushes all bytes in the given connection's input and output buffers.

پارامترها

  • شناسه اتصال

    شماره

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (result: boolean) => void

    • نتیجه

      boolean

بازگشت‌ها

  • قول <boolean>

    Chrome 117+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

getConnections()

وعده
chrome.serial.getConnections(
  callback?: function,
): Promise<ConnectionInfo[]>

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

پارامترها

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (connectionInfos: ConnectionInfo[]) => void

بازگشت‌ها

  • کروم ۱۱۷+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

getControlSignals()

وعده
chrome.serial.getControlSignals(
  connectionId: number,
  callback?: function,
): Promise<DeviceControlSignals>

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

پارامترها

بازگشت‌ها

  • کروم ۱۱۷+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

getDevices()

وعده
chrome.serial.getDevices(
  callback?: function,
): Promise<DeviceInfo[]>

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

Parameters

بازگشت‌ها

  • کروم ۱۱۷+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

getInfo()

وعده
chrome.serial.getInfo(
  connectionId: number,
  callback?: function,
): Promise<ConnectionInfo>

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

پارامترها

  • شناسه اتصال

    شماره

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (connectionInfo: ConnectionInfo) => void

بازگشت‌ها

  • کروم ۱۱۷+

    Promises are only supported for Manifest V3 and later, other platforms need to use callbacks.

send()

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

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

پارامترها

  • شناسه اتصال

    شماره

    شناسه اتصال.

  • داده‌ها

    آرایه بافر

    The data to send.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (sendInfo: SendInfo) => void

بازگشت‌ها

  • قول بده< ارسال اطلاعات >

    کروم ۱۱۷+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

setBreak()

قول کروم ۴۵+
chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
): Promise<boolean>

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

پارامترها

  • شناسه اتصال

    شماره

    The id of the connection.

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (result: boolean) => void

    • نتیجه

      بولی

بازگشت‌ها

  • قول <boolean>

    کروم ۱۱۷+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

setControlSignals()

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

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

پارامترها

  • شناسه اتصال

    شماره

    شناسه اتصال.

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

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (result: boolean) => void

    • نتیجه

      بولی

بازگشت‌ها

  • قول <boolean>

    کروم ۱۱۷+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

setPaused()

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

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

پارامترها

  • شناسه اتصال

    شماره

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

  • مکث کرد

    بولی

    پرچمی برای نشان دادن مکث یا لغو مکث.

  • تماس برگشتی

    تابع اختیاری

    The callback parameter looks like: 

    () => void

بازگشت‌ها

  • قول<void>

    کروم ۱۱۷+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

update()

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

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

پارامترها

  • شناسه اتصال

    شماره

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

  • گزینه‌های پیکربندی پورت

  • تماس برگشتی

    تابع اختیاری

    پارامتر callback به شکل زیر است: 

    (result: boolean) => void

    • نتیجه

      بولی

بازگشت‌ها

  • قول <boolean>

    کروم ۱۱۷+

    Promiseها فقط برای Manifest V3 و نسخه‌های بعدی پشتیبانی می‌شوند، سایر پلتفرم‌ها باید از callbackها استفاده کنند.

رویدادها

onReceive

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

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

پارامترها

onReceiveError

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

Event raised when an error occurred while the runtime was waiting for data on the serial port. Once this event is raised, the connection may be set to paused . A "timeout" error does not pause the connection.

پارامترها