392 lines
7.9 KiB
HTML
392 lines
7.9 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of HCITOOL</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>HCITOOL</H1>
|
|
Section: Linux System Administration (1)<BR>Updated: Nov 12 2002<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
hcitool - configure Bluetooth connections
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>hcitool [-h]</B>
|
|
|
|
<BR>
|
|
|
|
<B>hcitool [-i <hciX>] [command [command parameters]]</B>
|
|
|
|
<P>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
|
|
<B>hcitool</B>
|
|
|
|
is used to configure Bluetooth connections and send some special command to
|
|
Bluetooth devices. If no
|
|
<B>command</B>
|
|
|
|
is given, or if the option
|
|
<B>-h</B>
|
|
|
|
is used,
|
|
<B>hcitool</B>
|
|
|
|
prints some usage information and exits.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-h</B>
|
|
|
|
<DD>
|
|
Gives a list of possible commands
|
|
<DT id="2"><B>-i</B><I> <hciX></I>
|
|
|
|
<DD>
|
|
The command is applied to device
|
|
<I>hciX</I>
|
|
|
|
, which must be the name of an installed Bluetooth device. If not specified,
|
|
the command will be sent to the first available Bluetooth device.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>COMMANDS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="3"><B>dev</B>
|
|
|
|
<DD>
|
|
Display local devices
|
|
<DT id="4"><B>inq</B>
|
|
|
|
<DD>
|
|
Inquire remote devices. For each discovered device, Bluetooth device address,
|
|
clock offset and class are printed.
|
|
<DT id="5"><B>scan</B>
|
|
|
|
<DD>
|
|
Inquire remote devices. For each discovered device, device name are printed.
|
|
<DT id="6"><B>name</B><I> <bdaddr></I>
|
|
|
|
<DD>
|
|
Print device name of remote device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
<DT id="7"><B>info</B><I> <bdaddr></I>
|
|
|
|
<DD>
|
|
Print device name, version and supported features of remote device with
|
|
Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
<DT id="8"><B>spinq</B>
|
|
|
|
<DD>
|
|
Start periodic inquiry process. No inquiry results are printed.
|
|
<DT id="9"><B>epinq</B>
|
|
|
|
<DD>
|
|
Exit periodic inquiry process.
|
|
<DT id="10"><B>cmd</B><I> <ogf> <ocf> [parameters]</I>
|
|
|
|
<DD>
|
|
Submit an arbitrary HCI command to local device.
|
|
<I>ogf</I>,
|
|
|
|
<I>ocf</I>
|
|
|
|
and
|
|
<I>parameters</I>
|
|
|
|
are hexadecimal bytes.
|
|
<DT id="11"><B>con</B>
|
|
|
|
<DD>
|
|
Display active baseband connections
|
|
<DT id="12"><B>cc</B><I> [--role=m|s] [--pkt-type=<ptype>] <bdaddr></I>
|
|
|
|
<DD>
|
|
Create baseband connection to remote device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
Option
|
|
<I>--pkt-type</I>
|
|
|
|
specifies a list of allowed packet types.
|
|
<I><ptype></I>
|
|
|
|
is a comma-separated list of packet types, where the possible packet types are
|
|
<B>DM1</B>,
|
|
|
|
<B>DM3</B>,
|
|
|
|
<B>DM5</B>,
|
|
|
|
<B>DH1</B>,
|
|
|
|
<B>DH3</B>,
|
|
|
|
<B>DH5</B>,
|
|
|
|
<B>HV1</B>,
|
|
|
|
<B>HV2</B>,
|
|
|
|
<B>HV3</B>.
|
|
|
|
Default is to allow all packet types. Option
|
|
<I>--role</I>
|
|
|
|
can have value
|
|
<I>m</I>
|
|
|
|
(do not allow role switch, stay master) or
|
|
<I>s</I>
|
|
|
|
(allow role switch, become slave if the peer asks to become master). Default is
|
|
<I>m</I>.
|
|
|
|
<DT id="13"><B>dc</B><I> <bdaddr> [reason]</I>
|
|
|
|
<DD>
|
|
Delete baseband connection from remote device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
The reason can be one of the Bluetooth HCI error codes. Default is
|
|
<I>19</I>
|
|
|
|
for user ended connections. The value must be given in decimal.
|
|
<DT id="14"><B>sr</B><I> <bdaddr> <role></I>
|
|
|
|
<DD>
|
|
Switch role for the baseband connection from the remote device to
|
|
<B>master</B>
|
|
|
|
or
|
|
<B>slave</B>.
|
|
|
|
<DT id="15"><B>cpt</B><I> <bdaddr> <packet types></I>
|
|
|
|
<DD>
|
|
Change packet types for baseband connection to device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
<I>packet types</I>
|
|
|
|
is a comma-separated list of packet types, where the possible packet types are
|
|
<B>DM1</B>,
|
|
|
|
<B>DM3</B>,
|
|
|
|
<B>DM5</B>,
|
|
|
|
<B>DH1</B>,
|
|
|
|
<B>DH3</B>,
|
|
|
|
<B>DH5</B>,
|
|
|
|
<B>HV1</B>,
|
|
|
|
<B>HV2</B>,
|
|
|
|
<B>HV3</B>.
|
|
|
|
<DT id="16"><B>rssi</B><I> <bdaddr></I>
|
|
|
|
<DD>
|
|
Display received signal strength information for the connection to the device
|
|
with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
<DT id="17"><B>lq</B><I> <bdaddr></I>
|
|
|
|
<DD>
|
|
Display link quality for the connection to the device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
<DT id="18"><B>tpl</B><I> <bdaddr> [type]</I>
|
|
|
|
<DD>
|
|
Display transmit power level for the connection to the device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
The type can be
|
|
<B>0</B>
|
|
|
|
for the current transmit power level (which is default) or
|
|
<B>1</B>
|
|
|
|
for the maximum transmit power level.
|
|
<DT id="19"><B>afh</B><I> <bdaddr></I>
|
|
|
|
<DD>
|
|
Display AFH channel map for the connection to the device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
<DT id="20"><B>lp</B><I> <bdaddr> [value]</I>
|
|
|
|
<DD>
|
|
With no
|
|
<I>value</I>,
|
|
|
|
displays link policy settings for the connection to the device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
If
|
|
<I>value</I>
|
|
|
|
is given, sets the link policy settings for that connection to
|
|
<I>value</I>.
|
|
|
|
Possible values are RSWITCH, HOLD, SNIFF and PARK.
|
|
<DT id="21"><B>lst</B><I> <bdaddr> [value]</I>
|
|
|
|
<DD>
|
|
With no
|
|
<I>value</I>,
|
|
|
|
displays link supervision timeout for the connection to the device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
If
|
|
<I>value</I>
|
|
|
|
is given, sets the link supervision timeout for that connection to
|
|
<I>value</I>
|
|
|
|
slots, or to infinite if
|
|
<I>value</I>
|
|
|
|
is 0.
|
|
<DT id="22"><B>auth</B><I> <bdaddr></I>
|
|
|
|
<DD>
|
|
Request authentication for the device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
<DT id="23"><B>enc</B><I> <bdaddr> [encrypt enable]</I>
|
|
|
|
<DD>
|
|
Enable or disable the encryption for the device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
<DT id="24"><B>key</B><I> <bdaddr></I>
|
|
|
|
<DD>
|
|
Change the connection link key for the device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
<DT id="25"><B>clkoff</B><I> <bdaddr></I>
|
|
|
|
<DD>
|
|
Read the clock offset for the device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
<DT id="26"><B>clock</B><I> [bdaddr] [which clock]</I>
|
|
|
|
<DD>
|
|
Read the clock for the device with Bluetooth address
|
|
<I>bdaddr</I>.
|
|
|
|
The clock can be
|
|
<B>0</B>
|
|
|
|
for the local clock or
|
|
<B>1</B>
|
|
|
|
for the piconet clock (which is default).
|
|
<DT id="27"><B>lescan</B><I> [--privacy] [--passive] [--whitelist] [--discovery=g|l] [--duplicates]</I>
|
|
|
|
<DD>
|
|
Start LE scan
|
|
<DT id="28"><B>leinfo</B><I> [--static] [--random] <bdaddr></I>
|
|
|
|
<DD>
|
|
Get LE remote information
|
|
<DT id="29"><B>lewladd</B><I> [--random] <bdaddr></I>
|
|
|
|
<DD>
|
|
Add device to LE White List
|
|
<DT id="30"><B>lewlrm</B><I> <bdaddr></I>
|
|
|
|
<DD>
|
|
Remove device from LE White List
|
|
<DT id="31"><B>lewlsz</B>
|
|
|
|
<DD>
|
|
Read size of LE White List
|
|
<DT id="32"><B>lewlclr</B>
|
|
|
|
<DD>
|
|
Clear LE White List
|
|
<DT id="33"><B>lerladd</B><I> [--local irk] [--peer irk] [--random] <bdaddr></I>
|
|
|
|
<DD>
|
|
Add device to LE Resolving List
|
|
<DT id="34"><B>lerlrm</B><I> <bdaddr></I>
|
|
|
|
<DD>
|
|
Remove device from LE Resolving List
|
|
<DT id="35"><B>lerlclr</B>
|
|
|
|
<DD>
|
|
Clear LE Resolving List
|
|
<DT id="36"><B>lerlsz</B>
|
|
|
|
<DD>
|
|
Read size of LE Resolving List
|
|
<DT id="37"><B>lerlon</B>
|
|
|
|
<DD>
|
|
Enable LE Address Resolution
|
|
<DT id="38"><B>lerloff</B>
|
|
|
|
<DD>
|
|
Disable LE Address Resolution
|
|
<DT id="39"><B>lecc</B><I> [--static] [--random] <bdaddr> | [--whitelist]</I>
|
|
|
|
<DD>
|
|
Create a LE Connection
|
|
<DT id="40"><B>ledc</B><I> <handle> [reason]</I>
|
|
|
|
<DD>
|
|
Disconnect a LE Connection
|
|
<DT id="41"><B>lecup</B><I> <handle> <min> <max> <latency> <timeout></I>
|
|
|
|
<DD>
|
|
LE Connection Update
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>AUTHORS</H2>
|
|
|
|
Written by Maxim Krasnyansky <<A HREF="mailto:maxk@qualcomm.com">maxk@qualcomm.com</A>> and Marcel Holtmann <<A HREF="mailto:marcel@holtmann.org">marcel@holtmann.org</A>>
|
|
<P>
|
|
|
|
man page by Fabrizio Gennari <<A HREF="mailto:fabrizio.gennari@philips.com">fabrizio.gennari@philips.com</A>>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="42"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="43"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="44"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="45"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="46"><A HREF="#lbAF">COMMANDS</A><DD>
|
|
<DT id="47"><A HREF="#lbAG">AUTHORS</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:16 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|