chrome.serial

توضیحات

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

مجوزها

serial

انواع

ConnectionInfo

خواص

  • میزان بیت

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

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

  • bufferSize

    شماره

    ConnectionOptions.bufferSize را ببینید

  • شناسه اتصال

    شماره

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

  • ctsFlowControl

    بولی اختیاری

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

  • داده بیت ها

    DataBits اختیاری است

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

  • نام

    رشته

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

  • parityBit

    ParityBit اختیاری است

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

  • مکث کرد

    بولی

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

  • مداوم

    بولی

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

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

    شماره

    ConnectionOptions.receiveTimeout را ببینید

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

    شماره

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

  • stopBits

    StopBits اختیاری است

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

ConnectionOptions

خواص

  • میزان بیت

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

    نرخ بیت درخواستی اتصال برای باز شدن. برای سازگاری با وسیع‌ترین طیف سخت‌افزار، این عدد باید با یکی از نرخ بیت‌های رایج در دسترس، مانند 110، 300، 1200، 2400، 4800، 9600، 14400، 19200، 38400، 57600، 57600، 115 مطابقت داشته باشد. پورت از بیت ریت درخواستی پشتیبانی می کند، حتی اگر خود پورت آن بیت ریت را پشتیبانی کند. 9600 به صورت پیش فرض ارسال می شود.

  • bufferSize

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

    اندازه بافری که برای دریافت داده ها استفاده می شود. مقدار پیش فرض 4096 است.

  • ctsFlowControl

    بولی اختیاری

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

  • داده بیت ها

    DataBits اختیاری است

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

  • نام

    رشته اختیاری

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

  • parityBit

    ParityBit اختیاری است

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

  • مداوم

    بولی اختیاری

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

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

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

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

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

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

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

  • stopBits

    StopBits اختیاری است

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

DataBits

Enum

"هفت"

"هشت"

DeviceControlSignals

خواص

  • cts

    بولی

    CTS (پاک کردن برای ارسال).

  • دی سی دی

    بولی

    DCD (Data Carrier Detect) یا RLSD (Receive Line Signal/ Detect).

  • dsr

    بولی

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

  • ری

    بولی

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

DeviceInfo

خواص

  • نمایش نام

    رشته اختیاری

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

  • مسیر

    رشته

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

  • شناسه محصول

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

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

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

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

    شناسه فروشنده PCI یا USB اگر بتوان برای دستگاه زیربنایی تعیین کرد.

HostControlSignals

خواص

  • dtr

    بولی اختیاری

    DTR (Data Terminal Ready).

  • rts

    بولی اختیاری

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

ParityBit

Enum

"نه"

"عجیب"

"حتی"

ReceiveError

Enum

"قطع"
اتصال قطع شد.

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

"دستگاه_از دست رفته"
به احتمال زیاد ارتباط دستگاه با میزبان قطع شده است.

"شکستن"
دستگاه یک وضعیت شکست را تشخیص داد.

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

"غلو"
یک سرریز کاراکتر بافر رخ داده است. شخصیت بعدی گم شده است.

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

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

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

ReceiveErrorInfo

خواص

  • شناسه اتصال

    شماره

    شناسه اتصال

  • خطا

    ReceiveError

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

ReceiveInfo

خواص

  • شناسه اتصال

    شماره

    شناسه اتصال

  • داده ها

    ArrayBuffer

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

SendError

Enum

"قطع"
اتصال قطع شد.

"در انتظار"
ارسال از قبل در انتظار بود.

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

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

SendInfo

خواص

  • bytesSent

    شماره

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

  • خطا

    SendError اختیاری است

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

StopBits

Enum

"یک"

"دو"

روش ها

clearBreak()

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

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

پارامترها

  • شناسه اتصال

    شماره

    شناسه اتصال

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (result: boolean) => void

    • نتیجه

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 117+

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

connect()

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

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

پارامترها

  • مسیر

    رشته

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

  • گزینه ها

    ConnectionOptions اختیاری است

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (connectionInfo: ConnectionInfo) => void

برمی گرداند

  • Promise< ConnectionInfo >

    Chrome 117+

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

disconnect()

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

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

پارامترها

  • شناسه اتصال

    شماره

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (result: boolean) => void

    • نتیجه

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 117+

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

flush()

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

تمام بایت ها را در بافرهای ورودی و خروجی اتصال داده شده شستشو می دهد.

پارامترها

  • شناسه اتصال

    شماره

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (result: boolean) => void

    • نتیجه

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 117+

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

getConnections()

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

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

پارامترها

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (connectionInfos: ConnectionInfo[]) => void

برمی گرداند

  • Promise< ConnectionInfo []>

    Chrome 117+

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

getControlSignals()

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

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

پارامترها

  • شناسه اتصال

    شماره

    شناسه اتصال

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (signals: DeviceControlSignals) => void

برمی گرداند

  • Chrome 117+

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

getDevices()

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

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

پارامترها

برمی گرداند

  • Promise< DeviceInfo []>

    Chrome 117+

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

getInfo()

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

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

پارامترها

  • شناسه اتصال

    شماره

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (connectionInfo: ConnectionInfo) => void

برمی گرداند

  • Promise< ConnectionInfo >

    Chrome 117+

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

send()

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

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

پارامترها

  • شناسه اتصال

    شماره

    شناسه اتصال

  • داده ها

    ArrayBuffer

    داده های ارسالی

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (sendInfo: SendInfo) => void

برمی گرداند

  • وعده< SendInfo >

    Chrome 117+

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

setBreak()

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

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

پارامترها

  • شناسه اتصال

    شماره

    شناسه اتصال

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (result: boolean) => void

    • نتیجه

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 117+

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

setControlSignals()

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

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

پارامترها

  • شناسه اتصال

    شماره

    شناسه اتصال

  • سیگنال ها

    HostControlSignals

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (result: boolean) => void

    • نتیجه

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 117+

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

setPaused()

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

اتصال باز را متوقف یا لغو مکث می کند.

پارامترها

  • شناسه اتصال

    شماره

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

  • مکث کرد

    بولی

    برای نشان دادن توقف یا لغو مکث پرچم گذاری کنید.

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Chrome 117+

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

update()

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

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

پارامترها

  • شناسه اتصال

    شماره

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

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (result: boolean) => void

    • نتیجه

      بولی

برمی گرداند

  • وعده<boolean>

    Chrome 117+

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

رویدادها

onReceive

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

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

پارامترها

  • پاسخ به تماس

    تابع

    پارامتر callback به نظر می رسد: 

    (info: ReceiveInfo) => void

onReceiveError

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

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

پارامترها