Skip to content

Commit e205aab

Browse files
coderunnrcoderunnr
committed
bluetooth proximity files initialized
0 parents  commit e205aab

File tree

17 files changed

+655
-0
lines changed

17 files changed

+655
-0
lines changed

‎LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Bluetooth Proximity Detection
2+
3+
Python code for getting the RSSI value of a Bluetooth device by address. Based on the value returned, can determine the proximity of the device.
4+
5+
This code was adapted from [this Github](https://github.com/dagar/bluetooth-proximity) by Daniel Agar.
6+
7+
## Requirements
8+
9+
This code requires the `bluetooth` and `python-bluez` modules to be installed. On Ubuntu/Debian systems, this can usually be done with the following commands:
10+
11+
```
12+
sudo apt-get install bluetooth
13+
sudo apt-get install python-bluez
14+
```
15+
16+
*Note: Your system must also have a Bluetooth adapter.*
17+
18+
## Installation
19+
20+
```
21+
git clone https://github.com/ewenchou/bluetooth-proximity.git
22+
cd bluetooth-proximity
23+
sudo python setup.py install
24+
```
25+
26+
## Examples
27+
28+
### test_address.py
29+
30+
This is a simple script to scan and output the RSSI value of a Bluetooth address in a loop. This can be used to test if the code is working on your setup and also to output the detected RSSI values as you move your Bluetooth device closer/further from the Bluetooth adapter.
31+
32+
Use `Ctrl + C` to exit the script or wait until number of loops has finished.
33+
34+
```
35+
python test_address.py <bluetooth-address> [number-of-loops]
36+
```
37+
38+
### bluetooth_scanner.py
39+
40+
An example script that uses threads to scan for bluetooth addresses in a loop and invokes a callback function when the RSSI value is within a specified threshold.
41+
42+
Edit the script and set the `BT_ADDR_LIST` variable to the list of bluetooth addresses to scan.
43+
44+
Use `Ctrl + C` to exit the script.
45+
46+
```
47+
python bluetooth_scanner.py
48+
```
49+
50+
### lnsm.py (Log Normal Shadowing Model)
51+
52+
An example script to scan & output the distance between two bluetooth devices using the RSSI value . The distance between the two devices is calculated using the Log-Normal Shadowing Model/Log-Distance Pathloss Model.
53+
54+
Use `Ctrl + C` to exit the script or wait until number of loops has finished. Recommended number of loops = 30
55+
56+
```
57+
python lnsm.py <bluetooth-address> [number-of-loops]
58+
```
59+
60+
## Notes
61+
62+
* The RSSI values returned will differ depending on your Bluetooth devices and your surroundings (e.g. are there walls/obstructions, multiple floors, etc).
63+
* Use the test script mentioned above to see what values are returned in your setup.
64+
* RSSI values may be positive or negative integers. You can use the absolute value (i.e. always positive) if you see both.
65+

‎bt_proximity.egg-info/PKG-INFO

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Metadata-Version: 1.0
2+
Name: bt-proximity
3+
Version: 0.1
4+
Summary: Detects if a Bluetooth device is near by querying its RSSI value
5+
Home-page: UNKNOWN
6+
Author: Ewen Chou
7+
Author-email: ewenchou@gmail.com
8+
License: Apache 2.0
9+
Description: UNKNOWN
10+
Platform: UNKNOWN

‎bt_proximity.egg-info/SOURCES.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
setup.py
2+
bt_proximity/__init__.py
3+
bt_proximity/bt_rssi.py
4+
bt_proximity.egg-info/PKG-INFO
5+
bt_proximity.egg-info/SOURCES.txt
6+
bt_proximity.egg-info/dependency_links.txt
7+
bt_proximity.egg-info/not-zip-safe
8+
bt_proximity.egg-info/top_level.txt

‎bt_proximity.egg-info/dependency_links.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎bt_proximity.egg-info/not-zip-safe

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎bt_proximity.egg-info/top_level.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
bt_proximity

‎bt_proximity/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
from bt_rssi import BluetoothRSSI

‎bt_proximity/bt_rssi.py

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
import bluetooth
2+
import bluetooth._bluetooth as bt
3+
import struct
4+
import array
5+
import fcntl
6+
7+
8+
class BluetoothRSSI(object):
9+
"""Object class for getting the RSSI value of a Bluetooth address.
10+
Reference: https://github.com/dagar/bluetooth-proximity
11+
"""
12+
def __init__(self, addr):
13+
self.addr = addr
14+
self.hci_sock = bt.hci_open_dev()
15+
self.hci_fd = self.hci_sock.fileno()
16+
self.bt_sock = bluetooth.BluetoothSocket(bluetooth.L2CAP)
17+
self.bt_sock.settimeout(10)
18+
self.connected = False
19+
self.cmd_pkt = None
20+
21+
def prep_cmd_pkt(self):
22+
"""Prepares the command packet for requesting RSSI"""
23+
reqstr = struct.pack(
24+
"6sB17s", bt.str2ba(self.addr), bt.ACL_LINK, "\0" * 17)
25+
request = array.array("c", reqstr)
26+
handle = fcntl.ioctl(self.hci_fd, bt.HCIGETCONNINFO, request, 1)
27+
handle = struct.unpack("8xH14x", request.tostring())[0]
28+
self.cmd_pkt = struct.pack('H', handle)
29+
30+
def connect(self):
31+
"""Connects to the Bluetooth address"""
32+
self.bt_sock.connect_ex((self.addr, 1)) # PSM 1 - Service Discovery
33+
self.connected = True
34+
35+
def get_rssi(self):
36+
"""Gets the current RSSI value.
37+
38+
@return: The RSSI value (float) or None if the device connection fails
39+
(i.e. the device is nowhere nearby).
40+
"""
41+
try:
42+
# Only do connection if not already connected
43+
if not self.connected:
44+
self.connect()
45+
if self.cmd_pkt is None:
46+
self.prep_cmd_pkt()
47+
# Send command to request RSSI
48+
rssi = bt.hci_send_req(
49+
self.hci_sock, bt.OGF_STATUS_PARAM,
50+
bt.OCF_READ_RSSI, bt.EVT_CMD_COMPLETE, 4, self.cmd_pkt)
51+
rssi = struct.unpack('b', rssi[3])[0]
52+
return rssi
53+
except IOError:
54+
# Happens if connection fails (e.g. device is not in range)
55+
self.connected = False
56+
return None

‎build/lib/bt_proximity/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
from bt_rssi import BluetoothRSSI

0 commit comments

Comments
 (0)