Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(129)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/apps/experimental.serial.html

Issue 10852016: Move serial out of experimental. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: 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 unified diff | Download patch | Annotate | Revision Log
« chrome/common/extensions/api/_permission_features.json ('K') | « chrome/common/extensions/docs/apps/experimental.html ('k') | chrome/common/extensions/docs/examples/api/notifications.zip » ('j') | chrome/common/extensions/permissions/api_permission.cc » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
4 templating mechanism. 4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and 6 browser, it will be re-generated from the template, json schema and
7 authored overview content. 7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this 8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines. 9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="../css/print.css" rel="stylesheet" type="text/css" media="print" > 12 <link href="../css/print.css" rel="stylesheet" type="text/css" media="print" >
13 <script type="text/javascript" src="../../../../third_party/jstemplate/jstem plate_compiled.js"> 13 <script type="text/javascript" src="../../../../third_party/jstemplate/jstem plate_compiled.js">
14 </script> 14 </script>
15 <script type="text/javascript" src="../../../../../third_party/json_minify/m inify-sans-regexp.js"> 15 <script type="text/javascript" src="../../../../../third_party/json_minify/m inify-sans-regexp.js">
16 </script> 16 </script>
17 <script type="text/javascript" src="../js/api_page_generator.js"></script> 17 <script type="text/javascript" src="../js/api_page_generator.js"></script>
18 <script type="text/javascript" src="../js/bootstrap.js"></script> 18 <script type="text/javascript" src="../js/bootstrap.js"></script>
19 <script type="text/javascript" src="../js/sidebar.js"></script> 19 <script type="text/javascript" src="../js/sidebar.js"></script>
20 <meta name="description" content="Documentation for the chrome.experimental.se rial module, which is part of the Google Chrome extension APIs."><title>chrome. experimental.serial - Google Chrome Extensions - Google Code</title></head> 20 <title>Experimental.serial - Google Chrome Extensions - Google Code</title></h ead>
21 <body doc-family="apps"> <link href="../css/ApiRefStyles_apps.css" rel="style sheet" type="text/css"> 21 <body doc-family="apps"> <link href="../css/ApiRefStyles_apps.css" rel="style sheet" type="text/css">
22 <link href="../css/prettify.css" rel="stylesheet" type="text/css"> 22 <link href="../css/prettify.css" rel="stylesheet" type="text/css">
23 <link href="../css/shared.css" rel="stylesheet" type="text/css"> 23 <link href="../css/shared.css" rel="stylesheet" type="text/css">
24 <div id="devModeWarning" class="displayModeWarning"> 24 <div id="devModeWarning" class="displayModeWarning">
25 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files. 25 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
26 </div> 26 </div>
27 <div id="branchWarning" class="displayModeWarning"> 27 <div id="branchWarning" class="displayModeWarning">
28 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. 28 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
29 It may not work with the stable release of Chrome.</span> 29 It may not work with the stable release of Chrome.</span>
30 <select id="branchChooser"> 30 <select id="branchChooser">
(...skipping 119 matching lines...) Expand 10 before | Expand all | Expand 10 after
150 </li> 150 </li>
151 <li><h2><a href="https://github.com/GoogleChrome/chrome-app-samples">S amples</a></h2></li> 151 <li><h2><a href="https://github.com/GoogleChrome/chrome-app-samples">S amples</a></h2></li>
152 <li><h2><a href="app_known_issues.html">Known Issues</a></h2></li> 152 <li><h2><a href="app_known_issues.html">Known Issues</a></h2></li>
153 </ul> 153 </ul>
154 </div> 154 </div>
155 <script> 155 <script>
156 initToggles(); 156 initToggles();
157 </script> 157 </script>
158 <div class="g-unit" id="gc-pagecontent"> 158 <div class="g-unit" id="gc-pagecontent">
159 <div id="pageTitle"> 159 <div id="pageTitle">
160 <h1 class="page_title">chrome.experimental.serial</h1> 160 <h1 class="page_title">Experimental.serial</h1>
161 </div> 161 </div>
162 <!-- TABLE OF CONTENTS --> 162 <!-- TABLE OF CONTENTS -->
163 <div id="toc">
164 <h2>Contents</h2>
165 <ol>
166 <li>
167 <a href="#apiReference">API reference: chrome.experimental.seria l</a>
168 <ol>
169 <li>
170 <a href="#global-methods">Methods</a>
171 <ol>
172 <li>
173 <a href="#method-close">close</a>
174 </li><li>
175 <a href="#method-flush">flush</a>
176 </li><li>
177 <a href="#method-getControlSignals">getControlSignals</a>
178 </li><li>
179 <a href="#method-getPorts">getPorts</a>
180 </li><li>
181 <a href="#method-open">open</a>
182 </li><li>
183 <a href="#method-read">read</a>
184 </li><li>
185 <a href="#method-setControlSignals">setControlSignals</a>
186 </li><li>
187 <a href="#method-write">write</a>
188 </li>
189 </ol>
190 </li>
191 <li>
192 <a href="#types">Types</a>
193 <ol>
194 <li>
195 <a href="#type-experimental.serial.OpenOptions">experimental.ser ial.OpenOptions</a>
196 <ol>
197 </ol>
198 </li><li>
199 <a href="#type-experimental.serial.OpenInfo">experimental.serial .OpenInfo</a>
200 <ol>
201 </ol>
202 </li><li>
203 <a href="#type-experimental.serial.ReadInfo">experimental.serial .ReadInfo</a>
204 <ol>
205 </ol>
206 </li><li>
207 <a href="#type-experimental.serial.WriteInfo">experimental.seria l.WriteInfo</a>
208 <ol>
209 </ol>
210 </li><li>
211 <a href="#type-experimental.serial.ControlSignalOptions">experim ental.serial.ControlSignalOptions</a>
212 <ol>
213 </ol>
214 </li>
215 </ol>
216 </li>
217 </ol>
218 </li>
219 </ol>
220 </div>
221 <!-- /TABLE OF CONTENTS --> 163 <!-- /TABLE OF CONTENTS -->
222 <!-- Standard content lead-in for experimental API pages --> 164 <!-- Standard content lead-in for experimental API pages -->
223 <p id="classSummary">
224 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
225 </p>
226 <!-- STATIC CONTENT PLACEHOLDER --> 165 <!-- STATIC CONTENT PLACEHOLDER -->
227 <div id="static"></div> 166 <div id="static"></div>
228 <!-- API PAGE --> 167 <!-- API PAGE -->
229 <div class="apiPage"> 168 <!-- /apiPage -->
230 <a name="apiReference"></a>
231 <h2>API reference: chrome.experimental.serial</h2>
232 <!-- PROPERTIES -->
233 <!-- /apiGroup -->
234 <!-- METHODS -->
235 <div id="methodsTemplate" class="apiGroup">
236 <a name="global-methods"></a>
237 <h3>Methods</h3>
238 <!-- iterates over all functions -->
239 <div class="apiItem">
240 <a name="method-close"></a> <!-- method-anchor -->
241 <h4>close</h4>
242 <div class="summary">
243 <!-- Note: intentionally longer 80 columns -->
244 <span>chrome.experimental.serial.close</span>(<span class="nul l"><span>integer</span>
245 <var><span>connectionId</span></var></span><span class="nu ll"><span>, </span><span>function</span>
246 <var><span>CloseCallback</span></var></span>)</div>
247 <div class="description">
248 <p>Closes an open connection.</p>
249 <!-- PARAMETERS -->
250 <h4>Parameters</h4>
251 <dl>
252 <div>
253 <div>
254 <dt>
255 <var>connectionId</var>
256 <em>
257 <!-- TYPE -->
258 <div style="display:inline">
259 (
260 <span id="typeTemplate">
261 <span>
262 <span>integer</span>
263 </span>
264 </span>
265 )
266 </div>
267 </em>
268 </dt>
269 <dd>The id of the opened connection.</dd>
270 <!-- OBJECT PROPERTIES -->
271 <!-- OBJECT METHODS -->
272 <!-- OBJECT EVENT FIELDS -->
273 <!-- FUNCTION PARAMETERS -->
274 </div>
275 </div><div>
276 <div>
277 <dt>
278 <var>CloseCallback</var>
279 <em>
280 <!-- TYPE -->
281 <div style="display:inline">
282 (
283 <span id="typeTemplate">
284 <span>
285 <span>function</span>
286 </span>
287 </span>
288 )
289 </div>
290 </em>
291 </dt>
292 <dd>Returns true if operation was successful.</dd>
293 <!-- OBJECT PROPERTIES -->
294 <!-- OBJECT METHODS -->
295 <!-- OBJECT EVENT FIELDS -->
296 <!-- FUNCTION PARAMETERS -->
297 <dd>
298 <div>
299 <h5>Parameters</h5>
300 <dl>
301 <div>
302 <div>
303 <dt>
304 <var>result</var>
305 <em>
306 <!-- TYPE -->
307 <div style="display:inline">
308 (
309 <span id="typeTemplate">
310 <span>
311 <span>boolean</span>
312 </span>
313 </span>
314 )
315 </div>
316 </em>
317 </dt>
318 <dd class="todo">
319 Undocumented.
320 </dd>
321 <!-- OBJECT PROPERTIES -->
322 <!-- OBJECT METHODS -->
323 <!-- OBJECT EVENT FIELDS -->
324 <!-- FUNCTION PARAMETERS -->
325 </div>
326 </div>
327 </dl>
328 </div>
329 </dd>
330 </div>
331 </div>
332 </dl>
333 <!-- RETURNS -->
334 <dl>
335 </dl>
336 <!-- CALLBACK -->
337 <!-- MIN_VERSION -->
338 </div> <!-- /description -->
339 </div><div class="apiItem">
340 <a name="method-flush"></a> <!-- method-anchor -->
341 <h4>flush</h4>
342 <div class="summary">
343 <!-- Note: intentionally longer 80 columns -->
344 <span>chrome.experimental.serial.flush</span>(<span class="nul l"><span>integer</span>
345 <var><span>connectionId</span></var></span><span class="nu ll"><span>, </span><span>function</span>
346 <var><span>FlushCallback</span></var></span>)</div>
347 <div class="description">
348 <p>Flushes all bytes in the given connection's input and output buffers.</p>
349 <!-- PARAMETERS -->
350 <h4>Parameters</h4>
351 <dl>
352 <div>
353 <div>
354 <dt>
355 <var>connectionId</var>
356 <em>
357 <!-- TYPE -->
358 <div style="display:inline">
359 (
360 <span id="typeTemplate">
361 <span>
362 <span>integer</span>
363 </span>
364 </span>
365 )
366 </div>
367 </em>
368 </dt>
369 <dd>The id of the connection.</dd>
370 <!-- OBJECT PROPERTIES -->
371 <!-- OBJECT METHODS -->
372 <!-- OBJECT EVENT FIELDS -->
373 <!-- FUNCTION PARAMETERS -->
374 </div>
375 </div><div>
376 <div>
377 <dt>
378 <var>FlushCallback</var>
379 <em>
380 <!-- TYPE -->
381 <div style="display:inline">
382 (
383 <span id="typeTemplate">
384 <span>
385 <span>function</span>
386 </span>
387 </span>
388 )
389 </div>
390 </em>
391 </dt>
392 <dd>Returns true if operation was successful.</dd>
393 <!-- OBJECT PROPERTIES -->
394 <!-- OBJECT METHODS -->
395 <!-- OBJECT EVENT FIELDS -->
396 <!-- FUNCTION PARAMETERS -->
397 <dd>
398 <div>
399 <h5>Parameters</h5>
400 <dl>
401 <div>
402 <div>
403 <dt>
404 <var>result</var>
405 <em>
406 <!-- TYPE -->
407 <div style="display:inline">
408 (
409 <span id="typeTemplate">
410 <span>
411 <span>boolean</span>
412 </span>
413 </span>
414 )
415 </div>
416 </em>
417 </dt>
418 <dd class="todo">
419 Undocumented.
420 </dd>
421 <!-- OBJECT PROPERTIES -->
422 <!-- OBJECT METHODS -->
423 <!-- OBJECT EVENT FIELDS -->
424 <!-- FUNCTION PARAMETERS -->
425 </div>
426 </div>
427 </dl>
428 </div>
429 </dd>
430 </div>
431 </div>
432 </dl>
433 <!-- RETURNS -->
434 <dl>
435 </dl>
436 <!-- CALLBACK -->
437 <!-- MIN_VERSION -->
438 </div> <!-- /description -->
439 </div><div class="apiItem">
440 <a name="method-getControlSignals"></a> <!-- method-anchor -->
441 <h4>getControlSignals</h4>
442 <div class="summary">
443 <!-- Note: intentionally longer 80 columns -->
444 <span>chrome.experimental.serial.getControlSignals</span>(<spa n class="null"><span>integer</span>
445 <var><span>connectionId</span></var></span><span class="nu ll"><span>, </span><span>function</span>
446 <var><span>GetControlSignalsCallback</span></var></span>)< /div>
447 <div class="description">
448 <!-- PARAMETERS -->
449 <h4>Parameters</h4>
450 <dl>
451 <div>
452 <div>
453 <dt>
454 <var>connectionId</var>
455 <em>
456 <!-- TYPE -->
457 <div style="display:inline">
458 (
459 <span id="typeTemplate">
460 <span>
461 <span>integer</span>
462 </span>
463 </span>
464 )
465 </div>
466 </em>
467 </dt>
468 <dd class="todo">
469 Undocumented.
470 </dd>
471 <!-- OBJECT PROPERTIES -->
472 <!-- OBJECT METHODS -->
473 <!-- OBJECT EVENT FIELDS -->
474 <!-- FUNCTION PARAMETERS -->
475 </div>
476 </div><div>
477 <div>
478 <dt>
479 <var>GetControlSignalsCallback</var>
480 <em>
481 <!-- TYPE -->
482 <div style="display:inline">
483 (
484 <span id="typeTemplate">
485 <span>
486 <span>function</span>
487 </span>
488 </span>
489 )
490 </div>
491 </em>
492 </dt>
493 <dd>Returns a snapshot of current control signals.</dd>
494 <!-- OBJECT PROPERTIES -->
495 <!-- OBJECT METHODS -->
496 <!-- OBJECT EVENT FIELDS -->
497 <!-- FUNCTION PARAMETERS -->
498 <dd>
499 <div>
500 <h5>Parameters</h5>
501 <dl>
502 <div>
503 <div>
504 <dt>
505 <var>options</var>
506 <em>
507 <!-- TYPE -->
508 <div style="display:inline">
509 (
510 <span id="typeTemplate">
511 <span>
512 <a href="experimental.serial.html#type-experimental.seri al.ControlSignalOptions">experimental.serial.ControlSignalOptions</a>
513 </span>
514 </span>
515 )
516 </div>
517 </em>
518 </dt>
519 <dd class="todo">
520 Undocumented.
521 </dd>
522 <!-- OBJECT PROPERTIES -->
523 <!-- OBJECT METHODS -->
524 <!-- OBJECT EVENT FIELDS -->
525 <!-- FUNCTION PARAMETERS -->
526 </div>
527 </div>
528 </dl>
529 </div>
530 </dd>
531 </div>
532 </div>
533 </dl>
534 <!-- RETURNS -->
535 <dl>
536 </dl>
537 <!-- CALLBACK -->
538 <!-- MIN_VERSION -->
539 </div> <!-- /description -->
540 </div><div class="apiItem">
541 <a name="method-getPorts"></a> <!-- method-anchor -->
542 <h4>getPorts</h4>
543 <div class="summary">
544 <!-- Note: intentionally longer 80 columns -->
545 <span>chrome.experimental.serial.getPorts</span>(<span class=" null"><span>function</span>
546 <var><span>GetPortsCallback</span></var></span>)</div>
547 <div class="description">
548 <p>Returns names of valid ports on this machine, each of which i s likely to be valid to pass as the port argument to open(). The list is regener ated each time this method is called, as port validity is dynamic.</p>
549 <!-- PARAMETERS -->
550 <h4>Parameters</h4>
551 <dl>
552 <div>
553 <div>
554 <dt>
555 <var>GetPortsCallback</var>
556 <em>
557 <!-- TYPE -->
558 <div style="display:inline">
559 (
560 <span id="typeTemplate">
561 <span>
562 <span>function</span>
563 </span>
564 </span>
565 )
566 </div>
567 </em>
568 </dt>
569 <dd class="todo">
570 Undocumented.
571 </dd>
572 <!-- OBJECT PROPERTIES -->
573 <!-- OBJECT METHODS -->
574 <!-- OBJECT EVENT FIELDS -->
575 <!-- FUNCTION PARAMETERS -->
576 <dd>
577 <div>
578 <h5>Parameters</h5>
579 <dl>
580 <div>
581 <div>
582 <dt>
583 <var>ports</var>
584 <em>
585 <!-- TYPE -->
586 <div style="display:inline">
587 (
588 <span id="typeTemplate">
589 <span>
590 <span>
591 array of <span><span>
592 <span>
593 <span>string</span>
594 </span>
595 </span></span>
596 </span>
597 </span>
598 </span>
599 )
600 </div>
601 </em>
602 </dt>
603 <dd class="todo">
604 Undocumented.
605 </dd>
606 <!-- OBJECT PROPERTIES -->
607 <!-- OBJECT METHODS -->
608 <!-- OBJECT EVENT FIELDS -->
609 <!-- FUNCTION PARAMETERS -->
610 </div>
611 </div>
612 </dl>
613 </div>
614 </dd>
615 </div>
616 </div>
617 </dl>
618 <!-- RETURNS -->
619 <dl>
620 </dl>
621 <!-- CALLBACK -->
622 <!-- MIN_VERSION -->
623 </div> <!-- /description -->
624 </div><div class="apiItem">
625 <a name="method-open"></a> <!-- method-anchor -->
626 <h4>open</h4>
627 <div class="summary">
628 <!-- Note: intentionally longer 80 columns -->
629 <span>chrome.experimental.serial.open</span>(<span class="null "><span>string</span>
630 <var><span>port</span></var></span><span class="optional"> <span>, </span><span>experimental.serial.OpenOptions</span>
631 <var><span>options</span></var></span><span class="null">< span>, </span><span>function</span>
632 <var><span>OpenCallback</span></var></span>)</div>
633 <div class="description">
634 <p>Opens a connection to the given serial port.</p>
635 <!-- PARAMETERS -->
636 <h4>Parameters</h4>
637 <dl>
638 <div>
639 <div>
640 <dt>
641 <var>port</var>
642 <em>
643 <!-- TYPE -->
644 <div style="display:inline">
645 (
646 <span id="typeTemplate">
647 <span>
648 <span>string</span>
649 </span>
650 </span>
651 )
652 </div>
653 </em>
654 </dt>
655 <dd>The name of the serial port to open.</dd>
656 <!-- OBJECT PROPERTIES -->
657 <!-- OBJECT METHODS -->
658 <!-- OBJECT EVENT FIELDS -->
659 <!-- FUNCTION PARAMETERS -->
660 </div>
661 </div><div>
662 <div>
663 <dt>
664 <var>options</var>
665 <em>
666 <!-- TYPE -->
667 <div style="display:inline">
668 (
669 <span class="optional">optional</span>
670 <span id="typeTemplate">
671 <span>
672 <a href="experimental.serial.html#type-experimental.seri al.OpenOptions">experimental.serial.OpenOptions</a>
673 </span>
674 </span>
675 )
676 </div>
677 </em>
678 </dt>
679 <dd>Connection options.</dd>
680 <!-- OBJECT PROPERTIES -->
681 <!-- OBJECT METHODS -->
682 <!-- OBJECT EVENT FIELDS -->
683 <!-- FUNCTION PARAMETERS -->
684 </div>
685 </div><div>
686 <div>
687 <dt>
688 <var>OpenCallback</var>
689 <em>
690 <!-- TYPE -->
691 <div style="display:inline">
692 (
693 <span id="typeTemplate">
694 <span>
695 <span>function</span>
696 </span>
697 </span>
698 )
699 </div>
700 </em>
701 </dt>
702 <dd class="todo">
703 Undocumented.
704 </dd>
705 <!-- OBJECT PROPERTIES -->
706 <!-- OBJECT METHODS -->
707 <!-- OBJECT EVENT FIELDS -->
708 <!-- FUNCTION PARAMETERS -->
709 <dd>
710 <div>
711 <h5>Parameters</h5>
712 <dl>
713 <div>
714 <div>
715 <dt>
716 <var>openInfo</var>
717 <em>
718 <!-- TYPE -->
719 <div style="display:inline">
720 (
721 <span id="typeTemplate">
722 <span>
723 <a href="experimental.serial.html#type-experimental.seri al.OpenInfo">experimental.serial.OpenInfo</a>
724 </span>
725 </span>
726 )
727 </div>
728 </em>
729 </dt>
730 <dd class="todo">
731 Undocumented.
732 </dd>
733 <!-- OBJECT PROPERTIES -->
734 <!-- OBJECT METHODS -->
735 <!-- OBJECT EVENT FIELDS -->
736 <!-- FUNCTION PARAMETERS -->
737 </div>
738 </div>
739 </dl>
740 </div>
741 </dd>
742 </div>
743 </div>
744 </dl>
745 <!-- RETURNS -->
746 <dl>
747 </dl>
748 <!-- CALLBACK -->
749 <!-- MIN_VERSION -->
750 </div> <!-- /description -->
751 </div><div class="apiItem">
752 <a name="method-read"></a> <!-- method-anchor -->
753 <h4>read</h4>
754 <div class="summary">
755 <!-- Note: intentionally longer 80 columns -->
756 <span>chrome.experimental.serial.read</span>(<span class="null "><span>integer</span>
757 <var><span>connectionId</span></var></span><span class="nu ll"><span>, </span><span>integer</span>
758 <var><span>bytesToRead</span></var></span><span class="nul l"><span>, </span><span>function</span>
759 <var><span>ReadCallback</span></var></span>)</div>
760 <div class="description">
761 <p>Reads a byte from the given connection.</p>
762 <!-- PARAMETERS -->
763 <h4>Parameters</h4>
764 <dl>
765 <div>
766 <div>
767 <dt>
768 <var>connectionId</var>
769 <em>
770 <!-- TYPE -->
771 <div style="display:inline">
772 (
773 <span id="typeTemplate">
774 <span>
775 <span>integer</span>
776 </span>
777 </span>
778 )
779 </div>
780 </em>
781 </dt>
782 <dd>The id of the connection.</dd>
783 <!-- OBJECT PROPERTIES -->
784 <!-- OBJECT METHODS -->
785 <!-- OBJECT EVENT FIELDS -->
786 <!-- FUNCTION PARAMETERS -->
787 </div>
788 </div><div>
789 <div>
790 <dt>
791 <var>bytesToRead</var>
792 <em>
793 <!-- TYPE -->
794 <div style="display:inline">
795 (
796 <span id="typeTemplate">
797 <span>
798 <span>integer</span>
799 </span>
800 </span>
801 )
802 </div>
803 </em>
804 </dt>
805 <dd>The number of bytes to read.</dd>
806 <!-- OBJECT PROPERTIES -->
807 <!-- OBJECT METHODS -->
808 <!-- OBJECT EVENT FIELDS -->
809 <!-- FUNCTION PARAMETERS -->
810 </div>
811 </div><div>
812 <div>
813 <dt>
814 <var>ReadCallback</var>
815 <em>
816 <!-- TYPE -->
817 <div style="display:inline">
818 (
819 <span id="typeTemplate">
820 <span>
821 <span>function</span>
822 </span>
823 </span>
824 )
825 </div>
826 </em>
827 </dt>
828 <dd class="todo">
829 Undocumented.
830 </dd>
831 <!-- OBJECT PROPERTIES -->
832 <!-- OBJECT METHODS -->
833 <!-- OBJECT EVENT FIELDS -->
834 <!-- FUNCTION PARAMETERS -->
835 <dd>
836 <div>
837 <h5>Parameters</h5>
838 <dl>
839 <div>
840 <div>
841 <dt>
842 <var>readInfo</var>
843 <em>
844 <!-- TYPE -->
845 <div style="display:inline">
846 (
847 <span id="typeTemplate">
848 <span>
849 <a href="experimental.serial.html#type-experimental.seri al.ReadInfo">experimental.serial.ReadInfo</a>
850 </span>
851 </span>
852 )
853 </div>
854 </em>
855 </dt>
856 <dd class="todo">
857 Undocumented.
858 </dd>
859 <!-- OBJECT PROPERTIES -->
860 <!-- OBJECT METHODS -->
861 <!-- OBJECT EVENT FIELDS -->
862 <!-- FUNCTION PARAMETERS -->
863 </div>
864 </div>
865 </dl>
866 </div>
867 </dd>
868 </div>
869 </div>
870 </dl>
871 <!-- RETURNS -->
872 <dl>
873 </dl>
874 <!-- CALLBACK -->
875 <!-- MIN_VERSION -->
876 </div> <!-- /description -->
877 </div><div class="apiItem">
878 <a name="method-setControlSignals"></a> <!-- method-anchor -->
879 <h4>setControlSignals</h4>
880 <div class="summary">
881 <!-- Note: intentionally longer 80 columns -->
882 <span>chrome.experimental.serial.setControlSignals</span>(<spa n class="null"><span>integer</span>
883 <var><span>connectionId</span></var></span><span class="nu ll"><span>, </span><span>experimental.serial.ControlSignalOptions</span>
884 <var><span>options</span></var></span><span class="null">< span>, </span><span>function</span>
885 <var><span>SetControlSignalsCallback</span></var></span>)< /div>
886 <div class="description">
887 <!-- PARAMETERS -->
888 <h4>Parameters</h4>
889 <dl>
890 <div>
891 <div>
892 <dt>
893 <var>connectionId</var>
894 <em>
895 <!-- TYPE -->
896 <div style="display:inline">
897 (
898 <span id="typeTemplate">
899 <span>
900 <span>integer</span>
901 </span>
902 </span>
903 )
904 </div>
905 </em>
906 </dt>
907 <dd class="todo">
908 Undocumented.
909 </dd>
910 <!-- OBJECT PROPERTIES -->
911 <!-- OBJECT METHODS -->
912 <!-- OBJECT EVENT FIELDS -->
913 <!-- FUNCTION PARAMETERS -->
914 </div>
915 </div><div>
916 <div>
917 <dt>
918 <var>options</var>
919 <em>
920 <!-- TYPE -->
921 <div style="display:inline">
922 (
923 <span id="typeTemplate">
924 <span>
925 <a href="experimental.serial.html#type-experimental.seri al.ControlSignalOptions">experimental.serial.ControlSignalOptions</a>
926 </span>
927 </span>
928 )
929 </div>
930 </em>
931 </dt>
932 <dd class="todo">
933 Undocumented.
934 </dd>
935 <!-- OBJECT PROPERTIES -->
936 <!-- OBJECT METHODS -->
937 <!-- OBJECT EVENT FIELDS -->
938 <!-- FUNCTION PARAMETERS -->
939 </div>
940 </div><div>
941 <div>
942 <dt>
943 <var>SetControlSignalsCallback</var>
944 <em>
945 <!-- TYPE -->
946 <div style="display:inline">
947 (
948 <span id="typeTemplate">
949 <span>
950 <span>function</span>
951 </span>
952 </span>
953 )
954 </div>
955 </em>
956 </dt>
957 <dd>Returns true if operation was successful.</dd>
958 <!-- OBJECT PROPERTIES -->
959 <!-- OBJECT METHODS -->
960 <!-- OBJECT EVENT FIELDS -->
961 <!-- FUNCTION PARAMETERS -->
962 <dd>
963 <div>
964 <h5>Parameters</h5>
965 <dl>
966 <div>
967 <div>
968 <dt>
969 <var>result</var>
970 <em>
971 <!-- TYPE -->
972 <div style="display:inline">
973 (
974 <span id="typeTemplate">
975 <span>
976 <span>boolean</span>
977 </span>
978 </span>
979 )
980 </div>
981 </em>
982 </dt>
983 <dd class="todo">
984 Undocumented.
985 </dd>
986 <!-- OBJECT PROPERTIES -->
987 <!-- OBJECT METHODS -->
988 <!-- OBJECT EVENT FIELDS -->
989 <!-- FUNCTION PARAMETERS -->
990 </div>
991 </div>
992 </dl>
993 </div>
994 </dd>
995 </div>
996 </div>
997 </dl>
998 <!-- RETURNS -->
999 <dl>
1000 </dl>
1001 <!-- CALLBACK -->
1002 <!-- MIN_VERSION -->
1003 </div> <!-- /description -->
1004 </div><div class="apiItem">
1005 <a name="method-write"></a> <!-- method-anchor -->
1006 <h4>write</h4>
1007 <div class="summary">
1008 <!-- Note: intentionally longer 80 columns -->
1009 <span>chrome.experimental.serial.write</span>(<span class="nul l"><span>integer</span>
1010 <var><span>connectionId</span></var></span><span class="nu ll"><span>, </span><span>ArrayBuffer</span>
1011 <var><span>data</span></var></span><span class="null"><spa n>, </span><span>function</span>
1012 <var><span>WriteCallback</span></var></span>)</div>
1013 <div class="description">
1014 <p>Writes a string to the given connection.</p>
1015 <!-- PARAMETERS -->
1016 <h4>Parameters</h4>
1017 <dl>
1018 <div>
1019 <div>
1020 <dt>
1021 <var>connectionId</var>
1022 <em>
1023 <!-- TYPE -->
1024 <div style="display:inline">
1025 (
1026 <span id="typeTemplate">
1027 <span>
1028 <span>integer</span>
1029 </span>
1030 </span>
1031 )
1032 </div>
1033 </em>
1034 </dt>
1035 <dd>The id of the connection.</dd>
1036 <!-- OBJECT PROPERTIES -->
1037 <!-- OBJECT METHODS -->
1038 <!-- OBJECT EVENT FIELDS -->
1039 <!-- FUNCTION PARAMETERS -->
1040 </div>
1041 </div><div>
1042 <div>
1043 <dt>
1044 <var>data</var>
1045 <em>
1046 <!-- TYPE -->
1047 <div style="display:inline">
1048 (
1049 <span id="typeTemplate">
1050 <span>
1051 <span>ArrayBuffer</span>
1052 </span>
1053 </span>
1054 )
1055 </div>
1056 </em>
1057 </dt>
1058 <dd>The string to write.</dd>
1059 <!-- OBJECT PROPERTIES -->
1060 <!-- OBJECT METHODS -->
1061 <!-- OBJECT EVENT FIELDS -->
1062 <!-- FUNCTION PARAMETERS -->
1063 </div>
1064 </div><div>
1065 <div>
1066 <dt>
1067 <var>WriteCallback</var>
1068 <em>
1069 <!-- TYPE -->
1070 <div style="display:inline">
1071 (
1072 <span id="typeTemplate">
1073 <span>
1074 <span>function</span>
1075 </span>
1076 </span>
1077 )
1078 </div>
1079 </em>
1080 </dt>
1081 <dd class="todo">
1082 Undocumented.
1083 </dd>
1084 <!-- OBJECT PROPERTIES -->
1085 <!-- OBJECT METHODS -->
1086 <!-- OBJECT EVENT FIELDS -->
1087 <!-- FUNCTION PARAMETERS -->
1088 <dd>
1089 <div>
1090 <h5>Parameters</h5>
1091 <dl>
1092 <div>
1093 <div>
1094 <dt>
1095 <var>writeInfo</var>
1096 <em>
1097 <!-- TYPE -->
1098 <div style="display:inline">
1099 (
1100 <span id="typeTemplate">
1101 <span>
1102 <a href="experimental.serial.html#type-experimental.seri al.WriteInfo">experimental.serial.WriteInfo</a>
1103 </span>
1104 </span>
1105 )
1106 </div>
1107 </em>
1108 </dt>
1109 <dd class="todo">
1110 Undocumented.
1111 </dd>
1112 <!-- OBJECT PROPERTIES -->
1113 <!-- OBJECT METHODS -->
1114 <!-- OBJECT EVENT FIELDS -->
1115 <!-- FUNCTION PARAMETERS -->
1116 </div>
1117 </div>
1118 </dl>
1119 </div>
1120 </dd>
1121 </div>
1122 </div>
1123 </dl>
1124 <!-- RETURNS -->
1125 <dl>
1126 </dl>
1127 <!-- CALLBACK -->
1128 <!-- MIN_VERSION -->
1129 </div> <!-- /description -->
1130 </div> <!-- /apiItem -->
1131 </div> <!-- /apiGroup -->
1132 <!-- EVENTS -->
1133 <!-- /apiGroup -->
1134 <!-- TYPES -->
1135 <div class="apiGroup">
1136 <a name="types"></a>
1137 <h3 id="types">Types</h3>
1138 <!-- iterates over all types -->
1139 <div class="apiItem">
1140 <a name="type-experimental.serial.OpenOptions"></a>
1141 <h4>experimental.serial.OpenOptions</h4>
1142 <div>
1143 <dt>
1144 <em>
1145 <!-- TYPE -->
1146 <div style="display:inline">
1147 (
1148 <span id="typeTemplate">
1149 <span>
1150 <span>object</span>
1151 </span>
1152 </span>
1153 )
1154 </div>
1155 </em>
1156 </dt>
1157 <dd class="todo">
1158 Undocumented.
1159 </dd>
1160 <!-- OBJECT PROPERTIES -->
1161 <dd>
1162 <dl>
1163 <div>
1164 <div>
1165 <dt>
1166 <var>bitrate</var>
1167 <em>
1168 <!-- TYPE -->
1169 <div style="display:inline">
1170 (
1171 <span id="typeTemplate">
1172 <span>
1173 <span>integer</span>
1174 </span>
1175 </span>
1176 )
1177 </div>
1178 </em>
1179 </dt>
1180 <dd>The requested bitrate of the connection to be opened. For compatib ility with the widest range of hardware, this number should match one of commonl y-available bitrates, such as 110, 300, 1200, 2400, 4800, 9600, 14400, 19200, 38 400, 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 s upports that bitrate.</dd>
1181 <!-- OBJECT PROPERTIES -->
1182 <!-- OBJECT METHODS -->
1183 <!-- OBJECT EVENT FIELDS -->
1184 <!-- FUNCTION PARAMETERS -->
1185 </div>
1186 </div>
1187 </dl>
1188 </dd>
1189 <!-- OBJECT METHODS -->
1190 <!-- OBJECT EVENT FIELDS -->
1191 <!-- FUNCTION PARAMETERS -->
1192 </div>
1193 </div><div class="apiItem">
1194 <a name="type-experimental.serial.OpenInfo"></a>
1195 <h4>experimental.serial.OpenInfo</h4>
1196 <div>
1197 <dt>
1198 <em>
1199 <!-- TYPE -->
1200 <div style="display:inline">
1201 (
1202 <span id="typeTemplate">
1203 <span>
1204 <span>object</span>
1205 </span>
1206 </span>
1207 )
1208 </div>
1209 </em>
1210 </dt>
1211 <dd class="todo">
1212 Undocumented.
1213 </dd>
1214 <!-- OBJECT PROPERTIES -->
1215 <dd>
1216 <dl>
1217 <div>
1218 <div>
1219 <dt>
1220 <var>connectionId</var>
1221 <em>
1222 <!-- TYPE -->
1223 <div style="display:inline">
1224 (
1225 <span id="typeTemplate">
1226 <span>
1227 <span>integer</span>
1228 </span>
1229 </span>
1230 )
1231 </div>
1232 </em>
1233 </dt>
1234 <dd>The id of the opened connection.</dd>
1235 <!-- OBJECT PROPERTIES -->
1236 <!-- OBJECT METHODS -->
1237 <!-- OBJECT EVENT FIELDS -->
1238 <!-- FUNCTION PARAMETERS -->
1239 </div>
1240 </div>
1241 </dl>
1242 </dd>
1243 <!-- OBJECT METHODS -->
1244 <!-- OBJECT EVENT FIELDS -->
1245 <!-- FUNCTION PARAMETERS -->
1246 </div>
1247 </div><div class="apiItem">
1248 <a name="type-experimental.serial.ReadInfo"></a>
1249 <h4>experimental.serial.ReadInfo</h4>
1250 <div>
1251 <dt>
1252 <em>
1253 <!-- TYPE -->
1254 <div style="display:inline">
1255 (
1256 <span id="typeTemplate">
1257 <span>
1258 <span>object</span>
1259 </span>
1260 </span>
1261 )
1262 </div>
1263 </em>
1264 </dt>
1265 <dd class="todo">
1266 Undocumented.
1267 </dd>
1268 <!-- OBJECT PROPERTIES -->
1269 <dd>
1270 <dl>
1271 <div>
1272 <div>
1273 <dt>
1274 <var>bytesRead</var>
1275 <em>
1276 <!-- TYPE -->
1277 <div style="display:inline">
1278 (
1279 <span id="typeTemplate">
1280 <span>
1281 <span>integer</span>
1282 </span>
1283 </span>
1284 )
1285 </div>
1286 </em>
1287 </dt>
1288 <dd>The number of bytes received, or a negative number if an error occ urred. This number will be smaller than the number of bytes requested in the ori ginal read call if the call would need to block to read that number of bytes.</d d>
1289 <!-- OBJECT PROPERTIES -->
1290 <!-- OBJECT METHODS -->
1291 <!-- OBJECT EVENT FIELDS -->
1292 <!-- FUNCTION PARAMETERS -->
1293 </div>
1294 </div><div>
1295 <div>
1296 <dt>
1297 <var>data</var>
1298 <em>
1299 <!-- TYPE -->
1300 <div style="display:inline">
1301 (
1302 <span id="typeTemplate">
1303 <span>
1304 <span>ArrayBuffer</span>
1305 </span>
1306 </span>
1307 )
1308 </div>
1309 </em>
1310 </dt>
1311 <dd>The data received.</dd>
1312 <!-- OBJECT PROPERTIES -->
1313 <!-- OBJECT METHODS -->
1314 <!-- OBJECT EVENT FIELDS -->
1315 <!-- FUNCTION PARAMETERS -->
1316 </div>
1317 </div>
1318 </dl>
1319 </dd>
1320 <!-- OBJECT METHODS -->
1321 <!-- OBJECT EVENT FIELDS -->
1322 <!-- FUNCTION PARAMETERS -->
1323 </div>
1324 </div><div class="apiItem">
1325 <a name="type-experimental.serial.WriteInfo"></a>
1326 <h4>experimental.serial.WriteInfo</h4>
1327 <div>
1328 <dt>
1329 <em>
1330 <!-- TYPE -->
1331 <div style="display:inline">
1332 (
1333 <span id="typeTemplate">
1334 <span>
1335 <span>object</span>
1336 </span>
1337 </span>
1338 )
1339 </div>
1340 </em>
1341 </dt>
1342 <dd class="todo">
1343 Undocumented.
1344 </dd>
1345 <!-- OBJECT PROPERTIES -->
1346 <dd>
1347 <dl>
1348 <div>
1349 <div>
1350 <dt>
1351 <var>bytesWritten</var>
1352 <em>
1353 <!-- TYPE -->
1354 <div style="display:inline">
1355 (
1356 <span id="typeTemplate">
1357 <span>
1358 <span>integer</span>
1359 </span>
1360 </span>
1361 )
1362 </div>
1363 </em>
1364 </dt>
1365 <dd>The number of bytes written.</dd>
1366 <!-- OBJECT PROPERTIES -->
1367 <!-- OBJECT METHODS -->
1368 <!-- OBJECT EVENT FIELDS -->
1369 <!-- FUNCTION PARAMETERS -->
1370 </div>
1371 </div>
1372 </dl>
1373 </dd>
1374 <!-- OBJECT METHODS -->
1375 <!-- OBJECT EVENT FIELDS -->
1376 <!-- FUNCTION PARAMETERS -->
1377 </div>
1378 </div><div class="apiItem">
1379 <a name="type-experimental.serial.ControlSignalOptions"></a>
1380 <h4>experimental.serial.ControlSignalOptions</h4>
1381 <div>
1382 <dt>
1383 <em>
1384 <!-- TYPE -->
1385 <div style="display:inline">
1386 (
1387 <span id="typeTemplate">
1388 <span>
1389 <span>object</span>
1390 </span>
1391 </span>
1392 )
1393 </div>
1394 </em>
1395 </dt>
1396 <dd class="todo">
1397 Undocumented.
1398 </dd>
1399 <!-- OBJECT PROPERTIES -->
1400 <dd>
1401 <dl>
1402 <div>
1403 <div>
1404 <dt>
1405 <var>cts</var>
1406 <em>
1407 <!-- TYPE -->
1408 <div style="display:inline">
1409 (
1410 <span class="optional">optional</span>
1411 <span id="typeTemplate">
1412 <span>
1413 <span>boolean</span>
1414 </span>
1415 </span>
1416 )
1417 </div>
1418 </em>
1419 </dt>
1420 <dd class="todo">
1421 Undocumented.
1422 </dd>
1423 <!-- OBJECT PROPERTIES -->
1424 <!-- OBJECT METHODS -->
1425 <!-- OBJECT EVENT FIELDS -->
1426 <!-- FUNCTION PARAMETERS -->
1427 </div>
1428 </div><div>
1429 <div>
1430 <dt>
1431 <var>dcd</var>
1432 <em>
1433 <!-- TYPE -->
1434 <div style="display:inline">
1435 (
1436 <span class="optional">optional</span>
1437 <span id="typeTemplate">
1438 <span>
1439 <span>boolean</span>
1440 </span>
1441 </span>
1442 )
1443 </div>
1444 </em>
1445 </dt>
1446 <dd>Serial control signals that your machine can receive. If a get ope ration 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 platf orms.</dd>
1447 <!-- OBJECT PROPERTIES -->
1448 <!-- OBJECT METHODS -->
1449 <!-- OBJECT EVENT FIELDS -->
1450 <!-- FUNCTION PARAMETERS -->
1451 </div>
1452 </div><div>
1453 <div>
1454 <dt>
1455 <var>dtr</var>
1456 <em>
1457 <!-- TYPE -->
1458 <div style="display:inline">
1459 (
1460 <span class="optional">optional</span>
1461 <span id="typeTemplate">
1462 <span>
1463 <span>boolean</span>
1464 </span>
1465 </span>
1466 )
1467 </div>
1468 </em>
1469 </dt>
1470 <dd>Serial control signals that your machine can send. Missing fields will be set to false.</dd>
1471 <!-- OBJECT PROPERTIES -->
1472 <!-- OBJECT METHODS -->
1473 <!-- OBJECT EVENT FIELDS -->
1474 <!-- FUNCTION PARAMETERS -->
1475 </div>
1476 </div><div>
1477 <div>
1478 <dt>
1479 <var>rts</var>
1480 <em>
1481 <!-- TYPE -->
1482 <div style="display:inline">
1483 (
1484 <span class="optional">optional</span>
1485 <span id="typeTemplate">
1486 <span>
1487 <span>boolean</span>
1488 </span>
1489 </span>
1490 )
1491 </div>
1492 </em>
1493 </dt>
1494 <dd class="todo">
1495 Undocumented.
1496 </dd>
1497 <!-- OBJECT PROPERTIES -->
1498 <!-- OBJECT METHODS -->
1499 <!-- OBJECT EVENT FIELDS -->
1500 <!-- FUNCTION PARAMETERS -->
1501 </div>
1502 </div>
1503 </dl>
1504 </dd>
1505 <!-- OBJECT METHODS -->
1506 <!-- OBJECT EVENT FIELDS -->
1507 <!-- FUNCTION PARAMETERS -->
1508 </div>
1509 </div> <!-- /apiItem -->
1510 </div> <!-- /apiGroup -->
1511 </div> <!-- /apiPage -->
1512 </div> <!-- /gc-pagecontent --> 169 </div> <!-- /gc-pagecontent -->
1513 </div> <!-- /g-section --> 170 </div> <!-- /g-section -->
1514 </div> <!-- /codesiteContent --> 171 </div> <!-- /codesiteContent -->
1515 <div id="gc-footer" --=""> 172 <div id="gc-footer" --="">
1516 <div class="text"> 173 <div class="text">
1517 <p> 174 <p>
1518 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>, 175 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1519 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons 176 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1520 Attribution 3.0 License</a>, and code samples are licensed under the 177 Attribution 3.0 License</a>, and code samples are licensed under the
1521 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>. 178 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
(...skipping 26 matching lines...) Expand all
1548 _uff=0; 205 _uff=0;
1549 urchinTracker(); 206 urchinTracker();
1550 } 207 }
1551 catch(e) {/* urchinTracker not available. */} 208 catch(e) {/* urchinTracker not available. */}
1552 </script> 209 </script>
1553 <!-- end analytics --> 210 <!-- end analytics -->
1554 </div> 211 </div>
1555 </div> <!-- /gc-footer --> 212 </div> <!-- /gc-footer -->
1556 </div> <!-- /gc-container --> 213 </div> <!-- /gc-container -->
1557 </body></html> 214 </body></html>
OLDNEW
« chrome/common/extensions/api/_permission_features.json ('K') | « chrome/common/extensions/docs/apps/experimental.html ('k') | chrome/common/extensions/docs/examples/api/notifications.zip » ('j') | chrome/common/extensions/permissions/api_permission.cc » ('J')

Powered by Google App Engine
This is Rietveld 408576698