Mô tả
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
số 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 tốc độ bit không chuẩn đang được sử dụng, hoặc nếu đã xảy ra lỗi 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
. Trường này có thể bị bỏ qua nếu xảy ra lỗi khi truy vấn thiết bị cơ bản. -
dataBits
DataBits không bắt buộc
Vui lòng xem
ConnectionOptions.dataBits
. Trường này có thể bị bỏ qua nếu xảy ra lỗi khi truy vấn thiết bị cơ bản. -
tên
string
Xem
ConnectionOptions.name
-
parityBit
ParityBit không bắt buộc
Vui lòng xem
ConnectionOptions.parityBit
. Trường này có thể bị bỏ qua nếu xảy ra lỗi 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
. Trường này có thể bị bỏ qua nếu xảy ra lỗi khi truy vấn thiết bị cơ bản.
ConnectionOptions
Thuộc tính
-
bitrate
số không bắt buộc
Tốc độ bit được yêu cầu của kết nối để mở. Để tương thích với phạm vi phần cứng rộng nhất, số này phải khớp với một trong các tốc độ bit thường thấy, 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 độ bit mà bạn yêu cầu, ngay cả khi cổng đó hỗ trợ tốc độ bit đó.
9600
sẽ được truyền theo mặc định. -
bufferSize
số không bắt buộc
Dung lượng vùng đệ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 tính năng 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
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 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 tải ứng dụng, hệ thống có thể tìm nạp mọi kết nối nối tiếp đã mở trước đó bằng
getConnections
. -
receiveTimeout
số 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 một sự kiện
onReceiveError
có "thời gian chờ" . Nếu bằng 0, lỗi hết thời gian chờ sẽ không xuất hiện cho kết nối. Giá trị mặc định là: 0 -
sendTimeout
số 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 có "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
"bảy"
"8"
DeviceControlSignals
Thuộc tính
-
phần trăm
boolean
CTS (Xoá để gửi).
-
dcd
boolean
DCD (Phát hiện nhà mạng dữ liệu) hoặc rlSD (Phát hiện tín hiệu đường truyền/ Phát hiện).
-
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ị mà con người có thể đọc được cho thiết bị cơ bản nếu có thể truy vấn một thiết bị từ trình điều khiển máy chủ lưu trữ.
-
đường dẫn
string
Đường dẫn hệ thống của thiết bị. Tham số này phải được truyền dưới dạng đối số
path
chochrome.serial.connect
để kết nối với thiết bị này. -
productId
số không bắt buộc
Mã sản phẩm USB nếu có thể xác định mã đó cho thiết bị cơ bản.
-
vendorId
số không bắt buộc
Mã nhà cung cấp PCI hoặc USB nếu có thể xác định mã cho thiết bị cơ bản.
HostControlSignals
Thuộc tính
-
dtr
boolean không bắt buộc
DTR (Sẵn sàng cho thiết bị đầu cuối dữ liệu).
-
rts
boolean không bắt buộc
RTS (Yêu cầu gửi).
ParityBit
Enum
"không"
"lẻ"
"thậm chí"
ReceiveError
Enum
"bị ngắt kết nối"
Kết nối đã bị ngắt kết nối.
"timeout"
Không nhận được dữ liệu nào trong receiveTimeout
mili giây.
"device_lost"
Có nhiều khả năng đã ngắt kết nối thiết bị khỏi máy chủ.
"break"
Thiết bị đã phát hiện thấy tình trạng hỏng.
"frame_error"
Thiết bị đã phát hiện thấy lỗi lấy khung hình.
"overrun"
Đã xảy ra tràn vùng đệm ký tự. Ký tự tiếp theo sẽ bị mất.
"buffer_overflow"
Đã xảy ra tràn vùng đệm đầu vào. Không có chỗ trống trong vùng đệm đầu vào hoặc ký tự được nhận sau ký tự cuối tệp (EOF).
"parity_error"
Thiết bị phát hiện lỗi ngang nhau.
"system_error"
Đã xảy ra lỗi hệ thống và kết nối có thể không khôi phục được.
ReceiveErrorInfo
Thuộc tính
-
connectionId
số
Giá trị nhận dạng kết nối.
-
error
Mã lỗi cho biết đã xảy ra lỗi.
ReceiveInfo
Thuộc tính
-
connectionId
số
Giá trị nhận dạng kết nối.
-
dữ liệu
ArrayBuffer
Dữ liệu đã nhận được.
SendError
Enum
"Ngắt kết nối"
Kết nối đã bị ngắt kết nối.
"đang chờ xử lý"
Một lệnh 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à kết nối có thể không khôi phục được.
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
"một"
"hai"
Phương thức
clearBreak()
chrome.serial.clearBreak(
connectionId: number,
callback?: function,
)
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.
Tham số
-
connectionId
số
Mã của kết nối.
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(result: boolean) => void
-
kết quả
boolean
-
Giá trị trả về
-
Promise<boolean>
Chrome 117 trở lênLời hứa 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()
chrome.serial.connect(
path: string,
options?: ConnectionOptions,
callback?: function,
)
Kết nối với một cổng nối tiếp nhất định.
Tham số
-
đường dẫn
string
Đường dẫn hệ thống của cổng nối tiếp sẽ mở.
-
tùy chọn
ConnectionOptions không bắt buộc
Các lựa chọn cấu hình cổng.
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(connectionInfo: ConnectionInfo) => void
-
connectionInfo
-
Giá trị trả về
-
Promise<ConnectionInfo>
Chrome 117 trở lênLời hứa 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()
chrome.serial.disconnect(
connectionId: number,
callback?: function,
)
Ngắt kết nối khỏi một cổng nối tiếp.
Tham số
-
connectionId
số
Mã của kết nối đã mở.
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(result: boolean) => void
-
kết quả
boolean
-
Giá trị trả về
-
Promise<boolean>
Chrome 117 trở lênLời hứa 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()
chrome.serial.flush(
connectionId: number,
callback?: function,
)
Xoá tất cả các byte trong vùng đệm đầu vào và đầu ra của kết nối nhất định.
Tham số
-
connectionId
số
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(result: boolean) => void
-
kết quả
boolean
-
Giá trị trả về
-
Promise<boolean>
Chrome 117 trở lênLời hứa 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()
chrome.serial.getConnections(
callback?: function,
)
Truy xuất danh sách các kết nối cổng nối tiếp hiện đang mở mà ứng dụng sở hữu.
Tham số
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(connectionInfos: ConnectionInfo[]) => void
-
connectionInfos
-
Giá trị trả về
-
Promise<ConnectionInfo[]>
Chrome 117 trở lênLời hứa 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()
chrome.serial.getControlSignals(
connectionId: number,
callback?: function,
)
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.
Tham số
-
connectionId
số
Mã của kết nối.
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(signals: DeviceControlSignals) => void
-
tín hiệu
-
Giá trị trả về
-
Promise<DeviceControlSignals>
Chrome 117 trở lênLời hứa 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()
chrome.serial.getDevices(
callback?: function,
)
Trả về thông tin về các thiết bị nối tiếp hiện có trên hệ thống. Danh sách sẽ được tạo lại mỗi khi phương thức này được gọi.
Tham số
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(ports: DeviceInfo[]) => void
-
ports
-
Giá trị trả về
-
Promise<DeviceInfo[]>
Chrome 117 trở lênLời hứa 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()
chrome.serial.getInfo(
connectionId: number,
callback?: function,
)
Truy xuất trạng thái của một kết nối cụ thể.
Tham số
-
connectionId
số
Mã của kết nối đã mở.
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(connectionInfo: ConnectionInfo) => void
-
connectionInfo
-
Giá trị trả về
-
Promise<ConnectionInfo>
Chrome 117 trở lênLời hứa 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()
chrome.serial.send(
connectionId: number,
data: ArrayBuffer,
callback?: function,
)
Ghi dữ liệu vào kết nối đã cho.
Tham số
-
connectionId
số
Mã của kết nối.
-
dữ liệu
ArrayBuffer
Dữ liệu cần gửi.
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(sendInfo: SendInfo) => void
-
sendInfo
-
Giá trị trả về
-
Promise<SendInfo>
Chrome 117 trở lênLời hứa 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()
chrome.serial.setBreak(
connectionId: number,
callback?: function,
)
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.
Tham số
-
connectionId
số
Mã của kết nối.
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(result: boolean) => void
-
kết quả
boolean
-
Giá trị trả về
-
Promise<boolean>
Chrome 117 trở lênLời hứa 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()
chrome.serial.setControlSignals(
connectionId: number,
signals: HostControlSignals,
callback?: function,
)
Đặt trạng thái của tín hiệu điều khiển trên một kết nối nhất định.
Tham số
-
connectionId
số
Mã của kết nối.
-
tín hiệu
Tập hợp các thay đổi về tín hiệu để gửi đến thiết bị.
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(result: boolean) => void
-
kết quả
boolean
-
Giá trị trả về
-
Promise<boolean>
Chrome 117 trở lênLời hứa 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()
chrome.serial.setPaused(
connectionId: number,
paused: boolean,
callback?: function,
)
Tạm dừng hoặc huỷ tạm dừng một kết nối đang mở.
Tham số
-
connectionId
số
Mã của kết nối đã mở.
-
tạm dừng
boolean
Gắn cờ để cho biết bạn muốn tạm dừng hay huỷ tạm dừng.
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:() => void
Giá trị trả về
-
Lời hứa<vô hiệu>
Chrome 117 trở lênLời hứa 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()
chrome.serial.update(
connectionId: number,
options: ConnectionOptions,
callback?: function,
)
Cập nhật các chế độ cài đặt tuỳ chọn khi kết nối cổng nối tiếp đang mở.
Tham số
-
connectionId
số
Mã của kết nối đã mở.
-
tùy chọn
Các lựa chọn cấu hình cổng.
-
số gọi lại
hàm không bắt buộc
Tham số
callback
sẽ có dạng như sau:(result: boolean) => void
-
kết quả
boolean
-
Giá trị trả về
-
Promise<boolean>
Chrome 117 trở lênLời hứa 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 đưa ra khi dữ liệu được đọc từ kết nối.
Tham số
-
số gọi lại
hàm
Tham số
callback
sẽ có dạng như sau:(info: ReceiveInfo) => void
-
info
-
onReceiveError
chrome.serial.onReceiveError.addListener(
callback: function,
)
Sự kiện đã xảy ra khi xảy ra lỗi trong lúc môi trường 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 kết nối thành paused
. Lỗi "timeout"
không làm tạm dừng kết nối.
Tham số
-
số gọi lại
hàm
Tham số
callback
sẽ có dạng như sau:(info: ReceiveErrorInfo) => void
-
info
-