chrome.serial

Deskripsi

Gunakan chrome.serial API untuk membaca dan menulis ke perangkat yang terhubung ke port serial.

Izin

serial

Jenis

ConnectionInfo

Properti

  • bitrate

    nomor opsional

    Lihat ConnectionOptions.bitrate. Kolom ini mungkin dihilangkan atau tidak akurat jika menggunakan kecepatan bit non-standar, atau jika terjadi error saat mengkueri perangkat dasar.

  • bufferSize

    angka

    Lihat ConnectionOptions.bufferSize

  • connectionId

    angka

    ID koneksi port serial.

  • ctsFlowControl

    boolean opsional

    Lihat ConnectionOptions.ctsFlowControl. Kolom ini dapat dihilangkan jika terjadi error saat mengkueri perangkat pokok.

  • dataBits

    DataBits opsional

    Lihat ConnectionOptions.dataBits. Kolom ini dapat dihilangkan jika terjadi error saat mengkueri perangkat pokok.

  • name

    string

    Lihat ConnectionOptions.name

  • parityBit

    ParityBit opsional

    Lihat ConnectionOptions.parityBit. Kolom ini dapat dihilangkan jika terjadi error saat mengkueri perangkat pokok.

  • dijeda

    boolean

    Tanda yang menunjukkan apakah koneksi diblokir agar tidak mengaktifkan peristiwa onReceive.

  • persisten

    boolean

    Lihat ConnectionOptions.persistent

  • receiveTimeout

    angka

    Lihat ConnectionOptions.receiveTimeout

  • sendTimeout

    angka

    Lihat ConnectionOptions.sendTimeout

  • stopBits

    StopBits opsional

    Lihat ConnectionOptions.stopBits. Kolom ini dapat dihilangkan jika terjadi error saat mengkueri perangkat pokok.

ConnectionOptions

Properti

  • bitrate

    nomor opsional

    Kecepatan bit koneksi yang diminta yang akan dibuka. Untuk kompatibilitas dengan berbagai perangkat keras, angka ini harus sesuai dengan salah satu kecepatan bit yang tersedia secara umum, seperti 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200. Tentu saja tidak ada jaminan bahwa perangkat yang terhubung ke port serial akan mendukung kecepatan bit yang diminta, meskipun port itu sendiri mendukung kecepatan bit tersebut. 9600 akan diteruskan secara default.

  • bufferSize

    nomor opsional

    Ukuran buffer yang digunakan untuk menerima data. Nilai defaultnya adalah 4096.

  • ctsFlowControl

    boolean opsional

    Tanda yang menunjukkan apakah kontrol alur hardware RTS/CTS diaktifkan atau tidak. Nilai defaultnya adalah false (salah).

  • dataBits

    DataBits opsional

    "eight" akan diteruskan secara default.

  • name

    string opsional

    String yang ditentukan aplikasi untuk dikaitkan dengan koneksi.

  • parityBit

    ParityBit opsional

    "no" akan diteruskan secara default.

  • persisten

    boolean opsional

    Tanda yang menunjukkan apakah koneksi harus dibiarkan terbuka atau tidak saat aplikasi ditangguhkan (lihat Mengelola Siklus Proses Aplikasi). Nilai defaultnya adalah "false". Saat aplikasi dimuat, setiap koneksi serial yang sebelumnya dibuka dengan persistent=true dapat diambil dengan getConnections.

  • receiveTimeout

    nomor opsional

    Jumlah waktu maksimum (dalam milidetik) untuk menunggu data baru sebelum memunculkan peristiwa onReceiveError dengan error "waktu tunggu". Jika nol, error waktu tunggu penerimaan tidak akan dimunculkan untuk koneksi. Default-nya adalah 0.

  • sendTimeout

    nomor opsional

    Jumlah waktu maksimum (dalam milidetik) untuk menunggu operasi send selesai sebelum memanggil callback dengan error "waktu tunggu". Jika nol, error waktu tunggu pengiriman tidak akan dipicu. Default-nya adalah 0.

  • stopBits

    StopBits opsional

    "one" akan diteruskan secara default.

DataBits

Enum

DeviceControlSignals

Properti

  • cts

    boolean

    CTS (Hapus Untuk Mengirim).

  • dcd

    boolean

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

  • DSR

    boolean

    DSR (Set Data Siap).

  • ri

    boolean

    RI (Indikator Dering).

DeviceInfo

Properti

  • displayName

    string opsional

    Nama tampilan yang dapat dibaca manusia untuk perangkat pokok jika ada yang dapat dikueri dari driver host.

  • jalur

    string

    Jalur sistem perangkat. Ini harus diteruskan sebagai argumen path ke chrome.serial.connect agar dapat terhubung ke perangkat ini.

  • productId

    nomor opsional

    ID produk USB jika salah satunya dapat ditentukan untuk perangkat pokok.

  • vendorId

    nomor opsional

    ID vendor PCI atau USB jika salah satunya dapat ditentukan untuk perangkat pokok.

HostControlSignals

Properti

  • dtr

    boolean opsional

    DTR (Terminal Data Siap).

  • rts

    boolean opsional

    RTS (Permintaan untuk Mengirim).

ParityBit

Enum

ReceiveError

Enum

"terputus"
Koneksi terputus.

"timeout"
Tidak ada data yang diterima selama receiveTimeout milidetik.

"device_lost"
Koneksi perangkat kemungkinan besar terputus dari host.

"break"
Perangkat mendeteksi kondisi gangguan.

"frame_error"
Perangkat mendeteksi error penyesuaian frame.

"overrun"
Kelebihan buffer karakter telah terjadi. Karakter berikutnya hilang.

"buffer_overflow"
Overflow buffer input telah terjadi. Tidak ada ruang di buffer input, atau karakter diterima setelah karakter end-of-file (EOF).

"parity_error"
Perangkat mendeteksi error paritas.

"system_error"
Terjadi error pada sistem dan koneksi mungkin tidak dapat dipulihkan.

ReceiveErrorInfo

Properti

  • connectionId

    angka

    ID koneksi.

  • error

    ReceiveError

    Kode error yang menunjukkan masalah.

ReceiveInfo

Properti

  • connectionId

    angka

    ID koneksi.

  • data

    ArrayBuffer

    Data yang diterima.

SendError

Enum

"terputus"
Koneksi terputus.

"pending"
Pengiriman telah tertunda.

"timeout"
Waktu pengiriman habis.

"system_error"
Terjadi error pada sistem dan koneksi mungkin tidak dapat dipulihkan.

SendInfo

Properti

  • bytesSent

    angka

    Jumlah byte yang dikirim.

  • error

    SendError opsional

    Kode error jika terjadi error.

StopBits

Enum

Metode

clearBreak()

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

Memulihkan transmisi karakter pada koneksi tertentu dan menempatkan jalur transmisi dalam status non-jeda.

Parameter

  • connectionId

    angka

    ID koneksi.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (result: boolean)=>void

    • hasil

      boolean

Hasil

  • Promise<boolean>

    Chrome 117 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

connect()

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

Terhubung ke port serial tertentu.

Parameter

  • jalur

    string

    Jalur sistem port serial yang akan dibuka.

  • opsi

    ConnectionOptions opsional

    Opsi konfigurasi port.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (connectionInfo: ConnectionInfo)=>void

Hasil

  • Promise<ConnectionInfo>

    Chrome 117 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

disconnect()

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

Terputus dari port serial.

Parameter

  • connectionId

    angka

    ID koneksi yang dibuka.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (result: boolean)=>void

    • hasil

      boolean

Hasil

  • Promise<boolean>

    Chrome 117 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

flush()

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

Menghapus semua byte dalam buffer input dan output koneksi yang diberikan.

Parameter

  • connectionId

    angka

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (result: boolean)=>void

    • hasil

      boolean

Hasil

  • Promise<boolean>

    Chrome 117 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

getConnections()

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

Mengambil daftar koneksi port serial yang saat ini dibuka yang dimiliki oleh aplikasi.

Parameter

Hasil

  • Promise<ConnectionInfo[]>

    Chrome 117 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

getControlSignals()

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

Mengambil status sinyal kontrol pada koneksi tertentu.

Parameter

Hasil

  • Chrome 117 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

getDevices()

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

Menampilkan informasi tentang perangkat serial yang tersedia di sistem. Daftar dibuat ulang setiap kali metode ini dipanggil.

Parameter

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (ports: DeviceInfo[])=>void

Hasil

  • Promise<DeviceInfo[]>

    Chrome 117 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

getInfo()

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

Mengambil status koneksi tertentu.

Parameter

  • connectionId

    angka

    ID koneksi yang dibuka.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (connectionInfo: ConnectionInfo)=>void

Hasil

  • Promise<ConnectionInfo>

    Chrome 117 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

send()

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

Menulis data ke koneksi yang diberikan.

Parameter

  • connectionId

    angka

    ID koneksi.

  • data

    ArrayBuffer

    Data yang akan dikirim.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (sendInfo: SendInfo)=>void

Hasil

  • Promise<SendInfo>

    Chrome 117 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

setBreak()

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

Menangguhkan transmisi karakter pada koneksi tertentu dan menempatkan saluran transmisi dalam status jeda hingga clearBreak dipanggil.

Parameter

  • connectionId

    angka

    ID koneksi.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (result: boolean)=>void

    • hasil

      boolean

Hasil

  • Promise<boolean>

    Chrome 117 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

setControlSignals()

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

Menetapkan status sinyal kontrol pada koneksi tertentu.

Parameter

  • connectionId

    angka

    ID koneksi.

  • Kumpulan sinyal berubah untuk dikirim ke perangkat.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (result: boolean)=>void

    • hasil

      boolean

Hasil

  • Promise<boolean>

    Chrome 117 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

setPaused()

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

Menjeda atau membatalkan jeda koneksi terbuka.

Parameter

  • connectionId

    angka

    ID koneksi yang dibuka.

  • dijeda

    boolean

    Tanda untuk menunjukkan apakah akan menjeda atau membatalkan jeda.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    ()=>void

Hasil

  • Promise<void>

    Chrome 117 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

update()

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

Perbarui setelan opsi pada koneksi port serial yang terbuka.

Parameter

  • connectionId

    angka

    ID koneksi yang dibuka.

  • Opsi konfigurasi port.

  • callback

    fungsi opsional

    Parameter callback terlihat seperti: 

    (result: boolean)=>void

    • hasil

      boolean

Hasil

  • Promise<boolean>

    Chrome 117 dan yang lebih baru

    Promise hanya didukung untuk Manifes V3 dan yang lebih baru, platform lain perlu menggunakan callback.

Peristiwa

onReceive

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

Peristiwa muncul saat data telah dibaca dari koneksi.

Parameter

onReceiveError

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

Peristiwa dipicu saat terjadi error saat runtime menunggu data di port serial. Setelah peristiwa ini dipicu, koneksi dapat ditetapkan ke paused. Error "timeout" tidak menjeda koneksi.

Parameter