tools/hcitool.1

   1 .TH HCITOOL 1 "Nov 12 2002" BlueZ "Linux System Administration"
   2 .SH NAME
   3 hcitool \- configure Bluetooth connections
   4 .SH SYNOPSIS
   5 .B hcitool [-h]
   6 .br
   7 .B hcitool [-i <hciX>] [command [command parameters]]
   8
   9 .SH DESCRIPTION
  10 .LP
  11 .B
  12 hcitool
  13 is used to configure Bluetooth connections and send some special command to
  14 Bluetooth devices. If no
  15 .B
  16 command
  17 is given, or if the option
  18 .B
  19 -h
  20 is used,
  21 .B
  22 hcitool
  23 prints some usage information and exits.
  24 .SH OPTIONS
  25 .TP
  26 .BI -h
  27 Gives a list of possible commands
  28 .TP
  29 .BI -i " <hciX>"
  30 The command is applied to device
  31 .I
  32 hciX
  33 , which must be the name of an installed Bluetooth device. If not specified,
  34 the command will be sent to the first available Bluetooth device.
  35 .SH COMMANDS
  36 .TP
  37 .BI dev
  38 Display local devices
  39 .TP
  40 .BI inq
  41 Inquire remote devices. For each discovered device, Bluetooth device address,
  42 clock offset and class are printed.
  43 .TP
  44 .BI scan
  45 Inquire remote devices. For each discovered device, device name are printed.
  46 .TP
  47 .BI name " <bdaddr>"
  48 Print device name of remote device with Bluetooth address
  49 .IR bdaddr .
  50 .TP
  51 .BI info " <bdaddr>"
  52 Print device name, version and supported features of remote device with
  53 Bluetooth address
  54 .IR bdaddr .
  55 .TP
  56 .BI spinq
  57 Start periodic inquiry process. No inquiry results are printed.
  58 .TP
  59 .BI epinq
  60 Exit periodic inquiry process.
  61 .TP
  62 .BI cmd " <ogf> <ocf> [parameters]"
  63 Submit an arbitrary HCI command to local device.
  64 .IR ogf ,
  65 .IR ocf
  66 and
  67 .IR parameters
  68 are hexadecimal bytes.
  69 .TP
  70 .BI con
  71 Display active baseband connections
  72 .TP
  73 .BI cc " [--role=m|s] [--pkt-type=<ptype>] <bdaddr>"
  74 Create baseband connection to remote device with Bluetooth address
  75 .IR bdaddr .
  76 Option
  77 .I
  78 --pkt-type
  79 specifies a list of allowed packet types.
  80 .I
  81 <ptype>
  82 is a comma-separated list of packet types, where the possible packet types are
  83 .BR DM1 ,
  84 .BR DM3 ,
  85 .BR DM5 ,
  86 .BR DH1 ,
  87 .BR DH3 ,
  88 .BR DH5 ,
  89 .BR HV1 ,
  90 .BR HV2 ,
  91 .BR HV3 .
  92 Default is to allow all packet types. Option
  93 .I
  94 --role
  95 can have value
  96 .I
  97 m
  98 (do not allow role switch, stay master) or
  99 .I
 100 s
 101 (allow role switch, become slave if the peer asks to become master). Default is
 102 .IR m .
 103 .TP
 104 .BI dc " <bdaddr> [reason]"
 105 Delete baseband connection from remote device with Bluetooth address
 106 .IR bdaddr .
 107 The reason can be one of the Bluetooth HCI error codes. Default is
 108 .IR 19
 109 for user ended connections. The value must be given in decimal.
 110 .TP
 111 .BI sr " <bdaddr> <role>"
 112 Switch role for the baseband connection from the remote device to
 113 .BR master
 114 or
 115 .BR slave .
 116 .TP
 117 .BI cpt " <bdaddr> <packet types>"
 118 Change packet types for baseband connection to device with Bluetooth address
 119 .IR bdaddr .
 120 .I
 121 packet types
 122 is a comma-separated list of packet types, where the possible packet types are
 123 .BR DM1 ,
 124 .BR DM3 ,
 125 .BR DM5 ,
 126 .BR DH1 ,
 127 .BR DH3 ,
 128 .BR DH5 ,
 129 .BR HV1 ,
 130 .BR HV2 ,
 131 .BR HV3 .
 132 .TP
 133 .BI rssi " <bdaddr>"
 134 Display received signal strength information for the connection to the device
 135 with Bluetooth address
 136 .IR bdaddr .
 137 .TP
 138 .BI lq " <bdaddr>"
 139 Display link quality for the connection to the device with Bluetooth address
 140 .IR bdaddr .
 141 .TP
 142 .BI tpl " <bdaddr> [type]"
 143 Display transmit power level for the connection to the device with Bluetooth address
 144 .IR bdaddr .
 145 The type can be
 146 .BR 0
 147 for the current transmit power level (which is default) or
 148 .BR 1
 149 for the maximum transmit power level.
 150 .TP
 151 .BI afh " <bdaddr>"
 152 Display AFH channel map for the connection to the device with Bluetooth address
 153 .IR bdaddr .
 154 .TP
 155 .BI lp " <bdaddr> [value]"
 156 With no
 157 .IR value ,
 158 displays link policy settings for the connection to the device with Bluetooth address
 159 .IR bdaddr .
 160 If
 161 .IR value
 162 is given, sets the link policy settings for that connection to
 163 .IR value .
 164 Possible values are RSWITCH, HOLD, SNIFF and PARK.
 165 .TP
 166 .BI lst " <bdaddr> [value]"
 167 With no
 168 .IR value ,
 169 displays link supervision timeout for the connection to the device with Bluetooth address
 170 .IR bdaddr .
 171 If
 172 .I
 173 value
 174 is given, sets the link supervision timeout for that connection to
 175 .I
 176 value
 177 slots, or to infinite if
 178 .I
 179 value
 180 is 0.
 181 .TP
 182 .BI auth " <bdaddr>"
 183 Request authentication for the device with Bluetooth address
 184 .IR bdaddr .
 185 .TP
 186 .BI enc " <bdaddr> [encrypt enable]"
 187 Enable or disable the encryption for the device with Bluetooth address
 188 .IR bdaddr .
 189 .TP
 190 .BI key " <bdaddr>"
 191 Change the connection link key for the device with Bluetooth address
 192 .IR bdaddr .
 193 .TP
 194 .BI clkoff " <bdaddr>"
 195 Read the clock offset for the device with Bluetooth address
 196 .IR bdaddr .
 197 .TP
 198 .BI clock " [bdaddr] [which clock]"
 199 Read the clock for the device with Bluetooth address
 200 .IR bdaddr .
 201 The clock can be
 202 .BR 0
 203 for the local clock or
 204 .BR 1
 205 for the piconet clock (which is default).
 206 .TP
 207 .BI lescan " [--privacy] [--passive] [--whitelist] [--discovery=g|l] \
 208 [--duplicates]"
 209 Start LE scan
 210 .TP
 211 .BI leinfo " [--static] [--random] <bdaddr>"
 212 Get LE remote information
 213 .TP
 214 .BI lewladd " [--random] <bdaddr>"
 215 Add device to LE White List
 216 .TP
 217 .BI lewlrm " <bdaddr>"
 218 Remove device from LE White List
 219 .TP
 220 .BI lewlsz
 221 Read size of LE White List
 222 .TP
 223 .BI lewlclr
 224 Clear LE White List
 225 .TP
 226 .BI lerladd " [--local irk] [--peer irk] [--random] <bdaddr>"
 227 Add device to LE Resolving List
 228 .TP
 229 .BI lerlrm " <bdaddr>"
 230 Remove device from LE Resolving List
 231 .TP
 232 .BI lerlclr
 233 Clear LE Resolving List
 234 .TP
 235 .BI lerlsz
 236 Read size of LE Resolving List
 237 .TP
 238 .BI lerlon
 239 Enable LE Address Resolution
 240 .TP
 241 .BI lerloff
 242 Disable LE Address Resolution
 243 .TP
 244 .BI lecc " [--static] [--random] <bdaddr> | [--whitelist]"
 245 Create a LE Connection
 246 .TP
 247 .BI ledc " <handle> [reason]"
 248 Disconnect a LE Connection
 249 .TP
 250 .BI lecup " <handle> <min> <max> <latency> <timeout>"
 251 LE Connection Update
 252 .SH AUTHORS
 253 Written by Maxim Krasnyansky <maxk@qualcomm.com> and Marcel Holtmann <marcel@holtmann.org>
 254 .PP
 255 man page by Fabrizio Gennari <fabrizio.gennari@philips.com>