[fee14fb] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY bluez-download-http "http://www.kernel.org/pub/linux/bluetooth/bluez-&bluez-version;.tar.xz">
|
---|
| 8 | <!ENTITY bluez-download-ftp "ftp://ftp.kernel.org/pub/linux/bluetooth/bluez-&bluez-version;.tar.xz">
|
---|
[2f5cf5d6] | 9 | <!ENTITY bluez-md5sum "37b785185fb98269b45e51b254bd8d3d">
|
---|
[9b8c8705] | 10 | <!ENTITY bluez-size "1.4 MB">
|
---|
[2f5cf5d6] | 11 | <!ENTITY bluez-buildsize "72 MB (additional 17 MB for the tests)">
|
---|
| 12 | <!ENTITY bluez-time "0.5 SBU (additional 0.2 SBU for the tests)">
|
---|
[fee14fb] | 13 | ]>
|
---|
| 14 |
|
---|
[880c568] | 15 | <sect1 id="bluez" xreflabel="BlueZ-&bluez-version;">
|
---|
[fee14fb] | 16 | <?dbhtml filename="bluez.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
[880c568] | 23 | <title>BlueZ-&bluez-version;</title>
|
---|
[fee14fb] | 24 |
|
---|
| 25 | <indexterm zone="bluez">
|
---|
[880c568] | 26 | <primary sortas="a-BlueZ">BlueZ</primary>
|
---|
[fee14fb] | 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to BlueZ</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | The <application>BlueZ</application> package contains the
|
---|
| 34 | Bluetooth protocol stack for Linux.
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
[469bc5d4] | 37 | &lfs76_checked;
|
---|
[fee14fb] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&bluez-download-http;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&bluez-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download MD5 sum: &bluez-md5sum;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download size: &bluez-size;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated disk space required: &bluez-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &bluez-time;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
[9ceb07f] | 73 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 74 | <itemizedlist spacing="compact">
|
---|
| 75 | <listitem>
|
---|
| 76 | <para>
|
---|
[469bc5d4] | 77 | Required patch:
|
---|
[9ceb07f] | 78 | <ulink url="&patch-root;/bluez-&bluez-version;-obexd_without_systemd-1.patch"/>
|
---|
| 79 | </para>
|
---|
| 80 | </listitem>
|
---|
| 81 | </itemizedlist>
|
---|
| 82 |
|
---|
[fee14fb] | 83 | <bridgehead renderas="sect3">BlueZ Dependencies</bridgehead>
|
---|
| 84 |
|
---|
| 85 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 86 | <para role="required">
|
---|
[54666831] | 87 | <xref linkend="dbus"/>,
|
---|
| 88 | <xref linkend="glib2"/>, and
|
---|
[ef84ea0] | 89 | <xref linkend="libical"/>
|
---|
[fee14fb] | 90 | </para>
|
---|
| 91 |
|
---|
| 92 | <para condition="html" role="usernotes">
|
---|
| 93 | User Notes: <ulink url="&blfs-wiki;/bluez"/>
|
---|
| 94 | </para>
|
---|
| 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 |
|
---|
| 98 | <sect2 role="kernel" id="bluez-kernel">
|
---|
| 99 | <title>Kernel Configuration</title>
|
---|
| 100 |
|
---|
| 101 | <para>
|
---|
| 102 | Enable the following options in the kernel configuration and recompile the
|
---|
| 103 | kernel if necessary:
|
---|
| 104 | </para>
|
---|
| 105 |
|
---|
[c67c630] | 106 | <screen><literal>[*] Networking support ---> [CONFIG_NET]
|
---|
| 107 | <*> or <M> Bluetooth subsystem support ---> [CONFIG_BT]
|
---|
| 108 | <*> or <M> RFCOMM protocol support [CONFIG_BT_RFCOMM]
|
---|
| 109 | [*] RFCOMM TTY support [CONFIG_BT_RFCOMM_TTY]
|
---|
| 110 | <*> or <M> BNEP protocol support [CONFIG_BT_BNEP]
|
---|
| 111 | [*] Multicast filter support [CONFIG_BT_BNEP_MC_FILTER]
|
---|
| 112 | [*] Protocol filter support [CONFIG_BT_BNEP_PROTO_FILTER]
|
---|
| 113 | <*> or <M> HIDP protocol support [CONFIG_BT_HIDP]
|
---|
[fee14fb] | 114 |
|
---|
[a99fd8bd] | 115 | Bluetooth device drivers --->
|
---|
| 116 | <*> or <M> RF switch subsystem support</literal></screen>
|
---|
[fee14fb] | 117 |
|
---|
| 118 | <para>
|
---|
| 119 | Select the appropriate drivers for your Bluetooth hardware.
|
---|
| 120 | </para>
|
---|
| 121 |
|
---|
| 122 | <indexterm zone="bluez bluez-kernel">
|
---|
| 123 | <primary sortas="d-bluez">bluez</primary>
|
---|
| 124 | </indexterm>
|
---|
| 125 | </sect2>
|
---|
| 126 |
|
---|
| 127 | <sect2 role="installation">
|
---|
| 128 | <title>Installation of BlueZ</title>
|
---|
| 129 |
|
---|
| 130 | <para>
|
---|
| 131 | Install <application>BlueZ</application> by running the following
|
---|
| 132 | commands:
|
---|
| 133 | </para>
|
---|
| 134 |
|
---|
[469bc5d4] | 135 | <screen><userinput>patch -Np1 -i ../bluez-&bluez-version;-obexd_without_systemd-1.patch &&
|
---|
| 136 | ./configure --prefix=/usr \
|
---|
[ef84ea0] | 137 | --sysconfdir=/etc \
|
---|
| 138 | --localstatedir=/var \
|
---|
[459c449] | 139 | --enable-library &&
|
---|
[fee14fb] | 140 | make</userinput></screen>
|
---|
| 141 |
|
---|
| 142 | <para>
|
---|
[a99fd8bd] | 143 | To test the results, issue: <userinput>make check</userinput>.
|
---|
[fee14fb] | 144 | </para>
|
---|
| 145 |
|
---|
| 146 | <para>
|
---|
| 147 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 148 | </para>
|
---|
| 149 |
|
---|
[459c449] | 150 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[fee14fb] | 151 |
|
---|
| 152 | <para>
|
---|
[ef84ea0] | 153 | Install the main configuration file as the
|
---|
[fee14fb] | 154 | <systemitem class="username">root</systemitem> user:
|
---|
| 155 | </para>
|
---|
| 156 |
|
---|
[ef84ea0] | 157 | <screen role="root"><userinput>install -v -dm755 /etc/bluetooth &&
|
---|
| 158 | install -v -m644 src/main.conf /etc/bluetooth/main.conf</userinput></screen>
|
---|
[fee14fb] | 159 |
|
---|
| 160 | <para>
|
---|
| 161 | If desired, install the API documentation as the
|
---|
| 162 | <systemitem class="username">root</systemitem> user:
|
---|
| 163 | </para>
|
---|
| 164 |
|
---|
[ef84ea0] | 165 | <screen role="root"><userinput>install -v -dm755 /usr/share/doc/bluez-&bluez-version; &&
|
---|
[fee14fb] | 166 | install -v -m644 doc/*.txt /usr/share/doc/bluez-&bluez-version;</userinput></screen>
|
---|
[ef84ea0] | 167 |
|
---|
[fee14fb] | 168 | </sect2>
|
---|
| 169 |
|
---|
| 170 | <sect2 role="commands">
|
---|
| 171 | <title>Command Explanations</title>
|
---|
| 172 |
|
---|
| 173 | <para>
|
---|
[ef84ea0] | 174 | <parameter>--enable-library</parameter>: This switch enables building of the
|
---|
| 175 | <application>BlueZ</application> 4 compatibility library which is required by
|
---|
| 176 | some applications.
|
---|
[fee14fb] | 177 | </para>
|
---|
| 178 |
|
---|
| 179 | </sect2>
|
---|
| 180 |
|
---|
| 181 | <sect2 role="configuration">
|
---|
| 182 | <title>Configuring BlueZ</title>
|
---|
| 183 |
|
---|
| 184 | <sect3 id="bluez-config">
|
---|
[a99fd8bd] | 185 | <title>Configuration Files</title>
|
---|
[fee14fb] | 186 | <para>
|
---|
[529182e] | 187 | <filename>/etc/bluetooth/main.conf</filename> is installed
|
---|
| 188 | automatically during the install. Additionally, there are
|
---|
| 189 | two supplementary configuration files that you can install
|
---|
| 190 | by running the following commands as the
|
---|
[a99fd8bd] | 191 | <systemitem class="username">root</systemitem> user:
|
---|
[fee14fb] | 192 | </para>
|
---|
[a99fd8bd] | 193 |
|
---|
| 194 | <screen role="root"><userinput>cat > /etc/bluetooth/rfcomm.conf << "EOF"</userinput>
|
---|
| 195 | <literal># rfcomm.conf
|
---|
| 196 | # Set up the RFCOMM configuration of the Bluetooth subsystem in the Linux kernel.
|
---|
| 197 | # Use one line per command
|
---|
| 198 | # See the rfcomm man page for options
|
---|
| 199 |
|
---|
[9b8c8705] | 200 | # End of rfcomm.conf</literal>
|
---|
| 201 | EOF</screen>
|
---|
[a99fd8bd] | 202 |
|
---|
| 203 | <screen role="root"><userinput>cat > /etc/bluetooth/uart.conf << "EOF"</userinput>
|
---|
| 204 | <literal>#uart.conf
|
---|
| 205 | # Attach serial devices via UART HCI to BlueZ stack
|
---|
| 206 | # Use one line per device
|
---|
| 207 | # See the hciattach man page for options
|
---|
| 208 |
|
---|
[9b8c8705] | 209 | # End of uart.conf</literal>
|
---|
| 210 | EOF</screen>
|
---|
[fee14fb] | 211 |
|
---|
| 212 | <indexterm zone="bluez bluez-config">
|
---|
| 213 | <primary
|
---|
| 214 | sortas="e-etc-bluetooth-main.conf">/etc/bluetooth/main.conf</primary>
|
---|
| 215 | </indexterm>
|
---|
| 216 |
|
---|
[529182e] | 217 | <indexterm zone="bluez bluez-config">
|
---|
| 218 | <primary
|
---|
| 219 | sortas="e-etc-bluetooth-rfcomm.conf">/etc/bluetooth/rfcomm.conf</primary>
|
---|
| 220 | </indexterm>
|
---|
| 221 |
|
---|
| 222 | <indexterm zone="bluez bluez-config">
|
---|
| 223 | <primary
|
---|
[0c74e1f9] | 224 | sortas="e-etc-bluetooth-uart.conf">/etc/bluetooth/uart.conf</primary>
|
---|
[529182e] | 225 | </indexterm>
|
---|
| 226 |
|
---|
[fee14fb] | 227 | </sect3>
|
---|
| 228 |
|
---|
| 229 | <sect3 id="bluez-init">
|
---|
[96733af] | 230 | <title>Systemd Units</title>
|
---|
[fee14fb] | 231 |
|
---|
| 232 | <para>
|
---|
[96733af] | 233 | To start the <command>bluetoothd</command> daemon at boot,
|
---|
| 234 | enable the previously installed systemd unit by
|
---|
[459c449] | 235 | running the following command as the
|
---|
| 236 | <systemitem class="username">root</systemitem> user:
|
---|
[fee14fb] | 237 | </para>
|
---|
| 238 |
|
---|
| 239 | <indexterm zone="bluez bluez-init">
|
---|
| 240 | <primary sortas="f-bluetooth">bluetooth</primary>
|
---|
| 241 | </indexterm>
|
---|
| 242 |
|
---|
[459c449] | 243 | <screen role="root"><userinput>systemctl enable bluetooth</userinput></screen>
|
---|
| 244 |
|
---|
| 245 | <note>
|
---|
| 246 | <para>
|
---|
[96733af] | 247 | <application>Systemd</application> will start the Bluetooth daemon
|
---|
| 248 | only when a bluetooth device is detected on the system.
|
---|
[459c449] | 249 | </para>
|
---|
| 250 | </note>
|
---|
[ef84ea0] | 251 |
|
---|
[fee14fb] | 252 | </sect3>
|
---|
[ef84ea0] | 253 |
|
---|
[fee14fb] | 254 | </sect2>
|
---|
| 255 |
|
---|
| 256 | <sect2 role="content">
|
---|
| 257 | <title>Contents</title>
|
---|
| 258 |
|
---|
| 259 | <segmentedlist>
|
---|
| 260 | <segtitle>Installed Programs</segtitle>
|
---|
| 261 | <segtitle>Installed Library</segtitle>
|
---|
| 262 | <segtitle>Installed Directories</segtitle>
|
---|
| 263 |
|
---|
| 264 | <seglistitem>
|
---|
| 265 | <seg>
|
---|
[ef84ea0] | 266 | bccmd, bluemoon, bluetoothctl, bluetoothd, btmon, ciptool,
|
---|
| 267 | hciattach, hciconfig, hcidump, hcitool, hid2hci, l2ping,
|
---|
[9b8c8705] | 268 | l2test, mpris-proxy, obexd, rctest, rfcomm, and sdptool
|
---|
[fee14fb] | 269 | </seg>
|
---|
| 270 | <seg>
|
---|
| 271 | libbluetooth.so
|
---|
| 272 | </seg>
|
---|
| 273 | <seg>
|
---|
| 274 | /etc/bluetooth,
|
---|
| 275 | /usr/include/bluetooth,
|
---|
[ef84ea0] | 276 | /usr/libexec/bluetooth, and
|
---|
| 277 | /usr/share/doc/bluez-&bluez-version;
|
---|
[fee14fb] | 278 | </seg>
|
---|
| 279 | </seglistitem>
|
---|
| 280 | </segmentedlist>
|
---|
| 281 |
|
---|
| 282 | <variablelist>
|
---|
| 283 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 284 | <?dbfo list-presentation="list"?>
|
---|
| 285 | <?dbhtml list-presentation="table"?>
|
---|
| 286 |
|
---|
| 287 | <varlistentry id="bccmd">
|
---|
| 288 | <term><command>bccmd</command></term>
|
---|
| 289 | <listitem>
|
---|
| 290 | <para>
|
---|
| 291 | is used to issue BlueCore commands to Cambridge Silicon
|
---|
| 292 | Radio devices.
|
---|
| 293 | </para>
|
---|
| 294 | <indexterm zone="bluez bccmd">
|
---|
| 295 | <primary sortas="b-bccmd">bccmd</primary>
|
---|
| 296 | </indexterm>
|
---|
| 297 | </listitem>
|
---|
| 298 | </varlistentry>
|
---|
| 299 |
|
---|
| 300 | <varlistentry id="bluetoothd">
|
---|
| 301 | <term><command>bluetoothd</command></term>
|
---|
| 302 | <listitem>
|
---|
| 303 | <para>
|
---|
| 304 | is the Bluetooth daemon.
|
---|
| 305 | </para>
|
---|
| 306 | <indexterm zone="bluez bluetoothd">
|
---|
| 307 | <primary sortas="b-bluetoothd">bluetoothd</primary>
|
---|
| 308 | </indexterm>
|
---|
| 309 | </listitem>
|
---|
| 310 | </varlistentry>
|
---|
| 311 |
|
---|
| 312 | <varlistentry id="ciptool">
|
---|
| 313 | <term><command>ciptool</command></term>
|
---|
| 314 | <listitem>
|
---|
| 315 | <para>
|
---|
| 316 | is used to set up, maintain, and inspect the CIP configuration
|
---|
| 317 | of the Bluetooth subsystem in the Linux kernel.
|
---|
| 318 | </para>
|
---|
| 319 | <indexterm zone="bluez ciptool">
|
---|
| 320 | <primary sortas="b-ciptool">ciptool</primary>
|
---|
| 321 | </indexterm>
|
---|
| 322 | </listitem>
|
---|
| 323 | </varlistentry>
|
---|
| 324 |
|
---|
| 325 | <varlistentry id="hciattach">
|
---|
| 326 | <term><command>hciattach</command></term>
|
---|
| 327 | <listitem>
|
---|
| 328 | <para>
|
---|
| 329 | is used to attach a serial UART to the Bluetooth stack
|
---|
| 330 | as HCI transport interface.
|
---|
| 331 | </para>
|
---|
| 332 | <indexterm zone="bluez hciattach">
|
---|
| 333 | <primary sortas="b-hciattach">hciattach</primary>
|
---|
| 334 | </indexterm>
|
---|
| 335 | </listitem>
|
---|
| 336 | </varlistentry>
|
---|
| 337 |
|
---|
| 338 | <varlistentry id="hciconfig">
|
---|
| 339 | <term><command>hciconfig</command></term>
|
---|
| 340 | <listitem>
|
---|
| 341 | <para>
|
---|
| 342 | is used to configure Bluetooth devices.
|
---|
| 343 | </para>
|
---|
| 344 | <indexterm zone="bluez hciconfig">
|
---|
| 345 | <primary sortas="b-hciconfig">hciconfig</primary>
|
---|
| 346 | </indexterm>
|
---|
| 347 | </listitem>
|
---|
| 348 | </varlistentry>
|
---|
| 349 |
|
---|
| 350 | <varlistentry id="hcitool">
|
---|
| 351 | <term><command>hcitool</command></term>
|
---|
| 352 | <listitem>
|
---|
| 353 | <para>
|
---|
| 354 | is used to configure Bluetooth connections and send some
|
---|
| 355 | special command to Bluetooth devices.
|
---|
| 356 | </para>
|
---|
| 357 | <indexterm zone="bluez hcitool">
|
---|
| 358 | <primary sortas="b-hcitool">hcitool</primary>
|
---|
| 359 | </indexterm>
|
---|
| 360 | </listitem>
|
---|
| 361 | </varlistentry>
|
---|
| 362 |
|
---|
| 363 | <varlistentry id="hid2hci">
|
---|
| 364 | <term><command>hid2hci</command></term>
|
---|
| 365 | <listitem>
|
---|
| 366 | <para>
|
---|
| 367 | is used to set up switch supported Bluetooth devices into
|
---|
| 368 | the HCI mode and back.
|
---|
| 369 | </para>
|
---|
| 370 | <indexterm zone="bluez hid2hci">
|
---|
| 371 | <primary sortas="b-hid2hci">hid2hci</primary>
|
---|
| 372 | </indexterm>
|
---|
| 373 | </listitem>
|
---|
| 374 | </varlistentry>
|
---|
| 375 |
|
---|
| 376 | <varlistentry id="l2ping">
|
---|
| 377 | <term><command>l2ping</command></term>
|
---|
| 378 | <listitem>
|
---|
| 379 | <para>
|
---|
| 380 | is used to send a L2CAP echo request to the Bluetooth MAC
|
---|
| 381 | address given in dotted hex notation.
|
---|
| 382 | </para>
|
---|
| 383 | <indexterm zone="bluez l2ping">
|
---|
| 384 | <primary sortas="b-l2ping">l2ping</primary>
|
---|
| 385 | </indexterm>
|
---|
| 386 | </listitem>
|
---|
| 387 | </varlistentry>
|
---|
| 388 |
|
---|
[ef84ea0] | 389 | <varlistentry id="rctest">
|
---|
| 390 | <term><command>rctest</command></term>
|
---|
[fee14fb] | 391 | <listitem>
|
---|
| 392 | <para>
|
---|
[ef84ea0] | 393 | is used to test RFCOMM communications on the
|
---|
| 394 | Bluetooth stack.
|
---|
[fee14fb] | 395 | </para>
|
---|
[ef84ea0] | 396 | <indexterm zone="bluez rctest">
|
---|
| 397 | <primary sortas="b-rctest">rctest</primary>
|
---|
[fee14fb] | 398 | </indexterm>
|
---|
| 399 | </listitem>
|
---|
| 400 | </varlistentry>
|
---|
| 401 |
|
---|
| 402 | <varlistentry id="rfcomm">
|
---|
| 403 | <term><command>rfcomm</command></term>
|
---|
| 404 | <listitem>
|
---|
| 405 | <para>
|
---|
| 406 | is used to set up, maintain, and inspect the RFCOMM
|
---|
| 407 | configuration of the Bluetooth subsystem in the
|
---|
| 408 | Linux kernel.
|
---|
| 409 | </para>
|
---|
| 410 | <indexterm zone="bluez rfcomm">
|
---|
| 411 | <primary sortas="b-rfcomm">rfcomm</primary>
|
---|
| 412 | </indexterm>
|
---|
| 413 | </listitem>
|
---|
| 414 | </varlistentry>
|
---|
| 415 |
|
---|
| 416 | <varlistentry id="sdptool">
|
---|
| 417 | <term><command>sdptool</command></term>
|
---|
| 418 | <listitem>
|
---|
| 419 | <para>
|
---|
| 420 | is used to perform SDP queries on Bluetooth devices.
|
---|
| 421 | </para>
|
---|
| 422 | <indexterm zone="bluez sdptool">
|
---|
| 423 | <primary sortas="b-sdptool">sdptool</primary>
|
---|
| 424 | </indexterm>
|
---|
| 425 | </listitem>
|
---|
| 426 | </varlistentry>
|
---|
| 427 |
|
---|
| 428 | <varlistentry id="libbluetooth">
|
---|
| 429 | <term><filename class="libraryfile">libbluetooth.so</filename></term>
|
---|
| 430 | <listitem>
|
---|
| 431 | <para>
|
---|
[ef84ea0] | 432 | contains the <application>BlueZ</application> 4 API functions.
|
---|
[fee14fb] | 433 | </para>
|
---|
| 434 | <indexterm zone="bluez libbluetooth">
|
---|
| 435 | <primary sortas="c-libbluetooth">libbluetooth.so</primary>
|
---|
| 436 | </indexterm>
|
---|
| 437 | </listitem>
|
---|
| 438 | </varlistentry>
|
---|
| 439 | </variablelist>
|
---|
| 440 |
|
---|
| 441 | </sect2>
|
---|
| 442 |
|
---|
| 443 | </sect1>
|
---|