chrome.serial

Properties

• bitrate

  number optional

  See ConnectionOptions.bitrate. This field may be omitted or inaccurate if a non-standard bitrate is in use, or if an error occurred while querying the underlying device.

• bufferSize

  number

  See ConnectionOptions.bufferSize

• connectionId

  number

  The id of the serial port connection.

• ctsFlowControl

  boolean optional

  See ConnectionOptions.ctsFlowControl. This field may be omitted if an error occurred while querying the underlying device.

• dataBits

  DataBits optional

  See ConnectionOptions.dataBits. This field may be omitted if an error occurred while querying the underlying device.

• name

  string

  See ConnectionOptions.name

• parityBit

  ParityBit optional

  See ConnectionOptions.parityBit. This field may be omitted if an error occurred while querying the underlying device.

• paused

  boolean

  Flag indicating whether the connection is blocked from firing onReceive events.

• persistent

  boolean

  See ConnectionOptions.persistent

• receiveTimeout

  number

  See ConnectionOptions.receiveTimeout

• sendTimeout

  number

  See ConnectionOptions.sendTimeout

• stopBits

  StopBits optional

  See ConnectionOptions.stopBits. This field may be omitted if an error occurred while querying the underlying device.

Properties

• bitrate

  number optional

  The requested bitrate of the connection to be opened. For compatibility with the widest range of hardware, this number should match one of commonly-available bitrates, such as 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 57600, 115200. There is no guarantee, of course, that the device connected to the serial port will support the requested bitrate, even if the port itself supports that bitrate. 9600 will be passed by default.

• bufferSize

  number optional

  The size of the buffer used to receive data. The default value is 4096.

• ctsFlowControl

  boolean optional

  Flag indicating whether or not to enable RTS/CTS hardware flow control. Defaults to false.

• dataBits

  DataBits optional

  "eight" will be passed by default.

• name

  string optional

  An application-defined string to associate with the connection.

• parityBit

  ParityBit optional

  "no" will be passed by default.

• persistent

  boolean optional

  Flag indicating whether or not the connection should be left open when the application is suspended (see Manage App Lifecycle). The default value is "false." When the application is loaded, any serial connections previously opened with persistent=true can be fetched with getConnections.

• receiveTimeout

  number optional

  The maximum amount of time (in milliseconds) to wait for new data before raising an onReceiveError event with a "timeout" error. If zero, receive timeout errors will not be raised for the connection. Defaults to 0.

• sendTimeout

  number optional

  The maximum amount of time (in milliseconds) to wait for a send operation to complete before calling the callback with a "timeout" error. If zero, send timeout errors will not be triggered. Defaults to 0.

• stopBits

  StopBits optional

  "one" will be passed by default.

Properties

• cts

  boolean

  CTS (Clear To Send).

• dcd

  boolean

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

• dsr

  boolean

  DSR (Data Set Ready).

• ri

  boolean

  RI (Ring Indicator).

Properties

• displayName

  string optional

  A human-readable display name for the underlying device if one can be queried from the host driver.

• path

  string

  The device's system path. This should be passed as the path argument to chrome.serial.connect in order to connect to this device.

• productId

  number optional

  A USB product ID if one can be determined for the underlying device.

• vendorId

  number optional

  A PCI or USB vendor ID if one can be determined for the underlying device.

Properties

• dtr

  boolean optional

  DTR (Data Terminal Ready).

• rts

  boolean optional

  RTS (Request To Send).

Properties

• connectionId

  number

  The connection identifier.

• error

  ReceiveError

  An error code indicating what went wrong.

Properties

• connectionId

  number

  The connection identifier.

• data

  ArrayBuffer

  The data received.

Properties

• bytesSent

  number

  The number of bytes sent.

• error

  SendError optional

  An error code if an error occurred.

Enum

Enum

Enum

Enum

Enum

Parameters

• connectionId

  number

  The id of the connection.

• callback

  function

  The callback parameter should be a function that looks like this:

  (result: boolean) => {...}

  • result

    boolean

Parameters

• path

  string

  The system path of the serial port to open.

• options

  ConnectionOptions optional

  Port configuration options.

• callback

  function

  Called when the connection has been opened.

  The callback parameter should be a function that looks like this:

  (connectionInfo: ConnectionInfo) => {...}

  • connectionInfo

    ConnectionInfo

Parameters

• connectionId

  number

  The id of the opened connection.

• callback

  function

  Called when the connection has been closed.

  The callback parameter should be a function that looks like this:

  (result: boolean) => {...}

  • result

    boolean

Parameters

• connectionId

  number
• callback

  function

  The callback parameter should be a function that looks like this:

  (result: boolean) => {...}

  • result

    boolean

Parameters

• callback

  function

  Called with the list of connections when available.

  The callback parameter should be a function that looks like this:

  (connectionInfos: ConnectionInfo[]) => {...}

  • connectionInfos

    ConnectionInfo[]

Parameters

• connectionId

  number

  The id of the connection.

• callback

  function

  Called when the control signals are available.

  The callback parameter should be a function that looks like this:

  (signals: DeviceControlSignals) => {...}

  • signals

    DeviceControlSignals

Parameters

• callback

  function

  Called with the list of DeviceInfo objects.

  The callback parameter should be a function that looks like this:

  (ports: DeviceInfo[]) => {...}

  • ports

    DeviceInfo[]

Parameters

• connectionId

  number

  The id of the opened connection.

• callback

  function

  Called with connection state information when available.

  The callback parameter should be a function that looks like this:

  (connectionInfo: ConnectionInfo) => {...}

  • connectionInfo

    ConnectionInfo

Parameters

• connectionId

  number

  The id of the connection.

• data

  ArrayBuffer

  The data to send.

• callback

  function

  Called when the operation has completed.

  The callback parameter should be a function that looks like this:

  (sendInfo: SendInfo) => {...}

  • sendInfo

    SendInfo

Parameters

• connectionId

  number

  The id of the connection.

• callback

  function

  The callback parameter should be a function that looks like this:

  (result: boolean) => {...}

  • result

    boolean

Parameters

• connectionId

  number

  The id of the connection.

• signals

  HostControlSignals

  The set of signal changes to send to the device.

• callback

  function

  Called once the control signals have been set.

  The callback parameter should be a function that looks like this:

  (result: boolean) => {...}

  • result

    boolean

Parameters

• connectionId

  number

  The id of the opened connection.

• paused

  boolean

  Flag to indicate whether to pause or unpause.

• callback

  function

  Called when the connection has been successfully paused or unpaused.

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• connectionId

  number

  The id of the opened connection.

• options

  ConnectionOptions

  Port configuration options.

• callback

  function

  Called when the configuation has completed.

  The callback parameter should be a function that looks like this:

  (result: boolean) => {...}

  • result

    boolean

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (info: ReceiveInfo) => {...}

  • info

    ReceiveInfo

    Event data.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (info: ReceiveErrorInfo) => {...}

  • info

    ReceiveErrorInfo