chrome.serial

Mô tả

Sử dụng API chrome.serial để đọc và ghi vào một thiết bị kết nối với cổng nối tiếp.

Quyền

serial

Loại

ConnectionInfo

Thuộc tính

  • bitrate

    number không bắt buộc

    Vui lòng xem ConnectionOptions.bitrate. Trường này có thể bị bỏ qua hoặc không chính xác nếu đang sử dụng tốc độ bit không theo tiêu chuẩn hoặc nếu xảy ra lỗi trong khi truy vấn thiết bị cơ bản.

  • bufferSize

    số

    Xem ConnectionOptions.bufferSize

  • connectionId

    số

    Mã của kết nối cổng nối tiếp.

  • ctsFlowControl

    boolean không bắt buộc

    Vui lòng xem ConnectionOptions.ctsFlowControl. Bạn có thể bỏ qua trường này nếu xảy ra lỗi trong khi truy vấn thiết bị cơ bản.

  • dataBits

    DataBits không bắt buộc

    Vui lòng xem ConnectionOptions.dataBits. Bạn có thể bỏ qua trường này nếu xảy ra lỗi trong khi truy vấn thiết bị cơ bản.

  • tên

    chuỗi

    Xem ConnectionOptions.name

  • parityBit

    ParityBit không bắt buộc

    Vui lòng xem ConnectionOptions.parityBit. Bạn có thể bỏ qua trường này nếu xảy ra lỗi trong khi truy vấn thiết bị cơ bản.

  • tạm dừng

    boolean

    Cờ cho biết liệu kết nối có bị chặn kích hoạt các sự kiện onReceive hay không.

  • liên tục

    boolean

    Xem ConnectionOptions.persistent

  • receiveTimeout

    số

    Xem ConnectionOptions.receiveTimeout

  • sendTimeout

    số

    Xem ConnectionOptions.sendTimeout

  • stopBits

    StopBits không bắt buộc

    Vui lòng xem ConnectionOptions.stopBits. Bạn có thể bỏ qua trường này nếu xảy ra lỗi trong khi truy vấn thiết bị cơ bản.

ConnectionOptions

Thuộc tính

  • bitrate

    number không bắt buộc

    Tốc độ bit được yêu cầu của kết nối sẽ được mở. Để tương thích với nhiều loại phần cứng nhất có thể, số này phải khớp với một trong các tốc độ truyền dữ liệu thường có, chẳng hạn như 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200. Tất nhiên, không có gì đảm bảo rằng thiết bị kết nối với cổng nối tiếp sẽ hỗ trợ tốc độ truyền dữ liệu được yêu cầu, ngay cả khi bản thân cổng đó hỗ trợ tốc độ truyền dữ liệu đó. 9600 sẽ được truyền theo mặc định.

  • bufferSize

    number không bắt buộc

    Kích thước của bộ nhớ đệm dùng để nhận dữ liệu. Giá trị mặc định là 4096.

  • ctsFlowControl

    boolean không bắt buộc

    Cờ cho biết có bật chế độ kiểm soát luồng phần cứng RTS/CTS hay không. Giá trị mặc định là false.

  • dataBits

    DataBits không bắt buộc

    "eight" sẽ được truyền theo mặc định.

  • tên

    chuỗi không bắt buộc

    Một chuỗi do ứng dụng xác định để liên kết với kết nối.

  • parityBit

    ParityBit không bắt buộc

    "no" sẽ được truyền theo mặc định.

  • liên tục

    boolean không bắt buộc

    Cờ cho biết có nên để kết nối ở trạng thái mở khi ứng dụng bị tạm ngưng hay không (xem phần Quản lý vòng đời ứng dụng). Giá trị mặc định là "false". Khi ứng dụng được tải, mọi kết nối nối tiếp đã mở trước đó bằng persistent=true đều có thể được tìm nạp bằng getConnections.

  • receiveTimeout

    number không bắt buộc

    Khoảng thời gian tối đa (tính bằng mili giây) để chờ dữ liệu mới trước khi đưa ra sự kiện onReceiveError kèm theo lỗi "hết thời gian chờ". Nếu bằng 0, các lỗi thời gian chờ nhận sẽ không được tăng cho kết nối. Giá trị mặc định là: 0

  • sendTimeout

    number không bắt buộc

    Khoảng thời gian tối đa (tính bằng mili giây) để chờ một thao tác send hoàn tất trước khi gọi lệnh gọi lại bằng lỗi "hết thời gian chờ". Nếu bằng 0, lỗi hết thời gian chờ gửi sẽ không được kích hoạt. Giá trị mặc định là: 0

  • stopBits

    StopBits không bắt buộc

    "one" sẽ được truyền theo mặc định.

DataBits

Enum

"seven"

"eight"

DeviceControlSignals

Thuộc tính

  • cts

    boolean

    CTS (Clear To Send – Xoá để gửi).

  • dcd

    boolean

    DCD (Data Carrier Detect) hoặc RLSD (Receive Line Signal/ Detect).

  • dsr

    boolean

    DSR (Tập dữ liệu đã sẵn sàng).

  • ri

    boolean

    RI (Chỉ báo chuông).

DeviceInfo

Thuộc tính

  • Tên hiển thị

    chuỗi không bắt buộc

    Tên hiển thị dễ đọc cho thiết bị cơ bản nếu có thể truy vấn tên đó từ trình điều khiển máy chủ.

  • đường dẫn

    chuỗi

    Đường dẫn hệ thống của thiết bị. Bạn nên truyền tham số này dưới dạng đối số path đến chrome.serial.connect để kết nối với thiết bị này.

  • productId

    number không bắt buộc

    Mã sản phẩm USB nếu có thể xác định được cho thiết bị cơ bản.

  • vendorId

    number không bắt buộc

    Mã nhận dạng nhà cung cấp PCI hoặc USB nếu có thể xác định được cho thiết bị cơ bản.

HostControlSignals

Thuộc tính

  • dtr

    boolean không bắt buộc

    DTR (Data Terminal Ready – Thiết bị đầu cuối dữ liệu đã sẵn sàng).

  • rts

    boolean không bắt buộc

    RTS (Yêu cầu gửi).

ParityBit

Enum

"không"

"odd"

"even"

ReceiveError

Enum

"đã ngắt kết nối"
Kết nối đã bị ngắt.

"timeout"
Không nhận được dữ liệu nào trong receiveTimeout mili giây.

"device_lost"
Thiết bị có khả năng cao đã bị ngắt kết nối với máy chủ lưu trữ.

"break"
Thiết bị phát hiện thấy điều kiện ngắt.

"frame_error"
Thiết bị phát hiện thấy lỗi khung hình.

"overrun"
Đã xảy ra tình trạng tràn bộ nhớ đệm ký tự. Ký tự tiếp theo bị mất.

"buffer_overflow"
Đã xảy ra lỗi tràn bộ đệm đầu vào. Không có khoảng trống trong vùng đệm đầu vào hoặc một ký tự đã được nhận sau ký tự cuối tệp (EOF).

"parity_error"
Thiết bị phát hiện thấy lỗi chẵn lẻ.

"system_error"
Đã xảy ra lỗi hệ thống và có thể không khôi phục được kết nối.

ReceiveErrorInfo

Thuộc tính

  • connectionId

    số

    Giá trị nhận dạng kết nối.

  • error

    ReceiveError

    Mã lỗi cho biết vấn đề đã xảy ra.

ReceiveInfo

Thuộc tính

  • connectionId

    số

    Giá trị nhận dạng kết nối.

  • khác

    ArrayBuffer

    Dữ liệu đã nhận.

SendError

Enum

"đã ngắt kết nối"
Kết nối đã bị ngắt.

"đang chờ xử lý"
Đã có một yêu cầu gửi đang chờ xử lý.

"timeout"
Đã hết thời gian gửi.

"system_error"
Đã xảy ra lỗi hệ thống và có thể không khôi phục được kết nối.

SendInfo

Thuộc tính

  • bytesSent

    số

    Số byte đã gửi.

  • error

    SendError không bắt buộc

    Mã lỗi nếu xảy ra lỗi.

StopBits

Enum

"one"

"two"

Phương thức

clearBreak()

Promise Chrome 45 trở lên 
chrome.serial.clearBreak(
  connectionId: number,
  callback?: function,
): Promise<boolean>

Khôi phục quá trình truyền ký tự trên một kết nối nhất định và đặt đường truyền ở trạng thái không ngắt.

Thông số

  • connectionId

    số

    Mã nhận dạng của kết nối.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (result: boolean) => void

    • kết quả

      boolean

Giá trị trả về

  • Promise<boolean>

    Chrome 117 trở lên

    Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

connect()

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

Kết nối với một cổng nối tiếp nhất định.

Thông số

  • đường dẫn

    chuỗi

    Đường dẫn hệ thống của cổng nối tiếp cần mở.

  • tùy chọn

    ConnectionOptions không bắt buộc

    Các lựa chọn cấu hình cổng.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (connectionInfo: ConnectionInfo) => void

Giá trị trả về

  • Promise<ConnectionInfo>

    Chrome 117 trở lên

    Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

disconnect()

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

Ngắt kết nối khỏi một cổng nối tiếp.

Thông số

  • connectionId

    số

    Mã của kết nối đã mở.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (result: boolean) => void

    • kết quả

      boolean

Giá trị trả về

  • Promise<boolean>

    Chrome 117 trở lên

    Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

flush()

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

Xoá tất cả các byte trong vùng đệm đầu vào và đầu ra của kết nối đã cho.

Thông số

  • connectionId

    số

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (result: boolean) => void

    • kết quả

      boolean

Giá trị trả về

  • Promise<boolean>

    Chrome 117 trở lên

    Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getConnections()

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

Truy xuất danh sách các kết nối cổng nối tiếp hiện đang mở do ứng dụng sở hữu.

Thông số

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (connectionInfos: ConnectionInfo[]) => void

Giá trị trả về

  • Promise<ConnectionInfo[]>

    Chrome 117 trở lên

    Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getControlSignals()

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

Truy xuất trạng thái của các tín hiệu điều khiển trên một kết nối nhất định.

Thông số

  • connectionId

    số

    Mã nhận dạng của kết nối.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (signals: DeviceControlSignals) => void

Giá trị trả về

  • Chrome 117 trở lên

    Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getDevices()

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

Trả về thông tin về các thiết bị nối tiếp có sẵn trên hệ thống. Danh sách này được tạo lại mỗi khi phương thức này được gọi.

Thông số

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (ports: DeviceInfo[]) => void

Giá trị trả về

  • Promise<DeviceInfo[]>

    Chrome 117 trở lên

    Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

getInfo()

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

Truy xuất trạng thái của một kết nối nhất định.

Thông số

  • connectionId

    số

    Mã của kết nối đã mở.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (connectionInfo: ConnectionInfo) => void

Giá trị trả về

  • Promise<ConnectionInfo>

    Chrome 117 trở lên

    Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

send()

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

Ghi dữ liệu vào kết nối đã cho.

Thông số

  • connectionId

    số

    Mã nhận dạng của kết nối.

  • khác

    ArrayBuffer

    Dữ liệu cần gửi.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (sendInfo: SendInfo) => void

Giá trị trả về

  • Promise<SendInfo>

    Chrome 117 trở lên

    Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

setBreak()

Promise Chrome 45 trở lên 
chrome.serial.setBreak(
  connectionId: number,
  callback?: function,
): Promise<boolean>

Tạm ngưng việc truyền ký tự trên một kết nối nhất định và đặt đường truyền ở trạng thái ngắt cho đến khi clearBreak được gọi.

Thông số

  • connectionId

    số

    Mã nhận dạng của kết nối.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (result: boolean) => void

    • kết quả

      boolean

Giá trị trả về

  • Promise<boolean>

    Chrome 117 trở lên

    Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

setControlSignals()

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

Đặt trạng thái của các tín hiệu điều khiển trên một kết nối nhất định.

Thông số

  • connectionId

    số

    Mã nhận dạng của kết nối.

  • tín hiệu

    HostControlSignals

    Tập hợp các thay đổi về tín hiệu cần gửi đến thiết bị.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (result: boolean) => void

    • kết quả

      boolean

Giá trị trả về

  • Promise<boolean>

    Chrome 117 trở lên

    Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

setPaused()

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

Tạm dừng hoặc tiếp tục một kết nối đang mở.

Thông số

  • connectionId

    số

    Mã của kết nối đã mở.

  • tạm dừng

    boolean

    Cờ cho biết bạn muốn tạm dừng hay tiếp tục.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    () => void

Giá trị trả về

  • Promise<void>

    Chrome 117 trở lên

    Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

update()

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

Cập nhật chế độ cài đặt lựa chọn trên một kết nối cổng nối tiếp đang mở.

Thông số

  • connectionId

    số

    Mã của kết nối đã mở.

  • tùy chọn

    ConnectionOptions

    Các lựa chọn cấu hình cổng.

  • callback

    hàm không bắt buộc

    Tham số callback có dạng như sau: 

    (result: boolean) => void

    • kết quả

      boolean

Giá trị trả về

  • Promise<boolean>

    Chrome 117 trở lên

    Các promise chỉ được hỗ trợ cho Manifest V3 trở lên, các nền tảng khác cần sử dụng lệnh gọi lại.

Sự kiện

onReceive

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

Sự kiện được tạo khi dữ liệu đã được đọc từ kết nối.

Thông số

onReceiveError

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

Sự kiện được tạo khi xảy ra lỗi trong lúc thời gian chạy đang chờ dữ liệu trên cổng nối tiếp. Sau khi sự kiện này được tạo, bạn có thể đặt trạng thái kết nối thành paused. Lỗi "timeout" không làm tạm dừng kết nối.

Thông số