openhab-docs/_addons_bindings/bluetooth
Yannick Schaus c0eef8b525
Partial merge final -> final-stable (#1569)
This performs a selective merge of the current docs into the "stable" branch
that will hold the default docs for the 3.0.2 release (until they're
replaced with the current ones once 3.1 is released).

* Backport bindings docs that looked applicable to 3.0
* Revert UI components changes not in stable

Signed-off-by: Yannick Schaus <github@schaus.net>

Co-authored-by: openHAB Build Server <infrastructure@openhab.org>
Co-authored-by: stefan-hoehn <stefan.hoehn@aoe.com>
Co-authored-by: jimtng <2554958+jimtng@users.noreply.github.com>
Co-authored-by: Matt <lawrence.matt@gmail.com>
Co-authored-by: Jerome Luckenbach <github@luckenba.ch>
Co-authored-by: Kai Kreuzer <kai@openhab.org>
Co-authored-by: Felix Schneider <45742226+Trysupe@users.noreply.github.com>
Co-authored-by: Hilbrand Bouwkamp <hilbrand@h72.nl>
Co-authored-by: J-N-K <J-N-K@users.noreply.github.com>
Co-authored-by: Eiko Wagenknecht <eiko.wagenknecht@web.de>
Co-authored-by: Alexander Behring <github.com@alexander-behring.eu>
Co-authored-by: Matthew Skinner <matt@pcmus.com>
Co-authored-by: Christoph Weitkamp <github@christophweitkamp.de>
Co-authored-by: Patrick Fink <mail@pfink.de>
Co-authored-by: Gifford47 <49484063+Gifford47@users.noreply.github.com>
Co-authored-by: Seganku <seganku@users.noreply.github.com>
Co-authored-by: digitlength <62958838+digitlength@users.noreply.github.com>
Co-authored-by: Ross Kennedy <rossko@culzean.clara.co.uk>
Co-authored-by: Fabian Wolter <github@fabian-wolter.de>
Co-authored-by: Arjan Mels <43108771+arjanmels@users.noreply.github.com>
Co-authored-by: Jonathan Gilbert <github.10.jgilbert@xoxy.net>
Co-authored-by: Richard Koshak <rkoshak@users.noreply.github.com>
Co-authored-by: Wolfgang Schueschen <76775650+WolfgangSn@users.noreply.github.com>
Co-authored-by: Gareth Western <gareth@garethwestern.com>
Co-authored-by: Bob A <bobadair@users.noreply.github.com>
Co-authored-by: Sami Salonen <ssalonen@gmail.com>
Co-authored-by: Peter Schraffl <p.schraffl@gmx.at>
Co-authored-by: Georgios Moutsos <50378548+jossuar@users.noreply.github.com>
Co-authored-by: Markus Storm <markus.storm@gmx.net>
Co-authored-by: JensHoRi <47488279+JensHoRi@users.noreply.github.com>
Co-authored-by: Felix <24674809+fex01@users.noreply.github.com>
Co-authored-by: Koen Schockaert <54985218+QbusKoen@users.noreply.github.com>
Co-authored-by: Ethan Dye <mrtops03@gmail.com>
Co-authored-by: Senne Croughs <38940112+sencro@users.noreply.github.com>
Co-authored-by: Ben Clark <ben@benjyc.uk>
Co-authored-by: Sam Spencer <43712250+samsp99@users.noreply.github.com>
Co-authored-by: chingon007 <76529461+chingon007@users.noreply.github.com>
Co-authored-by: Wouter Born <github@maindrain.net>
Co-authored-by: mueller-ma <mueller-ma@users.noreply.github.com>
Co-authored-by: aurelio1 <aurelio@caliaro.net>
Co-authored-by: Bernd Weymann <bernd.weymann@gmail.com>
Co-authored-by: Martin Hogg <hoggm2@hotmail.co.uk>
2021-05-15 15:11:12 +02:00
..
readme.md Partial merge final -> final-stable (#1569) 2021-05-15 15:11:12 +02:00

readme.md

id label title type description since logo install
bluetooth Bluetooth Bluetooth - Bindings binding This binding provides support for generic Bluetooth devices. 3x images/addons/bluetooth.png auto

{% include base.html %}

Bluetooth Binding

This binding provides support for generic Bluetooth devices.

It has the following extensions:

Bridges

In order to function, this binding requires a Bluetooth adapter to be present, which handles the wireless communication. As there is no standard in Bluetooth for such dongles resp. chips, different adapters require a different implementation. This is why the Bluetooth binding itself does not come with any bridge handlers for such adapters itself, but instead is extensible by additional bundles which can implement support for a specific adapter.

For Linux, there exists a special bundle which provides a Bluetooth bridge that talks to BlueZ. This should be the best choice for any Linux-based single board computers like e.g. the Raspberry Pi.

Supported Things

The base bluetooth binding only supports a single thing type. Additional thing types are available through bluetooth extensions.

Thing Type ID Description
beacon A Bluetooth device that is not connected, but only broadcasts announcements.

Discovery

Discovery is performed through the Bluetooth bridge. Normally, any broadcasting Bluetooth device can be uniquely identified and thus a bridge can create an inbox result for it. As this might lead to a huge list of devices, bridges usually disable this behavior by default.

Thing Configuration

All bluetooth thing types require a configuration parameter address, which corresponds to the Bluetooth address of the device (in format "XX:XX:XX:XX:XX:XX"). Other configuration parameters may be required depending on the bluetooth thing type, look at the documentation for that thing type for details.

Channels

Every Bluetooth thing has the following channel:

Channel ID Item Type Description
rssi Number The "Received Signal Strength Indicator", the RSSI

Full Example

demo.things (assuming you have a Bluetooth bridge with the ID bluetooth:bluez:hci0):

bluetooth:beacon:hci0:b1  "BLE Beacon" (bluetooth:bluez:hci0) [ address="68:64:4C:14:FC:C4" ]

demo.items:

Number Beacon_RSSI "My Beacon [%.0f]" { channel="bluetooth:beacon:hci0:b1:rssi" }

demo.sitemap:

sitemap demo label="Main Menu"
{
    Frame {
        Text item=Beacon_RSSI
    }
}

See also the following extensions for further examples: