<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarativebluetoothdiscoverymodel.cpp -->
<title>BluetoothDiscoveryModel QML Type | Qt Bluetooth 5.12.6</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td ><a href="qtbluetooth-index.html">Qt Bluetooth</a></td><td ><a href="qtbluetooth-qmlmodule.html">QML Types</a></td><td >BluetoothDiscoveryModel QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtbluetooth-index.html">Qt 5.12.6 Reference Documentation</a></td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">BluetoothDiscoveryModel QML Type</h1>
<span class="subtitle"></span>
<!-- $$$BluetoothDiscoveryModel-brief -->
<p>Enables searching for the Bluetooth devices and services in range. <a href="#details">More...</a></p>
<!-- @@@BluetoothDiscoveryModel -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtBluetooth 5.12</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.2</td></tr></table></div><ul>
<li><a href="qml-qtbluetooth-bluetoothdiscoverymodel-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtbluetooth-bluetoothdiscoverymodel.html#discoveryMode-prop">discoveryMode</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtbluetooth-bluetoothdiscoverymodel.html#error-prop">error</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtbluetooth-bluetoothdiscoverymodel.html#remoteAddress-prop">remoteAddress</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtbluetooth-bluetoothdiscoverymodel.html#running-prop">running</a></b></b> : bool</li>
<li class="fn"><b><b><a href="qml-qtbluetooth-bluetoothdiscoverymodel.html#uuidFilter-prop">uuidFilter</a></b></b> : string</li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtbluetooth-bluetoothdiscoverymodel.html#deviceDiscovered-signal">deviceDiscovered</a></b></b>(string <i>device</i>)</li>
<li class="fn"><b><b><a href="qml-qtbluetooth-bluetoothdiscoverymodel.html#serviceDiscovered-signal">serviceDiscovered</a></b></b>(BluetoothService <i>service</i>)</li>
</ul>
<!-- $$$BluetoothDiscoveryModel-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qml-qtbluetooth-bluetoothdiscoverymodel.html">BluetoothDiscoveryModel</a> provides a model of connectable services. The contents of the model can be filtered by UUID allowing discovery to be limited to a single service such as a game.</p>
<p>The model roles provided by <a href="qml-qtbluetooth-bluetoothdiscoverymodel.html">BluetoothDiscoveryModel</a> are <code>service</code>, <code>name</code>, <code>remoteAddress</code> and <code>deviceName</code>. The meaning of the roles changes based on the current <a href="qml-qtbluetooth-bluetoothdiscoverymodel.html#discoveryMode-prop">discoveryMode</a>.</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Model role</th><th >Device Discovery</th><th >Service Discovery</th></tr></thead>
<tr valign="top" class="odd"><td ><code>name</code></td><td >The device's name and address.</td><td >The service name and the name of the device offering the service. If the device name is empty the devices address will be used.</td></tr>
<tr valign="top" class="even"><td ><code>deviceName</code></td><td >The name of the device.</td><td >The name of the device offering the service.</td></tr>
<tr valign="top" class="odd"><td ><code>service</code></td><td >The role is undefined in this mode.</td><td >The <a href="qml-qtbluetooth-bluetoothservice.html">BluetoothService</a> object describing the discovered service.</td></tr>
<tr valign="top" class="even"><td ><code>remoteAddress</code></td><td >The address of the found device.</td><td >The address of the device offering the service.</td></tr>
</table></div>
<p><b>See also </b><a href="qbluetoothservicediscoveryagent.html">QBluetoothServiceDiscoveryAgent</a>.</p>
<!-- @@@BluetoothDiscoveryModel -->
<h2>Property Documentation</h2>
<!-- $$$discoveryMode -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="discoveryMode-prop">
<td class="tblQmlPropNode"><p>
<a name="discoveryMode-prop"></a><span class="name">discoveryMode</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Sets the discovery mode. The discovery mode has to be set before the discovery is started</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Property</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td ><code>BluetoothDiscoveryModel.FullServiceDiscovery</code></td><td >Starts a full discovery of all services of all devices in range.</td></tr>
<tr valign="top" class="even"><td ><code>BluetoothDiscoveryModel.MinimalServiceDiscovery</code></td><td >(Default) Starts a minimal discovery of all services of all devices in range. A minimal discovery is faster but only guarantees the device and UUID information to be correct.</td></tr>
<tr valign="top" class="odd"><td ><code>BluetoothDiscoveryModel.DeviceDiscovery</code></td><td >Discovers only devices in range. The service role will be 0 for any model item.</td></tr>
</table></div>
</div></div><!-- @@@discoveryMode -->
<br/>
<!-- $$$error -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="error-prop">
<td class="tblQmlPropNode"><p>
<a name="error-prop"></a><span class="name">error</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the last error reported during discovery.</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Property</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td ><code>BluetoothDiscoveryModel.NoError</code></td><td >No error occurred.</td></tr>
<tr valign="top" class="even"><td ><code>BluetoothDiscoveryModel.InputOutputError</code></td><td >An IO failure occurred during device discovery</td></tr>
<tr valign="top" class="odd"><td ><code>BluetoothDiscoveryModel.PoweredOffError</code></td><td >The bluetooth device is not powered on.</td></tr>
<tr valign="top" class="even"><td ><code>BluetoothDiscoveryModel.InvalidBluetoothAdapterError</code></td><td >There is no default Bluetooth device to perform the service discovery. The model always uses the local default adapter. Specifying a default adapter is not possible. If that's required, <a href="qbluetoothservicediscoveryagent.html">QBluetoothServiceDiscoveryAgent</a> should be directly used. This value was introduced by Qt 5.4.</td></tr>
<tr valign="top" class="odd"><td ><code>BluetoothDiscoveryModel.UnknownError</code></td><td >An unknown error occurred.</td></tr>
</table></div>
<p>This property is read-only.</p>
</div></div><!-- @@@error -->
<br/>
<!-- $$$remoteAddress -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="remoteAddress-prop">
<td class="tblQmlPropNode"><p>
<a name="remoteAddress-prop"></a><span class="name">remoteAddress</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds an optional bluetooth address for a remote bluetooth device. Only services on this remote device will be discovered. It has no effect if an invalid bluetooth address was set or if the property was set after the discovery was started.</p>
<p>The property is ignored if device discovery is selected.</p>
</div></div><!-- @@@remoteAddress -->
<br/>
<!-- $$$running -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="running-prop">
<td class="tblQmlPropNode"><p>
<a name="running-prop"></a><span class="name">running</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property starts or stops discovery. A restart of the discovery process requires setting this property to <code>false</code> and subsequently to <code>true</code> again.</p>
</div></div><!-- @@@running -->
<br/>
<!-- $$$uuidFilter -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="uuidFilter-prop">
<td class="tblQmlPropNode"><p>
<a name="uuidFilter-prop"></a><span class="name">uuidFilter</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds an optional UUID filter. A UUID can be used to return only matching services. 16 bit, 32 bit or 128 bit UUIDs can be used. The string format is same as the format of QUuid.</p>
<p><b>See also </b><a href="qbluetoothuuid.html">QBluetoothUuid</a> and QUuid.</p>
</div></div><!-- @@@uuidFilter -->
<br/>
<h2>Signal Documentation</h2>
<!-- $$$deviceDiscovered -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="deviceDiscovered-signal">
<td class="tblQmlFuncNode"><p>
<a name="deviceDiscovered-signal"></a><span class="name">deviceDiscovered</span>(<span class="type">string</span> <i>device</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when a new device is discovered. <i>device</i> contains the Bluetooth address of the discovered device.</p>
<p>The corresponding handler is <code>onDeviceDiscovered</code>.</p>
</div></div><!-- @@@deviceDiscovered -->
<br/>
<!-- $$$serviceDiscovered -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="serviceDiscovered-signal">
<td class="tblQmlFuncNode"><p>
<a name="serviceDiscovered-signal"></a><span class="name">serviceDiscovered</span>(<span class="type"><a href="qml-qtbluetooth-bluetoothservice.html">BluetoothService</a></span> <i>service</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This signal is emitted when a new service is discovered. The <i>service</i> parameter contains the service details.</p>
<p>The corresponding handler is <code>onServiceDiscovered</code>.</p>
<p><b>See also </b><a href="qml-qtbluetooth-bluetoothservice.html">BluetoothService</a>.</p>
</div></div><!-- @@@serviceDiscovered -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
