chrome/common/extensions/docs/apps/serial.html - Issue 10832260: Fix broken documentation link on API documentation page.

Unified Diff: chrome/common/extensions/docs/apps/serial.html

Issue 10832260: Fix broken documentation link on API documentation page. (Closed) Base URL: http://git.chromium.org/git/chromium.git@trunk

Patch Set: removed devtools docs file as they are not needed Created 8 years, 4 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

Index: chrome/common/extensions/docs/apps/serial.html

diff --git a/chrome/common/extensions/docs/apps/experimental.usb.html b/chrome/common/extensions/docs/apps/serial.html

similarity index 68%

copy from chrome/common/extensions/docs/apps/experimental.usb.html

copy to chrome/common/extensions/docs/apps/serial.html

index 2b8986f77cf5e8d74d5c1f4f099970ddd0150ed2..f0da88fedb17ae94552b051eb3d37047157cc670 100644

--- a/chrome/common/extensions/docs/apps/experimental.usb.html

+++ b/chrome/common/extensions/docs/apps/serial.html

@@ -17,7 +17,7 @@

- <meta name="description" content="Documentation for the chrome.experimental.usb module, which is part of the Google Chrome extension APIs."><title>chrome.experimental.usb - Google Chrome Extensions - Google Code</title></head>

+ <meta name="description" content="Documentation for the chrome.serial module, which is part of the Google Chrome extension APIs."><title>chrome.serial - Google Chrome Extensions - Google Code</title></head>

@@ -157,38 +157,34 @@

</script>

- <h1 class="page_title">chrome.experimental.usb</h1>

+ <h1 class="page_title">chrome.serial</h1>

</div>

<h2>Contents</h2>

<ol>

<li>

- <a href="#apiReference">API reference: chrome.experimental.usb</a>

+ <a href="#apiReference">API reference: chrome.serial</a>

<ol>

<li>

<a href="#global-methods">Methods</a>

<ol>

<li>

- <a href="#method-bulkTransfer">bulkTransfer</a>

+ <a href="#method-close">close</a>

</li><li>

- <a href="#method-closeDevice">closeDevice</a>

+ <a href="#method-flush">flush</a>

</li><li>

- <a href="#method-controlTransfer">controlTransfer</a>

+ <a href="#method-getControlSignals">getControlSignals</a>

</li><li>

- <a href="#method-findDevice">findDevice</a>

+ <a href="#method-getPorts">getPorts</a>

</li><li>

- <a href="#method-interruptTransfer">interruptTransfer</a>

+ <a href="#method-open">open</a>

</li><li>

- <a href="#method-isochronousTransfer">isochronousTransfer</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#global-events">Events</a>

- <ol>

- <li>

- <a href="#event-onEvent">onEvent</a>

+ <a href="#method-read">read</a>

+ </li><li>

+ <a href="#method-setControlSignals">setControlSignals</a>

+ </li><li>

+ <a href="#method-write">write</a>

</li>

</ol>

</li>

@@ -196,27 +192,23 @@

<a href="#types">Types</a>

<ol>

<li>

- <a href="#type-experimental.usb.Device">experimental.usb.Device</a>

+ <a href="#type-serial.OpenOptions">serial.OpenOptions</a>

<ol>

</ol>

</li><li>

- <a href="#type-experimental.usb.ControlTransferInfo">experimental.usb.ControlTransferInfo</a>

+ <a href="#type-serial.OpenInfo">serial.OpenInfo</a>

<ol>

</ol>

</li><li>

- <a href="#type-experimental.usb.GenericTransferInfo">experimental.usb.GenericTransferInfo</a>

+ <a href="#type-serial.ReadInfo">serial.ReadInfo</a>

<ol>

</ol>

</li><li>

- <a href="#type-experimental.usb.IsochronousTransferInfo">experimental.usb.IsochronousTransferInfo</a>

+ <a href="#type-serial.WriteInfo">serial.WriteInfo</a>

<ol>

</ol>

</li><li>

- <a href="#type-experimental.usb.UsbEvent">experimental.usb.UsbEvent</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-experimental.usb.DeviceOptions">experimental.usb.DeviceOptions</a>

+ <a href="#type-serial.ControlSignalOptions">serial.ControlSignalOptions</a>

<ol>

</ol>

</li>

@@ -228,15 +220,23 @@

</div>

- <p id="classSummary">

- For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.

+ <p class="warning">

+ <!-- Standard content lead-in for APIs that are not yet available on

+ the stable channel. -->

+ <em>Warning:</em> This API is still under development. It is only

+ available for Chrome users on the

+ <span>

+ <strong>dev</strong>

+ <a href="http://www.chromium.org/getting-involved/dev-channel">early

+ release channel</a>.</span>

+ <a href="TODO">Learn more</a>.

</p>

- <h2>API reference: chrome.experimental.usb</h2>

+ <h2>API reference: chrome.serial</h2>

@@ -245,37 +245,36 @@

<h3>Methods</h3>

- <a name="method-bulkTransfer"></a>

- <h4>bulkTransfer</h4>

+ <a name="method-close"></a>

+ <h4>close</h4>

- <span>chrome.experimental.usb.bulkTransfer</span>(<span class="null"><span>experimental.usb.Device</span>

- <var><span>device</span></var></span><span class="null"><span>, </span><span>experimental.usb.GenericTransferInfo</span>

- <var><span>transferInfo</span></var></span><span class="optional"><span>, </span><span>function</span>

- <var><span>TransferCallback</span></var></span>)</div>

+ <span>chrome.serial.close</span>(<span class="null"><span>integer</span>

+ <var><span>connectionId</span></var></span><span class="null"><span>, </span><span>function</span>

+ <var><span>CloseCallback</span></var></span>)</div>

- <p>Performs a bulk transfer on the specified device.</p>

+ <p>Closes an open connection.</p>

<h4>Parameters</h4>

<dl>

<div>

<dt>

- <var>device</var>

+ <var>connectionId</var>

<em>

(

<span>

- <a href="experimental.usb.html#type-experimental.usb.Device">experimental.usb.Device</a>

+ <span>integer</span>

</span>

)

</div>

</em>

</dt>

- <dd>An open device to make the transfer on.</dd>

+ <dd>The id of the opened connection.</dd>

@@ -284,38 +283,40 @@

</div><div>

<div>

<dt>

- <var>transferInfo</var>

+ <var>CloseCallback</var>

<em>

(

<span>

- <a href="experimental.usb.html#type-experimental.usb.GenericTransferInfo">experimental.usb.GenericTransferInfo</a>

+ <span>function</span>

</span>

)

</div>

</em>

</dt>

- <dd>The paramters to the transfer. See GenericTransferInfo.</dd>

+ <dd>Returns true if operation was successful.</dd>

- </div>

- </div><div>

- <div>

+ <dd>

+ <div>

+ <h5>Parameters</h5>

+ <dl>

+ <div>

<dt>

- <var>TransferCallback</var>

+ <var>result</var>

<em>

(

- <span class="optional">optional</span>

<span>

- <span>function</span>

+ <span>boolean</span>

</span>

)

@@ -329,51 +330,11 @@

- <dd>

- </dd>

</div>

- </div>

- </dl>

-

- <dl>

- </dl>

-

-

- </div>

- </div><div class="apiItem">

- <a name="method-closeDevice"></a>

- <h4>closeDevice</h4>

- <div class="summary">

-

- <span>chrome.experimental.usb.closeDevice</span>(<span class="null"><span>experimental.usb.Device</span>

- <var><span>device</span></var></span>)</div>

- <div class="description">

- <p>Closes an open device instance. Invoking operations on a device after it has been closed is a safe operation, but causes no action to be taken.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>device</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.usb.html#type-experimental.usb.Device">experimental.usb.Device</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The device to close.</dd>

-

-

-

-

+ </div>

+ </dl>

+ </div>

+ </dd>

</div>

</dl>

@@ -384,37 +345,36 @@

</div>

</div><div class="apiItem">

- <a name="method-controlTransfer"></a>

- <h4>controlTransfer</h4>

+ <a name="method-flush"></a>

+ <h4>flush</h4>

- <span>chrome.experimental.usb.controlTransfer</span>(<span class="null"><span>experimental.usb.Device</span>

- <var><span>device</span></var></span><span class="null"><span>, </span><span>experimental.usb.ControlTransferInfo</span>

- <var><span>transferInfo</span></var></span><span class="optional"><span>, </span><span>function</span>

- <var><span>TransferCallback</span></var></span>)</div>

+ <span>chrome.serial.flush</span>(<span class="null"><span>integer</span>

+ <var><span>connectionId</span></var></span><span class="null"><span>, </span><span>function</span>

+ <var><span>FlushCallback</span></var></span>)</div>

- <p>Performs a control transfer on the specified device. See the ControlTransferInfo structure for the parameters required to make a transfer.</p>

+ <p>Flushes all bytes in the given connection's input and output buffers.</p>

<h4>Parameters</h4>

<dl>

<div>

<dt>

- <var>device</var>

+ <var>connectionId</var>

<em>

(

<span>

- <a href="experimental.usb.html#type-experimental.usb.Device">experimental.usb.Device</a>

+ <span>integer</span>

</span>

)

</div>

</em>

</dt>

- <dd>An open device to make the transfer on.</dd>

+ <dd>The id of the connection.</dd>

@@ -423,38 +383,40 @@

</div><div>

<div>

<dt>

- <var>transferInfo</var>

+ <var>FlushCallback</var>

<em>

(

<span>

- <a href="experimental.usb.html#type-experimental.usb.ControlTransferInfo">experimental.usb.ControlTransferInfo</a>

+ <span>function</span>

</span>

)

</div>

</em>

</dt>

- <dd>The parameters to the transfer. See ControlTransferInfo.</dd>

+ <dd>Returns true if operation was successful.</dd>

- </div>

- </div><div>

- <div>

+ <dd>

+ <div>

+ <h5>Parameters</h5>

+ <dl>

+ <div>

<dt>

- <var>TransferCallback</var>

+ <var>result</var>

<em>

(

- <span class="optional">optional</span>

<span>

- <span>function</span>

+ <span>boolean</span>

</span>

)

@@ -468,7 +430,10 @@

- <dd>

+ </div>

+ </dl>

+ </div>

</dd>

</div>

@@ -480,24 +445,21 @@

</div>

</div><div class="apiItem">

- <a name="method-findDevice"></a>

- <h4>findDevice</h4>

+ <a name="method-getControlSignals"></a>

+ <h4>getControlSignals</h4>

- <span>chrome.experimental.usb.findDevice</span>(<span class="null"><span>integer</span>

- <var><span>vendorId</span></var></span><span class="null"><span>, </span><span>integer</span>

- <var><span>productId</span></var></span><span class="null"><span>, </span><span>experimental.usb.DeviceOptions</span>

- <var><span>options</span></var></span><span class="null"><span>, </span><span>function</span>

- <var><span>FindDeviceCallback</span></var></span>)</div>

+ <span>chrome.serial.getControlSignals</span>(<span class="null"><span>integer</span>

+ <var><span>connectionId</span></var></span><span class="null"><span>, </span><span>function</span>

+ <var><span>GetControlSignalsCallback</span></var></span>)</div>

- <p>Finds the first instance of the USB device specified by the vendorId/ productId pair and, if permissions allow, opens it for use. Upon successfully opening a device the callback is invoked with a populated Device object. On failure, the callback is invoked with null.</p>

<h4>Parameters</h4>

<dl>

<div>

<dt>

- <var>vendorId</var>

+ <var>connectionId</var>

<em>

@@ -511,7 +473,9 @@

</div>

</em>

</dt>

- <dd>The vendor ID of the USB device to find.</dd>

+ <dd class="todo">

+ Undocumented.

+ </dd>

@@ -520,28 +484,31 @@

</div><div>

<div>

<dt>

- <var>productId</var>

+ <var>GetControlSignalsCallback</var>

<em>

(

<span>

- <span>integer</span>

+ <span>function</span>

</span>

)

</div>

</em>

</dt>

- <dd>The product ID of the USB device to find.</dd>

+ <dd>Returns a snapshot of current control signals.</dd>

- </div>

- </div><div>

- <div>

+ <dd>

+ <div>

+ <h5>Parameters</h5>

+ <dl>

+ <div>

<dt>

<var>options</var>

<em>

@@ -550,7 +517,7 @@

(

<span>

- <a href="experimental.usb.html#type-experimental.usb.DeviceOptions">experimental.usb.DeviceOptions</a>

+ <a href="serial.html#type-serial.ControlSignalOptions">serial.ControlSignalOptions</a>

</span>

)

@@ -565,10 +532,35 @@

</div>

- </div><div>

+ </div>

+ </dl>

+ </div>

+ </dd>

+ </div>

+ </dl>

+

+ <dl>

+ </dl>

+

+

+ </div>

+ </div><div class="apiItem">

+ <a name="method-getPorts"></a>

+ <h4>getPorts</h4>

+ <div class="summary">

+

+ <span>chrome.serial.getPorts</span>(<span class="null"><span>function</span>

+ <var><span>GetPortsCallback</span></var></span>)</div>

+ <div class="description">

+ <p>Returns names of valid ports on this machine, each of which is likely to be valid to pass as the port argument to open(). The list is regenerated each time this method is called, as port validity is dynamic.</p>

+

+ <h4>Parameters</h4>

+ <dl>

+ <div>

<div>

<dt>

- <var>FindDeviceCallback</var>

+ <var>GetPortsCallback</var>

<em>

@@ -596,15 +588,20 @@

<div>

<dt>

- <var>device</var>

+ <var>ports</var>

<em>

(

- <span class="optional">optional</span>

<span>

- <a href="experimental.usb.html#type-experimental.usb.Device">experimental.usb.Device</a>

+ <span>

+ array of <span><span>

+ <span>

+ <span>string</span>

+ </span>

+ </span></span>

+ </span>

</span>

)

@@ -633,37 +630,37 @@

</div>

</div><div class="apiItem">

- <a name="method-interruptTransfer"></a>

- <h4>interruptTransfer</h4>

+ <a name="method-open"></a>

+ <h4>open</h4>

- <span>chrome.experimental.usb.interruptTransfer</span>(<span class="null"><span>experimental.usb.Device</span>

- <var><span>device</span></var></span><span class="null"><span>, </span><span>experimental.usb.GenericTransferInfo</span>

- <var><span>transferInfo</span></var></span><span class="optional"><span>, </span><span>function</span>

- <var><span>TransferCallback</span></var></span>)</div>

+ <span>chrome.serial.open</span>(<span class="null"><span>string</span>

+ <var><span>port</span></var></span><span class="optional"><span>, </span><span>serial.OpenOptions</span>

+ <var><span>options</span></var></span><span class="null"><span>, </span><span>function</span>

+ <var><span>OpenCallback</span></var></span>)</div>

- <p>Performs an interrupt transfer on the specified device.</p>

+ <p>Opens a connection to the given serial port.</p>

<h4>Parameters</h4>

<dl>

<div>

<dt>

- <var>device</var>

+ <var>port</var>

<em>

(

<span>

- <a href="experimental.usb.html#type-experimental.usb.Device">experimental.usb.Device</a>

+ <span>string</span>

</span>

)

</div>

</em>

</dt>

- <dd>An open device to make the transfer on.</dd>

+ <dd>The name of the serial port to open.</dd>

@@ -672,21 +669,22 @@

</div><div>

<div>

<dt>

- <var>transferInfo</var>

+ <var>options</var>

<em>

(

+ <span class="optional">optional</span>

<span>

- <a href="experimental.usb.html#type-experimental.usb.GenericTransferInfo">experimental.usb.GenericTransferInfo</a>

+ <a href="serial.html#type-serial.OpenOptions">serial.OpenOptions</a>

</span>

)

</div>

</em>

</dt>

- <dd>The paramters to the transfer. See GenericTransferInfo.</dd>

+ <dd>Connection options.</dd>

@@ -695,12 +693,11 @@

</div><div>

<div>

<dt>

- <var>TransferCallback</var>

+ <var>OpenCallback</var>

<em>

(

- <span class="optional">optional</span>

<span>

<span>function</span>

@@ -718,6 +715,37 @@

<dd>

+ <div>

+ <h5>Parameters</h5>

+ <dl>

+ <div>

+ <dt>

+ <var>openInfo</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span>

+ <a href="serial.html#type-serial.OpenInfo">serial.OpenInfo</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+ </div>

</dd>

</div>

@@ -729,37 +757,37 @@

</div>

</div><div class="apiItem">

- <a name="method-isochronousTransfer"></a>

- <h4>isochronousTransfer</h4>

+ <a name="method-read"></a>

+ <h4>read</h4>

- <span>chrome.experimental.usb.isochronousTransfer</span>(<span class="null"><span>experimental.usb.Device</span>

- <var><span>device</span></var></span><span class="null"><span>, </span><span>experimental.usb.IsochronousTransferInfo</span>

- <var><span>transferInfo</span></var></span><span class="optional"><span>, </span><span>function</span>

- <var><span>TransferCallback</span></var></span>)</div>

+ <span>chrome.serial.read</span>(<span class="null"><span>integer</span>

+ <var><span>connectionId</span></var></span><span class="null"><span>, </span><span>integer</span>

+ <var><span>bytesToRead</span></var></span><span class="null"><span>, </span><span>function</span>

+ <var><span>ReadCallback</span></var></span>)</div>

- <p>Performs an isochronous transfer on the specific device.</p>

+ <p>Reads a byte from the given connection.</p>

<h4>Parameters</h4>

<dl>

<div>

<dt>

- <var>device</var>

+ <var>connectionId</var>

<em>

(

<span>

- <a href="experimental.usb.html#type-experimental.usb.Device">experimental.usb.Device</a>

+ <span>integer</span>

</span>

)

</div>

</em>

</dt>

- <dd>An open device to make the transfer on.</dd>

+ <dd>The id of the connection.</dd>

@@ -768,21 +796,21 @@

</div><div>

<div>

<dt>

- <var>transferInfo</var>

+ <var>bytesToRead</var>

<em>

(

<span>

- <a href="experimental.usb.html#type-experimental.usb.IsochronousTransferInfo">experimental.usb.IsochronousTransferInfo</a>

+ <span>integer</span>

</span>

)

</div>

</em>

</dt>

- <dd>The parameters to the transfer. See IsochronousTransferInfo.</dd>

+ <dd>The number of bytes to read.</dd>

@@ -791,12 +819,11 @@

</div><div>

<div>

<dt>

- <var>TransferCallback</var>

+ <var>ReadCallback</var>

<em>

(

- <span class="optional">optional</span>

<span>

<span>function</span>

@@ -814,46 +841,20 @@

<dd>

- </dd>

- </div>

- </dl>

-

- <dl>

- </dl>

-

-

- </div>

- </div>

- </div>

-

- <div id="eventsTemplate" class="apiGroup">

- <a name="global-events"></a>

- <h3>Events</h3>

-

- <div class="apiItem">

- <a name="event-onEvent"></a>

- <h4>onEvent</h4>

- <div class="summary">

-

- <span class="subdued">chrome.experimental.usb.</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>experimental.usb.UsbEvent event</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

+ <div>

+ <h5>Parameters</h5>

+ <dl>

+ <div>

<dt>

- <var>event</var>

+ <var>readInfo</var>

<em>

(

<span>

- <a href="experimental.usb.html#type-experimental.usb.UsbEvent">experimental.usb.UsbEvent</a>

+ <a href="serial.html#type-serial.ReadInfo">serial.ReadInfo</a>

</span>

)

@@ -868,34 +869,43 @@

</div>

- </div>

- </dl>

- </div>

-

-

+ </div>

+ </dl>

+ </div>

+ </dd>

+ </div>

+ </dl>

+

<dl>

</dl>

+

+

</div>

-

- </div>

- </div>

-

- <div class="apiGroup">

- <a name="types"></a>

- <h3 id="types">Types</h3>

-

- <div class="apiItem">

- <a name="type-experimental.usb.Device"></a>

- <h4>experimental.usb.Device</h4>

- <div>

+ </div><div class="apiItem">

+ <a name="method-setControlSignals"></a>

+ <h4>setControlSignals</h4>

+ <div class="summary">

+

+ <span>chrome.serial.setControlSignals</span>(<span class="null"><span>integer</span>

+ <var><span>connectionId</span></var></span><span class="null"><span>, </span><span>serial.ControlSignalOptions</span>

+ <var><span>options</span></var></span><span class="null"><span>, </span><span>function</span>

+ <var><span>SetControlSignalsCallback</span></var></span>)</div>

+ <div class="description">

+

+ <h4>Parameters</h4>

+ <dl>

+ <div>

<dt>

+ <var>connectionId</var>

<em>

(

<span>

- <span>object</span>

+ <span>integer</span>

</span>

)

@@ -906,19 +916,21 @@

Undocumented.

</dd>

- <dd>

- <dl>

- <div>

+

+

+

+ </div>

+ </div><div>

+ <div>

<dt>

- <var>handle</var>

+ <var>options</var>

<em>

(

<span>

- <span>integer</span>

+ <a href="serial.html#type-serial.ControlSignalOptions">serial.ControlSignalOptions</a>

</span>

)

@@ -933,42 +945,43 @@

</div>

- </div><div>

- <div>

+ </div><div>

+ <div>

<dt>

- <var>productId</var>

+ <var>SetControlSignalsCallback</var>

<em>

(

<span>

- <span>integer</span>

+ <span>function</span>

</span>

)

</div>

</em>

</dt>

- <dd class="todo">

- Undocumented.

- </dd>

+ <dd>Returns true if operation was successful.</dd>

- </div>

- </div><div>

- <div>

+ <dd>

+ <div>

+ <h5>Parameters</h5>

+ <dl>

+ <div>

<dt>

- <var>vendorId</var>

+ <var>result</var>

<em>

(

<span>

- <span>integer</span>

+ <span>boolean</span>

</span>

)

@@ -983,95 +996,90 @@

</div>

- </div>

- </dl>

+ </div>

+ </dl>

+ </div>

</dd>

-

-

-

</div>

- </div><div class="apiItem">

- <a name="type-experimental.usb.ControlTransferInfo"></a>

- <h4>experimental.usb.ControlTransferInfo</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

+ </div>

+ </dl>

+

+ <dl>

+ </dl>

+

+

+ </div>

+ </div><div class="apiItem">

+ <a name="method-write"></a>

+ <h4>write</h4>

+ <div class="summary">

+

+ <span>chrome.serial.write</span>(<span class="null"><span>integer</span>

+ <var><span>connectionId</span></var></span><span class="null"><span>, </span><span>ArrayBuffer</span>

+ <var><span>data</span></var></span><span class="null"><span>, </span><span>function</span>

+ <var><span>WriteCallback</span></var></span>)</div>

+ <div class="description">

+ <p>Writes a string to the given connection.</p>

+

+ <h4>Parameters</h4>

+ <dl>

+ <div>

<dt>

- <var>data</var>

+ <var>connectionId</var>

<em>

(

- <span class="optional">optional</span>

<span>

- <span>ArrayBuffer</span>

+ <span>integer</span>

</span>

)

</div>

</em>

</dt>

- <dd>The data payload carried by this transfer. If this is an output tranfer then this field must be set.</dd>

+ <dd>The id of the connection.</dd>

</div>

- </div><div>

- <div>

+ </div><div>

+ <div>

<dt>

- <var>direction</var>

+ <var>data</var>

<em>

(

<span>

- <span>string</span>

+ <span>ArrayBuffer</span>

</span>

)

</div>

</em>

</dt>

- <dd>The direction of this transfer. Must be one of either in or out.</dd>

+ <dd>The string to write.</dd>

</div>

- </div><div>

- <div>

+ </div><div>

+ <div>

<dt>

- <var>index</var>

+ <var>WriteCallback</var>

<em>

(

<span>

- <span>integer</span>

+ <span>function</span>

</span>

)

@@ -1085,65 +1093,69 @@

- </div>

- </div><div>

- <div>

+ <dd>

+ <div>

+ <h5>Parameters</h5>

+ <dl>

+ <div>

<dt>

- <var>length</var>

+ <var>writeInfo</var>

<em>

(

- <span class="optional">optional</span>

<span>

- <span>integer</span>

+ <a href="serial.html#type-serial.WriteInfo">serial.WriteInfo</a>

</span>

)

</div>

</em>

</dt>

- <dd>If this transfer is an input transfer, then this field must be set to indicate the expected data length. If this is an output transfer, then this field is ignored.</dd>

+ <dd class="todo">

+ Undocumented.

+ </dd>

</div>

- </div><div>

- <div>

- <dt>

- <var>recipient</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The intended recipient for this transfer. Must be one of device, interface, endpoint, or other.</dd>

-

-

-

-

+ </div>

+ </dl>

</div>

- </div><div>

- <div>

+ </dd>

+ </div>

+ </dl>

+

+ <dl>

+ </dl>

+

+

+ </div>

+ </div>

+ </div>

+

+

+

+ <div class="apiGroup">

+ <a name="types"></a>

+ <h3 id="types">Types</h3>

+

+ <div class="apiItem">

+ <a name="type-serial.OpenOptions"></a>

+ <h4>serial.OpenOptions</h4>

+ <div>

<dt>

- <var>request</var>

<em>

(

<span>

- <span>integer</span>

+ <span>object</span>

</span>

)

@@ -1154,37 +1166,12 @@

Undocumented.

</dd>

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>requestType</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The type of this request. Must be one of standard, class, vendor, or reserved.</dd>

-

-

-

-

- </div>

- </div><div>

+ <dd>

+ <dl>

+ <div>

<div>

<dt>

- <var>value</var>

+ <var>bitrate</var>

<em>

@@ -1198,9 +1185,7 @@

</div>

</em>

</dt>

- <dd class="todo">

- Undocumented.

- </dd>

+ <dd>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.</dd>

@@ -1214,8 +1199,8 @@

</div>

</div><div class="apiItem">

- <a name="type-experimental.usb.GenericTransferInfo"></a>

- <h4>experimental.usb.GenericTransferInfo</h4>

+ <a name="type-serial.OpenInfo"></a>

+ <h4>serial.OpenInfo</h4>

<div>

<dt>

<em>

@@ -1240,54 +1225,61 @@

<div>

<dt>

- <var>data</var>

+ <var>connectionId</var>

<em>

(

- <span class="optional">optional</span>

<span>

- <span>ArrayBuffer</span>

+ <span>integer</span>

</span>

)

</div>

</em>

</dt>

- <dd>If this is an output transfer then this field must be populated. Otherwise, it will be ignored.</dd>

+ <dd>The id of the opened connection.</dd>

</div>

- </div><div>

- <div>

+ </div>

+ </dl>

+ </dd>

+

+

+

+ </div>

+ </div><div class="apiItem">

+ <a name="type-serial.ReadInfo"></a>

+ <h4>serial.ReadInfo</h4>

+ <div>

<dt>

- <var>direction</var>

<em>

(

<span>

- <span>string</span>

+ <span>object</span>

</span>

)

</div>

</em>

</dt>

- <dd>The direction of this transfer. Must be one of in or out.</dd>

+ <dd class="todo">

+ Undocumented.

+ </dd>

-

-

-

- </div>

- </div><div>

+ <dd>

+ <dl>

+ <div>

<div>

<dt>

- <var>endpoint</var>

+ <var>bytesRead</var>

<em>

@@ -1301,9 +1293,7 @@

</div>

</em>

</dt>

- <dd class="todo">

- Undocumented.

- </dd>

+ <dd>The number of bytes received, or a negative number if an error occurred. This number will be smaller than the number of bytes requested in the original read call if the call would need to block to read that number of bytes.</dd>

@@ -1312,22 +1302,21 @@

</div><div>

<div>

<dt>

- <var>length</var>

+ <var>data</var>

<em>

(

- <span class="optional">optional</span>

<span>

- <span>integer</span>

+ <span>ArrayBuffer</span>

</span>

)

</div>

</em>

</dt>

- <dd>If this is an input transfer then this field indicates the size of the input buffer. If this is an output transfer then this field is ignored.</dd>

+ <dd>The data received.</dd>

@@ -1341,8 +1330,8 @@

</div>

</div><div class="apiItem">

- <a name="type-experimental.usb.IsochronousTransferInfo"></a>

- <h4>experimental.usb.IsochronousTransferInfo</h4>

+ <a name="type-serial.WriteInfo"></a>

+ <h4>serial.WriteInfo</h4>

<div>

<dt>

<em>

@@ -1367,30 +1356,7 @@

<div>

<dt>

- <var>packetLength</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The length of each of the packets in this transfer.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>packets</var>

+ <var>bytesWritten</var>

<em>

@@ -1404,30 +1370,7 @@

</div>

</em>

</dt>

- <dd>The total number of packets in this transfer.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>transferInfo</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.usb.html#type-experimental.usb.GenericTransferInfo">experimental.usb.GenericTransferInfo</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>All of the normal transfer parameters are encapsulated in the transferInfo parameters. Note that the data specified in this parameter block is split along packetLength boundaries to form the individual packets of the transfer.</dd>

+ <dd>The number of bytes written.</dd>

@@ -1441,8 +1384,8 @@

</div>

</div><div class="apiItem">

- <a name="type-experimental.usb.UsbEvent"></a>

- <h4>experimental.usb.UsbEvent</h4>

+ <a name="type-serial.ControlSignalOptions"></a>

+ <h4>serial.ControlSignalOptions</h4>

<div>

<dt>

<em>

@@ -1467,7 +1410,7 @@

<div>

<dt>

- <var>data</var>

+ <var>cts</var>

<em>

@@ -1475,14 +1418,16 @@

<span class="optional">optional</span>

<span>

- <span>ArrayBuffer</span>

+ <span>boolean</span>

</span>

)

</div>

</em>

</dt>

- <dd>If the transfer was an input transfer then this field will contain all of the input data requested.</dd>

+ <dd class="todo">

+ Undocumented.

+ </dd>

@@ -1491,7 +1436,7 @@

</div><div>

<div>

<dt>

- <var>error</var>

+ <var>dcd</var>

<em>

@@ -1499,14 +1444,14 @@

<span class="optional">optional</span>

<span>

- <span>string</span>

+ <span>boolean</span>

</span>

)

</div>

</em>

</dt>

- <dd>If resultCode is not 0, this field will contain a textual description of the error that occurred during the transfer.</dd>

+ <dd>Serial control signals that your machine can receive. If a get operation fails, success will be false, and these fields will be absent. DCD (Data Carrier Detect) is equivalent to RLSD (Receive Line Signal Detect) on some platforms.</dd>

@@ -1515,7 +1460,7 @@

</div><div>

<div>

<dt>

- <var>resultCode</var>

+ <var>dtr</var>

<em>

@@ -1523,14 +1468,14 @@

<span class="optional">optional</span>

<span>

- <span>integer</span>

+ <span>boolean</span>

</span>

)

</div>

</em>

</dt>

- <dd>A value of 0 indicates that the transfer was a success. Other values indicate failure.</dd>

+ <dd>Serial control signals that your machine can send. Missing fields will be set to false.</dd>

@@ -1539,61 +1484,7 @@

</div><div>

<div>

<dt>

- <var>type</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A string indicating the type of the event. Currently will only contain the value 'transferResult'.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-experimental.usb.DeviceOptions"></a>

- <h4>experimental.usb.DeviceOptions</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>onEvent</var>

+ <var>rts</var>

<em>

@@ -1601,33 +1492,7 @@

<span class="optional">optional</span>

<span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Invoked by the extension API whenever an event occurs for the device(s) that this DeviceOptions is associated with.</dd>

-

-

-

-

- <dd>

- <div>

- <h5>Parameters</h5>

- <dl>

- <div>

- <dt>

- <var>event</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="experimental.usb.html#type-experimental.usb.UsbEvent">experimental.usb.UsbEvent</a>

+ <span>boolean</span>

</span>

)

@@ -1642,11 +1507,6 @@

</div>

- </div>

- </dl>

- </div>

- </dd>

- </div>

</div>

</dl>

</dd>

« no previous file with comments | « chrome/common/extensions/docs/apps/events.html ('k') | chrome/common/extensions/docs/extensions/events.html » ('j') | no next file with comments »