8 Commits
v0.2.7 ... dev

Author SHA1 Message Date
Shin'ichiro Kawasaki
2d489321d0 BLESession.setNotifications: Lookup CCCD to start or stop notifications
Per Bluetooth Core Specification Vol.3, Part G, Section 3.3.1.1, if
Notify property is set for a Characteristic, the Client Characteristic
Configuration Descriptor, or CCCD, shall exist. As noted in section
3.3.3.3 of the specification, notification of the Characteristic is
enabled or disabled by setting bit 0 of the CCCD.

This CCCD exists within the characteristic definition following the
Characteristic Value declaration, and section 3.3.3 of the specification
warns that the order of characteristic declaration shall not be assumed.
However, current pyscrlink code assumes that the CCCD comes just after
the Characteristic Value and CCCD handle is obtained just adding 1 to
the handle of the Characteristic Value. This works many of the BLE
devices but does not work all of them.

To get correct CCCD handle, look up descriptors of the Characteristic to
find out the CCCD.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2022-01-03 12:27:39 +09:00
Shin'ichiro Kawasaki
48e460b9c6 BLESession: Add _getDevName() helper function
GitHub issue #31 reported that Intelino Smart Train is not connected
with pyscrlink. It also reported that getValueText(0x9) call for the
device instead of getValueText(0x8) avoids the failure. This implies
that the Intelino Smart Train does not report AdType 0x8 "Shortened
local name" but it reports AdType 0x9 "Complete local name".

To get local name of the BLE devices regardless AdType support status
of those devices, introduce a helper function _getDevName(). It gets the
AdType 0x9 "Complete local name" first. If it is not available, get
AdType 0x8 "Shortened local name". Use this helper function at all
places to get the device name.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2021-12-31 14:49:51 +09:00
Shin'ichiro Kawasaki
3cf61a145b BTSession: Additional change to pretend LEGO EV3 with LEGO Hub
The previous commit tweaked the class IDs returned from the LEGO Hub as
that of LEGO EV3. On top of that, it is required to tweak the class ID
to search and discover for bluetooth.DeviceDiscoverer API.

Also, add some more debug prints to track BT device discovery.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2021-11-21 14:07:15 +09:00
Shin'ichiro Kawasaki
3ffbde35b1 BLESession: handle device UUIDs as list
In the debug for the issue #30, it turned out that the bluepy API
ScanEntry.getValueText() for adtypes may return multiple UUIDs
concatenated with comma. Current code assumes that the API returns
single UUID, then multiple UUIDs cause the "Error: Non-hexadecimal digit
found" for the comma.

To fix it, replace ScanEntry.getValueText() call with getValue(), and
handle the result as a list of UUIDs. Also rename the helper function
_get_dev_uuid() to _get_dev_uuids() accordingly.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2021-11-14 20:46:53 +09:00
Shin'ichiro Kawasaki
18e0818e98 BTSession: Pretend LEGO EV3 with LEGO Hub
To try out LEGO Hub connection as LEGO EV3, tweak BTSession device
discovery code. When the device name has "LEGO Hub", prented its device
class (major/minor=8/4) as LEGO EV3's device class (major/minor=8/1).
This is a trial code for the GitHub issue #21.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2021-11-14 14:46:04 +09:00
Shin'ichiro Kawasaki
266bcc98bd BLESession: Enrich logs for device UUID check
To debug the GitHub issue #30, add more debug logs to functions to check
UUID.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2021-11-14 13:41:54 +09:00
Shin'ichiro Kawasaki
80b99f84a1 BLESession: Override unknown handle with known handle
Unknown handle "13" was recorded in debug log for the Git Hub issue #26.
As a debug trial, replace the unknown handle with the known handle.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2021-11-14 13:13:19 +09:00
Shin'ichiro Kawasaki
f8ce9e3089 BLESession: Enrich logs for notification handling
To debug the GitHub issue #26, add more debug and error logs to
functions to handle notifications.

Signed-off-by: Shin'ichiro Kawasaki <kawasaki@juno.dti.ne.jp>
2021-11-14 13:13:19 +09:00
6 changed files with 337 additions and 105 deletions

6
.gitignore vendored
View File

@@ -1,5 +1 @@
__pycache__ /__pycache__
build
dist
pyscrlink/__pycache__
pyscrlink.egg-info

103
README.md
View File

@@ -9,16 +9,11 @@ micro:bit.
Pyscrlink allows you to connect Scratch and bluetooth devices with the Linux Pyscrlink allows you to connect Scratch and bluetooth devices with the Linux
OSes. It uses the Linux Bluetooth protocol stack [Bluez](http://www.bluez.org/) OSes. It uses the Linux Bluetooth protocol stack [Bluez](http://www.bluez.org/)
and [bluepy](https://github.com/IanHarvey/bluepy) to handle Bluetooth Low Energy and its python interfaces [pybluez](https://github.com/pybluez/pybluez) to
(BLE) connections. It has been reported that pyscrlink connects Scratch 3.0 with handle Bluetooth, and [bluepy](https://github.com/IanHarvey/bluepy) to handle
micro:bit, LEGO WeDo, LEGO Boost and toio. Bluetooth Low Energy (BLE) connections. It has been reported that pyscrlink
connects Scratch 3.0 with micro:bit, LEGO Mindstorms EV3, LEGO WeDo, LEGO
Until version v0.2.5, pyscrlink supported Bluetooth Classic protocol using Boost, Intelino Smart Train and toio.
[pybluez](https://github.com/pybluez/pybluez). Unfortunately, pybluez is not
well maintained and caused technical troubles. Then Bluetooth Classic protocol
support is dropped from pyscrlink. This means that LEGO Mindstorm EV3 can not
be connected with pyscrlink. Bluetooth Classic support is the improvement
opportunity of pyscrlink.
To use websockets, pyscrlink requires python version 3.6 or later. If your To use websockets, pyscrlink requires python version 3.6 or later. If your
system has python older than version 3.6, install newer version. If your system has python older than version 3.6, install newer version. If your
@@ -44,6 +39,7 @@ Devices:
Linux distros: Linux distros:
* Arch Linux * Arch Linux
* elementary OS 5.1 Hera
Browsers: Browsers:
* Firefox * Firefox
@@ -53,8 +49,10 @@ It was reported that pyscrlink (former bluepy-scratch-link) working with
following devices and Linux distros. following devices and Linux distros.
Devices: Devices:
* LEGO Mindstorm EV3 by @chrisglencross
* LEGO WeDo by @zhaowe, @KingBBQ * LEGO WeDo by @zhaowe, @KingBBQ
* LEGO Boost and compatible devices by @laurentchar, @miguev, @jacquesdt, @n3storm * LEGO Boost and compatible devices by @laurentchar, @miguev, @jacquesdt, @n3storm
* Intelino Smart Train by @ErrorJan
* toio by @shimodash * toio by @shimodash
Linux distros: Linux distros:
@@ -91,6 +89,7 @@ Installation
``` ```
4. Set bluepy-helper capability. 4. Set bluepy-helper capability.
This step is required for most of devices except LEGO Mindstorm EV3.
``` ```
$ bluepy_helper_cap $ bluepy_helper_cap
@@ -109,18 +108,67 @@ Installation
Usage Usage
----- -----
1. Start scratch-link python script. 1. For LEGO Mindstorms EV3, pair your Linux PC to the EV3 brick.
First, turn on the EV3 and ensure Bluetooth is enabled.
Then, pair using your Linux desktop's the Bluetooth settings.
If using Gnome:
* Settings -> Bluetooth
* Click on the EV3 device name
* Accept the connection on EV3 brick
* Enter a matching PIN on EV3 brick and Linux PC. '1234' is the value Scratch suggests.
* Confirm EV3 status is "Disconnected" in Bluetooth settings
With a Raspberry Pi default Raspbian desktop, click the Bluetooth logo in the top right of the screen and
Add Device. Then follow the Gnome instructions. You will be warned that the Raspberry Pi
does not know how to talk to this device; that is not a problem.
Alternatively you can perform pairing from the command-line:
```shell script
$ bluetoothctl
[bluetooth]# power on
Changing power on succeeded
[bluetooth]# pairable on
Changing pairable on succeeded
[bluetooth]# agent KeyboardOnly
Agent registered
[bluetooth]# devices
...
Device 00:16:53:53:D3:19 EV3
...
[bluetooth]# pair 00:16:53:53:D3:19
Attempting to pair with 00:16:53:53:D3:19
# Confirm pairing on the EV3 display, set PIN to 1234
Request PIN code
[agent] Enter PIN code: 1234
[CHG] Device 00:16:53:53:D3:19 Connected: yes
[CHG] Device 00:16:53:53:D3:19 Paired: yes
Pairing successful
[bluetooth]# quit
```
2. Start scratch-link python script.
```sh ```sh
$ scratch_link $ scratch_link
``` ```
If your device is toio, add "-s 1" option to the scratch_link command. It If your device is toio, add "-s 1" option to the scratch_link command. It
allows the toio Do Visual Programming to connect to toio automatically. allows the toio Do Visual Programming to connect to toio automatically.
2. Connect scratch to the target device such as micro:bit: 3. Connect scratch to the target device such as micro:bit or LEGO Mindstorms:
* Open FireFox or Chrome. (Make sure to run as the same user for scratch-link python script.) * Open FireFox or Chrome. (Make sure to run as the same user for scratch-link python script.)
* Access [Scratch 3.0](https://scratch.mit.edu/) and create your project. * Access [Scratch 3.0](https://scratch.mit.edu/) and create your project.
* Select the "Add Extension" button. * Select the "Add Extension" button.
* Select the extension for your device (e.g., micro:bit) and follow the prompts to connect. * Select the extension for your device (e.g., micro:bit or Lego Mindstorms EV3 extension) and follow the prompts to connect.
* Build your project with the extension blocks. * Build your project with the extension blocks.
In Case You Fail to Connect In Case You Fail to Connect
@@ -141,22 +189,10 @@ In Case You Fail to Connect
* If the service is not working, refer guide of your distro to set it up. * If the service is not working, refer guide of your distro to set it up.
* If the service is working, also check that /etc/bluetooth/main.conf sets AutoEnable=true. * If the service is working, also check that /etc/bluetooth/main.conf sets AutoEnable=true.
3. If device scan still fails, use -r option to retry device scan. 3. If scratch_link.py says "failed to connect to BT device: [Errno 13] Permission denied",
The command line below does device scan twice. Each scan takes 10 seconds.
```
$ scratch_link -r 2
```
It would be good to use -s option together to reduce each scan duration.
The command line below does 3 seconds device scan twice.
```
$ scratch_link -r 2 -s 3
```
4. If scratch_link.py says "failed to connect to BT device: [Errno 13] Permission denied",
make sure to pair the bluetooth device to your PC before connecting to Scratch. make sure to pair the bluetooth device to your PC before connecting to Scratch.
5. To connect to multiple devices at the same time, make all the target devices 4. To connect to multiple devices at the same time, make all the target devices
ready for scan at the first device scan. This is important for toio. The toio ready for scan at the first device scan. This is important for toio. The toio
allows a single project to connect to two toio devices. allows a single project to connect to two toio devices.
* When the second device was prepared after the first device was connected, device scan can not find the second device. * When the second device was prepared after the first device was connected, device scan can not find the second device.
@@ -170,19 +206,6 @@ Please file issues to [GitHub issue tracker](https://github.com/kawasaki/pyscrli
Releases Releases
-------- --------
Release 0.2.7
* Supported Snap Firefox and Chromium
* Added -r option to retry BLE scan
Release 0.2.6
* Removed Bluetooth Classic and LEGO Mindstorm EV3 support
Release 0.2.5
* Fixed handling of multiple UUIDs for LEGO Boost
Release 0.2.4 Release 0.2.4
* Added -s option to specify BLE scan duration * Added -s option to specify BLE scan duration

View File

@@ -152,37 +152,36 @@ def prep_nss_cert(dir, cert, nickname):
remove_cert(dir, nickname) remove_cert(dir, nickname)
add_cert(dir, cert, nickname) add_cert(dir, cert, nickname)
def prep_cert_for_app(cert, app, search_path):
"""
Find a NSS DB in the search_path for the app and prepare the cert in the DB.
"""
nssdb = None
for root, dirs, files in os.walk(os.path.join(homedir, search_path)):
for name in files:
if not re.match("key.*\.db", name):
continue
nssdb = root
if prep_nss_cert(nssdb, cert, SCRATCH_CERT_NICKNAME):
logger.error(f"Failed to add certificate to {app}: {nssdb}")
sys.exit(3)
else:
logger.info(f"Certificate is ready in {app} NSS DB: {nssdb}")
if not nssdb:
logger.debug(f"NSS DB for {app} not found. Do not add certificate.")
def prep_cert(): def prep_cert():
# Generate certification and key # Generate certification and key
gen_cert(cert_file_path, key_file_path) gen_cert(cert_file_path, key_file_path)
nss_dbs = { # Add certificate to FireFox
"FireFox": ".mozilla/firefox/", nssdb = None
"FireFox(Snap)": "snap/firefox/common/.mozilla/firefox/", firefox_nss_path = os.path.join(homedir, ".mozilla/firefox/")
"Chrome": ".pki", for root, dirs, files in os.walk(firefox_nss_path):
"Chromium(Snap)": "snap/chromium", for name in files:
} if not re.match("key.*\.db", name):
continue
nssdb = root
if prep_nss_cert(nssdb, cert_file_path, SCRATCH_CERT_NICKNAME):
logger.error(f"Failed to add certificate to FireFox NSS DB: {nssdb}")
sys.exit(3)
else:
logger.info(f"Certificate is ready in FireFox NSS DB: {nssdb}")
if not nssdb:
logger.info("FireFox NSS DB not found. Do not add certificate.")
[ prep_cert_for_app(cert_file_path, k, nss_dbs[k]) for k in nss_dbs ] # Add certificate to Chrome
nssdb = os.path.join(homedir, ".pki/nssdb")
if os.path.isdir(nssdb):
if prep_nss_cert(nssdb, cert_file_path, SCRATCH_CERT_NICKNAME):
logger.error(f"Failed to add certificate to Chrome")
sys.exit(4)
else:
logger.info("Certificate is ready for Chrome")
else:
logger.info("Chrome NSS DB not found. Do not add certificate.")
if __name__ == "__main__": if __name__ == "__main__":
prep_cert() prep_cert()

View File

@@ -17,6 +17,9 @@ import signal
import traceback import traceback
import argparse import argparse
# for Bluetooth (e.g. Lego EV3)
import bluetooth
# for BLESession (e.g. BBC micro:bit) # for BLESession (e.g. BBC micro:bit)
from bluepy.btle import Scanner, UUID, Peripheral, DefaultDelegate from bluepy.btle import Scanner, UUID, Peripheral, DefaultDelegate
from bluepy.btle import BTLEDisconnectError, BTLEManagementError from bluepy.btle import BTLEDisconnectError, BTLEManagementError
@@ -44,6 +47,8 @@ logger.propagate = False
HOSTNAME="device-manager.scratch.mit.edu" HOSTNAME="device-manager.scratch.mit.edu"
scan_seconds=10.0 scan_seconds=10.0
CCCD_UUID = 0x2902
class Session(): class Session():
"""Base class for BTSession and BLESession""" """Base class for BTSession and BLESession"""
def __init__(self, websocket, loop): def __init__(self, websocket, loop):
@@ -135,6 +140,204 @@ class Session():
class BTSession(Session): class BTSession(Session):
"""Manage a session for Bluetooth device""" """Manage a session for Bluetooth device"""
INITIAL = 1
DISCOVERY = 2
DISCOVERY_COMPLETE = 3
CONNECTED = 4
DONE = 5
# Split this into discovery thread and communication thread
# discovery thread should auto-terminate
class BTThread(threading.Thread):
"""
Separated thread to control notifications to Scratch.
It handles device discovery notification in DISCOVERY status
and notifications from bluetooth devices in CONNECTED status.
"""
class BTDiscoverer(bluetooth.DeviceDiscoverer):
def __init__(self, major_class, minor_class):
super().__init__()
self.major_class = major_class
self.minor_class = minor_class
self.found_devices = {}
self.done = False
def pre_inquiry(self):
self.done = False
def device_discovered(self, address, device_class, rssi, name):
logger.debug(f"Found device {name} addr={address} class={device_class} rssi={rssi}")
major_class = (device_class & 0x1F00) >> 8
minor_class = (device_class & 0xFF) >> 2
if "LEGO Hub" in name:
minor_class = 1
logger.info(f"Pretend to be LEGO EV3 with LEGO Hub: class={major_class/minor_class}")
if major_class == self.major_class and minor_class == self.minor_class:
self.found_devices[address] = (name, device_class, rssi)
def inquiry_complete(self):
self.done = True
def __init__(self, session, major_device_class, minor_device_class):
threading.Thread.__init__(self)
self.session = session
self.major_device_class = major_device_class
self.minor_device_class = minor_device_class
self.cancel_discovery = False
self.ping_time = None
def discover(self):
major = self.major_device_class
minor = self.minor_device_class
if major == 8 and minor == 1:
logger.info(f"Search LEGO Hub instead of LEGO EV3")
minor = 4
logger.debug(f"BT discover: class={major}/{minor}")
discoverer = self.BTDiscoverer(major, minor)
discoverer.find_devices(lookup_names=True)
while self.session.status == self.session.DISCOVERY and not discoverer.done and not self.cancel_discovery:
readable = select.select([discoverer], [], [], 0.5)[0]
if discoverer in readable:
discoverer.process_event()
for addr, (device_name, device_class, rssi) in discoverer.found_devices.items():
logger.debug(f"notifying discovered {addr}: {device_name}")
params = {"rssi": rssi, 'peripheralId': addr, 'name': device_name.decode("utf-8")}
self.session.notify('didDiscoverPeripheral', params)
discoverer.found_devices.clear()
if not discoverer.done:
discoverer.cancel_inquiry()
def run(self):
while self.session.status != self.session.DONE:
logger.debug(f"loop in BT thread: session status={self.session.status}")
current_time = int(round(time.time()))
if self.session.status == self.session.DISCOVERY and not self.cancel_discovery:
logger.debug("in discovery status:")
try:
self.discover()
self.ping_time = current_time + 5
finally:
self.session.status = self.session.DISCOVERY_COMPLETE
elif self.session.status == self.session.CONNECTED:
logger.debug("in connected status:")
sock = self.session.sock
try:
ready = select.select([sock], [], [], 1)
if ready[0]:
header = sock.recv(2)
[msg_len] = struct.unpack("<H", header)
msg_data = sock.recv(msg_len)
data = header + msg_data
params = {'message': base64.standard_b64encode(data).decode('utf-8'), "encoding": "base64"}
self.session.notify('didReceiveMessage', params)
self.ping_time = current_time + 5
except Exception as e:
logger.error(e)
self.session.close()
break
# To avoid repeated lock by this single thread,
# yield CPU to other lock waiting threads.
time.sleep(0)
else:
# Nothing to do:
time.sleep(1)
# Terminate if we have lost websocket connection to Scratch (e.g. browser closed)
if self.ping_time is None or self.ping_time <= current_time:
try:
self.session.notify('ping', {})
self.ping_time = current_time + 5
except Exception as e:
logger.error(e)
self.session.close()
break
def __init__(self, websocket, loop):
super().__init__(websocket, loop)
self.status = self.INITIAL
self.sock = None
self.bt_thread = None
def close(self):
self.status = self.DONE
if self.sock:
logger.info(f"disconnect to BT socket: {self.sock}")
self.sock.close()
self.sock = None
def __del__(self):
self.close()
def handle_request(self, method, params):
"""Handle requests from Scratch"""
logger.debug("handle request to BT device")
logger.debug(method)
if len(params) > 0:
logger.debug(params)
res = { "jsonrpc": "2.0" }
if self.status == self.INITIAL and method == 'discover':
logger.debug("Starting async discovery")
self.status = self.DISCOVERY
self.bt_thread = self.BTThread(self, params["majorDeviceClass"], params["minorDeviceClass"])
self.bt_thread.start()
res["result"] = None
elif self.status in [self.DISCOVERY, self.DISCOVERY_COMPLETE] and method == 'connect':
# Cancel discovery
while self.status == self.DISCOVERY:
logger.debug("Cancelling discovery")
self.bt_thread.cancel_discovery = True
time.sleep(1)
addr = params['peripheralId']
logger.debug(f"connecting to the BT device {addr}")
try:
self.sock = bluetooth.BluetoothSocket(bluetooth.RFCOMM)
self.sock.connect((addr, 1))
logger.info(f"connected to BT device: {addr}")
except bluetooth.BluetoothError as e:
logger.error(f"failed to connect to BT device: {e}", exc_info=e)
self.status = self.DONE
self.sock = None
if self.sock:
res["result"] = None
self.status = self.CONNECTED
else:
err_msg = f"BT connect failed: {addr}"
res["error"] = { "message": err_msg }
self.status = self.DONE
elif self.status == self.CONNECTED and method == 'send':
logger.debug("handle send request")
if params['encoding'] != 'base64':
logger.error("encoding other than base 64 is not "
"yet supported: ", params['encoding'])
msg_bstr = params['message'].encode('ascii')
data = base64.standard_b64decode(msg_bstr)
self.sock.send(data)
res['result'] = len(data)
logger.debug(res)
return res
def end_request(self):
logger.debug(f"end_request of BTSession {self}")
return self.status == self.DONE
class BLESession(Session): class BLESession(Session):
""" """
Manage a session for Bluetooth Low Energy device such as micro:bit Manage a session for Bluetooth Low Energy device such as micro:bit
@@ -161,6 +364,14 @@ class BLESession(Session):
scan_lock = threading.RLock() scan_lock = threading.RLock()
scan_started = False scan_started = False
@staticmethod
def _getDevName(dev):
"""
Get AdType 0x09 (Completed local name). If it is not available,
get AdType 0x08 (Shortened local name).
"""
return dev.getValueText(0x9) or dev.getValueText(0x8)
class BLEThread(threading.Thread): class BLEThread(threading.Thread):
""" """
Separated thread to control notifications to Scratch. Separated thread to control notifications to Scratch.
@@ -180,7 +391,7 @@ class BLESession(Session):
for d in devices: for d in devices:
params = { 'rssi': d.rssi } params = { 'rssi': d.rssi }
params['peripheralId'] = devices.index(d) params['peripheralId'] = devices.index(d)
params['name'] = d.getValueText(0x9) or d.getValueText(0x8) params['name'] = BLESession._getDevName(d)
self.session.notify('didDiscoverPeripheral', params) self.session.notify('didDiscoverPeripheral', params)
time.sleep(1) time.sleep(1)
elif self.session.status == self.session.CONNECTED: elif self.session.status == self.session.CONNECTED:
@@ -197,7 +408,8 @@ class BLESession(Session):
logger.debug("after waitForNotification") logger.debug("after waitForNotification")
logger.debug("released lock for waitForNotification") logger.debug("released lock for waitForNotification")
except Exception as e: except Exception as e:
logger.error(e) logger.error(f"Exception in waitForNotifications: "
f"{type(e).__name__}: {e}")
self.session.close() self.session.close()
break break
else: else:
@@ -221,7 +433,8 @@ class BLESession(Session):
self.restart_notification_event.set() self.restart_notification_event.set()
def add_handle(self, serviceId, charId, handle): def add_handle(self, serviceId, charId, handle):
logger.debug(f"add handle for notification: {handle}") logger.debug(f"add handle for notification: "
f"{serviceId} {charId} {handle}")
params = { 'serviceId': UUID(serviceId).getCommonName(), params = { 'serviceId': UUID(serviceId).getCommonName(),
'characteristicId': charId, 'characteristicId': charId,
'encoding': 'base64' } 'encoding': 'base64' }
@@ -229,6 +442,14 @@ class BLESession(Session):
def handleNotification(self, handle, data): def handleNotification(self, handle, data):
logger.debug(f"BLE notification: {handle} {data}") logger.debug(f"BLE notification: {handle} {data}")
if handle not in self.handles:
logger.error(f"Notification with unknown handle: {handle}")
keys = list(self.handles.keys())
if keys and len(keys) == 1:
logger.debug(f"Debug: override {handle} with {keys[0]}")
handle = keys[0]
else:
return
params = self.handles[handle].copy() params = self.handles[handle].copy()
params['message'] = base64.standard_b64encode(data).decode('ascii') params['message'] = base64.standard_b64encode(data).decode('ascii')
self.session.notify('characteristicDidChange', params) self.session.notify('characteristicDidChange', params)
@@ -293,7 +514,7 @@ class BLESession(Session):
return True return True
if 'namePrefix' in f: if 'namePrefix' in f:
# 0x08: Shortened Local Name # 0x08: Shortened Local Name
deviceName = dev.getValueText(0x08) deviceName = self._getDevName(dev)
if not deviceName: if not deviceName:
continue continue
logger.debug(f"Name of \"{deviceName}\" begins with: \"{f['namePrefix']}\"?") logger.debug(f"Name of \"{deviceName}\" begins with: \"{f['namePrefix']}\"?")
@@ -318,7 +539,6 @@ class BLESession(Session):
BLESession.found_devices.clear() BLESession.found_devices.clear()
for i in range(self.MAX_SCANNER_IF): for i in range(self.MAX_SCANNER_IF):
scanner = Scanner(iface=i) scanner = Scanner(iface=i)
for j in range(scan_retry):
try: try:
logger.debug(f"start BLE scan: {scan_seconds} seconds") logger.debug(f"start BLE scan: {scan_seconds} seconds")
devices = scanner.scan(scan_seconds) devices = scanner.scan(scan_seconds)
@@ -327,14 +547,8 @@ class BLESession(Session):
BLESession.found_devices.append(dev) BLESession.found_devices.append(dev)
found = True found = True
logger.debug(f"BLE device found with iface #{i}"); logger.debug(f"BLE device found with iface #{i}");
if found: except BTLEManagementError as e:
break logger.debug(f"BLE iface #{i}: {e}");
except BTLEDisconnectError as de:
logger.debug(f"BLE iface #{i}: {de}");
except BTLEManagementError as me:
logger.debug(f"BLE iface #{i}: {me}");
if found:
break
else: else:
found = len(BLESession.found_devices) > 0 found = len(BLESession.found_devices) > 0
return found return found
@@ -416,7 +630,7 @@ class BLESession(Session):
elif self.status == self.DISCOVERY and method == 'connect': elif self.status == self.DISCOVERY and method == 'connect':
logger.debug("connecting to the BLE device") logger.debug("connecting to the BLE device")
self.device = BLESession.found_devices[params['peripheralId']] self.device = BLESession.found_devices[params['peripheralId']]
self.deviceName = self.device.getValueText(0x9) or self.device.getValueText(0x8) self.deviceName = self._getDevName(self.device)
try: try:
self.perip = Peripheral(self.device) self.perip = Peripheral(self.device)
logger.info(f"connected to the BLE peripheral: {self.deviceName}") logger.info(f"connected to the BLE peripheral: {self.deviceName}")
@@ -493,11 +707,19 @@ class BLESession(Session):
service = self._get_service(service_id) service = self._get_service(service_id)
c = self._get_characteristic(chara_id) c = self._get_characteristic(chara_id)
handle = c.getHandle() handle = c.getHandle()
# get CCCD or Client Characterstic Configuration Descriptor
cccd = None
for d in c.getDescriptors():
if d.uuid == UUID(CCCD_UUID):
cccd = d
if not cccd:
logger.error("Characteristic {char_id} does not have CCCD")
return
# prepare notification handler # prepare notification handler
self.delegate.add_handle(service_id, chara_id, handle) self.delegate.add_handle(service_id, chara_id, handle)
# request notification to the BLE device # request notification to the BLE device
with self.lock: with self.lock:
self.perip.writeCharacteristic(handle + 1, value, True) self.perip.writeCharacteristic(cccd.handle, value, True)
def startNotifications(self, service_id, chara_id): def startNotifications(self, service_id, chara_id):
logger.debug(f"start notification for {chara_id}") logger.debug(f"start notification for {chara_id}")
@@ -541,14 +763,11 @@ def stack_trace():
def main(): def main():
global scan_seconds global scan_seconds
global scan_retry
parser = argparse.ArgumentParser(description='start Scratch-link') parser = argparse.ArgumentParser(description='start Scratch-link')
parser.add_argument('-d', '--debug', action='store_true', parser.add_argument('-d', '--debug', action='store_true',
help='print debug messages') help='print debug messages')
parser.add_argument('-s', '--scan_seconds', type=float, default=10.0, parser.add_argument('-s', '--scan_seconds', type=float, default=10.0,
help='specifiy duration to scan BLE devices in seconds') help='specifiy duration to scan BLE devices in seconds')
parser.add_argument('-r', '--scan_retry', type=int, default=1,
help='specifiy retry times to scan BLE devices')
args = parser.parse_args() args = parser.parse_args()
if args.debug: if args.debug:
print("Print debug messages") print("Print debug messages")
@@ -556,9 +775,7 @@ def main():
handler.setLevel(logLevel) handler.setLevel(logLevel)
logger.setLevel(logLevel) logger.setLevel(logLevel)
scan_seconds = args.scan_seconds scan_seconds = args.scan_seconds
scan_retry = args.scan_retry
logger.debug(f"set scan_seconds: {scan_seconds}") logger.debug(f"set scan_seconds: {scan_seconds}")
logger.debug(f"set scan_retry: {scan_retry}")
# Prepare certificate of the WSS server # Prepare certificate of the WSS server
gencert.prep_cert() gencert.prep_cert()

View File

@@ -4,17 +4,13 @@ usage() {
echo "Usage: ${0} COMMAND" echo "Usage: ${0} COMMAND"
echo -e "COMMAND:" echo -e "COMMAND:"
echo -e "\tbuild" echo -e "\tbuild"
echo -e "\tupload FILES"
echo -e "\tupload-testpypi FILES" echo -e "\tupload-testpypi FILES"
echo -e "examples:"
echo -e "\t${0} build"
echo -e "\t${0} upload dist/*0.2.6*"
exit 1 exit 1
} }
case ${1} in case ${1} in
build) build)
python -m build python setup.py sdist bdist_wheel
;; ;;
upload) upload)
shift shift

View File

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
setuptools.setup( setuptools.setup(
name="pyscrlink", name="pyscrlink",
version="0.2.7", version="0.2.4",
author="Shin'ichiro Kawasaki", author="Shin'ichiro Kawasaki",
author_email='kawasaki@juno.dti.ne.jp', author_email='kawasaki@juno.dti.ne.jp',
description='Scratch-link for Linux with Python', description='Scratch-link for Linux with Python',
@@ -22,6 +22,7 @@ setuptools.setup(
install_requires=[ install_requires=[
'websockets', 'websockets',
'bluepy', 'bluepy',
'pybluez',
'pyOpenSSL', 'pyOpenSSL',
], ],
entry_points={ entry_points={