From: Gerhard Sittig <redacted>
Date: Sun, 30 Dec 2018 18:18:10 +0000 (+0100)
Subject: doc: update README for serial over Bluetooth
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=07e42cb2cb865801ff294c3244ef906c58b2b11e;p=libsigrok.git

doc: update README for serial over Bluetooth

Mention the optional external BlueZ dependency. Provide conn= examples
for Bluetooth communication. Mention the UT-D07 adapter.
---

diff --git a/README b/README
index a902e665..ace38209 100644
--- a/README
+++ b/README
@@ -42,6 +42,7 @@ Requirements for the C library:
  - librevisa >= 0.0.20130412 (optional, used by some drivers)
  - libusb-1.0 >= 1.0.16 (optional, used by some drivers)
  - hidapi >= 0.8.0 (optional, used for some HID based "serial cables")
+ - bluez >= 4.0 (optional, used for Bluetooth communication)
  - libftdi1 >= 1.0 (optional, used by some drivers)
  - libgpib (optional, used by some drivers)
  - libieee1284 (optional, used by some drivers)
diff --git a/README.devices b/README.devices
index a0b2fa4e..dd84f242 100644
--- a/README.devices
+++ b/README.devices
@@ -134,7 +134,10 @@ or USB-to-serial ones, CDC class) to connect to a PC. These serial cables are
 supported by the libserialport library. Some vendors prefer to use HID chips
 instead of CDC chips in their serial cables. These cables can get supported
 by means of the hidapi library. Note that each chip type requires specific
-support in the libsigrok library.
+support in the libsigrok library. Bluetooth connected devices may be supported
+as well when they communicate by means of RFCOMM channels, or one of the
+implemented BLE notification/indication approaches, and one of the Bluetooth
+supporting platforms is used.
 
 For all these devices, you need to specify the serial port they are connected
 to (e.g. using the 'conn' option in sigrok-cli). It is not possible to scan
@@ -144,6 +147,7 @@ Example:
 
  $ sigrok-cli --driver <somedriver>:conn=/dev/ttyUSB0 ...
  $ sigrok-cli --driver <somedriver>:conn=hid/cp2110 ...
+ $ sigrok-cli --driver <somedriver>:conn=bt/rfcomm/01-23-45-67-89-ab ...
 
 The following drivers/devices require a serial port specification. Some of
 the drivers implement a default for the connection. Some of the drivers
@@ -295,6 +299,7 @@ ship with different PC connectivity cables:
  - UT-D02 (RS232 cable)
  - UT-D04 (USB/HID cable with Hoitek HE2325U chip, USB VID/PID 04fa:2490)
  - UT-D04 (USB/HID cable with WCH CH9325 chip, USB VID/PID 1a86:e008)
+ - UT-D07 (Bluetooth adapter, ISSC BL79 BLETR chip)
  - UT-D09 (USB/HID cable with SiL CP2110 chip, USB VID/PID 10c4:ea80)
 
 The above cables are all physically compatible (same IR connector shape)