chrome.serial

תיאור

אפשר להשתמש ב-API של chrome.serial כדי לקרוא ולכתוב במכשיר שמחובר ליציאה טורית.

הרשאות

serial

סוגים

ConnectionInfo

מאפיינים

• קצב העברת נתונים

  מספר אופציונלי

  ConnectionOptions.bitrate. אם נעשה שימוש בקצב העברת נתונים לא סטנדרטי, או אם אירעה שגיאה במהלך שליחת שאילתה למכשיר הבסיסי, יכול להיות שהשדה הזה יושמט או לא יהיה מדויק.

• bufferSize

  number

  הצגה של ConnectionOptions.bufferSize

• connectionId

  number

  המזהה של החיבור ליציאה הטורית.

• ctsFlowControl

  ערך בוליאני אופציונלי

  ConnectionOptions.ctsFlowControl. אם אירעה שגיאה במהלך שליחת שאילתה למכשיר הבסיסי, יכול להיות שהשדה הזה יושמט.

• dataBits

  DataBits אופציונלי

  ConnectionOptions.dataBits. אם אירעה שגיאה במהלך שליחת שאילתה למכשיר הבסיסי, יכול להיות שהשדה הזה יושמט.

• שם

  מחרוזת

  הצגה של ConnectionOptions.name

• parityBit

  ParityBit אופציונלי

  ConnectionOptions.parityBit. אם אירעה שגיאה במהלך שליחת שאילתה למכשיר הבסיסי, יכול להיות שהשדה הזה יושמט.

• מושהה

  בוליאני

  סימון שמציין אם החיבור חסום להפעלה של אירועי onReceive.

• מתמיד

  בוליאני

  הצגה של ConnectionOptions.persistent

• receiveTimeout

  number

  הצגה של ConnectionOptions.receiveTimeout

• sendTimeout

  number

  הצגה של ConnectionOptions.sendTimeout

• stopBits

  StopBits אופציונלי

  ConnectionOptions.stopBits. אם אירעה שגיאה במהלך שליחת שאילתה למכשיר הבסיסי, יכול להיות שהשדה הזה יושמט.

ConnectionOptions

מאפיינים

• קצב העברת נתונים

  מספר אופציונלי

  קצב העברת הנתונים המבוקש של החיבור לפתיחה. לקבלת תאימות לטווח החומרה הרחב ביותר, המספר הזה צריך להתאים לאחד מקצבי העברת הנתונים הזמינים הנפוצים, כגון 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200. אין ערובה, כמובן, שהמכשיר שמחובר ליציאה הטורית יתמוך בקצב העברת הנתונים המבוקש, גם אם היציאה עצמה תומכת בקצב העברת הנתונים הזה. 9600 תועבר כברירת מחדל.

• bufferSize

  מספר אופציונלי

  גודל מאגר הנתונים הזמני המשמש לקבלת נתונים. ערך ברירת המחדל הוא 4096.

• ctsFlowControl

  ערך בוליאני אופציונלי

  סימון שמציין אם להפעיל או לא להפעיל בקרת זרימה בחומרה של RTS/CTS. ברירת המחדל היא False.

• dataBits

  DataBits אופציונלי

  "eight" תועבר כברירת מחדל.

• שם

  מחרוזת אופציונלי

  מחרוזת בהגדרת האפליקציה לשיוך לחיבור.

• parityBit

  ParityBit אופציונלי

  "no" תועבר כברירת מחדל.

• מתמיד

  ערך בוליאני אופציונלי

  סימון שמציין אם צריך להשאיר את החיבור פתוח כשהאפליקציה מושעית (מידע נוסף זמין במאמר ניהול מחזור החיים של אפליקציה). ערך ברירת המחדל הוא 'FALSE'. כשהאפליקציה נטענת, ניתן לאחזר כל חיבורים טוריים שנפתחו בעבר באמצעות persistent=true באמצעות getConnections.

• receiveTimeout

  מספר אופציונלי

  משך הזמן המקסימלי (באלפיות שנייה) להמתנה לנתונים חדשים לפני הגדלת אירוע onReceiveError עם 'זמן קצוב לתפוגה' שגיאה. אם הערך שלו הוא אפס, לא תתבצע קבלת שגיאות של זמן קצוב לתפוגה עבור החיבור. ברירת המחדל היא 0.

• sendTimeout

  מספר אופציונלי

  משך הזמן המקסימלי (באלפיות שנייה) שצריך להמתין לסיום פעולת send לפני קריאה חוזרת להתקשרות חזרה עם 'זמן קצוב לתפוגה' שגיאה. אם הערך אפס, שגיאות הזמן הקצוב לתפוגה לא יופעלו. ברירת המחדל היא 0.

• stopBits

  StopBits אופציונלי

  "one" תועבר כברירת מחדל.

DataBits

Enum

"שבע"

"שמונה"

DeviceControlSignals

מאפיינים

• cts

  בוליאני

  CTS (ניקוי).

• dcd

  בוליאני

  DCD (זיהוי ספק נתונים) או RLSD (אות/ זיהוי של קו קבלה).

• dsr

  בוליאני

  DSR (מוכן למערך הנתונים).

• רי

  בוליאני

  RI (אינדיקטור לצלצול).

DeviceInfo

מאפיינים

• displayName

  מחרוזת אופציונלי

  שם תצוגה של המכשיר הבסיסי שקריא לאנשים, אם אפשר לשלוח לגביו שאילתה ממנהל ההתקן של המארח.

• נתיב

  מחרוזת

  נתיב המערכת של המכשיר. צריך להעביר אותו בתור הארגומנט path אל chrome.serial.connect כדי להתחבר למכשיר הזה.

• productId

  מספר אופציונלי

  מזהה מוצר USB, אם אפשר לזהות אותו עבור המכשיר הבסיסי.

• vendorId

  מספר אופציונלי

  מזהה של ספק PCI או USB, אם ניתן לקבוע מהו המכשיר הבסיסי.

HostControlSignals

מאפיינים

• dtr

  ערך בוליאני אופציונלי

  DTR (מוכן למסוף נתונים).

• rts

  ערך בוליאני אופציונלי

  RTS (בקשה לשליחה).

ParityBit

Enum

"לא"

"odd"

"אפילו"

ReceiveError

Enum

"מנותק"
החיבור נותק.

"זמן קצוב לתפוגה"
לא התקבלו נתונים במשך receiveTimeout אלפיות השנייה.

"device_lost"
סביר להניח שהמכשיר נותק מהמארח.

"break"
המכשיר זיהה מצב של תקלה.

"frame_error"
המכשיר זיהה שגיאה בפריים.

"חריגה"
אירעה חריגה של מאגר תווים. התו הבא אבד.

"buffer_overflow"
אירעה חריגה ממאגר הנתונים הזמני של הקלט. אין מקום במאגר הנתונים הזמני, או שהתקבל תו אחרי התו בסוף הקובץ (EOF).

"parity_error"
המכשיר זיהה שגיאה בהתאמה.

"system_error"
אירעה שגיאת מערכת וייתכן שלא ניתן לשחזר את החיבור.

ReceiveErrorInfo

מאפיינים

• connectionId

  number

  מזהה החיבור.

• error

  ReceiveError

  קוד שגיאה שמציין מה השתבש.

ReceiveInfo

מאפיינים

• connectionId

  number

  מזהה החיבור.

• נתונים

  ArrayBuffer

  הנתונים שהתקבלו.

SendError

Enum

"מנותק"
החיבור נותק.

"בהמתנה"
שליחה כבר הייתה בהמתנה.

"timeout"
תם הזמן הקצוב לשליחה.

"system_error"
אירעה שגיאת מערכת וייתכן שלא ניתן לשחזר את החיבור.

SendInfo

מאפיינים

• bytesSent

  number

  מספר הבייטים שנשלחו.

• error

  SendError אופציונלי

  קוד שגיאה אם אירעה שגיאה.

StopBits

Enum

"אחת"

"שני"

שיטות

clearBreak()

הבטחה Chrome מגרסה 45 ואילך

chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
)

שחזור העברת תווים בחיבור נתון והצבת קו ההעברה במצב ללא הפסקה.

פרמטרים

• connectionId

  number

  מזהה החיבור.

• קריאה חוזרת (callback)

  פונקציה אופציונלית

  הפרמטר callback נראה כך:

  (result: boolean) => void

  • תוצאה

    בוליאני

החזרות

• Promise<boolean>

  Chrome 117 ואילך

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

connect()

הבטחה

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

מתחבר ליציאה טורית נתונה.

פרמטרים

• נתיב

  מחרוזת

  נתיב המערכת של היציאה הטורית לפתיחה.

• אפשרויות

  ConnectionOptions אופציונלי

  אפשרויות להגדרת יציאות.

• קריאה חוזרת (callback)

  פונקציה אופציונלית

  הפרמטר callback נראה כך:

  (connectionInfo: ConnectionInfo) => void

  • connectionInfo

    ConnectionInfo

החזרות

• Promise<ConnectionInfo>

  Chrome 117 ואילך

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

disconnect()

הבטחה

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

מתנתק מיציאה טורית.

פרמטרים

• connectionId

  number

  המזהה של החיבור שנפתח.

• קריאה חוזרת (callback)

  פונקציה אופציונלית

  הפרמטר callback נראה כך:

  (result: boolean) => void

  • תוצאה

    בוליאני

החזרות

• Promise<boolean>

  Chrome 117 ואילך

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

flush()

הבטחה

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

ניקוי כל הבייטים במאגרי הקלט והפלט של החיבור הנתון.

פרמטרים

• connectionId

  number

• קריאה חוזרת (callback)

  פונקציה אופציונלית

  הפרמטר callback נראה כך:

  (result: boolean) => void

  • תוצאה

    בוליאני

החזרות

• Promise<boolean>

  Chrome 117 ואילך

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getConnections()

הבטחה

chrome.serial.getConnections(
  callback?: function,
)

מאחזר את הרשימה של חיבורי היציאות הטוריות שפתוחים כרגע שבבעלות האפליקציה.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה אופציונלית

  הפרמטר callback נראה כך:

  (connectionInfos: ConnectionInfo[]) => void

  • connectionInfos

    ConnectionInfo[]

החזרות

• Promise<ConnectionInfo[]>

  Chrome 117 ואילך

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getControlSignals()

הבטחה

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

אחזור המצב של אותות הבקרה בחיבור נתון.

פרמטרים

• connectionId

  number

  מזהה החיבור.

• קריאה חוזרת (callback)

  פונקציה אופציונלית

  הפרמטר callback נראה כך:

  (signals: DeviceControlSignals) => void

  • אותות

    DeviceControlSignals

החזרות

• Promise<DeviceControlSignals>

  Chrome 117 ואילך

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getDevices()

הבטחה

chrome.serial.getDevices(
  callback?: function,
)

מחזירה מידע על המכשירים עם יציאה טורית זמינים במערכת. הרשימה נוצרת מחדש בכל פעם שמתבצעת קריאה ל-method הזה.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה אופציונלית

  הפרמטר callback נראה כך:

  (ports: DeviceInfo[]) => void

  • ports

    DeviceInfo[]

החזרות

• Promise<DeviceInfo[]>

  Chrome 117 ואילך

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

getInfo()

הבטחה

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

אחזור המצב של חיבור נתון.

פרמטרים

• connectionId

  number

  המזהה של החיבור שנפתח.

• קריאה חוזרת (callback)

  פונקציה אופציונלית

  הפרמטר callback נראה כך:

  (connectionInfo: ConnectionInfo) => void

  • connectionInfo

    ConnectionInfo

החזרות

• Promise<ConnectionInfo>

  Chrome 117 ואילך

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

send()

הבטחה

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

כותבת נתונים לחיבור הנתון.

פרמטרים

• connectionId

  number

  מזהה החיבור.

• נתונים

  ArrayBuffer

  הנתונים לשליחה.

• קריאה חוזרת (callback)

  פונקציה אופציונלית

  הפרמטר callback נראה כך:

  (sendInfo: SendInfo) => void

  • sendInfo

    SendInfo

החזרות

• Promise<SendInfo>

  Chrome 117 ואילך

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

setBreak()

הבטחה Chrome מגרסה 45 ואילך

chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
)

משעה את העברת התווים בחיבור נתון ומעבירה את קו ההעברה במצב הפסקה עד לקריאת ה-clearBreak (הפסקה ללא רעשי רקע).

פרמטרים

• connectionId

  number

  מזהה החיבור.

• קריאה חוזרת (callback)

  פונקציה אופציונלית

  הפרמטר callback נראה כך:

  (result: boolean) => void

  • תוצאה

    בוליאני

החזרות

• Promise<boolean>

  Chrome 117 ואילך

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

setControlSignals()

הבטחה

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

מגדיר את המצב של אותות הבקרה בחיבור נתון.

פרמטרים

• connectionId

  number

  מזהה החיבור.

• אותות

  HostControlSignals

  קבוצת האותות משתנה שצריך לשלוח למכשיר.

• קריאה חוזרת (callback)

  פונקציה אופציונלית

  הפרמטר callback נראה כך:

  (result: boolean) => void

  • תוצאה

    בוליאני

החזרות

• Promise<boolean>

  Chrome 117 ואילך

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

setPaused()

הבטחה

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

השהיה או ביטול ההשהיה של חיבור פתוח.

פרמטרים

• connectionId

  number

  המזהה של החיבור שנפתח.

• מושהה

  בוליאני

  סימון לציון השהיה או ביטול השהיה.

• קריאה חוזרת (callback)

  פונקציה אופציונלית

  הפרמטר callback נראה כך:

  () => void

החזרות

• הבטחה<Empty>

  Chrome 117 ואילך

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

update()

הבטחה

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

יש לעדכן את הגדרות האפשרות בחיבור פתוח ביציאה טורית.

פרמטרים

• connectionId

  number

  המזהה של החיבור שנפתח.

• אפשרויות

  ConnectionOptions

  אפשרויות להגדרת יציאות.

• קריאה חוזרת (callback)

  פונקציה אופציונלית

  הפרמטר callback נראה כך:

  (result: boolean) => void

  • תוצאה

    בוליאני

החזרות

• Promise&lt;boolean&gt;

  Chrome 117 ואילך

  הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

אירועים

onReceive

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

אירוע שמתרחש כשנתונים נקראו מהחיבור.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (info: ReceiveInfo) => void

  • מידע

    ReceiveInfo

onReceiveError

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

האירוע שהתרחש כשאירעה שגיאה בזמן שסביבת זמן הריצה ממתינה לנתונים ביציאה הטורית. אחרי שהאירוע הזה יוגדל, אפשר להגדיר את החיבור ל-paused. שגיאה מסוג "timeout" לא גורמת להשהיית החיבור.

פרמטרים

• קריאה חוזרת (callback)

  פונקציה

  הפרמטר callback נראה כך:

  (info: ReceiveErrorInfo) => void

  • מידע

    ReceiveErrorInfo