-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.html
263 lines (148 loc) · 8.88 KB
/
api.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Application programming interface — PyBluez master documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="GNU/Linux" href="api_bt_bluez.html" />
<link rel="prev" title="<no title>" href="dev/authors.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> PyBluez
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="user/intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="user/install.html">Installing PyBluez</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Application programming interface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api_bt_bluez.html">GNU/Linux</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_bt_macos.html">Mac OS</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_bt_ms.html">Windows</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_bt_widcomm.html">Windows widcomm stack</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_com.html">Helper Functions and Exceptions</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">PyBluez</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Application programming interface</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/pybluez/pybluez/blob/master/docs/api.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="application-programming-interface">
<span id="api"></span><h1>Application programming interface<a class="headerlink" href="#application-programming-interface" title="Permalink to this headline">¶</a></h1>
<p>This section of the documentation contains the PyBluez API (Application Programming Interface).
For most applications understanding use of the PyBluez common library is sufficient.
For applications where operating system dependent functionality is required please
see the operating system specific pages.</p>
<p>Documentation for the Python objects defined by the project is divided into package, module,
and class.</p>
<div class="section" id="package-bluetooth">
<h2>Package: bluetooth<a class="headerlink" href="#package-bluetooth" title="Permalink to this headline">¶</a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">bluetooth</span> <span class="k">as</span> <span class="nn">bt</span>
</pre></div>
</div>
<span class="target" id="module-bluetooth"></span><div class="section" id="modules">
<h3>Modules<a class="headerlink" href="#modules" title="Permalink to this headline">¶</a></h3>
<p>When the bluetooth package is imported the appropriate operating system module is automatically
loaded in. This means application developers access the api classes and functions using the package
reference rather than the specific module.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">For</span> <span class="n">example</span><span class="p">:</span>
<span class="o">>>></span> <span class="kn">import</span> <span class="nn">bluetooth</span> <span class="k">as</span> <span class="nn">bt</span>
<span class="o">>>></span> <span class="n">services</span> <span class="o">=</span> <span class="n">bt</span><span class="o">.</span><span class="n">find_service</span><span class="p">(</span><span class="n">address</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
<span class="n">Should</span> <span class="n">work</span> <span class="n">on</span> <span class="nb">all</span> <span class="n">operating</span> <span class="n">systems</span><span class="o">.</span>
</pre></div>
</div>
<p>The modules are documented by operating system here purely as reference.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="api_bt_bluez.html">GNU/Linux</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api_bt_bluez.html#classes">Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_bt_bluez.html#functions">Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_bt_macos.html">Mac OS</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api_bt_macos.html#classes">Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_bt_macos.html#functions">Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_bt_ms.html">Windows</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api_bt_ms.html#classes">Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_bt_ms.html#functions">Functions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api_bt_widcomm.html">Windows widcomm stack</a></li>
<li class="toctree-l1"><a class="reference internal" href="api_com.html">Helper Functions and Exceptions</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="api_bt_bluez.html" class="btn btn-neutral float-right" title="GNU/Linux" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="dev/authors.html" class="btn btn-neutral float-left" title="<no title>" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2004 - 2019, Albert Haung & contributors
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>