File: Devices.html

package info (click to toggle)
brltty 6.8-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 35,776 kB
  • sloc: ansic: 150,447; java: 13,484; sh: 9,667; xml: 5,702; tcl: 2,634; makefile: 2,328; awk: 713; lisp: 366; python: 321; ml: 301
file content (738 lines) | stat: -rw-r--r-- 25,455 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="Docutils 0.20.1: https://docutils.sourceforge.io/" />
<title>Device Identifiers</title>
<style type="text/css">

/*
:Author: David Goodger (goodger@python.org)
:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
:Copyright: This stylesheet has been placed in the public domain.

Default cascading style sheet for the HTML output of Docutils.

See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
customize this style sheet.
*/

/* used to remove borders from tables and images */
.borderless, table.borderless td, table.borderless th {
  border: 0 }

table.borderless td, table.borderless th {
  /* Override padding for "table.docutils td" with "! important".
     The right padding separates the table cells. */
  padding: 0 0.5em 0 0 ! important }

.first {
  /* Override more specific margin styles with "! important". */
  margin-top: 0 ! important }

.last, .with-subtitle {
  margin-bottom: 0 ! important }

.hidden {
  display: none }

.subscript {
  vertical-align: sub;
  font-size: smaller }

.superscript {
  vertical-align: super;
  font-size: smaller }

a.toc-backref {
  text-decoration: none ;
  color: black }

blockquote.epigraph {
  margin: 2em 5em ; }

dl.docutils dd {
  margin-bottom: 0.5em }

object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  overflow: hidden;
}

/* Uncomment (and remove this text!) to get bold-faced definition list terms
dl.docutils dt {
  font-weight: bold }
*/

div.abstract {
  margin: 2em 5em }

div.abstract p.topic-title {
  font-weight: bold ;
  text-align: center }

div.admonition, div.attention, div.caution, div.danger, div.error,
div.hint, div.important, div.note, div.tip, div.warning {
  margin: 2em ;
  border: medium outset ;
  padding: 1em }

div.admonition p.admonition-title, div.hint p.admonition-title,
div.important p.admonition-title, div.note p.admonition-title,
div.tip p.admonition-title {
  font-weight: bold ;
  font-family: sans-serif }

div.attention p.admonition-title, div.caution p.admonition-title,
div.danger p.admonition-title, div.error p.admonition-title,
div.warning p.admonition-title, .code .error {
  color: red ;
  font-weight: bold ;
  font-family: sans-serif }

/* Uncomment (and remove this text!) to get reduced vertical space in
   compound paragraphs.
div.compound .compound-first, div.compound .compound-middle {
  margin-bottom: 0.5em }

div.compound .compound-last, div.compound .compound-middle {
  margin-top: 0.5em }
*/

div.dedication {
  margin: 2em 5em ;
  text-align: center ;
  font-style: italic }

div.dedication p.topic-title {
  font-weight: bold ;
  font-style: normal }

div.figure {
  margin-left: 2em ;
  margin-right: 2em }

div.footer, div.header {
  clear: both;
  font-size: smaller }

div.line-block {
  display: block ;
  margin-top: 1em ;
  margin-bottom: 1em }

div.line-block div.line-block {
  margin-top: 0 ;
  margin-bottom: 0 ;
  margin-left: 1.5em }

div.sidebar {
  margin: 0 0 0.5em 1em ;
  border: medium outset ;
  padding: 1em ;
  background-color: #ffffee ;
  width: 40% ;
  float: right ;
  clear: right }

div.sidebar p.rubric {
  font-family: sans-serif ;
  font-size: medium }

div.system-messages {
  margin: 5em }

div.system-messages h1 {
  color: red }

div.system-message {
  border: medium outset ;
  padding: 1em }

div.system-message p.system-message-title {
  color: red ;
  font-weight: bold }

div.topic {
  margin: 2em }

h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  margin-top: 0.4em }

h1.title {
  text-align: center }

h2.subtitle {
  text-align: center }

hr.docutils {
  width: 75% }

img.align-left, .figure.align-left, object.align-left, table.align-left {
  clear: left ;
  float: left ;
  margin-right: 1em }

img.align-right, .figure.align-right, object.align-right, table.align-right {
  clear: right ;
  float: right ;
  margin-left: 1em }

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

table.align-center {
  margin-left: auto;
  margin-right: auto;
}

.align-left {
  text-align: left }

.align-center {
  clear: both ;
  text-align: center }

.align-right {
  text-align: right }

/* reset inner alignment in figures */
div.align-right {
  text-align: inherit }

/* div.align-center * { */
/*   text-align: left } */

.align-top    {
  vertical-align: top }

.align-middle {
  vertical-align: middle }

.align-bottom {
  vertical-align: bottom }

ol.simple, ul.simple {
  margin-bottom: 1em }

ol.arabic {
  list-style: decimal }

ol.loweralpha {
  list-style: lower-alpha }

ol.upperalpha {
  list-style: upper-alpha }

ol.lowerroman {
  list-style: lower-roman }

ol.upperroman {
  list-style: upper-roman }

p.attribution {
  text-align: right ;
  margin-left: 50% }

p.caption {
  font-style: italic }

p.credits {
  font-style: italic ;
  font-size: smaller }

p.label {
  white-space: nowrap }

p.rubric {
  font-weight: bold ;
  font-size: larger ;
  color: maroon ;
  text-align: center }

p.sidebar-title {
  font-family: sans-serif ;
  font-weight: bold ;
  font-size: larger }

p.sidebar-subtitle {
  font-family: sans-serif ;
  font-weight: bold }

p.topic-title {
  font-weight: bold }

pre.address {
  margin-bottom: 0 ;
  margin-top: 0 ;
  font: inherit }

pre.literal-block, pre.doctest-block, pre.math, pre.code {
  margin-left: 2em ;
  margin-right: 2em }

pre.code .ln { color: grey; } /* line numbers */
pre.code, code { background-color: #eeeeee }
pre.code .comment, code .comment { color: #5C6576 }
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
pre.code .literal.string, code .literal.string { color: #0C5404 }
pre.code .name.builtin, code .name.builtin { color: #352B84 }
pre.code .deleted, code .deleted { background-color: #DEB0A1}
pre.code .inserted, code .inserted { background-color: #A3D289}

span.classifier {
  font-family: sans-serif ;
  font-style: oblique }

span.classifier-delimiter {
  font-family: sans-serif ;
  font-weight: bold }

span.interpreted {
  font-family: sans-serif }

span.option {
  white-space: nowrap }

span.pre {
  white-space: pre }

span.problematic {
  color: red }

span.section-subtitle {
  /* font-size relative to parent (h1..h6 element) */
  font-size: 80% }

table.citation {
  border-left: solid 1px gray;
  margin-left: 1px }

table.docinfo {
  margin: 2em 4em }

table.docutils {
  margin-top: 0.5em ;
  margin-bottom: 0.5em }

table.footnote {
  border-left: solid 1px black;
  margin-left: 1px }

table.docutils td, table.docutils th,
table.docinfo td, table.docinfo th {
  padding-left: 0.5em ;
  padding-right: 0.5em ;
  vertical-align: top }

table.docutils th.field-name, table.docinfo th.docinfo-name {
  font-weight: bold ;
  text-align: left ;
  white-space: nowrap ;
  padding-left: 0 }

/* "booktabs" style (no vertical lines) */
table.docutils.booktabs {
  border: 0px;
  border-top: 2px solid;
  border-bottom: 2px solid;
  border-collapse: collapse;
}
table.docutils.booktabs * {
  border: 0px;
}
table.docutils.booktabs th {
  border-bottom: thin solid;
  text-align: left;
}

h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  font-size: 100% }

ul.auto-toc {
  list-style-type: none }

</style>
</head>
<body>
<div class="document" id="device-identifiers">
<h1 class="title">Device Identifiers</h1>

<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#description" id="toc-entry-1">Description</a><ul>
<li><a class="reference internal" href="#serial-device-identifiers" id="toc-entry-2">Serial Device Identifiers</a></li>
<li><a class="reference internal" href="#usb-device-identifiers" id="toc-entry-3">USB Device Identifiers</a></li>
<li><a class="reference internal" href="#bluetooth-device-identifiers" id="toc-entry-4">Bluetooth Device Identifiers</a></li>
<li><a class="reference internal" href="#hid-device-identifiers" id="toc-entry-5">HID Device Identifiers</a></li>
<li><a class="reference internal" href="#null-device-identifiers" id="toc-entry-6">Null Device Identifiers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="description">
<h2><a class="toc-backref" href="#toc-entry-1">Description</a></h2>
<p>The general syntax of a device identifier is:</p>
<pre class="literal-block">
qualifier:parameter=value+...
</pre>
<p>More specifically, with [brackets] meaning optional, the syntax is:</p>
<pre class="literal-block">
[qualifier:][parameter=]value[+parameter=value]...
</pre>
<p>The qualifier specifies which class of device is being identified.
It is separated from the rest of the device identifier by a colon (<tt class="docutils literal">:</tt>).
It may be one of:</p>
<blockquote>
<table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="70%" />
</colgroup>
<tbody valign="top">
<tr><td>Qualifier</td>
<td>Assumed First Parameter</td>
</tr>
<tr><td>serial:</td>
<td>name=</td>
</tr>
<tr><td>usb:</td>
<td>serialNumber=</td>
</tr>
<tr><td>bluetooth:</td>
<td>address=</td>
</tr>
<tr><td>hid:</td>
<td>address=</td>
</tr>
<tr><td>null:</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>
</blockquote>
<p>The qualifier is case insensitive, and any abbreviation may be used.
For backward compatibility (to when a device identifier was
strictly interpreted as the absolute path to a serial device),
the qualifier (along with its colon delimiter) is optional,
and, if it isn't supplied, <tt class="docutils literal">serial</tt> is assumed.</p>
<p>One or more parameters may be supplied after the qualifier.
Each parameter is specified as its name and its value,
in that order, separated by an equals (<tt class="docutils literal">=</tt>) sign.
Parameters are separated from one another by a plus (<tt class="docutils literal">+</tt>) sign.
Parameter names are case insensitive, and any abbreviation may be used.
Supplying a zero-length value means to use the parameter's default value.</p>
<p>For backward compatibility
(to when device identifier parameters weren't supported),
the first supplied parameter is special
in that its name (along with its equals sign delimiter) is optional.
If the name of the first parameter isn't supplied then the
class-dependent parameter that most specifically identifies the device is assumed.
See the table above for which parameter is assumed for each class.</p>
<p>It isn't possible to supply no parameters at all.
Specifying only the qualifier is equivalent to also specifying
a zero-length value for the assumed first parameter for that class.
For example, specifying <tt class="docutils literal">usb:</tt> is equivalent to specifying <tt class="docutils literal">usb:serialNumber=</tt>.</p>
<p>An example to illustrate the optionality of both the qualifier
and the name of the first supplied parameter:</p>
<ul>
<li><p class="first">On Linux, the name of the first serial device is <tt class="docutils literal">ttyS0</tt>.
All of the following device identifiers refer to the same serial device:</p>
<pre class="literal-block">
serial:name=ttyS0
serial:ttyS0
ttyS0
name=ttyS0
</pre>
</li>
</ul>
<div class="section" id="serial-device-identifiers">
<h3><a class="toc-backref" href="#toc-entry-2">Serial Device Identifiers</a></h3>
<p>Serial device identifiers support the following parameters:</p>
<blockquote>
<table border="1" class="docutils">
<colgroup>
<col width="21%" />
<col width="79%" />
</colgroup>
<tbody valign="top">
<tr><td>Name</td>
<td>Value</td>
</tr>
<tr><td><tt class="docutils literal">name</tt></td>
<td>name of, relative path to, or absolute path to the device</td>
</tr>
<tr><td><tt class="docutils literal">baud</tt></td>
<td>the data transmission/reception rate (bits per second)</td>
</tr>
<tr><td><tt class="docutils literal">dataBits</tt></td>
<td>the number of data bits per character</td>
</tr>
<tr><td><tt class="docutils literal">stopBits</tt></td>
<td>the number of stop bits per character</td>
</tr>
<tr><td><tt class="docutils literal">parity</tt></td>
<td><tt class="docutils literal">none</tt>, <tt class="docutils literal">odd</tt>, <tt class="docutils literal">even</tt>, <tt class="docutils literal">space</tt>, <tt class="docutils literal">mark</tt></td>
</tr>
<tr><td><tt class="docutils literal">flowControl</tt></td>
<td><tt class="docutils literal">none</tt>, <tt class="docutils literal">hardware</tt></td>
</tr>
</tbody>
</table>
</blockquote>
<p>All of the parameters are optional,
although the <tt class="docutils literal">name=</tt> parameter should be supplied.
It shouldn't normally be necessary to supply any of the others,
especially since, in most cases, the braille driver overrides them.</p>
<dl class="docutils">
<dt><tt class="docutils literal">name=</tt></dt>
<dd>Specify the host device to use. It must be the name of the device, the
relative path to the device, or the absolute path to the device. If it's either
a name or a relative path then the host's device directory (usually <tt class="docutils literal">/dev</tt>
on Unix-based platforms) is used. If this parameter isn't supplied then the
primary (first) serial device is assumed.</dd>
<dt><tt class="docutils literal">baud=</tt></dt>
<dd>Specify the speed, in bits per second, at which to communicate with the
device. It must be a positive integer. Typical values are: <tt class="docutils literal">9600</tt>, <tt class="docutils literal">19200</tt>,
<tt class="docutils literal">38400</tt>, <tt class="docutils literal">57600</tt>, <tt class="docutils literal">115200</tt>. If this parameter isn't supplied then
<tt class="docutils literal">9600</tt> is assumed.</dd>
<dt><tt class="docutils literal">dataBits=</tt></dt>
<dd>Specify the number of bits to use to represent a character, not including
any metadata (start bit, stop bit(s), parity, etc). It must be a positive integer,
and is usually within the range <tt class="docutils literal">5</tt>-<tt class="docutils literal">8</tt>. If this parameter isn't
supplied then <tt class="docutils literal">8</tt> is assumed.</dd>
<dt><tt class="docutils literal">stopBits=</tt></dt>
<dd>Specify the number of stop bits to inject after a character has been
transmitted and to expect after a character has been received. It must be
a positive integer, and is usually either <tt class="docutils literal">1</tt> (for higher speeds) or <tt class="docutils literal">2</tt> (for
lower speeds). If this parameter isn't supplied then <tt class="docutils literal">1</tt> is assumed.</dd>
<dt><tt class="docutils literal">parity=</tt></dt>
<dd>Specify the type of error detection to use. It must be one of: <tt class="docutils literal">none</tt>,
<tt class="docutils literal">odd</tt>, <tt class="docutils literal">even</tt>, <tt class="docutils literal">space</tt>, <tt class="docutils literal">mark</tt>. If this parameter isn't supplied
then <tt class="docutils literal">none</tt> is assumed.</dd>
<dt><tt class="docutils literal">flowControl=</tt></dt>
<dd>Specify the kind of flow control to use. It must be one of: <tt class="docutils literal">none</tt>,
<tt class="docutils literal">hardware</tt>. If this parameter isn't supplied then <tt class="docutils literal">none</tt> is assumed.</dd>
</dl>
</div>
<div class="section" id="usb-device-identifiers">
<h3><a class="toc-backref" href="#toc-entry-3">USB Device Identifiers</a></h3>
<p>USB device identifiers support the following parameters:</p>
<blockquote>
<table border="1" class="docutils">
<colgroup>
<col width="30%" />
<col width="70%" />
</colgroup>
<tbody valign="top">
<tr><td>Name</td>
<td>Value</td>
</tr>
<tr><td><tt class="docutils literal">serialNumber=</tt></td>
<td>one or more arbitrary characters</td>
</tr>
<tr><td><tt class="docutils literal">vendorIdentifier=</tt></td>
<td>an integer within the range 1-65535 (0X0001-0XFFFF)</td>
</tr>
<tr><td><tt class="docutils literal">productIdentifier=</tt></td>
<td>an integer within the range 1-65535 (0X0001-0XFFFF)</td>
</tr>
<tr><td><tt class="docutils literal">genericDevices=</tt></td>
<td><tt class="docutils literal">yes</tt>, <tt class="docutils literal">no</tt></td>
</tr>
</tbody>
</table>
</blockquote>
<p>All of the parameters are optional. It shouldn't normally be necessary to
supply any of them.</p>
<dl class="docutils">
<dt><tt class="docutils literal">serialNumber=</tt></dt>
<dd>Specify the serial number that the device must have. The match is case
sensitive and must be exact. If this parameter isn't supplied then the
serial number of the device isn't verified.</dd>
<dt><tt class="docutils literal">vendorIdentifier=</tt></dt>
<dd>Specify the vendor identifier that the device must have. It must be an
integer within the range <tt class="docutils literal">1</tt>-<tt class="docutils literal">65535</tt> (or, in hexadecimal,
<tt class="docutils literal">0X0001</tt>-<tt class="docutils literal">0XFFFF</tt>). If this parameter isn't supplied then the vendor
identifier of the device isn't verified.</dd>
<dt><tt class="docutils literal">productIdentifier=</tt></dt>
<dd>Specify the product identifier that the device must have. It must be an
integer within the range <tt class="docutils literal">1</tt>-<tt class="docutils literal">65535</tt> (or, in hexadecimal,
<tt class="docutils literal">0X0001</tt>-<tt class="docutils literal">0XFFFF</tt>). If this parameter isn't supplied then the product
identifier of the device isn't verified.</dd>
<dt><tt class="docutils literal">genericDevices=</tt></dt>
<dd>Specify whether or not a device that has a generic vendor/product identifier
pair may be used. It's value must be either <tt class="docutils literal">yes</tt> or <tt class="docutils literal">no</tt>. The check is
case insensitive, and any abbreviation may be used. If this parameter isn't
supplied then <tt class="docutils literal">yes</tt> is assumed.</dd>
</dl>
</div>
<div class="section" id="bluetooth-device-identifiers">
<h3><a class="toc-backref" href="#toc-entry-4">Bluetooth Device Identifiers</a></h3>
<p>Bluetooth device identifiers support the following parameters:</p>
<blockquote>
<table border="1" class="docutils">
<colgroup>
<col width="18%" />
<col width="82%" />
</colgroup>
<tbody valign="top">
<tr><td>Name</td>
<td>Value</td>
</tr>
<tr><td><tt class="docutils literal">address=</tt></td>
<td>six two-digit hexadecimal numbers separated by <tt class="docutils literal">:</tt> or <tt class="docutils literal">-</tt></td>
</tr>
<tr><td><tt class="docutils literal">name=</tt></td>
<td>one or more arbitrary characters</td>
</tr>
<tr><td><tt class="docutils literal">channel=</tt></td>
<td>an integer within the range <tt class="docutils literal">1</tt>-<tt class="docutils literal">30</tt></td>
</tr>
<tr><td><tt class="docutils literal">discover=</tt></td>
<td><tt class="docutils literal">yes</tt>, <tt class="docutils literal">no</tt></td>
</tr>
<tr><td><tt class="docutils literal">timeout=</tt></td>
<td>an integer within the range <tt class="docutils literal">1</tt>-<tt class="docutils literal">59</tt></td>
</tr>
</tbody>
</table>
</blockquote>
<p>All of the parameters are optional except that
the <tt class="docutils literal">address=</tt> parameter is required on platforms where
BRLTTY can't yet detect a Bluetooth device based on its name.
It shouldn't normally be necessary to supply any of the others.</p>
<p>BRLTTY can detect a Bluetooth device by name on the following platforms:</p>
<ul class="simple">
<li>Android</li>
<li>Linux (if the Bluetooth version is at least 5)</li>
<li>Windows</li>
</ul>
<dl class="docutils">
<dt><tt class="docutils literal">address=</tt></dt>
<dd>Specify the MAC address of the device. It must be six two-digit
hexadecimal numbers (the &quot;letter&quot; digits may be in either case) separated
from one another by either a colon (<tt class="docutils literal">:</tt>) or a minus (<tt class="docutils literal">-</tt>) sign.</dd>
<dt><tt class="docutils literal">name=</tt></dt>
<dd>Specify the name of the device. It must be one or more
arbitrary characters. They need only match the beginning (so not
necessarily all) of the name. Case is significant.
Only the names of paired devices are considered.
This parameter is ignored if the <tt class="docutils literal">address=</tt> parameter has been specified.</dd>
<dt><tt class="docutils literal">channel=</tt></dt>
<dd>Specify the RFCOMM channel to use. It must be an integer within the range
<tt class="docutils literal">1</tt>-<tt class="docutils literal">30</tt>. If this parameter isn't supplied then either a driver-supplied
default channel number is assumed or service discovery is performed.</dd>
<dt><tt class="docutils literal">discover=</tt></dt>
<dd><p class="first">Specify whether or not service discovery is to be performed. In other words,
this parameter specifies whether or not the device is to be &quot;asked&quot; for the
RFCOMM channel number. It must be either <tt class="docutils literal">yes</tt> or <tt class="docutils literal">no</tt>. The check is
case insensitive, and any abbreviation may be used. If this parameter isn't
supplied then whether or not service discovery is performed is decided
according to the following sequence of tests:</p>
<ol class="last arabic simple">
<li>If the <tt class="docutils literal">channel=</tt> parameter has been supplied, then <strong>no</strong>.</li>
<li>If the driver has requested service discovery, then <strong>yes</strong>.</li>
<li>If the driver has specified a default channel number, then <strong>no</strong>.</li>
<li>Otherwise, <strong>no</strong>.</li>
</ol>
</dd>
<dt><tt class="docutils literal">timeout=</tt></dt>
<dd>Specify the number of seconds to wait for a connection to the device to be
acquired. It must be an integer within the range <tt class="docutils literal">1</tt>-<tt class="docutils literal">59</tt>. If this
parameter isn't supplied then a reasonable default is assumed.</dd>
</dl>
</div>
<div class="section" id="hid-device-identifiers">
<h3><a class="toc-backref" href="#toc-entry-5">HID Device Identifiers</a></h3>
<p>HID device identifiers support the following parameters:</p>
<blockquote>
<table border="1" class="docutils">
<colgroup>
<col width="38%" />
<col width="62%" />
</colgroup>
<tbody valign="top">
<tr><td>Name</td>
<td>Value</td>
</tr>
<tr><td><tt class="docutils literal">address=</tt></td>
<td>Bluetooth MAC address</td>
</tr>
<tr><td><tt class="docutils literal">name=</tt></td>
<td>Bluetooth device name</td>
</tr>
<tr><td><tt class="docutils literal">manufacturer=</tt></td>
<td>USB device manufacturer</td>
</tr>
<tr><td><tt class="docutils literal">description=</tt></td>
<td>USB product description</td>
</tr>
<tr><td><tt class="docutils literal">serialNumber=</tt></td>
<td>USB serial number</td>
</tr>
<tr><td><tt class="docutils literal">vendor=</tt></td>
<td>four hexadecimal digits</td>
</tr>
<tr><td><tt class="docutils literal">product=</tt></td>
<td>four hexadecimal digits</td>
</tr>
</tbody>
</table>
</blockquote>
<p>All of the parameters are optional, although, in most cases,
either the <tt class="docutils literal">serialNumber=</tt> parameter (for a USB device)
or the <tt class="docutils literal">address=</tt> parameter (for a Bluetooth device)
should be supplied.
USB-specific and Bluetooth-specific parameters may not be combined.</p>
<dl class="docutils">
<dt><tt class="docutils literal">address=</tt></dt>
<dd>The MAC address of a Bluetooth device.
It must be six two-digit hexadecimal numbers
separated from one another by a colon (<tt class="docutils literal">:</tt>).
The letter digits may be in either case.</dd>
<dt><tt class="docutils literal">name=</tt></dt>
<dd>The name of a Bluetooth device.
Only the start of the name is matched.
Matching is case insensitive.</dd>
<dt><tt class="docutils literal">manufacturer=</tt></dt>
<dd>The name of the manufacturer of a USB device.
Only the start of the name is matched.
Matching is case insensitive.</dd>
<dt><tt class="docutils literal">description=</tt></dt>
<dd>The product description of a USB device.
Only the start of the description is matched.
Matching is case insensitive.</dd>
<dt><tt class="docutils literal">serialNumber=</tt></dt>
<dd>The serial number of a USB device.
Only the start of the serial number is matched.
Matching is case insensitive.</dd>
<dt><tt class="docutils literal">vendor=</tt></dt>
<dd>The vendor identifier of the device.
It must be four hexadecimal digits.
The letter digits may be in either case.</dd>
<dt><tt class="docutils literal">product=</tt></dt>
<dd>The product identifier of the device.
It must be four hexadecimal digits.
The letter digits may be in either case.</dd>
</dl>
</div>
<div class="section" id="null-device-identifiers">
<h3><a class="toc-backref" href="#toc-entry-6">Null Device Identifiers</a></h3>
<p>A <tt class="docutils literal">null</tt> endpoint has the following properties:</p>
<ul class="simple">
<li>It always indicates that input is available.</li>
<li>Reading from it always yields end-of-file.</li>
<li>Writing to it is always successful but does nothing.</li>
</ul>
</div>
</div>
</div>
</body>
</html>